Retrieve an order by reference

GET

https://core.shopimind.com/v1/orders/reference/{reference}

Retrieves the details of an existing order by its reference (the human-readable order number shown on invoices and confirmation emails). Use this endpoint when you only have the order reference rather than the merchant-supplied order_id.

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key.

Type

string

Required

Pattern

"^[a-zA-Z0-9-]{20,64}$"

Path Parameters

reference*

Order reference as supplied in the reference field of bulkCreateOrders.

Type

string

Required

Query Parameters

fields

Subset of order fields to return. Repeat the parameter or use fields[]= syntax.

Type

array

Responses

Resource successfully retrieved.

Content-Type

application/json

{

  

"statusCode": 200,

  

"data": {

  

  

"order_id": "ord_2024_0001",

  

  

"order_reference": "CMD-2024-0001",

  

  

"customer_id": "cust_001",

  

  

"status_id": "paid",

  

  

"carrier_id": "colissimo",

  

  

"amount": 129.9,

  

  

"amount_without_tax": 108.25,

  

  

"shipping_costs": 6.9,

  

  

"currency": "EUR",

  

  

"is_confirmed": true,

  

  

"created_at": "2024-04-30T18:25:00.000Z"

  

}

}

GET

https://core.shopimind.com/v1/orders/reference/{reference}

Playground

Headers

spm-api-key*

Variables

Key

Value

reference*

fields

Samples

Retrieve an order by reference Retrieves the details of an existing order by its reference (the human-readable order number shown on invoices and confirmation emails). Use this endpoint when you only have the order reference rather than the merchant-supplied order_id. GET /v1/orders/reference/{reference} getOrderByReference Orders spm-api-key [Authentication] Required API key. reference Order reference as supplied in the reference field of bulkCreateOrders. fields Subset of order fields to return. Repeat the parameter or use fields[]= syntax. Resource successfully retrieved. Client error - Invalid request or authentication issues Server error - Internal processing failure