POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/click_and_collect

Create click & collect reservation

Creates a click & collect reservation at a retail store. Validates the retail store is in the ecom store's click & collect network, creates a cart with the requested SKUs, reserves inventory from the store's warehouse, and parks the cart with the customer's name for later checkout.

Parameters

tenantIdpathstringnon-nullrequired
eComStoreIdpathstringnon-nullrequired

Request body (required)

Click & collect reservation details including retail store ID, customer name, and line items

application/jsonobjectnon-null

customerIdstringnullableoptional

Customer ID (optional, will try to match B2C customer by email/phone if not provided)

Example"01234567-89ab-cdef-0123-456789abcdef"

lineItemsarray of objectnon-nullrequired

List of SKUs to reserve for click & collect

Show item fields

netUnitPricestringnullableoptional: Net unit price (excluding VAT) the shopper was shown. Optional: the collecting store prices the reservation by its own sales price and campaigns regardless, and when omitted that store price is also the initial value. Required only for a SKU the store has no sales price for.
Format: BigDecimal
Example"299.00"
quantitystringnon-nullrequired: Quantity to reserve
Format: BigDecimal
Example"2.0"
skuIdstringnullableoptional: SKU ID to reserve (provide either skuId or skuNumber)
Example"01234567-89ab-cdef-0123-456789abcdef"
skuNumberstringnullableoptional: SKU number/code to reserve (provide either skuId or skuNumber)
Example"PROD-BLK-M"
vatRatestringnullableoptional: VAT rate as percentage. Optional: when omitted, the rate for the product's VAT group in the collecting store's country is used.
Format: BigDecimal
Example"25.00"

reservationEmailstringnullableoptional

Reservation email (optional, used to match B2C customer if customerId not set)

Example"ola@example.com"

reservationNamestringnon-nullrequired

Name for the reservation (typically customer name)

Example"Ola Nordmann"

reservationPhonestringnullableoptional

Reservation phone (optional, used to match B2C customer if customerId not set)

Example"+4712345678"

retailStoreIdstringnon-nullrequired

ID of the retail store where customer will pick up items

Example"01234567-89ab-cdef-0123-456789abcdef"

View schema definition

Responses

202Response

application/jsonobjectnon-null

idstringnon-nullrequired: ID of the click and collect cart
Example"01234567-89ab-cdef-0123-456789abcdef"

View schema definition

400Bad Request - Invalid input, SKU not found, or insufficient inventory

Bad Request - Invalid input, SKU not found, or insufficient inventory

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

401Unauthorized - Invalid or missing authentication

Unauthorized - Invalid or missing authentication

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

403

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

404Not Found - Retail store not found or not in click & collect network

Not Found - Retail store not found or not in click & collect network

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

500

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition