Sign in
latestOpenAPI 3.0.32026-08-132711294.7 KB

8506f9062fca

Logistics

Creates a logistic order for a given process_id, customer and address. Must specify the provider and carrier to be used to create the pickup.

  • Returns UNIMPLEMENTED (gRPC code 12) if the provider is OPS, meaning it didn't generated any action.
  • Returns InvalidArgument (gRPC code 3) if the combination of return-method, providerand carrier is not supported.
put/v1/logistics/orders

Request body

carrierstring

Carrier to be used for generating the pickup (DHL, UPS, Correos...) kwown & available for the given provider

currencystring

Currency code (e.g. "EUR", "USD"). Falls back to EUR if empty.

ecommerce_groupstring

ecommerce group

ecommerce_idstring

Ecommerce associated to this logistic order

ecommerce_order_idstring

Id of the original ecommerce order (if any) associated to this shipping

exchange_flow'NO_EXCHANGE_FLOW' | 'OPEN' | 'ONE_ON_ONE' | 'OPEN_WITH_GIFT_CARD' | 'FULL' enum

Exchange flow of the return. Some carriers vary the label by this (e.g. CTT for Álvaro Moreno uses a different additional code on exchanges).

line_items_typestring

Line items type used for customs/product data generation for some providers (e.g. UPS). Example values:

  • "random": send a single aggregated product line instead of real items
  • "real": send one product per returned item If empty, providers fall back to their default behaviour.
order_numberstring

Id of the original order (if any) associated to this shipping E-commerces uses this to match the original order when the package arrives to the warehouse

order_purchased_atstring date-time

When the original order was purchased. Used to scope order lookups on platforms that don't key orders by the shop's order number (e.g. Monta colourfulrebel, resolved via a date-windowed Reference search).

original_carriersstring[]

Carriers that shipped the original outbound order (used to flag same-carrier returns).

original_trackingsstring

Original tracking numbers

pickup_rangesstring[]

Pick-up time ranges. Only required for return_type = PICKUP

platform_process_idstring

Id of the return process in the source platform. Some carriers use it as the client reference on the label (e.g. CTT for Álvaro Moreno).

process_idstring

Id of the process that the pickup is associated to

providerstring

Provider to be used for generating the pickup (SendCloud, OPS, etc).

return_type'NO_RETURN_METHOD' | 'HOME_PICK_UP' | 'DROP_OFF_POINT' | 'DELIVERY_PICKUP' | 'IN_STORE' enum

Return method associated to the logistic order (PICKUP, DROP_OFF)

vat_numberstring

VAT Number

weight_in_gramsinteger

protolint:disable:next FIELD_NAMES_EXCLUDE_PREPOSITIONS Weight of the total sum of packags in grams

Response

OK