Skip to content

Payload branch "carrier"

This branch contains general informations about the "carrier" or "courier" choosed by the User or automatically selected by the business logic;

Let's review an example:

js
{
  "context": "...",
  "event": "...",
  "checkout_step": "...",
  "attributes": {...},
  "products": [...],
  "carrier": {
    "id": 4,
    "name": "Ritiro presso Store Bluespirit",
    "virtual": false,
    "shops_required": false,
    "skip_shipping": false
  },
  "payment": {...},
  "delivery": {...},
  "billing": {...},
  "user": {...},
  "engagements": {...}
}

Variables full details

Here you can find a detailed description of each variable or sub-branch:

VarTypeDescription
idintUnique carrier id (cross-tenant)
namestringCarrier name (translated)
virtualbooleanCarrier is present but do not required
shops_requiredbooleanShipment must be fulfilled with a pickup store
skip_shippingbooleanCarrier does not require a physical shipment

Released under the MIT License.