Shipsidekick LogoShipsidekick Docs
API/Orders

Create a new order

Create a new order in the system. Optionally include a return order to be created simultaneously (useful for pre-paid return labels included with outbound orders). Requires full write access to orders.

POST
/orders

Request Body

application/jsonRequired
nameRequiredstring

Order name prefix - the system will generate a unique order name using this prefix

aliasstring

Alternative identifier for the order

priceRequirednumber

Total price of the order

Format: "float"
compareAtPricenumber

Original price before discounts

Format: "float"
currencyRequiredstring

Currency code for the order

Default: "usd"
financialStatusRequiredstring

Payment status of the order

Default: "pending"Value in: "authorized" | "expired" | "paid" | "partially-paid" | "partially-refunded" | "pending" | "refunded" | "voided"
fulfillmentStatusRequiredstring

Fulfillment status of the order

Default: "open"Value in: "scheduled" | "open" | "confirmed" | "on-hold" | "partially-fulfilled" | "fulfilled"
orderDateRequiredstring

Date the order was placed

Format: "date-time"
targetDeliveryDatestring

Target date for delivery

Format: "date-time"
shipToAddressobject

Shipping address details

customerIdstring

ID of the customer placing the order

Format: "uuid"
lineItemsarray<object>

Products to include in the order

tagsarray<string>

Tags to associate with the order

notesarray<string>

Notes to attach to the order

returnOrderobject

Return order information to be created with this order (useful for pre-paid return labels included with outbound orders)

curl -X POST "https://www.shipsidekick.com/api/v1/orders" \
  -H "Content-Type: application/json" \
  -d '{
    "$ref": "#/components/examples/CreateOrderExample/value"
  }'

Order created successfully

{
  "$ref": "#/components/examples/CreatedOrderResponseExample/value"
}

Orders

Creating orders in Shipsidekick

Get order by ID GET

Retrieve a specific order by its unique identifier. Results are filtered to orders the authenticated user has access to.