OrderItemAdjustments

Get Order Item Adjustments by key

get/v1/OrderItemAdjustments({ID})

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/OrderItemAdjustments({ID})
  • Auth: OAuth 2 (authorization code, authorization URL https://api.channeladvisor.com/oauth2/authorize, token URL https://api.channeladvisor.com/oauth2/token; implicit, authorization URL https://api.channeladvisor.com/oauth2/authorize, scopes: orders, inventory) and HTTP bearer

Path parameters

IDnumber required

The unique identifier of OrderItemAdjustment

Query parameters

$selectstring[]

Select properties to be returned

$expandstring[]

Expand related entities

Response

Retrieved entity

CreatedSource'Channel' | 'UserInterface' | 'Api' | 'System'
LastUpdatedSource'Channel' | 'UserInterface' | 'Api' | 'System'
ReturnSellerCommentstring nullable
ReturnDistributionCenterIDnumber nullable
ReturnDistributionCenterCodestring nullable
BuyerReturnCommentstring nullable
IDnumber
ProfileIDnumber
OrderIDnumber
OrderItemIDnumber nullable
Quantitynumber nullable
IsRestockboolean
Reason'GeneralAdjustment' | 'ItemNotAvailable' | 'CustomerReturnedItem' | 'CouldNotShip' | 'AlternateItemProvided' | 'BuyerCancelled' | 'CustomerExchange' | 'MerchandiseNotReceived' | 'ShippingAddressUndeliverable'
ItemAdjustmentnumber nullable
TaxAdjustmentnumber nullable
ShippingAdjustmentnumber nullable
ShippingTaxAdjustmentnumber nullable
GiftWrapAdjustmentnumber nullable
GiftWrapTaxAdjustmentnumber nullable
RecyclingFeeAdjustmentnumber nullable
Type'Refund' | 'Cancellation'
SellerAdjustmentIDstring nullable
SiteAdjustmentIDstring nullable
SiteRefundDateUtcstring date-time nullable
AdjustmentTransactionIDstring nullable
PublicNotesstring nullable
Commentstring nullable
CreatedDateUtcstring date-time nullable
RequestStatus'SubmittedNotProcessed' | 'NewRma' | 'PendingApproval' | 'ProcessingApproval' | 'ReadyForReturn' | 'PendingReturn' | 'ProcessingReturn' | 'PendingRejection' | 'ProcessingRejection' | 'ProcessedNotAcknowledged' | 'PendingReturnRejection' | 'ProcessingReturnRejection' | 'AcknowledgedPostProcessingNotComplete' | 'Queued' | 'PostProcessingComplete' | 'RejectionCompleted' | 'InformationOnly' | 'NoChange' | 'Error'
RestockStatus'SubmittedNotProcessed' | 'NewRma' | 'PendingApproval' | 'ProcessingApproval' | 'ReadyForReturn' | 'PendingReturn' | 'ProcessingReturn' | 'PendingRejection' | 'ProcessingRejection' | 'ProcessedNotAcknowledged' | 'PendingReturnRejection' | 'ProcessingReturnRejection' | 'AcknowledgedPostProcessingNotComplete' | 'Queued' | 'PostProcessingComplete' | 'RejectionCompleted' | 'InformationOnly' | 'NoChange' | 'Error'
RmaNumberstring nullable
ReturnShippingFeenumber nullable
RestockingFeenumber nullable
ReturnTrackingNumberOrUrlstring nullable
ReturnShippingMethodstring nullable
ReturnShippingCostnumber nullable
ReferenceSkustring nullable
ReferenceProductIDnumber nullable
ReturnRejectionReason'IneligibleForReturn' | 'ReturnNotNeeded' | 'ReturnWindowClosed' | 'DamagedProduct' | 'MissingItem' | 'ProductReturnedAfterTheReturnWindow' | 'WrongProduct' | 'Other'
LastUpdatedDateUtcstring date-time nullable
IsRmaboolean

Example response

{
  "CreatedSource": "Channel",
  "LastUpdatedSource": "Channel",
  "ReturnSellerComment": "string",
  "ReturnDistributionCenterID": 0,
  "ReturnDistributionCenterCode": "string",
  "BuyerReturnComment": "string",
  "ID": 0,
  "ProfileID": 0,
  "OrderID": 0,
  "OrderItemID": 0,
  "Quantity": 0,
  "IsRestock": true,
  "Reason": "GeneralAdjustment",
  "ItemAdjustment": 0,
  "TaxAdjustment": 0,
  "ShippingAdjustment": 0,
  "ShippingTaxAdjustment": 0,
  "GiftWrapAdjustment": 0,
  "GiftWrapTaxAdjustment": 0,
  "RecyclingFeeAdjustment": 0,
  "Type": "Refund",
  "SellerAdjustmentID": "string",
  "SiteAdjustmentID": "string",
  "SiteRefundDateUtc": "0001-01-01T00:00:00.0000000+00:00",
  "AdjustmentTransactionID": "string",
  "PublicNotes": "string",
  "Comment": "string",
  "CreatedDateUtc": "0001-01-01T00:00:00.0000000+00:00",
  "RequestStatus": "SubmittedNotProcessed",
  "RestockStatus": "SubmittedNotProcessed",
  "RmaNumber": "string",
  "ReturnShippingFee": 0,
  "RestockingFee": 0,
  "ReturnTrackingNumberOrUrl": "string",
  "ReturnShippingMethod": "string",
  "ReturnShippingCost": 0,
  "ReferenceSku": "string",
  "ReferenceProductID": 0,
  "ReturnRejectionReason": "IneligibleForReturn",
  "LastUpdatedDateUtc": "0001-01-01T00:00:00.0000000+00:00",
  "IsRma": true,
  "OrderItem": {
    "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItem"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.