latestOpenAPI 3.0.32026-08-193973220.1 KB

6a1303364143

Orders

Get a specific order

get/ws/orders/{order_id}

Path parameters

order_idinteger required

The order identifier

Response

Return the order with the specified id

order_idinteger

The unique id of the order. Used to update orderlines of a given order

delivery_mode'HOME_DELIVERY' | 'COLLECTION_POINT'

The delivery mode associated with the shipping address of the order.

HOME_DELIVERY: The shipping address is a home-delivery address.
COLLECTION_POINT: The shipping address is a collection-point address.

delivery_notestring url

Document to add in package which contains useful information for the customer, related to his order.

expected_dispatch_datestring date-time

The shipment expected dispatch date (only applicable for orders not already SENT).

tracking_numberstring

Tracking number of the package

tracking_urlstring url

Tracking Url of the package

shipper_displaystring

Name of the shipper

is_backshipboolean

True if the shipper of the order is backship

date_creationstring date-time

Date of order

date_modificationstring date-time

Date of last modification

date_shippingstring date-time

Date of shipping

date_paymentstring date-time

Date of payment

state0 | 10 | 1 | 3 | 8 | 9

Order state.

State	Description
0	New order. Payment validation is pending. We are doing verifications to check the customer identity. The orders in this state must not be shipped.
10	Order is pending. The customer has ordered but still has time to pay. The merchant has to wait for payment, and the orders in this state must not be shipped.
1	Payment is checked and validated. The merchant has to process (accept or cancel) the orderlines.
3	Order shipping is pending. The payment and the order (i.e. all orderlines) have been validated. The merchant has to ship the package to the customer.
8	Order is not paid. Payment process has failed, and the merchant must ignore this order.
9	Order processed. The merchant has shipped the package.

pricestring

The total price of the order (including taxes) without the shipping price

shipping_pricestring

Total shipping price (including taxes)

currencystring

Currency used for the order

paypal_referencestring nullable

Paypal reference ID

installment_paymentboolean

Whether the customer chose a payment in multiple increments

payment_methodstring

The customer payment method (Eg: CARD, PAYPAL)

sales_taxesstring

Sales taxes (country/state dependent)

Example response

{
  "order_id": 5978,
  "delivery_mode": "HOME_DELIVERY",
  "shipping_address": {
    "id": 1,
    "country": "FR",
    "city": "Paris",
    "postalCode": "75003",
    "firstName": "Victor",
    "lastName": "Hugo",
    "company": "backmarket",
    "phoneNumber": "+33639981234",
    "state": "California",
    "street": "3, Imaginary Street",
    "street2": "Apartement X"
  },
  "billing_address": {
    "id": 1,
    "country": "FR",
    "city": "Paris",
    "postalCode": "75003",
    "firstName": "Victor",
    "lastName": "Hugo",
    "company": "backmarket",
    "phoneNumber": "+33639981234",
    "state": "California",
    "street": "3, Imaginary Street",
    "street2": "Apartement X"
  },
  "delivery_note": "https://example.com/delivery_note/1519221434.69.pdf",
  "expected_dispatch_date": "2022-04-29T09:35:24",
  "tracking_number": "my_tracking_number",
  "tracking_url": "http://www.colissimo.fr/my_tracking_url",
  "shipper_display": "Colissimo",
  "date_creation": "2022-04-29T09:35:24.123456Z",
  "date_modification": "2022-04-29T09:35:24Z",
  "date_shipping": "2022-04-29T09:35:24.123456Z",
  "date_payment": "2022-04-29T09:35:24.123Z",
  "state": 1,
  "orderlines": [
    {
      "id": 37195,
      "date_creation": "2022-04-29T09:35:24.123456Z",
      "state": 1,
      "price": "229.0",
      "shipping_price": "0.00",
      "shipping_delay": 48,
      "currency": "EUR",
      "listing": "IPHONE416GONLIB0",
      "listing_id": 142,
      "orderline_fee": "22.9",
      "product": "Apple Iphone 4 16 Go - Noir - D\\u00e9bloqu\\u00e9",
      "quantity": 2,
      "brand": "apple",
      "product_id": 141,
      "backcare": true,
      "backcare_price": 500,
      "sales_taxes": "25.8",
      "imei": "011415009346880",
      "condition": 10
    }
  ],
  "price": "299.25",
  "shipping_price": "5.99",
  "currency": "EUR",
  "country_code": "fr-fr",
  "payment_method": "PAYPAL",
  "sales_taxes": "25.8"
}