{ "openapi": "3.0.0", "info": { "description": "### URL for API requests\n\n`https://api.paazl.com/`\n\n### Optional keys\n\nSome of the optional key-value pairs have a default value. Where this is the case, the default values will be indicated.\n\nYou can leave out optional keys from requests. If you leave out an optional key, it will not be included in the response concerned.\n\n### Paazl authentication\n\nPaazl uses a three-legged OAuth 2.0 authentication process in which the API Secret (private key) is only known to the webshop. Webshop customers never have access to that key. However, they do have access the API Key (public key). See the online help article titled \"Authentication & Authorization\" for an explanation of how to generate these keys in the Paazl web app.\n\nIn Swagger, you authorize a call using the Authorize button. After clicking this button, you enter a string with either the format \"Bearer api_key\" or the format \"Bearer api_key:api_secret\" depending on the endpoint method concerned.\n\n#### Calls requiring \"Bearer api_key\":\n\n• POST shippingOptions\n\n• POST pickupLocations\n\n• POST checkout\n\nExample:`\"Bearer sI3flYhflh\"`\n\n #### Calls requiring \"Bearer api_key:api_secret\":\n\n• POST token\n\n• GET checkout\n\n• POST order\n\n• PUT order\n\n• PATCH order\n\n• DELETE order\n\nExample:`\"Bearer sI3flYhflh:sdHlHkyunLKsoI94luilIlndD\"`\n", "version": "1.0", "title": "REST API introduction" }, "servers": [ { "url": "https://api-acc.paazl.com/", "description": "Paazl staging (acceptance testing) environment" } ], "tags": [ { "name": "Checkout", "description": "Checkout endpoint" }, { "name": "Order", "description": "Order endpoint" }, { "name": "Shipping options", "description": "Shipping options endpoint" } ], "paths": { "/v1/checkout": { "get": { "tags": [ "Checkout" ], "summary": "Gets checkout session data.", "description": "Gets your reference for a checkout session, along with the customer's preferred delivery date, country code, postal code, preferred shipping option or pickup location, and the order's shipping rate.", "operationId": "getCheckoutUsingGET", "parameters": [ { "name": "reference", "in": "query", "description": "Your reference for the checkout session whose details you want to\nretrieve.\n\n**Note!** If the reference value provided already exists, the existing session will be replaced with a new session.\n\nExample:`https://api.paazl.com/checkout?reference=AA01234`\n", "required": true, "allowEmptyValue": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/CheckoutInfo" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/CheckoutInfo" } } } } }, "security": [ { "Authorization": [ "global" ] } ], "deprecated": false }, "post": { "tags": [ "Checkout" ], "summary": "Saves checkout session data.", "description": "Saves the most important information of a specific checkout session to\nthe Paazl database. The information will be kept for 30 days.\n\nIf the checkout data is successfully saved, the call simply returns `HTTP Status 200 OK`.\n", "operationId": "saveCheckoutUsingPOST", "requestBody": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/SaveCheckout" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/SaveCheckout" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "Authorization": [ "global" ] } ], "deprecated": false } }, "/v1/checkout/token": { "post": { "tags": [ "Checkout" ], "summary": "Returns access token.", "description": "Returns an access token for a checkout session. This enables the Paazl checkout widget to access Paazl resources.\n\nSee [Authentication and authorization](https://support.paazl.com/hc/en-us/articles/360007607413-Authentication-and-authorization) for an explanation of how Paazl authentication and authorization works.\n", "operationId": "createTokenUsingPOST", "requestBody": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Reference" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/Reference" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/CheckoutToken" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/CheckoutToken" } } } } }, "security": [ { "Authorization": [ "global" ] } ], "deprecated": false } }, "/v1/order": { "post": { "tags": [ "Order" ], "summary": "Saves order information.", "description": "Saves an order's most important information to the Paazl database once a customer has paid for his/her purchase. You commonly implement POST order when you want to make use of Paazl's [label printing](https://support.paazl.com/hc/en-us/articles/360015545993-About-label-printing) and [track & trace notification](https://support.paazl.com/hc/en-us/articles/360008210773-Customizing-email-notification-templates) functionality. You can also use it with an OMS or WMS.\n\nIf the order information is successfully saved, the call simply returns `HTTP Status 200 OK`.\n\n***\n**Note!**\n\nThe `POST order` method lets you to save shipping address information (required), as well as sender address and return address information (optional). Whenever you specify an address, you can either fill `street` and `streetNumber` separately or you can specify both as a single string using `streetAddressLine`. Whether you use one or the other depends on the requirements of the carrier concerned. Paazl applies the following logic to these attributes:\n\n• If you fill `street` and `streetNumber`, they take priority over a filled `streetAddressLine`\n\n• If you fill `street` or `streetNumber` but not both, then a filled `streetAddressLine` takes priority\n\n• If you fill `street` or `streetNumber` but not both, and `streetAddresssLine` is empty, an error will be thrown\n", "operationId": "saveOrderUsingPOST", "requestBody": { "$ref": "#/components/requestBodies/ShopOrder" }, "responses": { "200": { "description": "OK" } }, "security": [ { "Authorization": [ "global" ] } ], "deprecated": false }, "put": { "tags": [ "Order" ], "summary": "Modifies order information.", "description": "Modifies the information of an order with a specific reference in the Paazl database. The method overwrites the whole order so the same attribute restrictions apply as for the `POST order` method.\n\nIf the order data is successfully modified, the call simply returns `HTTP Status 200 OK`.\n\n**Note!**\n\nThe `PUT order` method lets you to save shipping address information (required), as well as sender address and return address information (optional). Whenever you specify an address, you can either fill `street` and `streetNumber` separately or you can specify both as a single string using `streetAddressLine`. Whether you use one or the other depends on the requirements of the carrier concerned. Paazl applies the following logic to these attributes:\n\n• If you fill `street` and `streetNumber`, they take priority over a filled `streetAddressLine`\n\n• If you fill `street` or `streetNumber` but not both, then a filled `streetAddressLine` takes priority\n\n• If you fill `street` or `streetNumber` but not both, and `streetAddresssLine` is empty, an error will be thrown\n", "operationId": "editOrderUsingPUT", "requestBody": { "$ref": "#/components/requestBodies/ShopOrder" }, "responses": { "200": { "description": "OK" } }, "security": [ { "Authorization": [ "global" ] } ], "deprecated": false }, "patch": { "tags": [ "Order" ], "summary": "Patch order", "operationId": "editOrderParticularlyUsingPATCH", "requestBody": { "$ref": "#/components/requestBodies/ShopOrder" }, "responses": { "200": { "description": "OK" } }, "security": [ { "Authorization": [ "global" ] } ], "deprecated": false } }, "/v1/order/{reference}": { "delete": { "tags": [ "Order" ], "summary": "Deletes order.", "description": "Deletes an order in the Paazl database along with all its details.\n\nIf the order is successfully deleted, the call simply returns `HTTP Status 200 OK`.\n", "operationId": "deleteOrderUsingDELETE", "parameters": [ { "name": "reference", "in": "path", "description": "Your reference for the order you want to delete.\n\nExample: `https://api.paazl.com/order/order0010`\n", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "Authorization": [ "global" ] } ], "deprecated": false } }, "/v1/pickuplocations": { "post": { "tags": [ "Shipping options" ], "summary": "Gets the shipping options to a set of pickup locations for a specific checkout session.", "description": "Contains pickup locations for your checkout page, including their\ndistance from your customer's home address, geographical coordinates,\nopening times and associated shipping options.\n\nThe information you request will be returned in JSON (default) or XML format.\n\nThe pickup locations returned are sorted by distance (price) in ascending order. The shipping options to a particular pickup location are sorted by price in ascending order.\n", "operationId": "getPickupLocationsUsingPOST", "requestBody": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PickupLocationRequest" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/PickupLocationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PickupLocationResponse" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/PickupLocationResponse" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "409": { "description": "Webshop not found" }, "415": { "description": "Unsupported Media Type" }, "422": { "description": "Invalid or missing required information in request" }, "500": { "description": "Internal error" } }, "security": [ { "Authorization": [ "global" ] } ], "deprecated": false } }, "/v1/shippingoptions": { "post": { "tags": [ "Shipping options" ], "summary": "Gets the shipping options for home delivery for a specific checkout session.", "description": "Contains shipping options for your checkout page, including delivery\ndates, shipping costs and carrier names - based on your customer's\naddress, and your shipping rate engine configuration.\n\nThe information you request will be returned in JSON (default) or XML format.\n\nBy default, the shipping options returned are sorted by shipping rate (price) in ascending order.\n", "operationId": "shippingOptionsUsingPOST", "requestBody": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ShippingOptionRequest" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ShippingOptionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ShippingOptionResponse" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ShippingOptionResponse" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "409": { "description": "Webshop not found" }, "415": { "description": "Unsupported Media Type" }, "422": { "description": "Invalid or missing required information in request" }, "500": { "description": "Internal error" } }, "security": [ { "Authorization": [ "global" ] } ], "deprecated": false } } }, "components": { "requestBodies": { "ShopOrder": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ShopOrder" } }, "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ShopOrder" } } }, "required": true } }, "securitySchemes": { "Authorization": { "type": "apiKey", "name": "Authorization", "in": "header" } }, "schemas": { "Address": { "type": "object", "properties": { "city": { "type": "string", "description": "The city or town of a pickup location." }, "country": { "type": "string", "description": "The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code for the country of the pickup location." }, "postalCode": { "type": "string", "description": "The postal code of a pickup location." }, "province": { "type": "string", "description": "The province or state of a pickup location." }, "street": { "type": "string", "description": "The street name of a pickup location address." }, "streetNumber": { "type": "integer", "format": "int32", "description": "The street number of a pickup location address.\n\nExample: the \"12\" in \"12-A\".\n" }, "streetNumberSuffix": { "type": "string", "description": "The street number suffix of a pickup location address.\n\nExample: the \"-A\" in \"12-A\".\n" } }, "title": "Address", "xml": { "name": "address", "attribute": false, "wrapped": false }, "description": "Contains the address details of a pickup location." }, "BusinessHour": { "type": "object", "properties": { "from": { "type": "string", "description": "A pickup location's opening time.\n" }, "to": { "type": "string", "description": "A pickup location's closing time.\n" } }, "title": "BusinessHour", "xml": { "name": "businessHour", "attribute": false, "wrapped": false } }, "Carrier": { "type": "object", "properties": { "description": { "type": "string", "description": "The name of a carrier, as configured by [Paazl Customer Support](mailto:support@paazl.com)." }, "name": { "type": "string", "description": "The Paazl identifier for a carrier. This should correspond with one of the identifiers you see in your web app account under *Settings>Account>Overview of shipping options*." } }, "title": "Carrier", "description": "Contains a carrier's details." }, "CheckoutInfo": { "type": "object", "properties": { "consigneeCountryCode": { "type": "string", "description": "The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code for the country the shipment is being sent to." }, "consigneePostalCode": { "type": "string", "description": "The postal code of the address the shipment is being sent to. The code is used to get a more precise list of available shipping options." }, "deliveryType": { "type": "string", "description": "A code used to filter the returned shipping option for display.\n", "enum": [ "PICKUP_LOCATION", "HOME" ] }, "notificationEmailAddress": { "type": "string", "description": "The email address that track-and-trace status updates have to be sent to." }, "notificationPhoneNumber": { "type": "string", "description": "The SMS number that track-and-trace status updates have to be sent to." }, "pickupDate": { "type": "string", "format": "date", "description": "The date on which a shipment has to be picked up from a warehouse by a carrier in order to meet the preferred delivery date." }, "pickupLocation": { "$ref": "#/components/schemas/SelectedPickupLocation" }, "preferredDeliveryDate": { "type": "string", "format": "date", "description": "The day of the week on which customers want their order delivered." }, "reference": { "type": "string", "description": "Your reference for the checkout session whose details you have retrieved." }, "shippingOption": { "$ref": "#/components/schemas/SelectedShippingOption" }, "token": { "type": "string", "format": "uuid", "description": "The access token returned by the `token` endpoint." }, "webshopId": { "type": "integer", "format": "int64", "description": "Paazl's internal code for your webshop. You will find this in your Paazl web app account under *Settings>Account>My account>Webshop ID*." } }, "title": "CheckoutInfo", "xml": { "name": "checkoutInfo", "attribute": false, "wrapped": false } }, "CheckoutToken": { "type": "object", "properties": { "token": { "type": "string", "format": "uuid", "description": "The access token returned by the `token` endpoint." } }, "title": "CheckoutToken", "xml": { "name": "checkoutToken", "attribute": false, "wrapped": false } }, "CodValue": { "type": "object", "properties": { "value": { "type": "number", "format": "double", "description": "The value of the amount that has to be paid.\n\nExample: `value:40.2`\n" }, "currency": { "type": "string", "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency concerned.\n\nThe default code is \"EUR\".\n\nExample: `currency:\"USD\"`\n" } }, "title": "MoneyValue", "description": "The amount that a consignee has to pay on receipt of a \"Cash On Delivery\" order." }, "Consignee": { "type": "object", "required": [ "address" ], "properties": { "companyName": { "type": "string", "description": "The name of the company to ship an order to.\n\nExample: `companyName:\"Bonn Mac Tosch\"`\n" }, "email": { "type": "string", "description": "The email address of the person to ship an order to.\n\nExample: `email:\"freddie.kwiksilver@konningin.org\"`\n" }, "name": { "type": "string", "description": "The name of the person to ship an order to.\n\nExample: `name:\"Friederich Feuerstein\"`\n" }, "other": { "type": "string", "description": "Additional details used to identify the person to ship an order to.\n\nExample: `other:\"Logistik Manager\"`\n" }, "phone": { "type": "string", "description": "The phone number of the person to ship an order to.\n\nExample: `phone:\"+31-20-7736303\"`\n" }, "locale": { "type": "string", "description": "Specifies the language of the email templates used for track & trace notifications.\n\n`locale` is specified using the format `{language}_{country}`, where `{language}` is an [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code and `{country}` is an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code.\n\nExample: `locale:\"fr_FR\"`\n" }, "address": { "$ref": "#/components/schemas/ShopOrderShippingAddress" } }, "title": "Contact", "description": "Contains details of the party to ship an order to." }, "Coordinates": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double", "description": "A pickup location's latitude in decimal degrees." }, "longitude": { "type": "number", "format": "double", "description": "A pickup location's longitude in decimal degrees." } }, "title": "Coordinates", "xml": { "name": "coordinates", "attribute": false, "wrapped": false }, "description": "Contains the geographic coordinates of a pickup location." }, "CustomsValue": { "type": "object", "properties": { "value": { "type": "number", "format": "double", "description": "The value of the order.\n\nExample: `value:40.2`\n" }, "currency": { "type": "string", "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency concerned.\n\nThe default code is \"EUR\".\n\nExample: `currency:\"USD\"`\n" } }, "title": "MoneyValue", "description": "The total value of an order for customs purposes." }, "DeliveryDate": { "type": "object", "properties": { "deliveryDate": { "type": "string", "format": "date", "description": "The date on which a shipment is delivered to a home address or a\npick-up location.\n\nFormat: `\"YYYY-MM-DD\"`\n" }, "pickupDate": { "type": "string", "format": "date", "description": "The date on which a shipment is picked up from a warehouse by a\ncarrier.\n\nFormat: `\"YYYY-MM-DD\"`\n" }, "timeRange": { "$ref": "#/components/schemas/TimeRange" } }, "title": "DeliveryDate", "xml": { "name": "deliveryDate" } }, "DeliveryDateOptions": { "type": "object", "properties": { "numberOfDays": { "type": "integer", "format": "int32", "description": "The length of time in days after startDate for which shipping options are supplied.\n\nThe default value is `7`.\n\nExample: `numberOfDays:3`\n" }, "startDate": { "type": "string", "format": "date", "description": "The starting point of a range of possible delivery dates.\n\nFormat: \"YYYY-MM-DD\"\n\nThe default value is today's date.\n\n**Note!** When calculating the start date for a delivery date range, Paazl adds the number of delivery days and processing days you have configured in your webshop's [delivery matrix](https://support.paazl.com/hc/en-us/articles/360007580074-Configuring-your-delivery-matrix-).\n\nExample: `startDate:\"2018-08-27\"`\n" } }, "title": "DeliveryDateOptions", "description": "Contains options affecting the delivery date.\n\nExample: `deliveryDateOptions: {\"startDate\":\"2018-08-27\", \"numberOfDays\":5}`\n" }, "DeliveryWindow": { "type": "object", "properties": { "end": { "type": "string", "description": "The global setting for the end of a shipping option's delivery\ntime range as configured by [Paazl Customer\nSupport](mailto:support@paazl.com). This is the fall-back if the\ntime range end hasn't been set at a shipping option level.\n" }, "start": { "type": "string", "description": "The global setting for the start of a shipping option's delivery\ntime range as configured by [Paazl Customer\nSupport](mailto:support@paazl.com). This is the fall-back if the\ntime range start hasn't been set at a shipping option level.\n" } }, "title": "DeliveryWindow", "description": "The time range within which a shipment will be delivered as configured by [Paazl Customer Support](mailto:support@paazl.com) in the web app's global settings." }, "EstimatedDeliveryRange": { "type": "object", "properties": { "earliestDate": { "type": "string", "format": "date", "description": "The earliest date that a shipment could be delivered by a carrier.\nThis is the default way of indicating the start of an estimated\ndelivery date range.\n" }, "latestDate": { "type": "string", "format": "date", "description": "The latest date that a shipment could be delivered by a carrier.\nThis is the default way of indicating the end of an estimated\ndelivery date range.\n" }, "max": { "type": "integer", "format": "int32", "description": "The maximum number of days a shipment will be in transit." }, "min": { "type": "integer", "format": "int32", "description": "The minimum number of days a shipment will be in transit." } }, "title": "EstimatedDeliveryRange", "description": "Specifies the length of time a shipment will be in transit." }, "OpeningTime": { "type": "object", "properties": { "alwaysOpen": { "type": "boolean", "description": "Some pickup locations offer physical lockers that can be accessed outside office hours. If this is the case, this key's value will be `true`." }, "businessHours": { "type": "array", "xml": { "name": "businessHours", "attribute": false, "wrapped": true }, "description": "A pickup location's hours of business on a given weekday.", "items": { "$ref": "#/components/schemas/BusinessHour" } }, "day": { "type": "string", "description": "The full name of a specific weekday.\n", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } }, "title": "OpeningTime", "xml": { "name": "openingTime", "attribute": false, "wrapped": false } }, "PickupLocation": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/Address" }, "code": { "type": "string", "description": "A carrier's unique code for a pickup location." }, "coordinates": { "$ref": "#/components/schemas/Coordinates" }, "distance": { "type": "number", "format": "double", "description": "The distance between a home delivery address and a pickup location in meters." }, "name": { "type": "string", "description": "The name of the pickup location." }, "openingTimes": { "type": "array", "xml": { "name": "openingTimes", "attribute": false, "wrapped": true }, "description": "Contains objects with information on a pick-up location's opening times for each day of the week.", "items": { "$ref": "#/components/schemas/OpeningTime" } }, "shippingOptions": { "type": "array", "xml": { "name": "shippingOptions", "attribute": false, "wrapped": true }, "description": "Contains shipping option objects.", "items": { "$ref": "#/components/schemas/PickupShippingOption" } } }, "title": "PickupLocation", "xml": { "name": "pickupLocation", "attribute": false, "wrapped": false } }, "PickupLocationRequest": { "type": "object", "required": [ "consigneeCountryCode" ], "properties": { "consigneeCountryCode": { "type": "string", "description": "The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code for\nthe country the shipment is being sent to.\n\nExample: `consigneeCountryCode:\"NL\"`\n" }, "consigneePostalCode": { "type": "string", "description": "The postal code of the address the shipment is being sent to. The\ncode is used to get a more precise list of available shipping\noptions.\n\nExample: `consigneePostalCode:\"1020HD\"`\n" }, "consignorCountryCode": { "type": "string", "description": "The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code for\nthe country the shipment is being sent from.\n\nIf left empty, Paazl will use the default setting in your Paazl web app account under *Settings>Account>My address book>Sender address>Country.*\n\nExample: `consignorCountryCode:\"NL\"`\n" }, "consignorPostalCode": { "type": "string", "description": "The postal code of the address the shipment is being sent from. The\ncode is used to get delivery dates from carriers if they offer this\nservice.\n\nIf left empty, Paazl will use the default setting in your Paazl web app account under *Settings>Account>My addres book>Sender address>Postal code*.\n\nExample: `consignorPostalCode:\"1019HD\"`\n" }, "deliveryDateOptions": { "$ref": "#/components/schemas/DeliveryDateOptions" }, "includeExternalDeliveryDates": { "type": "boolean", "description": "Gets delivery dates directly from the carrier if the carrier\nsupplies them.\n\nThe default value is `false`.\n\nExample: `includeExternalDeliveryDates: true`\n" }, "limit": { "type": "integer", "format": "int32", "description": "The maximum number of shipping options that Paazl must return.\n\nMinimum value: 1\n\nMaximum value: 99\n\nExample: `limit:10`\n" }, "locale": { "type": "string", "description": "Specifies the language in which the widget is displayed as well as\nthe localized shipping option names you have configured in your web\napp account (under *Settings>Paazl Perfect>Shipping options*).\n\n`locale` is specified using the format `{language}_{country}`, where `{language}` is an [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code and `{country}` is an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code.\n\nExample: `locale:\"fr_FR\"`\n" }, "numberOfProcessingDays": { "type": "integer", "format": "int32", "description": "The number of days a warehouse needs to get an order ready for\npick-up by a carrier. \n\nThe default value is `0`. However, if you have specified a value for processing days in your webshop's [delivery matrix](https://support.paazl.com/hc/en-us/articles/360007580074-Configuring-your-delivery-matrix-), that value will override `numberOfProcessingDays`.\n\nMinimum value: `0`\n\nMaximum value: `99`\n\nExample: `numberOfProcessingDays:5`\n" }, "shipmentParameters": { "$ref": "#/components/schemas/ShipmentParameters" }, "tags": { "type": "array", "xml": { "name": "tags", "attribute": false, "wrapped": true }, "description": "Codes that are used to filter returned shipping options for display. \n\nExample: `tags:[\"CASH_ON_DELIVERY\",\"INSURANCE\"]`\n", "items": { "type": "string", "xml": { "name": "tag" }, "enum": [ "PACK_STATION", "SAME_DAY", "FLEX_DELIVERY", "CASH_ON_DELIVERY", "INSURANCE", "SIGNATURE_REQUIRED", "AT_NEIGHBOURS", "NOT_AT_NEIGHBOURS", "RETURN_ON_FAILURE", "DATE_PREFERENCE", "TWENTYFOUR_SEVEN", "NOTIFY_RECEIVER", "SUNDAY_SORTING", "AGE_CHECK", "ID_CHECK", "CLIMATE_COMPENSATION", "DANGEROUS_GOODS", "RETURN_TO_SENDER", "NO_PROOF_OF_DELIVERY", "PERISHABLE" ] } }, "token": { "type": "string", "format": "uuid", "description": "The access token returned by the `token` endpoint.\n\nIf you assign token a value, Paazl temporarily registers session details in its database in order to keep track of the choices made by webshop customers.\n\nExample: `token:\"4f7c7af4-a379-4d5e-8ccf-807f4ba97a52\"`\n" }, "network": { "type": "string", "description": "Specifies what type(s) of pickup locations you want Paazl to send you:\n\n• \"CARRIER\": carrier pickup location\n\n• \"STORE\": click & collect pickup location\n\n• \"ALL\": both types of pickup location\n\nThe default value is `\"ALL\"`.\n\nExample: `network: \"STORE\"`\n", "enum": [ "CARRIER", "STORE", "ALL" ] } }, "title": "PickupLocationRequest", "xml": { "name": "pickupLocationRequest", "attribute": false, "wrapped": false } }, "PickupLocationResponse": { "type": "object", "properties": { "fullDeliveryDateSelection": { "type": "boolean", "description": "If `true`, customers can select the delivery date they want. If `false`, they are given the first available delivery date." }, "pickupLocations": { "type": "array", "xml": { "name": "pickupLocations", "attribute": false, "wrapped": true }, "description": "Pickup location objects.", "items": { "$ref": "#/components/schemas/PickupLocation" } } }, "title": "PickupLocationResponse", "xml": { "name": "pickupLocationResponse", "attribute": false, "wrapped": false } }, "PickupLocationSelection": { "type": "object", "properties": { "accountNumber": { "type": "string", "description": "An individual code that DHL issues to customers so that they can identify themselves at a DHL PackStation." }, "code": { "type": "string", "description": "A carrier's unique code for a pickup location.\n\nExample: `code:ABC242526`\n" } }, "title": "PickupLocationSelection", "xml": { "name": "pickupLocation", "attribute": false, "wrapped": false }, "description": "Contains details of the pickup location that your customer selected at checkout." }, "PickupShippingOption": { "type": "object", "properties": { "carrier": { "$ref": "#/components/schemas/Carrier" }, "deliveryDates": { "type": "array", "xml": { "name": "deliveryDates", "attribute": false, "wrapped": true }, "description": "Contains delivery date objects.", "items": { "$ref": "#/components/schemas/DeliveryDate" } }, "deliveryWindow": { "$ref": "#/components/schemas/DeliveryWindow" }, "description": { "type": "string", "description": "The contents of the `details` field for localized shipping option names you have configured in your Paazl web app account under *Settings>Paazl Perfect>Shipping options*." }, "estimatedDeliveryRange": { "$ref": "#/components/schemas/EstimatedDeliveryRange" }, "identifier": { "type": "string", "description": "A shipping option's Paazl code. You will find a list of the identifiers of the shipping options available to your webshop in your webshop account under *Settings>Account>Overview of shipping options*." }, "name": { "type": "string", "description": "The name of the shipping option as it appears in the Paazl Sell\nwidget. This can have one of three values, in order of ascending\npriority:\n\n1. The Paazl \"default description\" for a shipping option (hard-coded in Paazl)\n\n2. The (customized) \"description\" of a shipping option (configured by [Paazl Customer Support](mailto:support@paazl.com))\n\n3. The localized name of a shipping option (you can configure this in the Paazl web app under *Settings>Paazl Perfect>Shipping options*.)\n" }, "rate": { "type": "number", "description": "The shipping rate defined for the shipping option concerned in you webshop's delivery matrix." }, "tags": { "type": "array", "xml": { "name": "tags", "attribute": false, "wrapped": true }, "description": "Codes that are used to filter returned shipping options for display.\n", "items": { "type": "string", "xml": { "name": "tag" }, "enum": [ "PACK_STATION", "SAME_DAY", "FLEX_DELIVERY", "CASH_ON_DELIVERY", "INSURANCE", "SIGNATURE_REQUIRED", "AT_NEIGHBOURS", "NOT_AT_NEIGHBOURS", "RETURN_ON_FAILURE", "DATE_PREFERENCE", "TWENTYFOUR_SEVEN", "NOTIFY_RECEIVER", "SUNDAY_SORTING", "AGE_CHECK", "ID_CHECK", "CLIMATE_COMPENSATION", "DANGEROUS_GOODS", "RETURN_TO_SENDER", "NO_PROOF_OF_DELIVERY", "PERISHABLE" ] } }, "network": { "type": "string", "description": "Specifies what type(s) of pickup locations you want Paazl to send you:\n\n• \"CARRIER\": carrier pickup location\n\n• \"STORE\": click & collect pickup location\n\n• \"ALL\": both types of pickup location\n", "enum": [ "CARRIER", "STORE", "ALL" ] }, "needsCustomerNumber": { "type": "boolean", "description": "If the shipping option concerned delivers to a DHL PackStation, this element will be set to `true`.\n" } }, "title": "PickupShippingOption", "xml": { "name": "shippingOption", "attribute": false, "wrapped": false } }, "ProductParameters": { "type": "object", "required": [ "quantity" ], "properties": { "height": { "type": "integer", "format": "int32", "description": "The height in whole centimeters (cm) of a single item in a shipment.\n\n**Note!** The value you assign this attribute must be an integer. If you assign a floating-point value, Paazl will truncate it.\n\nExample: `height:10`\n\nThis element is intended for use by the Paazl Sell widget. Set its values using the widget's [setShipmentParameters](https://support.paazl.com/hc/en-us/articles/360008748434-Paazl-Sell-widget-methods-#setShipmentParameters) method.\n" }, "length": { "type": "integer", "format": "int32", "description": "The length in whole centimeters (cm) of a single item in a shipment.\n\n**Note!** The value you assign this attribute must be an integer. If you assign a floating-point value, Paazl will truncate it.\n\nExample: `length:30`\n\nThis element is intended for use by the Paazl Sell widget. Set its values using the widget's [setShipmentParameters](https://support.paazl.com/hc/en-us/articles/360008748434-Paazl-Sell-widget-methods-#setShipmentParameters) method.\n" }, "price": { "type": "number", "format": "double", "description": "The price of a single item in a shipment. This is a scalar value.\nThe currency unit is assigned by your webshop's checkout page.\n\nExample: `price:250`\n\nThis element is intended for use by the Paazl Sell widget. Set its values using the widget's [setShipmentParameters](https://support.paazl.com/hc/en-us/articles/360008748434-Paazl-Sell-widget-methods-#setShipmentParameters) method.\n" }, "quantity": { "type": "integer", "format": "int32", "description": "The number of products of a particular type in a shipment.\n\nExample: `quantity:7`\n\nThis element is intended for use by the Paazl Sell widget. Set its values using the widget's [setShipmentParameters](https://support.paazl.com/hc/en-us/articles/360008748434-Paazl-Sell-widget-methods-#setShipmentParameters) method.\n" }, "volume": { "type": "number", "format": "float", "description": "The volume of a single item in a shipment in cubic meters (m3) including packaging.\n\nExample: `volume:0.5`\n\nThis element is intended for use by the Paazl Sell widget. Set its values using the widget's [setShipmentParameters](https://support.paazl.com/hc/en-us/articles/360008748434-Paazl-Sell-widget-methods-#setShipmentParameters) method.\n" }, "weight": { "type": "number", "format": "double", "description": "The weight in kilograms (kg) of a single item in a shipment.\n\nExample: `weight:100`\n\nThis element is intended for use by the Paazl Sell widget. Set its values using the widget's [setShipmentParameters](https://support.paazl.com/hc/en-us/articles/360008748434-Paazl-Sell-widget-methods-#setShipmentParameters) method.\n" }, "width": { "type": "integer", "format": "int32", "description": "The width in whole centimeters (cm) of a single item in a shipment.\n\n**Note!** The value you assign this attribute must be an integer. If you assign a floating-point value, Paazl will truncate it.\n\nExample: `width:20`\n\nThis element is intended for use by the Paazl Sell widget. Set its values using the widget's [setShipmentParameters](https://support.paazl.com/hc/en-us/articles/360008748434-Paazl-Sell-widget-methods-#setShipmentParameters) method.\n" } }, "title": "ProductParameters", "xml": { "name": "good" } }, "Product": { "type": "object", "required": [ "quantity" ], "properties": { "height": { "type": "integer", "format": "int32", "description": "The height in whole centimeters (cm) of the product concerned.\n\n**Note!** The value you assign this attribute must be an integer. If you assign a floating-point value, Paazl will truncate it.\n\nExample: `height:10`\n" }, "length": { "type": "integer", "format": "int32", "description": "The length in whole centimeters (cm) of the product concerned.\n\n**Note!** The value you assign this attribute must be an integer. If you assign a floating-point value, Paazl will truncate it.\n\nExample: `length:30`\n" }, "unitPrice": { "$ref": "#/components/schemas/UnitPrice" }, "quantity": { "type": "integer", "format": "int32", "description": "The number of items of a particular product.\n\nExample: `quantity:7`\n" }, "volume": { "type": "number", "format": "float", "description": "The volume of the product concerned in cubic meters (m3), including product packaging.\n\nExample: `volume:0.5`\n" }, "weight": { "type": "number", "format": "double", "description": "The weight in kilograms (kg) of the product concerned.\n\nExample: `weight:100`\n" }, "width": { "type": "integer", "format": "int32", "description": "The width in whole centimeters (cm) of the product concerned.\n\n**Note!** The value you assign this attribute must be an integer. If you assign a floating-point value, Paazl will truncate it.\n\nExample: `width:20`\n" }, "countryOfManufacture": { "type": "string", "description": "The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code for the country in which the product concerned was manufactured.\n\nExample: `country:\"DE\"`\n" }, "description": { "type": "string", "description": "A general description of the contents of the product concerned.\n\nExample: `description:\"Zhitomir socks\"`\n" }, "hsTariffCode": { "type": "string", "description": "The HS code for the commodity category of the product concerned.\n\nExample: `hsTariffCode:\"6115\"`\n" } }, "title": "Product", "xml": { "name": "product" } }, "Reference": { "type": "object", "required": [ "reference" ], "properties": { "reference": { "type": "string", "description": "Your reference for the checkout session whose details you want to retrieve.\n\n**Note!** If the reference value you provide already exists, Paazl will replace the existing session with a new session.\n\nExample: `reference:\"order1234\"`\n" } }, "title": "Reference", "xml": { "name": "reference", "attribute": false, "wrapped": false } }, "SaveCheckout": { "type": "object", "required": [ "shippingOption", "token" ], "properties": { "pickupLocation": { "$ref": "#/components/schemas/PickupLocationSelection" }, "preferredDeliveryDate": { "type": "string", "format": "date", "description": "The day of the week on which customers want their order delivered." }, "shippingOption": { "$ref": "#/components/schemas/ShippingOptionSelection" }, "token": { "type": "string", "format": "uuid", "description": "The access token returned by the `token` endpoint.\n\nExample: `token:\"4f7c7af4-a379-4d5e-8ccf-807f4ba97a52\"`\n" } }, "title": "SaveCheckout", "xml": { "name": "saveCheckout", "attribute": false, "wrapped": false } }, "SelectedPickupLocation": { "type": "object", "properties": { "accountNumber": { "type": "string", "description": "An individual code that DHL issues to customers so that they can identify themselves at a DHL PackStation." }, "address": { "$ref": "#/components/schemas/Address" }, "code": { "type": "string", "description": "A carrier's unique code for a pickup location." }, "coordinates": { "$ref": "#/components/schemas/Coordinates" }, "distance": { "type": "number", "format": "double", "description": "The distance between a home delivery address and a pickup location in meters." }, "name": { "type": "string", "description": "The name of the pickup location." }, "openingTimes": { "type": "array", "xml": { "name": "openingTimes", "attribute": false, "wrapped": true }, "description": "Contains objects with information on a pick-up location's opening times for each day of the week.", "items": { "$ref": "#/components/schemas/OpeningTime" } } }, "title": "SelectedPickupLocation", "xml": { "name": "selectedPickupLocation", "attribute": false, "wrapped": false }, "description": "Contains details of the pickup location that your customer selected at checkout." }, "SelectedShippingOption": { "type": "object", "properties": { "carrier": { "$ref": "#/components/schemas/Carrier" }, "deliveryDates": { "type": "array", "xml": { "name": "deliveryDates", "attribute": false, "wrapped": true }, "description": "Contains delivery date objects.", "items": { "$ref": "#/components/schemas/DeliveryDate" } }, "deliveryWindow": { "$ref": "#/components/schemas/DeliveryWindow" }, "description": { "type": "string", "description": "The contents of the `details` field for localized shipping option names you have configured in your Paazl web app account under *Settings>Paazl Perfect>Shipping options*." }, "estimatedDeliveryRange": { "$ref": "#/components/schemas/EstimatedDeliveryRange" }, "identifier": { "type": "string", "description": "A shipping option's Paazl code. You will find a list of the identifiers of the shipping options available to your webshop in your webshop account under *Settings>Account>Overview of shipping options*." }, "name": { "type": "string", "description": "The name of the shipping option as it appears in the Paazl Sell\nwidget. This can have one of three values, in order of ascending\npriority:\n\n1. The Paazl \"default description\" for a shipping option (hard-coded in Paazl)\n\n2. The (customized) \"description\" of a shipping option (configured by [Paazl Customer Support](mailto:support@paazl.com))\n\n3. The localized name of a shipping option (you can configure this in the Paazl web app under *Settings>Paazl Perfect>Shipping options*.)\n" }, "rate": { "type": "number", "description": "The shipping rate defined for the shipping option concerned in your webshop's [delivery matrix](https://support.paazl.com/hc/en-us/articles/360007580074-Delivery-matrix-concepts-#shipping-rates)." }, "tags": { "type": "array", "xml": { "name": "tags", "attribute": false, "wrapped": true }, "description": "Codes that are used to filter returned shipping options for display. \n", "items": { "type": "string", "xml": { "name": "tag" }, "enum": [ "PACK_STATION", "SAME_DAY", "FLEX_DELIVERY", "CASH_ON_DELIVERY", "INSURANCE", "SIGNATURE_REQUIRED", "AT_NEIGHBOURS", "NOT_AT_NEIGHBOURS", "RETURN_ON_FAILURE", "DATE_PREFERENCE", "TWENTYFOUR_SEVEN", "NOTIFY_RECEIVER", "SUNDAY_SORTING", "AGE_CHECK", "ID_CHECK", "CLIMATE_COMPENSATION", "DANGEROUS_GOODS", "RETURN_TO_SENDER", "NO_PROOF_OF_DELIVERY", "PERISHABLE" ] } } }, "title": "SelectedShippingOption", "xml": { "name": "selectedShippingOption", "attribute": false, "wrapped": false } }, "ShipmentParameters": { "type": "object", "properties": { "goods": { "type": "array", "xml": { "name": "goods", "attribute": false, "wrapped": true }, "description": "An array of variables used to determine the applicable delivery\nmatrix. See [Configuring delivery\nmatrices](https://support.paazl.com/hc/en-us/articles/360009610354-Configuring-delivery-matrices-)\nfor an explanation of how delivery matrices work.\n\nExample: `goods:[{quantity:2, weight:3}, {width:1, height:5}]`\n\nThis element is intended for use by the Paazl Sell widget. Set its values using the widget's [setShipmentParameters](https://support.paazl.com/hc/en-us/articles/360008748434-Paazl-Sell-widget-methods-#setShipmentParameters) method.\n", "items": { "$ref": "#/components/schemas/ProductParameters" } }, "numberOfGoods": { "type": "integer", "format": "int32", "description": "The total number of packages or individual goods in a shipment.\n\n**Note!** If you give `numberOfGoods` a value, the `quantity` attribute of each `goods` array will be ignored.\n\nExample: `numberOfGoods:8`\n\nThis element is intended for use by the Paazl Sell widget. Set its values using the widget's [setShipmentParameters](https://support.paazl.com/hc/en-us/articles/360008748434-Paazl-Sell-widget-methods-#setShipmentParameters) method.\n" }, "startMatrix": { "type": "string", "description": "A one- or two-letter code identifying the delivery matrix column to\nstart with when determining the appropriate shipping option and\nrate for the whole shipment. See [Configuring delivery\nmatrices](https://support.paazl.com/hc/en-us/articles/360009610354-Configuring-delivery-matrices-)\nfor an explanation of how delivery matrices work.\n\nExample: `startMatrix:\"B\"`\n\nThis element is intended for use by the Paazl Sell widget. Set its values using the widget's [setShipmentParameters](https://support.paazl.com/hc/en-us/articles/360008748434-Paazl-Sell-widget-methods-#setShipmentParameters) method.\n" }, "totalPrice": { "type": "number", "format": "double", "description": "The total price of the shipment concerned. This is a scalar value.\nThe currency unit is assigned by your webshop's checkout page.\n\n**Note!** If you give `totalPrice` a value, the prices of the individual goods in the shipment will be ignored.\n\nExample: `totalPrice:100`\n\nThis element is intended for use by the Paazl Sell widget. Set its values using the widget's [setShipmentParameters](https://support.paazl.com/hc/en-us/articles/360008748434-Paazl-Sell-widget-methods-#setShipmentParameters) method.\n" }, "totalVolume": { "type": "number", "format": "float", "description": "The total volume in cubic meters (m3) of the shipment\nconcerned, including packaging.\n\n**Note!** If you give `totalVolume` a value, the volumes of the individual goods in the shipment will be ignored.\n\nExample: `totalVolume:1`\n\nThis element is intended for use by the Paazl Sell widget. Set its values using the widget's [setShipmentParameters](https://support.paazl.com/hc/en-us/articles/360008748434-Paazl-Sell-widget-methods-#setShipmentParameters) method.\n" }, "totalWeight": { "type": "number", "format": "double", "description": "The total weight in kilograms (kg)of the shipment concerned,\nincluding packaging.\n\n**Note!** If you give `totalWeight` a value, the weights of the individual goods in the shipment will be ignored.\n\nExample: `totalWeight:10`\n\nThis element is intended for use by the Paazl Sell widget. Set its values using the widget's [setShipmentParameters](https://support.paazl.com/hc/en-us/articles/360008748434-Paazl-Sell-widget-methods-#setShipmentParameters) method.\n" } }, "title": "ShipmentParameters", "description": "Contains details of a customer's order.\n\nExample: `shipmentParameters: {totalWeight:3.14, startMatrix:\"AA\", goods: [{quantity:2, weight:3}, {width:1, height:5}]}`\n\nThis element is intended for use by the Paazl Sell widget. Set its values using the widget's [setShipmentParameters](https://support.paazl.com/hc/en-us/articles/360008748434-Paazl-Sell-widget-methods-#setShipmentParameters) method.\n" }, "ShippingOption": { "type": "object", "properties": { "carrier": { "$ref": "#/components/schemas/Carrier" }, "deliveryDates": { "type": "array", "xml": { "name": "deliveryDates", "attribute": false, "wrapped": true }, "description": "Contains delivery date objects.", "items": { "$ref": "#/components/schemas/DeliveryDate" } }, "deliveryWindow": { "$ref": "#/components/schemas/DeliveryWindow" }, "description": { "type": "string", "description": "The contents of the `details` field for localized shipping option names you have configured in your Paazl web app account under *Settings>Paazl Perfect>Shipping options*." }, "estimatedDeliveryRange": { "$ref": "#/components/schemas/EstimatedDeliveryRange" }, "identifier": { "type": "string", "description": "A shipping option's Paazl code. You will find a list of the identifiers of the shipping options available to your webshop in your webshop account under *Settings>Account>Overview of shipping options*." }, "name": { "type": "string", "description": "The name of the shipping option as it appears in the Paazl Sell widget. This\ncan have one of three values, in order of ascending priority:\n\n1. The Paazl \"default description\" for a shipping option (hard-coded in Paazl)\n\n2. The (customized) \"description\" of a shipping option (configured by [Paazl Customer Support](mailto:support@paazl.com))\n\n3. The localized name of a shipping option (you can configure this in the Paazl web app under *Settings>Paazl Perfect>Shipping options*.)\n" }, "rate": { "type": "number", "description": "The shipping rate defined for the shipping option concerned in your webshop's [delivery matrix](https://support.paazl.com/hc/en-us/articles/360007580074-Delivery-matrix-concepts-#shipping-rates)." }, "tags": { "type": "array", "xml": { "name": "tags", "attribute": false, "wrapped": true }, "description": "Codes that are used to filter returned shipping options for display.\n", "items": { "type": "string", "xml": { "name": "tag" }, "enum": [ "PACK_STATION", "SAME_DAY", "FLEX_DELIVERY", "CASH_ON_DELIVERY", "INSURANCE", "SIGNATURE_REQUIRED", "AT_NEIGHBOURS", "NOT_AT_NEIGHBOURS", "RETURN_ON_FAILURE", "DATE_PREFERENCE", "TWENTYFOUR_SEVEN", "NOTIFY_RECEIVER", "SUNDAY_SORTING", "AGE_CHECK", "ID_CHECK", "CLIMATE_COMPENSATION", "DANGEROUS_GOODS", "RETURN_TO_SENDER", "NO_PROOF_OF_DELIVERY", "PERISHABLE" ] } } }, "title": "ShippingOption", "xml": { "name": "shippingOption", "attribute": false, "wrapped": false } }, "ShippingOptionRequest": { "type": "object", "required": [ "consigneeCountryCode" ], "properties": { "consigneeCountryCode": { "type": "string", "description": "The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code for\nthe country the shipment is being sent to.\n\nExample: `consigneeCountryCode:\"NL\"`\n" }, "consigneePostalCode": { "type": "string", "description": "The postal code of the address the shipment is being sent to. The\ncode is used to get a more precise list of available shipping\noptions.\n\nExample: `consigneePostalCode:\"1020HD\"`\n" }, "consignorCountryCode": { "type": "string", "description": "The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code for\nthe country the shipment is being sent from.\n\nIf left empty, Paazl will use the default setting in your Paazl web app account under *Settings>Account>My address book>Sender address>Country.*\n\nExample: `consignorCountryCode:\"NL\"`\n" }, "consignorPostalCode": { "type": "string", "description": "The postal code of the address the shipment is being sent from. The\ncode is used to get delivery dates from carriers if they offer this\nservice.\n\nIf left empty, Paazl will use the default setting in your Paazl web app account under *Settings>Account>My addres book>Sender address>Postal code*.\n\nExample: `consignorPostalCode:\"1019HD\"`\n" }, "deliveryDateOptions": { "$ref": "#/components/schemas/DeliveryDateOptions" }, "includeExternalDeliveryDates": { "type": "boolean", "description": "Gets delivery dates directly from the carrier if the carrier\nsupplies them.\n\nThe default value is `false`.\n\nExample: `includeExternalDeliveryDates:true`\n" }, "limit": { "type": "integer", "format": "int32", "description": "The maximum number of shipping options that Paazl must return.\n\nMinimum value: 1\n\nMaximum value: 99\n\nExample: `limit:10`\n" }, "locale": { "type": "string", "description": "Specifies the language in which the widget is displayed as well as\nthe localized shipping option names you have configured in your web\napp account (under *Settings>Paazl Perfect>Shipping options*).\n\n`locale` is specified using the format `{language}_{country}`, where `{language}` is an [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code and `{country}` is an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code.\n\nExample: `locale:\"fr_FR\"`\n" }, "numberOfProcessingDays": { "type": "integer", "format": "int32", "description": "The number of days a warehouse needs to get an order ready for\npick-up by a carrier. \n\nThe default value is `0`. However, if you have specified a value for processing days in your webshop's [delivery matrix](https://support.paazl.com/hc/en-us/articles/360007580074-Configuring-your-delivery-matrix-), that value will override `numberOfProcessingDays`.\n\nMinimum value: `0`\n\nMaximum value: `99`\n\nExample: `numberOfProcessingDays:5`\n" }, "shipmentParameters": { "$ref": "#/components/schemas/ShipmentParameters" }, "sortingModel": { "$ref": "#/components/schemas/SortingModel" }, "tags": { "type": "array", "xml": { "name": "tags", "attribute": false, "wrapped": true }, "description": "Codes that are used to filter the shipping options that Paazl returns for\ndisplay.\n\nExample: `tags:[\"CASH_ON_DELIVERY\",\"INSURANCE\"]`\n", "items": { "type": "string", "xml": { "name": "tag" }, "enum": [ "PACK_STATION", "SAME_DAY", "FLEX_DELIVERY", "CASH_ON_DELIVERY", "INSURANCE", "SIGNATURE_REQUIRED", "AT_NEIGHBOURS", "NOT_AT_NEIGHBOURS", "RETURN_ON_FAILURE", "DATE_PREFERENCE", "TWENTYFOUR_SEVEN", "NOTIFY_RECEIVER", "SUNDAY_SORTING", "AGE_CHECK", "ID_CHECK", "CLIMATE_COMPENSATION", "DANGEROUS_GOODS", "RETURN_TO_SENDER", "NO_PROOF_OF_DELIVERY", "PERISHABLE" ] } }, "token": { "type": "string", "format": "uuid", "description": "The access token returned by the `token` endpoint.\n\nIf you assign token a value, Paazl temporarily registers session details in its database in order to keep track of the choices made by webshop customers.\n\nExample: `token:\"4f7c7af4-a379-4d5e-8ccf-807f4ba97a52\"`\n" } }, "title": "ShippingOptionRequest", "xml": { "name": "shippingOptionRequest", "attribute": false, "wrapped": false } }, "ShippingOptionResponse": { "type": "object", "properties": { "fullDeliveryDateSelection": { "type": "boolean", "description": "If `true`, customers can select the delivery date they want. If `false`, they are given the first available delivery date." }, "shippingOptions": { "type": "array", "xml": { "name": "shippingOptions", "attribute": false, "wrapped": true }, "description": "Contains shipping option objects.", "items": { "$ref": "#/components/schemas/ShippingOption" } } }, "title": "ShippingOptionResponse", "xml": { "name": "shippingOptionResponse", "attribute": false, "wrapped": false } }, "ShippingOptionSelection": { "type": "object", "required": [ "identifier" ], "properties": { "identifier": { "type": "string", "description": "A shipping option's Paazl code. You will find a list of the identifiers of the shipping options available to your webshop in your webshop account under *Settings>Account>Overview of shipping options*.\n\nExample: `identifier:\"AVG\"`\n" } }, "title": "ShippingOptionSelection", "xml": { "name": "shippingOption", "attribute": false, "wrapped": false }, "description": "Contains details of the shipping option that your customer selected at checkout." }, "ShopOrder": { "type": "object", "required": [ "reference", "consignee", "shipping" ], "properties": { "additionalInstruction": { "type": "string", "description": "Additional instructions concerning the delivery of an order.\n\nExample: `additionalInstruction:\"Call before delivery\"`\n" }, "consignee": { "$ref": "#/components/schemas/Consignee" }, "customsValue": { "$ref": "#/components/schemas/CustomsValue" }, "codValue": { "$ref": "#/components/schemas/CodValue" }, "description": { "type": "string", "description": "A general description of the contents of a whole order.\n\nExample: `description:\"Socks\"`\n" }, "requestedDeliveryDate": { "type": "string", "format": "date", "description": "The date on which a customer has requested that an order be delivered.\n\nFormat: \"YYYY-MM-DD\"\n\nExample: `requestedDeliveryDate:2019-18-02`\n" }, "products": { "type": "array", "xml": { "name": "products", "attribute": false, "wrapped": true }, "description": "Contains objects representing the products making up a order.", "items": { "$ref": "#/components/schemas/Product" } }, "reference": { "type": "string", "description": "Your own order reference for a purchase transaction.\n\n**Note!** The order reference must be unique within the webshop concerned.\n\nExample: `reference:\"myOrderReference00123\"`\n" }, "return": { "$ref": "#/components/schemas/ShopOrderReturn" }, "sender": { "$ref": "#/components/schemas/ShopOrderSender" }, "shipping": { "$ref": "#/components/schemas/ShopOrderShipping" }, "weight": { "type": "number", "format": "double", "description": "The total weight in kilograms (kg) of an order, including packaging for shipping.\n\nExample: `weight:10.12`\n" } }, "title": "ShopOrder", "xml": { "name": "shopOrder", "attribute": false, "wrapped": false } }, "ShopOrderReturn": { "type": "object", "required": [ "address" ], "properties": { "name": { "type": "string", "description": "The name of the party to return an order to.\n\nExample: `name:\"A'dam Mac Tosch\"`\n" }, "address": { "$ref": "#/components/schemas/ShopOrderReturnAddress" } }, "title": "ShopOrderParty", "description": "Contains details of the party to return an order to." }, "ShopOrderReturnAddress": { "type": "object", "properties": { "city": { "type": "string", "description": "The city of the address to return an order to.\n\n**Note!** If you provide a return address, `city` is required.\n\nExample: `city:\"Bonn\"`\n" }, "country": { "type": "string", "description": "The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code for the country of the address to return an order to.\n\nThe default value is \"NL\".\n\nExample: `country:\"DE\"`\n" }, "postalCode": { "type": "string", "description": "The postal code of the address to return an order to.\n\nExample: `postalCode:\"53111\"`\n" }, "province": { "type": "string", "description": "The province or state of the address to return an order to.\n\nExample: `province:\"Nordrhein-Westfalen\"`\n" }, "street": { "type": "string", "description": "The street name of the address to return an order to.\n\nSee the note in the general method description.\n\nExample: `street:\"Jacob Bontousplaats\"`\n" }, "streetLines": { "type": "array", "xml": { "name": "streetLines", "attribute": false, "wrapped": true }, "items": { "type": "string", "xml": { "name": "streetLine" } }, "description": "The street address to return an order to, specified as a series of strings.\n\nSee the note in the general method description.\n\n**Note!** Paazl does not parse the string to perform validation with any values that may be provided for the other parameters of a return address.\n\nExample: `streetLines:\"Jacob Bontiusplaats 9\", \"Unit 580\"`\n" }, "houseNumber": { "type": "integer", "format": "int32", "description": "The house number of the address to return an order to.\n\nSee the note in the general method description.\n\nExample: `houseNumber:9`\n" }, "houseNumberExtension": { "type": "string", "description": "The house number extension (such as the \"-A\" in \"12-A\") of the address to return an order to.\n\nExample: `houseNumberExtension:\"-A\"`\n" } }, "title": "ShopOrderAddress", "description": "Contains details of the address to return an order to.\n\n**Note!** If not provided, the default is the address specified in your web app account under *Settings>Account>My address book>Return address*.\n" }, "ShopOrderSender": { "type": "object", "required": [ "address" ], "properties": { "name": { "type": "string", "description": "The name of the party that shipped an order.\n\nExample: `name:\"A'dam Mac Tosch\"`\n" }, "address": { "$ref": "#/components/schemas/ShopOrderSenderAddress" } }, "title": "ShopOrderParty", "description": "Contains details of a party that shipped an order." }, "ShopOrderSenderAddress": { "type": "object", "properties": { "city": { "type": "string", "description": "The city in which the party that shipped an order is located.\n\n**Note!** If you provide a sender address, `city` is required.\n\nExample: `city:\"Bonn\"`\n" }, "country": { "type": "string", "description": "The ISO 3166-2 code for the country in which the party that shipped an order is located.\n\nThe default value is \"NL\".\n\nExample: `country:\"DE\"`\n" }, "postalCode": { "type": "string", "description": "The postal code of the address of the party that shipped an order.\n\nExample: `postalCode:\"53111\"`\n" }, "province": { "type": "string", "description": "The province or state in which the party that shipped an order is located.\n\nExample: `province:\"Nordrhein-Westfalen\"`\n" }, "street": { "type": "string", "description": "The street name of the address of the party that shipped an order.\n\nSee the note in the general method description.\n\nExample: `street:\"John Plagis Avenue\"`\n" }, "streetLines": { "type": "array", "xml": { "name": "streetLines", "attribute": false, "wrapped": true }, "items": { "type": "string", "xml": { "name": "streetLine" } }, "description": "The street address of the party that shipped an order, specified as a series of strings.\n\nSee the note in the general method description.\n\n**Note!** Paazl does not parse the string to perform validation with any values that may be provided for the other parameters of a sender address.\n\nExample: `streetLines:\"6 John Plagis Avenue\", \"Around the corner\"`\n" }, "houseNumber": { "type": "integer", "format": "int32", "description": "The house number of the address of the party that shipped an order.\n\nSee the note in general method description.\n\nExample: `houseNumber:6`\n" }, "houseNumberExtension": { "type": "string", "description": "The house number extension (such as the \"-A\" in \"12-A\") of the address of the party that shipped an order.\n\nExample: `houseNumberExtension:\"-A\"`\n" } }, "title": "ShopOrderAddress", "description": "Contains details of the address of the party that shipped an order.\n\n**Note!** If not provided, the default is the address specified in your web app account under *Settings>Account>My address book>Sender address*.\n" }, "ShopOrderShippingAddress": { "type": "object", "properties": { "city": { "type": "string", "description": "The city of the address to ship an order to.\n\nExample: `city:\"Bonn\"`\n" }, "country": { "type": "string", "description": "The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code for the country of the address to ship an order to.\n\nThe default value is \"NL\".\n\nExample: `country:\"DE\"`\n" }, "postalCode": { "type": "string", "description": "The postal code of the address to ship an order to.\n\nExample: `postalCode:\"53111\"`\n" }, "province": { "type": "string", "description": "The province or state of the address to ship an order to.\n\nExample: `province:\"Nordrhein-Westfalen\"`\n" }, "street": { "type": "string", "description": "The street name of the address to ship an order to.\n\nExample: `street:\"Am Hauptbahnhof\"`\n" }, "streetLines": { "type": "array", "xml": { "name": "streetLines", "attribute": false, "wrapped": true }, "items": { "type": "string", "xml": { "name": "streetLine" } }, "description": "The street address to ship an order to, specified as a series of strings.\n\nSee the note in the general method description.\n\n**Note!** Paazl does not parse the string to perform validation with any values that may be provided for the other parameters of a consignee address.\n\nExample: `streetLines:\"Jacob Bontiusplaats 9\", \"Unit 580\"`\n" }, "houseNumber": { "type": "integer", "format": "int32", "description": "The house number of the address to ship an order to.\n\nSee the note in the general method description.\n\nExample: `houseNumber:9`\n" }, "houseNumberExtension": { "type": "string", "description": "The house number extension (such as the \"-A\" in \"12-A\") of the address to ship an order to.\n\nExample: `houseNumberExtension:\"-A\"`\n" } }, "title": "ShopOrderAddress", "description": "Contains details of the address to ship an order to." }, "ShopOrderPickupLocation": { "type": "object", "required": [ "code" ], "properties": { "accountNumber": { "type": "string", "description": "An individual code that DHL issues to customers so that they can identify themselves at a DHL PackStation. DHL refers to this code as \"Postnummer\" or \"Customer Number\".\n\nExample: `accountNumber:XYZ123`\n" }, "code": { "type": "string", "description": "A carrier's unique code for a pickup location.\n\nExample: `code:\"NOP12345\"`\n\n**Note!** If your customer selected a pickup location, `code` is required.\n" } }, "title": "ShopOrderPickupLocation", "description": "If your customer selected a pickup location at checkout, this object contains information on that location." }, "ShopOrderShipping": { "type": "object", "required": [ "option" ], "properties": { "option": { "type": "string", "description": "A shipping option's Paazl code. You will find a list of the identifiers of the shipping options available to your webshop in your webshop account under *Settings>Account>Overview of shipping options*.\n\nExample: `option:\"AVG\"`\n" }, "pickupLocation": { "$ref": "#/components/schemas/ShopOrderPickupLocation" }, "contract": { "type": "string", "description": "The identification code of your carrier contract for an outbound shipment.\n\n**Note!** If you don't have this code, contact [Paazl Customer Support](mailto:support@paazl.com).\n\nExample: `contract:\"XYZ123\"`\n" }, "returnContract": { "type": "string", "description": "The identification code of your carrier contract for a return shipment.\n\n**Note!** If you don't have this code, contact [Paazl Customer Support](mailto:support@paazl.com).\n\nExample: `returnContract:\"321ZYX\"`\n" }, "packageCount": { "type": "integer", "format": "int32", "description": "The number of packages in a shipment.\n\n**Note!** If `multiPackageShipment` is set to `true`, the default value of `packageCount` will be `2`.\n\nExample: `packageCount:3`\n" }, "multiPackageShipment": { "type": "boolean", "description": "If `true`, Paazl will treat the shipment as consolidated.\n\nThis setting affects how the packages in the shipment are numbered on its labels. The number of packages in a shipment is indicated by `packageCount`. So, for example, if `multiPackageShipment` is `true` and `packageCount` is `3`, then the labels will be numbered 1/3, 2/3, 3/3.\n\n**Note!** If `packageCount` > `1`, then the default value of `multiPackageShipment` will be `true`. If you don't want Paazl to treat a multi-package shipment as consolidated, you have to set `multiPackageShipment` to `false`.\n\nExample: `multiPackageShipment:false`\n" } }, "title": "ShopOrderShipping", "description": "Contains information on the shipping option selected by a customer." }, "SortingModel": { "type": "object", "properties": { "distributor": { "type": "string", "description": "Indicates which carrier's shipping options should appear at the top\nof the shipping options list. \n\nYou will find carrier codes available to you in your web app account under *Settings>Account>Overview of shipping options*.\n\nThe shipping options displayed following those of distributor will be displayed in order of ascending price.\n\n**Note!** if `orderBy` has the value `\"CARRIER\"`, this element is required; if `orderBy` has the value `\"PRICE\"` or `\"DATE\"`, this element will be ignored.\n\nExmaple: `distributor:\"SELEKTVRACHT\"`\n", "enum": [ "SELEKTVRACHT", "TNT", "TNT_EXPRESS", "DPD", "FEDEX", "DYNALOGIC", "KIALA", "DHL_EXPRESS", "DHL_DE", "UPS", "BPOST", "GLS", "TSN", "MONDIALRELAY", "B2C_EUROPE", "B2C_EUROPE_LAB", "DE_BUREN", "CARGOOFFICE", "VAN_SPREUWEL", "PACKS", "COLISSIMO", "BRT", "CORREOS", "TRANSMISSION", "HERMES", "FADELLO", "AUS_POST", "SAGAWA", "ASENDIA", "MENDRIX", "FEDEX_ZA", "RJP", "YUNDA_EXPRESS", "HERMES_UK", "POSTNORD", "BLANK", "GENERIC" ] }, "orderBy": { "type": "string", "description": "Indicates the field by which to sort the shipping options returned.\n\nThe default value is `\"PRICE\"`\n\nExample: `orderBy:\"DATE\"`\n", "enum": [ "PRICE", "DATE", "CARRIER" ] }, "sortOrder": { "type": "string", "description": "Indicates the order in which shipping options should be sorted.\n\nThe default value is `\"ASC\"`\n\n**Note!** If `orderBy` has the value \"CARRIER\", this element will be ignored.\n\nExample: `sortOrder:\"DESC\"`\n", "enum": [ "ASC", "DESC" ] } }, "title": "SortingModel", "xml": { "name": "sortingModel", "attribute": false, "wrapped": false }, "description": "Contains elements that tell Paazl how to sort the shipping options it\nsends back.\n\nExamples:\n\n`sortingModel:{orderBy:\"DATE\", sortOrder:\"DESC\"}`\n\n`sortingModel:{orderBy:\"CARRIER\", distributor:\"DHL Deutschland\"}`\n" }, "TimeRange": { "type": "object", "properties": { "end": { "type": "string", "description": "The end of a particular shipping option's delivery time range as\nsupplied by the carrier concerned, or as configured by [Paazl\nCustomer Support](mailto:support@paazl.com).\n" }, "start": { "type": "string", "description": "The start of a particular shipping option's delivery time range as\nsupplied by the carrier concerned, or as configured by [Paazl\nCustomer Support](mailto:support@paazl.com).\n" } }, "title": "TimeRange", "description": "The time range within which a shipment will be delivered.\n\nThe values returned depend on whether or not the carrier concerned offers a service that supplies time range information. Contact your carrier to find out if they supply this service. If it does and Paazl does not yet support the carrier's service, contact [Paazl Customer Support](mailto:support@paazl.com).\n\n• If the carrier does offer such a service and Paazl supports it, Paazl will return the values it receives from the carrier. If the carrier does not return anything, neither will Paazl.\n\n• If the carrier does **not** offer such a service, Paazl will return the shipping-option specific settings or, failing that, the global settings configured by [Paazl Customer Support](mailto:support@paazl.com).\n" }, "UnitPrice": { "type": "object", "properties": { "value": { "type": "number", "format": "double", "description": "The value of the product.\n\nExample: `value:40.2`\n" }, "currency": { "type": "string", "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency concerned.\n\nThe default code is \"EUR\".\n\nExample: `currency:\"USD\"`\n" } }, "title": "MoneyValue", "description": "The value of the product concerned." } } } }