OrderItems

Adjust

post/v1/OrderItems({ID})/Adjust

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/OrderItems({ID})/Adjust
  • 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 OrderItem

Request body

Quantitynumber nullable
Reason'GeneralAdjustment' | 'ItemNotAvailable' | 'CustomerReturnedItem' | 'CouldNotShip' | 'AlternateItemProvided' | 'BuyerCancelled' | 'CustomerExchange' | 'MerchandiseNotReceived' | 'ShippingAddressUndeliverable'
Restockboolean nullable
ItemAdjustmentnumber nullable
TaxAdjustmentnumber nullable
ShippingAdjustmentnumber nullable
ShippingTaxAdjustmentnumber nullable
GiftWrapAdjustmentnumber nullable
GiftWrapTaxAdjustmentnumber nullable
RecyclingFeeAdjustmentnumber nullable
PreventSiteProcessingboolean nullable
SellerAdjustmentIDstring nullable
ForceCalculateOmittedAmountsboolean nullable
RefundOnlyboolean nullable
ReturnTrackingNumberOrUrlstring nullable
ReturnShippingMethodstring nullable
ReturnShippingCostnumber nullable
ReturnDistributionCenterIDnumber nullable
ReturnDistributionCenterCodestring nullable
BuyerReturnCommentstring nullable

Response

Success

Changes

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