PUT /v1/logistics/orders — rever-admin-api

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.

Request body

carrierstring

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

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

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

pickup_rangesstring[]

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

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)

weight_in_gramsinteger

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

Response

OK