Skip to main content

Delivery checkouts

Fetches delivery options.

GET /delivery-checkouts/{deliveryCheckoutId}

Fetches delivery options that are available in a delivery checkout.

Caution

The language and currency used as query parameters must be configured for the delivery checkout in nShift Delivery.

Note

Some carriers may require more address parameters to consider the address complete.

URI parameters

deliveryCheckoutId

string

The delivery checkout ID from the set-up

Required

Query parameters

currency

string

Currency code

Required

language

string

Language code

Required

tocountry

string

Receiver country

Required

tozipcode

string

Receiver zip code

Required

Please refer to the parameter list for values and other parameters that can be added in the query.

For description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /delivery-checkouts/{deliveryCheckoutId} GET.

POST /delivery-checkouts/{deliveryCheckoutId}/shipments

Creates a partial shipment based on the delivery option the consumer has selected in the webshop.

Note

This endpoint is mandatory.

Caution

Always use the complete delivery checkout ID since the delivery checkout version is included in the ID.

URI parameters

deliveryCheckoutId

string

The delivery checkout ID returned from the GET request

Required

returnShipmentData

boolean

Shipment data will be returned in the response.

Optional

For description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /delivery-checkouts/{deliveryCheckoutId}/shipments POST.