Get Order

Retrieves the complete details of an order by its reference.

Reference Types

You can retrieve an order using:

  • Carriyo Order ID: The unique identifier generated by Carriyo (default)
  • Partner Order Reference: Your system's order reference by setting key=partner_order_reference

Response

Returns the full order object including:

  • Order details and status
  • All fulfillment orders and their current states
  • Line item details and fulfillment status
  • Customer and address information
SecurityOAuth2-Production or OAuth2-Demo
Request
path Parameters
reference
required
string

The order reference (order_id or partner_order_reference based on the key parameter).

query Parameters
key
string
Default: "order_id"

Specifies which reference type is being used:

  • order_id: Carriyo's unique order identifier (default)
  • partner_order_reference: Your system's order reference
Enum: "order_id" "partner_order_reference"
header Parameters
x-api-key
required
string

Your Carriyo API key for authentication.

tenant-id
required
string

Your unique tenant identifier in Carriyo.

Content-Type
string
Default: application/json
Responses
200

Order retrieved successfully.

404

Order not found.

get/orders/{reference}
Request samples 
Response samples 
application/json
{
  • "tenant": "string",
  • "order_id": "string",
  • "merchant": "string",
  • "partner_order_reference": "string",
  • "language": "string",
  • "order_date": "2019-08-24T14:15:22Z",
  • "sales_channel": "string",
  • "creation_source": {
    },
  • "update_source": {
    },
  • "carriyo_metadata": [
    ],
  • "status": "open",
  • "auto_allocation_failed": true,
  • "cancellation_reason": "CUSTOMER_CANCELLATION",
  • "shipping_address": {
    },
  • "billing_address": {
    },
  • "customer": {
    },
  • "payment": {
    },
  • "redacted": true,
  • "taxes_included": true,
  • "duties_included": true,
  • "discount_applications": [
    ],
  • "line_items": [
    ],
  • "fulfillment_orders": [
    ],
  • "shipping_lines": [
    ],
  • "error_details": [
    ],
  • "creation_date": "2019-08-24T14:15:22Z",
  • "update_date": "2019-08-24T14:15:22Z"
}