Versions Compared

Old Version 3

changes.mady.by.user Thibault Galharret

Saved on

compared with

New Version 4

changes.mady.by.user Thibault Galharret

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Returnable order types

  • Returnable order line states

  • Status of return lines that can be declared in a new return

  • Limit the returnable items by a query

  • Returnable period

Pour afficher des choix

  • Return reasons : Reasons for returns proposed when declaring in the Store App and Backoffice

    • Ex: ["damaged","retract","size_small","size_big"]

  • General conditions of the items : General conditions of items proposed for returns validation in the Store App or in other external systems.

    • Ex:

Configuration

Key

Description

Example

Return reasons

return_management.return_reasons

Reasons for returns proposed when declaring in the Store App and Backoffice

["damaged","retract","size_small","size_big"]

General conditions of the items

return_management.return_conditions

General conditions of items proposed for returns validation in the Store App or in other external systems.

["sellable","not_sellable"]

Return methods

Configuration fields

fieldField

typeType

Validation

descriptionDescription

Example

carriers

array of objects

Optional

Array of carriers proposed for the given sales channel

name

string

Mandatory (if carriers given)

Name of the carrier. If the carrier label is to be generated by Onestock ("ignore_shipment" not set or set to false), the carrier name must match the format expected by Onestock.

colissimov2

option

string

Mandatory (if carriers given)

Delivery option. If the carrier label is to be generated by Onestock ("ignore_shipment" not set or set to false), the option must match those expected by the carrier.

DOM

destination_endpoint

string

Mandatory (if carriers given)

Stock location to which return parcels will be sent . The stock location must be created in Onestock, and its address given.

001

ignore_shipment

bool

Optional

If the parameter is set to true, Onestock will not generate any shipping label. This makes it possible to create returns with carriers not managed by Onestock.

true

notifications

array of strings

Optional

Name of the notification that will be sent when the return parcel is created. Generally, an email. A template has been designed by our teams for adding documents as email attachments.

return_with_colissimo

documents

array of strings

Optional

Name of documents to be generated when the return parcel is created (in addition to the shipment that will be autogenerated)

return_note

in_store

object

Optional

endpoint_request

string

Mandatory (if in_store given)

Allows you to filter on a precise perimeter of stock locations proposed on the map. The stock location query must exist in Onestock.

stores_sc_1

notifications

array of strings

Optional

Name of the notification that will be sent when the return parcel is created. Generally, an email. A template has been designed by our teams for adding documents as email attachments.

in_store_return

documents

array of strings

Optional

Name of documents to be generated when the return parcel is created.

return_note

...