Features V2

Fulfillment feature V2 - Return

How to manage your fulfillment return

Please notice : this API is for Octopia fulfillment sellers only.

you can not use it if you are a fulfilment legacy seller front Cdiscount.

API Return Feature

  • Create a customer return, for a Fulfillment order shipped from France or Spain, to the logistic partner in order to return a product following a customer claim;

  • Consult carrier returns to the warehouse (because of undeliverable reason, customer refusal...)

  • Consult the status of a return;

  • Consult the return state (if this is the expected product, if the product is in good state or damaged, the quantity returned)

  • Retrieve the return label for a customer return, to communicate to the customer in order to add it to his package to be returned to the warehouse. The return label is only available for a Fulfillment order shipped from France at this time. For a Fulfillment order shipped from Spain, the return label will be sent by mail.

Endpoint

What is the fulfillment ?

In order to understand what "fulfillment" means for Octopia you can read the help center documentation. You will find :

  1. What is fulfillment (FFM) pricing and invoicing

  2. What is FFM order

  3. How to take back or yield your products

  4. How to activate/desactivate FMM product

Help center documentation

How it works

The Return API enables you to manage your customer and carrier returns for a fulfillment shipping order. It is compound of 4 services:

  • Create a customer return; 

  • Retrieve a list of customer returns / carrier returns;

  • Consult the status of a customer return posted or a carrier return;

  • Retrieve a return label to communicate to the customer to send the product(s) to the warehouse. Only available for FR at the moment

Pre-requesites : In order to post a return request, you must fill in :

  • the shipping order number (the reference of your order or the outbound shipment number), on which you want to make a return,

  • the product id (Octopia product reference) concerned and product condition

  • The quantity to return

  • The return reason

Please notice that for the moment, it is only possible to make simple customer return (and not prepaid return*)

(*not available yet)

Return lifecycle

1. To create a customer return, you must know the productId.

If you haven't registered productId on your side, you can recover the Product Id for products you want to return via:

2. If a return is already registered for a given shipping order and product id for a quantity equal to the shipping quantity, you can't submit a new return request anymore

3. If your return request contains product(s) that you sent from your own warehouse, you will have to manage by yourself return to your warehouse for these products.

If you submit a return with Product Id / Product State, which is not from a fulfillment shipping order, we will return a 400 error with the products you need to remove from your request

4. If your return request contains 100% products managed by Octopia Fulfillment, we will take in charge the request and will send it to the logistic partner.

Upon sending your request to the logistic partner, we provide you with the return label so that the customer can return their products to the warehouse.

When products arrive and are qualified by the warehouse, we will update return status and information of the return reception (product, quantity, state).


Picture

Endpoints

Retrieve some returns
GET /returns

Used this route to get a list of return with filter.

Create a new returns
POST /returns

Used this route in order to create a new return.

Retrieve a label of a return 
GET /returns/{returnId}/label

Used this route to get a label return with an identifier.

Retrieve a specific return 
GET /returns/{returnId}

Used this route to get a return with an identifier.

Count the number of returns 
GET /returns/count

Allows to retrieve the amount of returns.