Sign in

v1

latestOpenAPI 3.0.32026-07-13149852.3 MB
order

Order - Get Single

Retrieve a single order by its order number and store ID.

get/order/get_single

Query parameters

store_idstring required

Store ID

Example:507f1f77bcf86cd799439011
order_numberstring required

Order number

Example:ORD-1234

Response

Order found with full details

metricsobject

Performance metrics

Example response

{
  "order": {
    "_id": "507f1f77bcf86cd799439011",
    "store_id": "507f1f77bcf86cd799439011",
    "stash": {
      "store_id": "507f1f77bcf86cd799439011",
      "date": "2025-01-15"
    },
    "backup_stash": {
      "store_id": "507f1f77bcf86cd799439011",
      "date": "2025-01-15"
    },
    "log": [
      {
        "user_id": "507f1f77bcf86cd799439011",
        "time": "2025-01-15T12:00:00.000Z"
      }
    ],
    "scans": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "user_id": "507f1f77bcf86cd799439011",
        "time": "2025-01-15T12:00:00.000Z"
      }
    ],
    "notes": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "user_id": "507f1f77bcf86cd799439011",
        "time": "2025-01-15T12:00:00.000Z"
      }
    ],
    "shipments": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "user_id": "507f1f77bcf86cd799439011",
        "time": "2025-01-15T12:00:00.000Z"
      }
    ],
    "fulfillments": [
      {
        "_id": "507f1f77bcf86cd799439011"
      }
    ],
    "transactions": [
      {
        "_id": "507f1f77bcf86cd799439011"
      }
    ],
    "returns": [
      {
        "_id": "507f1f77bcf86cd799439011"
      }
    ],
    "tags": [
      "507f1f77bcf86cd799439011",
      "507f1f77bcf86cd799439012"
    ],
    "purchase_orders": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "due_date": "2025-01-15",
        "log": [
          {
            "user_id": "507f1f77bcf86cd799439011",
            "time": "2025-01-15T12:00:00.000Z"
          }
        ]
      }
    ],
    "shipped_date": "2025-01-15T12:00:00.000Z",
    "opened_date": "2025-01-15T12:00:00.000Z",
    "delivery_instructions": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "user_id": "507f1f77bcf86cd799439011",
        "time": "2025-01-15T12:00:00.000Z"
      }
    ]
  }
}