Order feature

How to manage your order

Why use it

This allows you to manage your orders, and validate them

  • Retrieve your orders

  • Validate your orders

  • More methods to come

Endpoint

Use cases

In order to find different cases that you may encounter, you will find a list of use cases

  1. Retrieve your orders

  2. Accept your orders and validate them

Use cases

Some definition

Order status : Status management is important in order not to miss an order during your recovery. The most common ones are :

  • PaymentInProgress

  • WaitingForSellerAcceptation

  • AcceptedBySeller

  • WaitingForShipmentAcceptation

  • Shipped

Validation of orders : An order can be accepted by API and / or validated as shipped

How the Order work

To begin with, you must regularly check the arrival of your orders, once received accept them either by API or automatically from your seller back office. Once your orders are ready to be shipped, validate their shipment.

Picture

Endpoints

Validates an order
GET /orders/{orderNumber}/validate

Allows you to accept/validate your orders

Recommandations of call : Be sure to include the product and carrier information to avoid errors

Searches orders by criteria
POST/orders/search

Allows you to retrieve your order

Recommandations of call : Adapt your recovery filters according to your needs

Use cases

  • Manage order
  • Examples
  • Workflow

Workflow of your orders

1 - Retrieve your orders

Automate the retrieval of your orders by filtering on the different status and/or date with the method searches orders by criteria

2 - Accept the order or not via API or accept automatically via your seller back office

3 - Validate your shipment

We insist on including product information (condition, reference...) and shipping information, TrackingNumber, CareerName and TrackingUrl

Some examples

Validation of orders possible :

Accept an order

{
  "order_state": "AcceptedBySeller",
  "order_line_list": [
    {
      "seller_product_id": "referenceExample",
      "acceptation_state": "AcceptedBySeller",
      "product_condition": "New",
    }
  ]
}

Ship an order

{
    "order_state": "Shipped",
    "tracking_number": "1231548ere1245",
    "carrier_name": "DPD",
    "tracking_url": "https:dpd.com/1231548ere1245",
    "order_line_list": [
      {
         "seller_product_id": "referenceExample",
         "acceptation_state": "ShippedBySeller",
         "product_condition": "New",
      }
    ]
}

Workflow

Manage your order with Order search and the status do you need.

Then validate the status with validated order according to the status on which the order depends.

The different status of orders :

CancelledByCustomer The order is cancelled at the customer initiative Action to call None - final status

WaitingForSellerAcceptation The order is just created Action to call Accept totaly, partially or refuse the order

AcceptedBySeller The order has been accepted, the customer debit will be launched Action to call Confirm shipping of the order line or refund the order line

PaymentInProgress The order has been accepted, the customer debit is processing Action to call None - transit status

WaitingForShipmentAcceptation The customer debit is successfull, the order has to be prepared Action to call Confirm shipping totally, partially or refused

AvailableOnStore the order is available at pick-up point (only for click & collect) Action to call confirme the pick-up

Shipped The order has been shipped Action to call None - final status

RefusedBySeller The order has been refused at the validation step Action to call None - final status

AutomaticCancellation The order has been cancelled due to no action at validation step from the seller Action to call None - final status

PaymentRefused The order has been cancelled due to payement refused Action to call None - final status

ShipmentRefusedBySeller The order has been cancelled due to no shippment call from the seller Action to call None - final status

RefusedNoShipment The order has been cancelled because no action for shipment has been called by seller Action to call None - final status

NonPickedUpByCustomer The order has been cancelled because the seller call the customer has not picked-up the order (only for click & collect) Action to call None - final status