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/Orders Query 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 Create a new order
POST /v1/Orders(id)/Ship Mark an order as shipped
POST /v1/Orders(id)/Export Mark an order as exported
DELETE /v1/Orders(id)/Export Mark an order as not exported
POST /v1/Orders(id)/Adjust Create an order level adjustment

Orders Items

GET /v1/Orders(id)/Items Retrieve all items for a single order
POST /v1/OrderItems(id)/Adjust Create an item level adjustment

Order Item Bundle Components

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

Fulfillments

GET /v1/Orders(id)/Fulfillments Retrieve all fulfillments for a single order
GET /v1/Fulfillments Query 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/Fulfillments Create a new fulfillment
POST /v1/Fulfillments(id)/Move Move fulfillment items
GET /v1/Fulfillments(id)/Label Retrieve a shipping label
DELETE /v1/Fulfillments(id)/Label Cancel a shipping label

Fulfillment Items

GET /v1/Fulfillments(id)/Items Retrieve all items for a single fulfillment
GET /v1/FulfillmentsItems Query 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)/Move Move 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)/ApproveBuyerRequest Approve a buyer-initiated return that is in the NewRma status
POST /v1/OrderAdjustments(id)/RejectBuyerRequest Reject a buyer-initiated return that is in the NewRma status
POST /v1/OrderAdjustments(id)/ApproveReturn Approve a buyer-initiated return that is in the ReadyForReturn status
POST /v1/OrderAdjustments(id)/RejectReturn Reject 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)/ApproveBuyerRequest Approve a buyer-initiated return that is in the NewRma status
POST /v1/OrderItemAdjustments(id)/RejectBuyerRequest Reject a buyer-initiated return that is in the NewRma status
POST /v1/OrderItemAdjustments(id)/ApproveReturn Approve a buyer-initiated return that is in the ReadyForReturn status
POST /v1/OrderItemAdjustments(id)/RejectReturn Reject a buyer-initiated return that is in the ReadyForReturn status