Shipsidekick LogoShipsidekick Docs
API/Orders

Get order by ID

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

GET
/orders/{orderId}

Path Parameters

orderIdRequiredstring

Unique identifier of the order

Format: "uuid"
curl -X GET "https://www.shipsidekick.com/api/v1/orders/abcd1234-e89b-12d3-a456-426614174000"

Successful operation

{
  "object": "order",
  "data": {
    "$ref": "#/components/examples/OrderExample/value"
  }
}

Create a new order POST

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.

List orders GET

Retrieve a list of orders with pagination and filtering options. Results are filtered to orders the authenticated user has access to.