SbPublicApiCreateClickAndCollectRequest

snowbee.SbPublicApiCreateClickAndCollectRequest

object · non-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 raw schema

{
  "type": "object",
  "properties": {
    "customerId": {
      "type": [
        "null",
        "string"
      ],
      "description": "Customer ID (optional, will try to match B2C customer by email/phone if not provided)",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    },
    "lineItems": {
      "type": "array",
      "description": "List of SKUs to reserve for click & collect",
      "items": {
        "$ref": "#/components/schemas/snowbee.SbPublicApiClickAndCollectLineItemRequest"
      },
      "title": "List<SbPublicApiClickAndCollectLineItemRequest>"
    },
    "reservationEmail": {
      "type": [
        "null",
        "string"
      ],
      "description": "Reservation email (optional, used to match B2C customer if customerId not set)",
      "example": "ola@example.com",
      "title": "String"
    },
    "reservationName": {
      "type": "string",
      "description": "Name for the reservation (typically customer name)",
      "example": "Ola Nordmann",
      "title": "String"
    },
    "reservationPhone": {
      "type": [
        "null",
        "string"
      ],
      "description": "Reservation phone (optional, used to match B2C customer if customerId not set)",
      "example": "+4712345678",
      "title": "String"
    },
    "retailStoreId": {
      "type": "string",
      "description": "ID of the retail store where customer will pick up items",
      "example": "01234567-89ab-cdef-0123-456789abcdef",
      "title": "String"
    }
  },
  "required": [
    "lineItems",
    "reservationName",
    "retailStoreId"
  ],
  "title": "SbPublicApiCreateClickAndCollectRequest"
}