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": {
    "id": "abcd1234-e89b-12d3-a456-426614174000",
    "organizationId": "org-5678-1234-abcd-efgh-987654321000",
    "name": "ORD-12345",
    "alias": "CONT-789",
    "price": 42.98,
    "compareAtPrice": 52.98,
    "currency": "usd",
    "financialStatus": "paid",
    "fulfillmentStatus": "open",
    "orderDate": "2025-03-06T14:30:00Z",
    "targetDeliveryDate": "2025-03-09T14:30:00Z",
    "shipToAddress": {
      "name": "John Wick",
      "company": "The Continental",
      "street1": "345 California St.",
      "street2": "",
      "city": "San Francisco",
      "state": "CA",
      "postalCode": "94104",
      "country": "US",
      "phone": "2504806765",
      "email": "johnwick@example.com"
    },
    "createdAt": "2025-03-06T14:32:15Z",
    "customer": {
      "id": "cust-9876-5432-abcd",
      "name": "John Wick",
      "email": "johnwick@example.com",
      "phone": "2504806765",
      "company": "The Continental"
    },
    "lineItems": [
      {
        "id": "li-1234-5678-9abc-def0",
        "price": 19.99,
        "compareAtPrice": null,
        "currency": "usd",
        "quantity": 1,
        "productVariant": {
          "id": "pv-abcd-1234-efgh-5678",
          "productId": "prod-1234-5678-abcd",
          "title": "Red / Small",
          "sku": "RCT-RED-S",
          "skuAliases": [],
          "barcode": "1234567890123",
          "price": 19.99,
          "compareAtPrice": null,
          "currency": "usd",
          "weight": 0.5,
          "weightUnit": "lb",
          "dimensions": {
            "length": 10,
            "width": 8,
            "height": 2
          },
          "dimensionsUnit": "in",
          "tracksInventory": true,
          "product": {
            "name": "Retro Crew Tee"
          }
        }
      },
      {
        "id": "li-5678-9abc-def0-1234",
        "price": 22.99,
        "compareAtPrice": null,
        "currency": "usd",
        "quantity": 1,
        "productVariant": {
          "id": "pv-efgh-5678-ijkl-9012",
          "productId": "prod-1234-5678-abcd",
          "title": "Blue / Small",
          "sku": "RCT-BLUE-S",
          "skuAliases": [],
          "barcode": "1234567890124",
          "price": 22.99,
          "compareAtPrice": null,
          "currency": "usd",
          "weight": 0.5,
          "weightUnit": "lb",
          "dimensions": {
            "length": 10,
            "width": 8,
            "height": 2
          },
          "dimensionsUnit": "in",
          "tracksInventory": true,
          "product": {
            "name": "Retro Crew Tee"
          }
        }
      }
    ],
    "tags": [
      {
        "id": "tag-1234-5678",
        "name": "VIP"
      },
      {
        "id": "tag-5678-9012",
        "name": "Priority"
      }
    ],
    "notes": [
      {
        "id": "note-1234-5678",
        "content": "Customer requested expedited shipping",
        "createdAt": "2025-03-06T14:32:20Z",
        "user": {
          "id": "user-1234-5678",
          "name": "Admin User",
          "email": "admin@example.com"
        }
      }
    ],
    "shipments": [],
    "tasks": [],
    "returnOrders": []
  }
}

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.