Récupère une commande par sa référence

GET

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

Récupère les informations d'une commande existante par sa reference (le numéro de commande lisible affiché sur les factures et e-mails de confirmation). À utiliser lorsque seule la référence est connue et non l'order_id fourni par le marchand.

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key, in the form {prefix}.{secret}.

Type

string

Required

Example"a1b2c3d4.xK9pR2mVn6QwErTyUiOpAsDfGhJkLzXcVbNmQwErTyU"

Pattern

"^[a-zA-Z0-9]{8}\\.[A-Za-z0-9_-]+$"

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

Récupère une commande par sa référence Récupère les informations d'une commande existante par sa reference (le numéro de commande lisible affiché sur les factures et e-mails de confirmation). À utiliser lorsque seule la référence est connue et non l'order_id fourni par le marchand. GET /v1/orders/reference/{reference} getOrderByReference Orders spm-api-key [Authentication] Required API key, in the form {prefix}.{secret}. 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