Orders Endpoints

Case-Sensitivity in URIs:

  • Every property definition before the "?" in a URI is case-sensitive (e.g. attribute name string values)
  • Everything after the "?" in a URI is not case-sensitive (e.g. $filter=property definitions, operators; $select, $orderby, etc)

Orders

GET /v1/OrdersQuery against all orders across accounts
GET /v1/Orders(id)Retrieve a single order
PATCH or PUT /v1/Orders(id)Modify an existing order
POST /v1/Orders/CreateCreate a new order
POST /v1/Orders(id)/ShipMark an order as shipped
POST /v1/Orders(id)/ExportMark an order as exported
DELETE /v1/Orders(id)/ExportMark an order as not exported
POST /v1/Orders(id)/AdjustCreate an order level adjustment
POST /v1/Orders(id)/ShippingRatesRetrieve shipping rates
POST /v1/Orders(id)/PurchaseLabelPurchase a shipping label

Orders Items

GET /v1/Orders(id)/ItemsRetrieve all items for a single order
POST /v1/OrderItems(id)/AdjustCreate an item level adjustment

Order Item Bundle Components

GET /v1/OrderItems(id)/BundleComponentsRetrieve all bundle components that comprise an order item

Fulfillments

GET /v1/Orders(id)/FulfillmentsRetrieve all fulfillments for a single order
GET /v1/FulfillmentsQuery against all fulfillments across accounts
GET /v1/Fulfillments(id)Retrieve a single fulfillment
PATCH or PUT /v1/Fulfillments(id)Modify an existing fulfillment
POST /v1/FulfillmentsCreate a new fulfillment
POST /v1/Fulfillments(id)/MoveMove fulfillment items
GET /v1/Fulfillments(id)/LabelRetrieve a shipping label
DELETE /v1/Fulfillments(id)/LabelCancel a shipping label
GET /v1/Fulfillments(id)/ReturnLabelRetrieve a return label
GET /v1/Fulfillments(id)/ChannelReturnLabelRetrieve a channel return label
GET /v1/Fulfillments(id)/ChannelPackingSlipRetrieve a channel packing slip

Fulfillment Items

GET /v1/Fulfillments(id)/ItemsRetrieve all items for a single fulfillment
GET /v1/FulfillmentsItemsQuery against all fulfillment items across accounts
GET /v1/FulfillmentsItems(id)Retrieve a single fulfillment item
PATCH or PUT /v1/FulfillmentsItems(id)Modify an existing fulfillment item
POST /v1/FulfillmentItems(id)/MoveMove fulfillment items

Order Adjustments

GET /v1/OrderAdjustments(id)Retrieve a single order adjustment
PATCH or PUT /v1/OrderAdjustments(id)Modify an existing order adjustment
POST /v1/OrderAdjustments(id)/ApproveBuyerRequestApprove a buyer-initiated return that is in the NewRma status
POST /v1/OrderAdjustments(id)/RejectBuyerRequestReject a buyer-initiated return that is in the NewRma status
POST /v1/OrderAdjustments(id)/ApproveReturnApprove a buyer-initiated return that is in the ReadyForReturn status
POST /v1/OrderAdjustments(id)/RejectReturnReject a buyer-initiated return that is in the ReadyForReturn status

Order Item Adjustments

GET /v1/OrderItemAdjustments(id)Retrieve a single order item adjustment
PATCH or PUT /v1/OrderItemAdjustments(id)Modify an existing order item adjustment
POST /v1/OrderItemAdjustments(id)/ApproveBuyerRequestApprove a buyer-initiated return that is in the NewRma status
POST /v1/OrderItemAdjustments(id)/RejectBuyerRequestReject a buyer-initiated return that is in the NewRma status
POST /v1/OrderItemAdjustments(id)/ApproveReturnApprove a buyer-initiated return that is in the ReadyForReturn status
POST /v1/OrderItemAdjustments(id)/RejectReturnReject a buyer-initiated return that is in the ReadyForReturn status

Channel Documents

GET /v1/ChannelDocumentsRetrieve a list of any existing channel documents that have not yet been retrieved
GET /v1/ChannelDocuments/NotSuppliedRetrieve a list of any missing channel documents that need to uploaded
GET /v1/Orders(ID)/ChannelDocumentsRetrieve a list of any channel documents uploaded and their status for a specified order
POST /v1/ChannelDocumentsSubmit files to associate with REST API
GET /v1/ChannelDocuments(‘DocumentKey’)Retrieve a specific channel document, including its metadata, status, and content.
POST /v1/ChannelDocuments(‘DocumentKey’)/RetrievedMark a channel document as retrieved
DELETE /v1/ChannelDocuments(‘DocumentKey’)/RetrievedMark a channel document as not retrieved