Returns an order by id.

GET /api/v2/orders/{id}

Path parameters

id string Required

Responses

200

Returns an order by id
Hide response attributes Show response attributes object
- id integer
- bordereau_url string
- price_h_t integer
- price_t_v_a integer
- price_t_t_c integer
- shipping_h_t integer
- shipping_t_v_a integer
- shipping_t_t_c integer
- shipping_address_json string
- shipping_status string
- tracking_slug string
- tracking_number string
- delivered_at string
- invoiced_at string
- public_id string
- created_at string
- to_ship boolean
- cart_items array[object]
  
  Hide cart_items attributes Show cart_items attributes object
  
  tax_class string
  
  product_sku string
  
  product_name string
  
  product_quantity integer
  
  product_extra_infos object
  
  Hide product_extra_infos attributes Show product_extra_infos attributes object
  
  extended_images array[string]
  
  grouped_id integer
  
  id integer
  
  product_id integer
  
  price integer
  
  position string
  
  name string
  
  grade string
  
  tax_class string
  
  color string
  
  packaging string
  
  sku string
  
  stock integer
404

Not found
Hide response attributes Show response attributes object
- code integer
- msg string
500

Internal server error
Hide response attributes Show response attributes object
- code integer
- msg string

GET /api/v2/orders/{id}

curl \
 -X GET https://sandbox-w6wvm5a-qhobd463uhz3w.eu-2.platformsh.site/api/v2/orders/{id} \
 -H "apikey: $API_KEY"

Response examples (200)

{
  "id": 111111,
  "bordereau_url": "762b60bbe9f82bca7b80f5747fe959a4",
  "price_h_t": 1000,
  "price_t_v_a": 200,
  "price_t_t_c": 1200,
  "shipping_h_t": 100,
  "shipping_t_v_a": 20,
  "shipping_t_t_c": 120,
  "shipping_address_json": "{\"street\":\"a\",\"additionnal\":\"a\",\"postcode\":\"75000\",\"city\":\"a\",\"country\":\"FR\",\"firstname\":\"a\",\"lastname\":\"a\",\"company\":\"A\", \"type\":\"shipping\",\"email\":\"email@dipli.com\",\"telephone\":\"061111111111\",\"deliveryinfos\":null,\"ref\":null}",
  "shipping_status": "pending_confirmation",
  "tracking_slug": "ups",
  "tracking_number": "X12FA123GT",
  "delivered_at": "2022-09-01",
  "invoiced_at": "2022-09-01",
  "public_id": "A-111111",
  "created_at": "2022-09-01",
  "to_ship": true,
  "cart_items": [
    {
      "tax_class": "TVA Classique",
      "product_sku": "APPLE_IPHONE_8_SKU",
      "product_name": "Apple iPhone 8 64",
      "product_quantity": 10,
      "product_extra_infos": {
        "extended_images": [
          "f6f5692eecb63dde4c94.jpg"
        ],
        "grouped_id": 707026,
        "id": 11699153,
        "product_id": 25005,
        "price": 12000,
        "position": "1er",
        "name": "Apple iPhone 8 32",
        "grade": "Grade C",
        "tax_class": "Tva classique",
        "color": "Gris sideral",
        "packaging": "Chargeur et cable",
        "sku": "O3_MQ3D2ZD/A",
        "stock": 1
      }
    }
  ]
}

Response examples (404)

{
  "code": 404,
  "msg": "Not Found"
}

Response examples (500)

{
  "code": 500,
  "msg": "Internale Server Error"
}