Sign in
Logistics

Creates a pickup for a given process_id, customer and address A logistic order must be created prior requesting a pickup 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.
post/v1/logistics/pickup

Request body

carrierstring

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

currencystring

Currency code of the declared value, e.g. "EUR"

declared_valuestring

Total declared value of the shipment in REVER money

ecommerce_idstring

Ecommerce associated to this logistic order

order_numberstring

Order number shown to the customer, used as the carrier's own reference for the collect. Some carriers require it.

pickup_rangesstring[]

Preferred times for the pickup a the customer address

process_idstring

Id of the process that the pickup is associated to

providerstring

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

repickup_attemptinteger

Repickup attempt number. 0 means first pickup, >0 means repickup. Used to bypass duplicate-pickup guards for providers like GLS where a new collect code (tracking ID) is generated per pickup.

Response

OK

Changes

Changed in 1 of the 2 revisions of this API.7

  • 8506f9062fca7See the full diff
    • ○

      added the new optional request property currency

      new-optional-request-property

    • ○

      added the new optional request property customer/allOf[models.Customer]/platform_customer_id

      new-optional-request-property

    • ○

      added the new optional request property declared_value

      new-optional-request-property

    • ○

      added the new optional request property order_number

      new-optional-request-property

    • ○

      added the new optional request property repickup_attempt

      new-optional-request-property

    • ○

      added the new optional request property settings/allOf[logistics.LogisticSettings]/logistic_config/items/service_id

      new-optional-request-property

    • ○

      added the optional property pickup_order/allOf[logistics.PickupOrder]/tracking_url to the response with the 200 status

      response-optional-property-added

    This revision also has 331 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog