{ "openapi" : "3.1.0", "info" : { "title" : "nShift Go API", "description" : "API documentation for nShift Go", "contact" : { "name" : "nShift", "url" : "https://nshift.com" }, "version" : "2.3.0" }, "servers" : [ { "url" : "https://api.nshiftgo.com", "description" : "nShift Go API — production environment.", "x-internal" : false } ], "security" : [ { "CompanyToken" : [ ] }, { "AccountToken" : [ ] }, { "ClientCredentials" : [ ] } ], "tags" : [ { "name" : "Companies", "description" : "Operations related to companies" }, { "name" : "Affiliates", "description" : "Operations related to affiliates" }, { "name" : "Accounts", "description" : "Represents an isolated data environment for managing shipments, configurations, and reports. Each account has unique credentials and is used to segment operations for different merchants, warehouses, or business units." }, { "name" : "Parcels", "description" : "Represents a physical shipment container included as part of a shipment booking. Parcels include packing, weight, volume, and item-level details required for transport and tracking. Each shipment booking must contain at least one parcel." }, { "name" : "Parcel Items", "description" : "Represents the individual products contained within a Parcel. Parcel Items include details such as description, quantity, weight, dimensions, and product identifiers. Use Parcel Items to specify the contents of a Parcel for transport, tracking, and customs purposes." }, { "name" : "Addresses", "description" : "Represents a standardized address structure used across the platform. Addresses are role-neutral and can be created, stored, and reused in orders, shipment bookings, and other processes. Roles such as sender or receiver are assigned when an address is used, defining its function in the shipment flow. The address model supports both fine-grained location input and preformatted address lines, as long as key properties like street name, postal code, city, and country code are included." }, { "name" : "PUDO Points", "description" : "Represents a pickup or drop-off location provided by a carrier. PUDO Points are used as alternatives to delivery addresses, allowing shipments to be collected from or delivered to designated locations. They can be queried and selected during shipment booking based on criteria such as sender country, service, destination country, postal code, and address line." }, { "name" : "Dangerous Goods Declaration Types", "description" : "Represents a type of dangerous goods declaration supported by carriers. Dangerous Goods Declaration Types define the codes, validation rules, and specific requirements for handling and declaring dangerous goods. These types are used to ensure compliance with carrier and regulatory standards for the transport of dangerous goods, and can be fetched for integration to reflect carrier connectivity changes." }, { "name" : "Serial Types", "description" : "Represents a type of serial identifier, such as a tracking number or label format, used for booking, labeling, or tracking shipments. Serial types define the formats that are valid for each carrier or service." }, { "name" : "Customs Declaration Types", "description" : "Represents a type of customs declaration, such as CN22 or CN23, used to declare goods for cross-border shipments. Customs Declaration Types specify the information required by carriers or customs authorities and determine which documents are generated for each shipment. They are selected during shipment booking based on route, value, and carrier requirements." }, { "name" : "Carriers", "description" : "Represents a carrier supported for shipment booking. Each carrier has a unique identifier and properties required for booking and configuring shipments, including validation rules." }, { "name" : "Carrier Logos", "description" : "Endpoints for retrieving carrier logo images" }, { "name" : "Document Types", "description" : "Represents the types of documents that carriers support, including associated media types, content types, and layouts." }, { "name" : "Services", "description" : "Represents a specific service offered by a carrier for shipment booking. Each service includes codes, available options, and restrictions required for booking and configuring shipments, including validation rules." }, { "name" : "Packing Types", "description" : "Represents how items are packaged for transport in shipping and logistics operations. Packing types specify packaging methods to ensure proper handling and compliance with shipping regulations." }, { "name" : "Service Definitions", "description" : "Represents the association of a carrier service with an account, including the configuration and options required to enable and use that service for shipments. Service definitions must be configured before creating shipment bookings." }, { "name" : "Carrier Definitions", "description" : "Represents the association of a carrier with an account, including the credentials and settings required to book shipments through that carrier. Carrier definitions must be configured before creating shipment bookings." }, { "name" : "Shipment Dispatches", "description" : "Represents a collection of shipment bookings grouped together for carrier pickup or delivery. Shipment dispatches make it easier to track, manage, and calculate details such as total weight and volume for multiple shipments. They also provide a way to generate shipment manifests, which some carriers require as receipts during collection." }, { "name" : "Trackers", "description" : "Represents tracking information for shipment bookings. Trackers store harmonized status, shipment details, and parcel information for monitoring delivery progress." }, { "name" : "Shipment Channels", "description" : "Represents a reusable configuration for shipment bookings. Shipment Channels store settings for document and label formats, customs declarations, and unit preferences, centralizing key booking parameters for repeated use." }, { "name" : "Shipment Bookings", "description" : "Represents the process of booking and confirming a shipment with a carrier. A shipment booking brings together all required details, including addresses, PUDO point, parcels, parcel items, carrier definition, service definition, customs declaration, and shipment channel, to initiate delivery. Creating a shipment booking generates tracking numbers, shipping documents, and submits the shipment data to the carrier." }, { "name" : "Shipment Manifests", "description" : "Represents documentation for shipments within a dispatch. A shipment manifest includes shipment and carrier details and returns documents for handoff and verification during carrier collection or pickup." }, { "name" : "Shipment Dispatch Trackers", "description" : "Represents tracking information for shipment dispatches. Shipment Dispatch Trackers store status, manifest, shipment, and parcel information for monitoring dispatch progress." }, { "name" : "Mock Events", "description" : "Generate mock events for testing purposes" }, { "name" : "Event Channels", "description" : "Represents a configuration for capturing and delivering system events to the integrating system. An event channel specifies which event topics to subscribe to and forwards matching events to a configured webhook using a standardized minimal format." }, { "name" : "Shipping Quotes", "description" : "Represents a temporary shipping option and pricing generated by evaluating Delivery Options. Shipping Quotes are used to present available shipping methods to users or end-consumers during checkout and are valid for 24 hours." }, { "name" : "Zones", "description" : "Represents a zone used to define geographical or logical areas for shipping purposes. Each zone is defined using a set of conditions evaluated against shipment details, and is used to determine shipping rates and delivery options based on the destination. Zones help determine the validity of connected Delivery Options, making it possible to create dynamic markets without directly maintaining individual Delivery Options." }, { "name" : "Delivery Options", "description" : "Represents a set of shipping alternatives available to customers during checkout. Each Delivery Option is associated with carrier and service configurations, shipping zones, rates, and rules. When evaluated, Delivery Options generate shipping quotes that include available shipping methods and prices. Shipping quotes are valid for 24 hours and can be used to display options to consumers and create shipment bookings." }, { "name" : "Documents", "description" : "Represents a document generated or attached as part of a shipment booking, customs declaration, or shipment manifest. Documents include items such as labels, invoices, waybills, and customs forms, and may be generated automatically or uploaded for carriers that support paperless handling." }, { "name" : "Documentation", "description" : "Operations related to documentation management" }, { "name" : "Reports", "description" : "Represents aggregated usage data for all accounts associated with a company. Usage is measured in tokens and doesn’t include pricing information. During each billing cycle, the number of tokens used for each event type is accumulated and later converted to costs based on event pricing when the invoice is generated." }, { "name" : "Customs Declarations", "description" : "Customs Declarations operations" }, { "name" : "Dangerous Goods Declarations", "description" : "Dangerous Goods Declarations operations" } ], "paths" : { "/v1/affiliates/{affiliate-id}" : { "put" : { "tags" : [ "Affiliates" ], "summary" : "Replace Affiliate checkout and billing configuration", "description" : "Fully replaces the Affiliate's Stripe Checkout redirect URLs and billing grace period. An AFFILIATE caller may only update its own affiliateId; ADMIN may update any. This is a full replacement, not a partial update: any field omitted from the request is cleared and falls back to the nShift default.", "operationId" : "replaceAffiliate", "parameters" : [ { "name" : "affiliate-id", "in" : "path", "description" : "Affiliate id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReplaceAffiliateConfigRequest" }, "example" : { "billingGracePeriodDays" : 14, "checkoutUrlFailure" : "https://example-affiliate.com/checkout/failure", "checkoutUrlSuccess" : "https://example-affiliate.com/checkout/success" } } }, "required" : true }, "responses" : { "403" : { "description" : "Forbidden", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "ClientCredentials" : [ ] }, { "AffiliateToken" : [ ] }, { "AdminToken" : [ ] } ] } }, "/v1/accounts/{account-id}" : { "get" : { "tags" : [ "Accounts" ], "summary" : "Fetch Account", "description" : "Fetches a specific Account. Provide `account-id`. \nReturns the Account.\n", "operationId" : "fetchAccount", "parameters" : [ { "name" : "account-id", "in" : "path", "description" : "Account id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AccountResponse" }, "example" : { "id" : "019a8bc4-f94b-725f-90ee-ffc91f7acea6", "createdAt" : "2024-01-15T10:30:00Z", "updatedAt" : "2024-01-15T10:30:00Z", "alias" : "amber-falcon-river", "company" : { "name" : "nShift AB", "address" : "Kungsgatan 1", "city" : "Stockholm", "countryCode" : "SE", "postalCode" : "11143", "vatNumber" : "SE556546371701" }, "contact" : { "name" : "Doe", "email" : "jdoe@nshift.com", "phone" : "+46721234567" }, "enabled" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "sources" : [ "example" ], "type" : "NORMAL" } } } } }, "security" : [ { "CompanyToken" : [ ] } ] }, "put" : { "tags" : [ "Accounts" ], "summary" : "Update Account", "description" : "Updates an existing Account. Provide `account-id`, `company.name`, `company.vatNumber`, `company.countryCode`, `company.city`, `company.postalCode`, `company.address`, `contact.name`, `contact.email`, and `contact.phone`, along with updated values. Returns confirmation (`204 No Content`).", "operationId" : "replaceAccount", "parameters" : [ { "name" : "account-id", "in" : "path", "description" : "Account id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AccountRequest" }, "example" : { "alias" : "amber-falcon-river", "company" : { "name" : "nShift AB", "address" : "Kungsgatan 1", "city" : "Stockholm", "countryCode" : "SE", "postalCode" : "11143", "vatNumber" : "SE556546371701" }, "contact" : { "name" : "Doe", "email" : "jdoe@nshift.com", "phone" : "+46721234567" }, "enabled" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "persistence" : { "type" : "example" }, "sources" : [ "example" ], "type" : "SHARED" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "CompanyToken" : [ ] } ] } }, "/v1/companies/{company-id}/tokens" : { "post" : { "tags" : [ "Companies" ], "summary" : "Authorize Company", "description" : "Issues an Access Token for the specified Company. Provide `company-id` issued during signup and `grantType`. Returns an Access Token valid for 4 hours. **Note:** The token must be renewed by calling this endpoint again after expiration.\n", "operationId" : "authorizeCompany", "parameters" : [ { "name" : "company-id", "in" : "path", "description" : "Company id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationRequest" }, "example" : { "grantType" : "client_credentials" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationResponse" }, "example" : { "accessToken" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "expiresAt" : 1705315800000, "tokenType" : "Bearer" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } } }, "security" : [ { "ClientCredentials" : [ ] } ] } }, "/v1/affiliates/tokens" : { "post" : { "tags" : [ "Affiliates" ], "summary" : "Authorize Affiliate", "description" : "Issues an Access Token for the authenticated Affiliate. Provide `grantType`. \nReturns an Access Token valid for 15 minutes. **Note:** The token must be renewed by calling this endpoint again after expiration.", "operationId" : "generateToken", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationRequest" }, "example" : { "grantType" : "client_credentials" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationResponse" }, "example" : { "accessToken" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "expiresAt" : 1705315800000, "tokenType" : "Bearer" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } } }, "security" : [ { "ClientCredentials" : [ ] } ] } }, "/v1/accounts" : { "get" : { "tags" : [ "Accounts" ], "summary" : "List Accounts", "description" : "Lists Accounts. Returns a paginated list of Accounts.\n", "operationId" : "listAccounts", "parameters" : [ { "name" : "enabled", "in" : "query", "description" : "Enabled.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean", "example" : true }, "example" : true }, { "name" : "type", "in" : "query", "description" : "Returns only Accounts of this type, `NORMAL` or `SHARED`. Not case-sensitive.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "description" : "Account type. A `NORMAL` account is a regular account. A `SHARED` account holds data, such as addresses and PUDO points, that other accounts in the same Company can read.", "enum" : [ "NORMAL", "SHARED" ], "example" : "NORMAL" }, "example" : "NORMAL" }, { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AccountListResponse" }, "example" : { "items" : [ { "id" : "019a8bc4-f94b-725f-90ee-ffc91f7acea6", "createdAt" : "2024-01-15T10:30:00Z", "updatedAt" : "2024-01-15T10:30:00Z", "alias" : "amber-falcon-river", "company" : { "name" : "nShift AB", "address" : "Kungsgatan 1", "city" : "Stockholm", "countryCode" : "SE", "postalCode" : "11143", "vatNumber" : "SE556546371701" }, "contact" : { "name" : "Doe", "email" : "jdoe@nshift.com", "phone" : "+46721234567" }, "enabled" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "sources" : [ "example" ], "type" : "NORMAL" } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "CompanyToken" : [ ] } ] }, "post" : { "tags" : [ "Accounts" ], "summary" : "Create Account", "description" : "Creates a new Account. Provide `company.name`, `company.vatNumber`, `company.countryCode`, `company.city`, `company.postalCode`, `company.address`, `contact.name`, `contact.email`, and `contact.phone`. \nReturns the `account-id`. **Note:** Clients must create at least one Account before creating other resources via the API. The `account-id` is confidential and is required for issuing Access Tokens.\n", "operationId" : "createAccount", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AccountRequest" }, "example" : { "alias" : "amber-falcon-river", "company" : { "name" : "nShift AB", "address" : "Kungsgatan 1", "city" : "Stockholm", "countryCode" : "SE", "postalCode" : "11143", "vatNumber" : "SE556546371701" }, "contact" : { "name" : "Doe", "email" : "jdoe@nshift.com", "phone" : "+46721234567" }, "enabled" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "persistence" : { "type" : "example" }, "sources" : [ "example" ], "type" : "SHARED" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AccountCreateResponse" }, "example" : { "id" : "01991a03-c860-7000-bb91-5a9cb479f522", "alias" : "amber-falcon-river" } } } } }, "security" : [ { "CompanyToken" : [ ] } ] } }, "/v1/accounts/{account-id}/tokens" : { "post" : { "tags" : [ "Accounts" ], "summary" : "Authorize Account", "description" : "Issues an Access Token for the specified Account. Provide `account-id` and `grantType`. \nReturns an Access Token valid for 4 hours. **Note:** The token must be renewed by calling this endpoint again after expiration.", "operationId" : "authorizeAccount", "parameters" : [ { "name" : "account-id", "in" : "path", "description" : "Account id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationRequest" }, "example" : { "grantType" : "client_credentials" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthorizationResponse" }, "example" : { "accessToken" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "expiresAt" : 1705315800000, "tokenType" : "Bearer" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } } }, "security" : [ { "ClientCredentials" : [ ] } ] } }, "/v1/parcels/{parcel-id}" : { "get" : { "tags" : [ "Parcels" ], "summary" : "Fetch Parcel", "description" : "Fetches a specific Parcel. Provide `parcel-id`. Returns the Parcel.", "operationId" : "fetchParcel", "parameters" : [ { "name" : "parcel-id", "in" : "path", "description" : "Parcel id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ParcelResponse" }, "example" : { "id" : "019beadd-818c-792d-9bd4-ea04b0dbe23e", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "#45678", "serial" : "473325380000006010", "dangerousGoods" : [ { "netQuantity" : 10.5, "netQuantityUnit" : "KG", "quantity" : 5, "type" : "UN1950" } ], "description" : "This is a parcel description", "items" : [ { "id" : "019ab5ae-7cbb-7665-94a8-86edb63c6191", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "ITEM-REF-001", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ { "type" : "GTIN", "value" : "4006381333931" } ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "dimensionsUnit" : "M", "height" : 10.0, "length" : 10.0, "markings" : [ "THIS_SIDE_UP" ], "pallet" : { "group" : "GROUP-A", "type" : "EPAL-1" }, "type" : "PACKAGE", "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "G", "width" : 10.0 }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "weight" : 10.0, "weightUnit" : "G" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "put" : { "tags" : [ "Parcels" ], "summary" : "Update Parcel", "description" : "Updates an existing Parcel. Provide `parcel-id` and updated values. Returns confirmation (`204 No Content`).", "operationId" : "replaceParcel", "parameters" : [ { "name" : "parcel-id", "in" : "path", "description" : "Parcel id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ParcelRequest" }, "example" : { "reference" : "#45678", "serial" : "473325380000006010", "dangerousGoods" : [ { "netQuantity" : 10.5, "netQuantityUnit" : "KG", "quantity" : 5, "type" : "UN1950" } ], "description" : "This is a parcel description", "itemIds" : [ "019beadd-818c-792d-9bd4-ea04b0dbe23e", "019beadc-8d6e-7031-8636-06c636e72d4f" ], "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "dimensionsUnit" : "M", "height" : 10.0, "length" : 10.0, "markings" : [ "THIS_SIDE_UP" ], "pallet" : { "group" : "GROUP-A", "type" : "EPAL-1" }, "type" : "PACKAGE", "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "G", "width" : 10.0 }, "persistence" : { "type" : "example" }, "weight" : 10.0, "weightUnit" : "G" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "delete" : { "tags" : [ "Parcels" ], "summary" : "Delete Parcel", "description" : "Deletes an existing Parcel. Provide `parcel-id`. Returns confirmation (`204 No Content`).", "operationId" : "removeParcel", "parameters" : [ { "name" : "parcel-id", "in" : "path", "description" : "Parcel id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/parcels/items/{item-id}" : { "get" : { "tags" : [ "Parcel Items" ], "summary" : "Fetch Parcel Item", "description" : "Fetches a specific Parcel Item. Provide `item-id`. Returns the Parcel Item.", "operationId" : "fetchParcelItem", "parameters" : [ { "name" : "item-id", "in" : "path", "description" : "Item id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ParcelItemResponse" }, "example" : { "id" : "019ab5ae-7cbb-7665-94a8-86edb63c6191", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "ITEM-REF-001", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ { "type" : "GTIN", "value" : "4006381333931" } ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "put" : { "tags" : [ "Parcel Items" ], "summary" : "Update Parcel Item", "description" : "Updates an existing Parcel Item. Provide `item-id` and updated values. Returns confirmation (`204 No Content`).\n", "operationId" : "replaceParcelItem", "parameters" : [ { "name" : "item-id", "in" : "path", "description" : "Item id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ParcelItemRequest" }, "example" : { "reference" : "ITEM-REF-12345", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ { "type" : "GTIN", "value" : "4006381333931" } ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "delete" : { "tags" : [ "Parcel Items" ], "summary" : "Delete Parcel Item", "description" : "Deletes an existing Parcel Item. Provide `item-id`. Returns confirmation (`204 No Content`).", "operationId" : "removeParcelItem", "parameters" : [ { "name" : "item-id", "in" : "path", "description" : "Item id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/parcels" : { "get" : { "tags" : [ "Parcels" ], "summary" : "List Parcels", "description" : "Lists Parcels. Returns a paginated list of Parcels.", "operationId" : "listParcels", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ParcelListResponse" }, "example" : { "items" : [ { "id" : "019beadd-818c-792d-9bd4-ea04b0dbe23e", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "#45678", "serial" : "473325380000006010", "dangerousGoods" : [ { "netQuantity" : 10.5, "netQuantityUnit" : "KG", "quantity" : 5, "type" : "UN1950" } ], "description" : "This is a parcel description", "items" : [ { "id" : "019ab5ae-7cbb-7665-94a8-86edb63c6191", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "ITEM-REF-001", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ { "type" : "GTIN", "value" : "4006381333931" } ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "dimensionsUnit" : "M", "height" : 10.0, "length" : 10.0, "markings" : [ "THIS_SIDE_UP" ], "pallet" : { "group" : "GROUP-A", "type" : "EPAL-1" }, "type" : "PACKAGE", "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "G", "width" : 10.0 }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "weight" : 10.0, "weightUnit" : "G" } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "post" : { "tags" : [ "Parcels" ], "summary" : "Create Parcel", "description" : "Creates a new Parcel. Provide weight at parcel level, packing level, or ensure items have weights.\nReturns the `parcel-id`.\n", "operationId" : "createParcel", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ParcelRequest" }, "example" : { "reference" : "#45678", "serial" : "473325380000006010", "dangerousGoods" : [ { "netQuantity" : 10.5, "netQuantityUnit" : "KG", "quantity" : 5, "type" : "UN1950" } ], "description" : "This is a parcel description", "itemIds" : [ "019beadd-818c-792d-9bd4-ea04b0dbe23e", "019beadc-8d6e-7031-8636-06c636e72d4f" ], "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "dimensionsUnit" : "M", "height" : 10.0, "length" : 10.0, "markings" : [ "THIS_SIDE_UP" ], "pallet" : { "group" : "GROUP-A", "type" : "EPAL-1" }, "type" : "PACKAGE", "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "G", "width" : 10.0 }, "persistence" : { "type" : "example" }, "weight" : 10.0, "weightUnit" : "G" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BasicResponse" }, "example" : { "id" : "01991a03-c860-7000-bb91-5a9cb479f522" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/parcels/items" : { "get" : { "tags" : [ "Parcel Items" ], "summary" : "List Parcel Items", "description" : "Lists Parcel Items. Returns a paginated list of Parcel Items.\n", "operationId" : "listParcelItems", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ParcelItemListResponse" }, "example" : { "items" : [ { "id" : "019ab5ae-7cbb-7665-94a8-86edb63c6191", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "ITEM-REF-001", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ { "type" : "GTIN", "value" : "4006381333931" } ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "post" : { "tags" : [ "Parcel Items" ], "summary" : "Create Parcel Item", "description" : "Creates a new Parcel Item. Provide `quantity` and `product.sku`. Returns the `parcel-item-id`.\n\n\n", "operationId" : "createParcelItem", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ParcelItemRequest" }, "example" : { "reference" : "ITEM-REF-12345", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ { "type" : "GTIN", "value" : "4006381333931" } ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BasicResponse" }, "example" : { "id" : "01991a03-c860-7000-bb91-5a9cb479f522" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/addresses/{address-id}" : { "get" : { "tags" : [ "Addresses" ], "summary" : "Fetch Address", "description" : "Fetches a specific Address. Provide `address-id`. Returns the Address.", "operationId" : "fetchAddress", "parameters" : [ { "name" : "address-id", "in" : "path", "description" : "Address id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "source", "in" : "query", "description" : "Alias of a `SHARED` account the caller has access to. Reads from that account instead of the caller's own. An unknown, malformed or inaccessible alias gives 404.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "amber-falcon-river", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "example" : "amber-falcon-river" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AddressResponse" }, "example" : { "id" : "019b2766-8eb4-795c-899f-9ac8d5cc6a34", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "company" : { "name" : "nShift", "identification" : [ { "type" : "VAT", "value" : "SE556546371701" } ] }, "contact" : { "careOf" : "Jane Smith", "doorCode" : "11", "email" : "jdoe@nshift.com", "fax" : "+46721234567", "firstName" : "John", "lastName" : "Doe", "mobile" : "+46721234567", "phone" : "+46721234567" }, "group" : "warehouse_1", "lines" : [ "John Doe c/o Mr Smith, nShift", "Schiller street 45, Neighborhood x", "Century Plaza 13, Floor 3, Apt 32", "District 4, DC, US-NY, US, 111111" ], "location" : { "buildingName" : "Skyline Towers", "buildingNumber" : "13", "city" : "Washington DC", "countryCode" : "US", "floor" : "2", "geoCoding" : { "latitude" : "38.8977", "longitude" : "-77.0365" }, "locality" : "Brooklyn", "postalCode" : "111111", "region" : "District of Columbia", "stateCode" : "US_WA", "streetName" : "Main Street", "streetNumber" : "5", "unit" : "4B" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "references" : { "external" : "987654-321", "internal" : "1234567-7890-12" }, "source" : "amber-falcon-river", "type" : "RESIDENTIAL" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "put" : { "tags" : [ "Addresses" ], "summary" : "Update Address", "description" : "Updates an existing Address. Provide `address-id` and updated values. Returns confirmation (`204 No Content`). **Note:** Changes may not affect previously processed entities such as Shipment Bookings.", "operationId" : "replaceAddress", "parameters" : [ { "name" : "address-id", "in" : "path", "description" : "Address id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "validations", "in" : "query", "description" : "Comma-separated address validation toggles. Format: KEY or KEY:true/false. Supported: POSTALCODE, PHONENUMBER. Defaults: PHONENUMBER enabled, POSTALCODE disabled. Example: POSTALCODE:true,PHONENUMBER:false", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "example", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "example" : "example" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AddressRequest" }, "example" : { "company" : { "name" : "nShift", "identification" : [ { "type" : "VAT", "value" : "SE556546371701" } ] }, "contact" : { "careOf" : "Jane Smith", "doorCode" : "11", "email" : "jdoe@nshift.com", "fax" : "+46721234567", "firstName" : "John", "lastName" : "Doe", "mobile" : "+46721234567", "phone" : "+46721234567" }, "group" : "warehouse_A", "lines" : [ "John Doe c/o Mr Smith, nShift", "Schiller street 45, Neighborhood x", "Century Plaza 13, Floor 3, Apt 32", "District 4, DC, US-NY, US, 111111" ], "location" : { "buildingName" : "Skyline Towers", "buildingNumber" : "13", "city" : "Washington DC", "countryCode" : "US", "floor" : "2", "geoCoding" : { "latitude" : "38.8977", "longitude" : "-77.0365" }, "locality" : "Brooklyn", "postalCode" : "111111", "region" : "District of Columbia", "stateCode" : "US_WA", "streetName" : "Main Street", "streetNumber" : "5", "unit" : "4B" }, "persistence" : { "type" : "example" }, "references" : { "external" : "987654-321", "internal" : "1234567-7890-12" }, "type" : "RESIDENTIAL" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "delete" : { "tags" : [ "Addresses" ], "summary" : "Delete Address", "description" : "Deletes an existing Address. Provide address-id. Returns confirmation (`204 No Content`). **Note:** Changes may not affect previously processed entities such as Shipment Bookings.", "operationId" : "removeAddress", "parameters" : [ { "name" : "address-id", "in" : "path", "description" : "Address id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/pudo-points/queries" : { "post" : { "tags" : [ "PUDO Points" ], "summary" : "Query PUDO Points", "description" : "Queries PUDO Points. Provide `serviceId`, `countryCode`, `senderCountryCode`, and `postalCode`. Returns a list of PUDO Points.", "operationId" : "queryPudoPoints", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QueryPudoPointRequest" }, "example" : { "addressLine" : "Åvägen", "cached" : false, "city" : "Askim", "countryCode" : "DE", "maxDistance" : 20, "maxResults" : 10, "operationTypes" : [ "shop", "locker" ], "postalCode" : "41251", "senderCountryCode" : "DE", "serviceId" : "087a5c15-44af-3912-ab4b-8b11be3367c2" } } }, "required" : true }, "responses" : { "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "501" : { "description" : "Not Implemented: the query has `cached` set to true, and cached PUDO Point queries are not available yet", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PudoPointListResponse" }, "example" : { "items" : [ { "id" : "019c17d0-7831-79bb-8cec-1a164bf2627a", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "carrierId" : "00000000-0000-7000-8000-000000000000", "company" : { "name" : "nShift", "identification" : [ { "type" : "VAT", "value" : "SE556546371701" } ] }, "contact" : { "careOf" : "Jane Smith", "doorCode" : "11", "email" : "jdoe@nshift.com", "fax" : "+46721234567", "firstName" : "John", "lastName" : "Doe", "mobile" : "+46721234567", "phone" : "+46721234567" }, "lines" : [ "John Doe c/o Mr Smith, nShift", "Schiller street 45, Neighborhood x", "Century Plaza 13, Floor 3, Apt 32", "District 4, DC, US-NY, US, 111111" ], "location" : { "buildingName" : "Skyline Towers", "buildingNumber" : "13", "city" : "Washington DC", "countryCode" : "US", "floor" : "2", "geoCoding" : { "latitude" : "38.8977", "longitude" : "-77.0365" }, "locality" : "Brooklyn", "postalCode" : "111111", "region" : "District of Columbia", "stateCode" : "US_WA", "streetName" : "Main Street", "streetNumber" : "5", "unit" : "4B" }, "operations" : { "openingHours" : { "weeklyOpening" : [ { "closeTime" : "19:00", "day" : "Monday", "openTime" : "10:00" } ] }, "type" : "SERVICE_POINT" }, "references" : { "external" : "987654-321", "internal" : "1234567-7890-12" }, "source" : "amber-falcon-river" } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/addresses" : { "get" : { "tags" : [ "Addresses" ], "summary" : "List Addresses", "description" : "Lists Addresses. Returns a paginated list of Addresses.", "operationId" : "listAddresses", "parameters" : [ { "name" : "source", "in" : "query", "description" : "Alias of a `SHARED` account the caller has access to. Lists that account's Addresses instead of the caller's own. An inaccessible alias gives 404. The cursor isn't bound to `source`, so send the same `source` on every page.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "amber-falcon-river", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "example" : "amber-falcon-river" }, { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "group", "in" : "query", "description" : "The group filtering criteria", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "UPS_saver", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "example" : "UPS_saver" }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "ASC" }, "example" : "ASC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AddressListResponse" }, "example" : { "items" : [ { "id" : "019b2766-8eb4-795c-899f-9ac8d5cc6a34", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "company" : { "name" : "nShift", "identification" : [ { "type" : "VAT", "value" : "SE556546371701" } ] }, "contact" : { "careOf" : "Jane Smith", "doorCode" : "11", "email" : "jdoe@nshift.com", "fax" : "+46721234567", "firstName" : "John", "lastName" : "Doe", "mobile" : "+46721234567", "phone" : "+46721234567" }, "group" : "warehouse_1", "lines" : [ "John Doe c/o Mr Smith, nShift", "Schiller street 45, Neighborhood x", "Century Plaza 13, Floor 3, Apt 32", "District 4, DC, US-NY, US, 111111" ], "location" : { "buildingName" : "Skyline Towers", "buildingNumber" : "13", "city" : "Washington DC", "countryCode" : "US", "floor" : "2", "geoCoding" : { "latitude" : "38.8977", "longitude" : "-77.0365" }, "locality" : "Brooklyn", "postalCode" : "111111", "region" : "District of Columbia", "stateCode" : "US_WA", "streetName" : "Main Street", "streetNumber" : "5", "unit" : "4B" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "references" : { "external" : "987654-321", "internal" : "1234567-7890-12" }, "source" : "amber-falcon-river", "type" : "RESIDENTIAL" } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "post" : { "tags" : [ "Addresses" ], "summary" : "Create Address", "description" : "Creates a new Address. Provide `location.streetName`, `location.postalCode`,` location.city`, and `location.countryCode`. Returns the `address-id`.", "operationId" : "createAddress", "parameters" : [ { "name" : "validations", "in" : "query", "description" : "Comma-separated address validation toggles. Format: KEY or KEY:true/false. Supported: POSTALCODE, PHONENUMBER. Defaults: PHONENUMBER enabled, POSTALCODE disabled. Example: POSTALCODE:true,PHONENUMBER:false", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "example", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "example" : "example" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AddressRequest" }, "example" : { "company" : { "name" : "nShift", "identification" : [ { "type" : "VAT", "value" : "SE556546371701" } ] }, "contact" : { "careOf" : "Jane Smith", "doorCode" : "11", "email" : "jdoe@nshift.com", "fax" : "+46721234567", "firstName" : "John", "lastName" : "Doe", "mobile" : "+46721234567", "phone" : "+46721234567" }, "group" : "warehouse_A", "lines" : [ "John Doe c/o Mr Smith, nShift", "Schiller street 45, Neighborhood x", "Century Plaza 13, Floor 3, Apt 32", "District 4, DC, US-NY, US, 111111" ], "location" : { "buildingName" : "Skyline Towers", "buildingNumber" : "13", "city" : "Washington DC", "countryCode" : "US", "floor" : "2", "geoCoding" : { "latitude" : "38.8977", "longitude" : "-77.0365" }, "locality" : "Brooklyn", "postalCode" : "111111", "region" : "District of Columbia", "stateCode" : "US_WA", "streetName" : "Main Street", "streetNumber" : "5", "unit" : "4B" }, "persistence" : { "type" : "example" }, "references" : { "external" : "987654-321", "internal" : "1234567-7890-12" }, "type" : "RESIDENTIAL" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BasicResponse" }, "example" : { "id" : "01991a03-c860-7000-bb91-5a9cb479f522" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/pudo-points/{pudo-point-id}" : { "get" : { "tags" : [ "PUDO Points" ], "summary" : "Fetch PUDO Point", "description" : "Fetches a specific PUDO Point. Provide `pudo-point-id`. Returns the PUDO Point.", "operationId" : "fetchPudoPoint", "parameters" : [ { "name" : "pudo-point-id", "in" : "path", "description" : "Pudo point id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "source", "in" : "query", "description" : "Alias of a `SHARED` account the caller has access to. Reads from that account instead of the caller's own. An unknown, malformed or inaccessible alias gives 404.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "amber-falcon-river", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "example" : "amber-falcon-river" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PudoPointResponse" }, "example" : { "id" : "019c17d0-7831-79bb-8cec-1a164bf2627a", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "carrierId" : "00000000-0000-7000-8000-000000000000", "company" : { "name" : "nShift", "identification" : [ { "type" : "VAT", "value" : "SE556546371701" } ] }, "contact" : { "careOf" : "Jane Smith", "doorCode" : "11", "email" : "jdoe@nshift.com", "fax" : "+46721234567", "firstName" : "John", "lastName" : "Doe", "mobile" : "+46721234567", "phone" : "+46721234567" }, "lines" : [ "John Doe c/o Mr Smith, nShift", "Schiller street 45, Neighborhood x", "Century Plaza 13, Floor 3, Apt 32", "District 4, DC, US-NY, US, 111111" ], "location" : { "buildingName" : "Skyline Towers", "buildingNumber" : "13", "city" : "Washington DC", "countryCode" : "US", "floor" : "2", "geoCoding" : { "latitude" : "38.8977", "longitude" : "-77.0365" }, "locality" : "Brooklyn", "postalCode" : "111111", "region" : "District of Columbia", "stateCode" : "US_WA", "streetName" : "Main Street", "streetNumber" : "5", "unit" : "4B" }, "operations" : { "openingHours" : { "weeklyOpening" : [ { "closeTime" : "19:00", "day" : "Monday", "openTime" : "10:00" } ] }, "type" : "SERVICE_POINT" }, "references" : { "external" : "987654-321", "internal" : "1234567-7890-12" }, "source" : "amber-falcon-river" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/packing-types/{packing-type-id}" : { "get" : { "tags" : [ "Packing Types" ], "summary" : "Fetch Packing Type", "description" : "Fetches a specific Packing Type. Provide `packing-type-id`. \nReturns the Packing Type.\n", "operationId" : "fetchPackingType", "parameters" : [ { "name" : "packing-type-id", "in" : "path", "description" : "Packing type id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PackingTypeResponse" }, "example" : { "id" : "cfe26e72-bf79-3960-b38f-f3708982635a", "codeTypes" : [ { "code" : "PC", "type" : "GSPackageCode" } ], "description" : "Package", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "type" : "PACKAGE" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] }, { "AdminToken" : [ ] } ] } }, "/v1/document-types/{document-type-id}" : { "get" : { "tags" : [ "Document Types" ], "summary" : "Fetch Document Type", "description" : "Fetches a specific Document Type. Provide `document-type-id`. \nReturns the Document Type.\n", "operationId" : "fetchDocumentType", "parameters" : [ { "name" : "document-type-id", "in" : "path", "description" : "Document type id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DocumentTypeResponse" }, "example" : { "id" : "123e4567-e89b-12d3-a456-426614174000", "createdAt" : "2025-01-16T12:07:09Z", "updatedAt" : "2025-01-16T12:07:09Z", "carrierId" : "123e4567-e89b-12d3-a456-426614174000", "contentTypes" : [ { "description" : "Portable Document Format", "type" : "pdf" } ], "description" : "Shipping label for parcels", "layouts" : [ "example" ], "mediaTypes" : [ { "description" : "Normal A4 paper", "type" : "laser-a4" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "serviceId" : "123e4567-e89b-12d3-a456-426614174001", "type" : "LABEL" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] }, { "AdminToken" : [ ] } ] } }, "/v1/dangerous-goods-declaration-types/{dangerous-goods-declaration-type-id}" : { "get" : { "tags" : [ "Dangerous Goods Declaration Types" ], "summary" : "Fetch Dangerous Goods Declaration Type", "description" : "Fetches a specific Dangerous Goods Declaration Type. Provide `dangerous-goods-declaration-type-id`. Returns the Dangerous Goods Declaration Type.", "operationId" : "fetchDangerousGoodsDeclarationType", "parameters" : [ { "name" : "dangerous-goods-declaration-type-id", "in" : "path", "description" : "Dangerous goods declaration type id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DangerousGoodsDeclarationTypeResponse" }, "example" : { "id" : "328af029-7629-3355-a6df-029593db9d82", "access" : false, "carrierId" : "123e4567-e89b-12d3-a456-426614174000", "code" : "ADR", "description" : "European Agreement concerning the International Carriage of Dangerous Goods by Road", "documentTypes" : [ { "contentTypes" : [ { "description" : "Portable Document Format", "type" : "pdf" } ], "description" : "Bring VOEC", "mediaTypes" : [ { "description" : "Normal A4 paper", "type" : "laser-a4" } ], "type" : "CUSTOMS_DOCUMENT" } ], "goods" : { "explicitTypes" : true, "itemLimit" : false, "maxItems" : 50, "maxParcels" : 10, "netQuantityMandatory" : true, "netQuantityUnits" : [ "example" ], "packingGroup" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false } }, "parcelLimit" : false, "types" : [ { "code" : "UN1950", "hazard" : { "code" : "F1", "environmental" : false, "flashPoint" : -20, "hazardClass" : "3" }, "notes" : [ "Handle with care" ], "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "group" : "II", "type" : "BOTTLE" }, "shippingName" : "Aerosols, flammable", "technicalName" : "Propane, Butane mixture", "transportation" : { "emergencyCode" : "2YE", "separation" : 3, "tunnelRestriction" : "D/E" }, "type" : "DG_01" } ] }, "handling" : { "items" : [ { "externalReference" : "example", "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false } } ] }, "modal" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false } }, "paperless" : true, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "standard" : "example", "type" : "ADR" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] }, { "AdminToken" : [ ] } ] } }, "/v1/packing-types" : { "get" : { "tags" : [ "Packing Types" ], "summary" : "List Packing Types", "description" : "Lists Packing Types. \nReturns a paginated list of Packing Types.", "operationId" : "listPackingTypes", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PackingTypesListResponse" }, "example" : { "items" : [ { "id" : "cfe26e72-bf79-3960-b38f-f3708982635a", "codeTypes" : [ { "code" : "PC", "type" : "GSPackageCode" } ], "description" : "Package", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "type" : "PACKAGE" } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] }, { "AdminToken" : [ ] } ] } }, "/v1/document-types" : { "get" : { "tags" : [ "Document Types" ], "summary" : "List Document Types", "description" : "Lists Document Types. \nReturns a paginated list of Document Types.", "operationId" : "listDocumentTypes", "parameters" : [ { "name" : "carrier_id", "in" : "query", "description" : "Carrier id.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "service_id", "in" : "query", "description" : "Service id.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DocumentTypeListResponse" }, "example" : { "items" : [ { "id" : "123e4567-e89b-12d3-a456-426614174000", "createdAt" : "2025-01-16T12:07:09Z", "updatedAt" : "2025-01-16T12:07:09Z", "carrierId" : "123e4567-e89b-12d3-a456-426614174000", "contentTypes" : [ { "description" : "Portable Document Format", "type" : "pdf" } ], "description" : "Shipping label for parcels", "layouts" : [ "example" ], "mediaTypes" : [ { "description" : "Normal A4 paper", "type" : "laser-a4" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "serviceId" : "123e4567-e89b-12d3-a456-426614174001", "type" : "LABEL" } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] }, { "AdminToken" : [ ] } ] } }, "/v1/dangerous-goods-declaration-types" : { "get" : { "tags" : [ "Dangerous Goods Declaration Types" ], "summary" : "List Dangerous Goods Declaration Types", "description" : "Lists Dangerous Goods Declaration Types. Returns a paginated list of Dangerous Goods Declaration Types.\n", "operationId" : "listDangerousGoodsDeclarationTypes", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DangerousGoodsDeclarationTypeListResponse" }, "example" : { "items" : [ { "id" : "328af029-7629-3355-a6df-029593db9d82", "access" : false, "carrierId" : "123e4567-e89b-12d3-a456-426614174000", "code" : "ADR", "description" : "European Agreement concerning the International Carriage of Dangerous Goods by Road", "documentTypes" : [ { "contentTypes" : [ { "description" : "Portable Document Format", "type" : "pdf" } ], "description" : "Bring VOEC", "mediaTypes" : [ { "description" : "Normal A4 paper", "type" : "laser-a4" } ], "type" : "CUSTOMS_DOCUMENT" } ], "goods" : { "explicitTypes" : true, "itemLimit" : false, "maxItems" : 50, "maxParcels" : 10, "netQuantityMandatory" : true, "netQuantityUnits" : [ "example" ], "packingGroup" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false } }, "parcelLimit" : false, "types" : [ { "code" : "UN1950", "hazard" : { "code" : "F1", "environmental" : false, "flashPoint" : -20, "hazardClass" : "3" }, "notes" : [ "Handle with care" ], "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "group" : "II", "type" : "BOTTLE" }, "shippingName" : "Aerosols, flammable", "technicalName" : "Propane, Butane mixture", "transportation" : { "emergencyCode" : "2YE", "separation" : 3, "tunnelRestriction" : "D/E" }, "type" : "DG_01" } ] }, "handling" : { "items" : [ { "externalReference" : "example", "validations" : { "allowedValues" : [ { } ], "mandatory" : false } } ] }, "modal" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false } }, "paperless" : true, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "standard" : "example", "type" : "ADR" } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] }, { "AdminToken" : [ ] } ] } }, "/v1/services" : { "get" : { "tags" : [ "Services" ], "summary" : "List Services", "description" : "Lists all Services.\nProvide the `carrier-id` returned from the List Carriers endpoint.\nProvide `route_from` and `route_to` for route-specific validation.\nReturns a paginated list of Services.", "operationId" : "listServices", "parameters" : [ { "name" : "route_from", "in" : "query", "description" : "Origin country code for route-specific validation", "required" : false, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/CountryCode", "example" : "US" }, "example" : "US" }, { "name" : "route_to", "in" : "query", "description" : "Destination country code for route-specific validation", "required" : false, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/CountryCode", "example" : "CA" }, "example" : "CA" }, { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceListResponse" }, "example" : { "items" : [ { "id" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82", "updatedAt" : "2024-07-01T00:00:00+00:00", "name" : "UPS", "access" : false, "addons" : [ { "id" : "2b71b8f1-6d27-4b63-8093-d31257d46d4f", "access" : false, "code" : "DLVNOPOD", "combine" : [ { "addons" : [ { } ], "allowed" : false } ], "description" : "Delivery without POD", "explicitRoutes" : false, "fields" : [ { "context" : "SHIPMENT", "defaultValue" : "PC", "description" : "Customer Number", "externalReference" : "custNo", "key" : "TEXT4", "route" : { "fromCountryCode" : "SE", "toCountryCode" : "DE" }, "validations" : { "allowedValues" : [ ], "mandatory" : false, "maxLength" : 10, "minLength" : 2, "precision" : 2, "type" : "STRING" } } ], "obsolete" : false, "portalReferences" : { "addonId" : "345675" }, "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "routes" : [ { "condition" : [ "POSTAL_CODE_BASED", "AGREEMENT_BASED" ], "domestic" : false, "dutiable" : false, "fromCountryCodes" : [ "US" ], "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "toCountryCodes" : [ "US" ] } ] } ], "addressValidations" : [ { "companyIdentification" : [ { "context" : "SHIPMENT", "description" : "Delivery instructions", "externalReference" : "EXT-REF-123", "key" : "TEXT4", "validations" : { "allowedValues" : [ ], "mandatory" : false, "maxLength" : 10, "minLength" : 2, "precision" : 2, "type" : "STRING" } } ], "conditions" : { "roles" : [ "SENDER", "RECEIVER" ] }, "maxLinesLength" : 35, "requiredCompanyName" : false, "requiredContactCareOf" : false, "requiredContactDoorCode" : false, "requiredContactEmail" : false, "requiredContactFax" : false, "requiredContactFirstName" : false, "requiredContactLastName" : false, "requiredContactMobile" : false, "requiredContactPhone" : false, "requiredLocationBuildingName" : false, "requiredLocationBuildingNumber" : false, "requiredLocationCity" : false, "requiredLocationCountryCode" : false, "requiredLocationFloor" : false, "requiredLocationLocality" : false, "requiredLocationPostalCode" : false, "requiredLocationRegion" : false, "requiredLocationStateCode" : false, "requiredLocationStreetName" : false, "requiredLocationStreetNumber" : false, "requiredLocationUnit" : false, "requiredReferencesExternal" : false, "requiredReferencesInternal" : false } ], "carrierCode" : "2b71b8f1", "carrierId" : "8c2b9506-043c-3adb-918b-e134d3c36bd6", "carrierRates" : { "supported" : true }, "classification" : { "crossborder" : false, "returnService" : false }, "code" : "UPS", "consolidation" : { "supported" : false }, "criteria" : { "addressValidations" : false, "customsValidations" : false, "itemValidations" : true, "parcelValidations" : false, "postalCodeValidation" : false, "routeValidation" : false, "shipmentValidations" : false }, "customs" : { "declarationTypes" : [ { "mandatory" : false, "type" : "CN22DHLECOM" } ], "supported" : true }, "customsDeclarationTypes" : [ { "id" : "019ad761-9247-79b3-8cda-416fc404bbe9", "access" : false, "addressValidations" : [ { "companyIdentification" : [ { } ], "conditions" : { "roles" : [ "SENDER", "RECEIVER" ] }, "maxLinesLength" : 35, "requiredCompanyName" : false, "requiredContactCareOf" : false, "requiredContactDoorCode" : false, "requiredContactEmail" : false, "requiredContactFax" : false, "requiredContactFirstName" : false, "requiredContactLastName" : false, "requiredContactMobile" : false, "requiredContactPhone" : false, "requiredLocationBuildingName" : false, "requiredLocationBuildingNumber" : false, "requiredLocationCity" : false, "requiredLocationCountryCode" : false, "requiredLocationFloor" : false, "requiredLocationLocality" : false, "requiredLocationPostalCode" : false, "requiredLocationRegion" : false, "requiredLocationStateCode" : false, "requiredLocationStreetName" : false, "requiredLocationStreetNumber" : false, "requiredLocationUnit" : false, "requiredReferencesExternal" : false, "requiredReferencesInternal" : false } ], "charges" : { "supportsDuty" : false, "supportsFreight" : false, "supportsInsurance" : false, "supportsInvoice" : false, "supportsOther" : false }, "comments" : { "validations" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "criteria" : { "addressValidations" : false, "itemValidations" : false }, "currencies" : [ "NOK", "SEK", "USD" ], "description" : "Bring VOEC", "documentTypes" : [ { "contentTypes" : [ { } ], "description" : "Bring VOEC", "mediaTypes" : [ { } ], "type" : "CUSTOMS_DOCUMENT" } ], "invoice" : { "itemLimit" : false, "maxItems" : 1 }, "itemValidations" : [ { "conditions" : [ { } ], "pricing" : { "countryOfOrigin" : { }, "tariffNumber" : { }, "unitPrice" : { } }, "product" : { "composition" : { }, "description" : { }, "identification" : { }, "weight" : { } } } ], "paperless" : true, "parties" : [ { "mandatory" : false, "role" : "SENDER" } ], "purpose" : { "code" : { "validations" : { "allowedValues" : [ ], "mandatory" : false } }, "defaultValue" : "DEFAULT_DECLARATION", "description" : "Customs declaration for imported goods", "type" : "CUSTOMS_DECLARATION" }, "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "statements" : { "validations" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "terms" : { "code" : { "validations" : { "allowedValues" : [ ], "mandatory" : false } }, "defaultValue" : "DEFAULT_DECLARATION", "description" : "Customs declaration for imported goods", "type" : "CUSTOMS_DECLARATION" }, "type" : "BRINGEDI" } ], "dangerousGoods" : { "declarationTypes" : [ { "id" : "328af029-7629-3355-a6df-029593db9d82", "access" : false, "carrierId" : "123e4567-e89b-12d3-a456-426614174000", "code" : "ADR", "description" : "European Agreement concerning the International Carriage of Dangerous Goods by Road", "documentTypes" : [ { "contentTypes" : [ ], "description" : "Bring VOEC", "mediaTypes" : [ ], "type" : "CUSTOMS_DOCUMENT" } ], "goods" : { "explicitTypes" : true, "itemLimit" : false, "maxItems" : 50, "maxParcels" : 10, "netQuantityMandatory" : true, "netQuantityUnits" : [ "example" ], "packingGroup" : { "validations" : { } }, "parcelLimit" : false, "types" : [ ] }, "handling" : { "items" : [ { } ] }, "modal" : { "validations" : { "allowedValues" : [ ], "mandatory" : false } }, "paperless" : true, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "standard" : "example", "type" : "ADR" } ], "explicitRoutes" : false, "goods" : { "hazard" : { "code" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "environmental" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "flashPoint" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "hazardClass" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "itemLimit" : true, "maxItems" : 1, "maxParcels" : 1, "notes" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "packing" : { "group" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "type" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "parcelLimit" : true, "technicalName" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "transportation" : { "emergencyCode" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "separation" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "tunnelRestriction" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } } }, "packingCodeType" : { "code" : { "defaultValue" : "UPSTermsOfSale", "validations" : { "allowedValues" : [ { } ], "mandatory" : false } }, "type" : "GSPackageCode" }, "packingTypes" : [ { "description" : "Package", "type" : "PACKAGE" } ], "routes" : [ { "condition" : [ "POSTAL_CODE_BASED", "AGREEMENT_BASED" ], "domestic" : false, "dutiable" : false, "fromCountryCodes" : [ "US" ], "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "toCountryCodes" : [ "US" ] } ], "supported" : true }, "deliveryBooking" : { "date" : { "format" : "date", "mandatory" : false, "supported" : false }, "timeFrom" : { "format" : "date", "mandatory" : false, "supported" : false }, "timeTo" : { "format" : "date", "mandatory" : false, "supported" : false } }, "documentTypes" : [ { "contentTypes" : [ { "description" : "Portable Document Format", "type" : "pdf" } ], "description" : "Bring VOEC", "mediaTypes" : [ { "description" : "Normal A4 paper", "type" : "laser-a4" } ], "type" : "CUSTOMS_DOCUMENT" } ], "explicitRoutes" : false, "fields" : [ { "context" : "SHIPMENT", "defaultValue" : "PC", "description" : "Customer Number", "externalReference" : "custNo", "key" : "TEXT4", "route" : { "fromCountryCode" : "SE", "toCountryCode" : "DE" }, "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false, "maxLength" : 10, "minLength" : 2, "precision" : 2, "type" : "STRING" } } ], "itemValidations" : [ { "conditions" : { "dangerousGoodsDeclarationTypes" : [ "example" ] }, "dangerousGoods" : { "netQuantity" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "netQuantityUnit" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "quantity" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "type" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } } } } ], "manifest" : { "supported" : false, "types" : [ { "description" : "Portable Document Format", "documentTypes" : [ { "contentTypes" : [ ], "description" : "Bring VOEC", "mediaTypes" : [ ], "type" : "CUSTOMS_DOCUMENT" } ], "type" : "PDF" } ] }, "meta" : { "key1" : "value1", "key2" : "value2" }, "obsolete" : false, "packingCodeType" : { "code" : { "defaultValue" : "UPSTermsOfSale", "validations" : { "allowedValues" : [ { "description" : "Package", "value" : "PACKAGE" } ], "mandatory" : false } }, "type" : "GSPackageCode" }, "packingTypes" : [ { "description" : "Package", "type" : "PACKAGE" } ], "parcelValidations" : [ { "conditions" : [ { "addons" : [ "ADDON1", "ADDON2" ], "explicitRoutes" : false, "packingCodeTypes" : [ "PC", "GS" ], "routes" : [ { } ] } ], "maxHeight" : 80, "maxLength" : 120, "maxTotalDimensions" : 300, "maxVolume" : 2.5, "maxWeight" : 30, "maxWidth" : 100, "minHeight" : 1, "minLength" : 1, "minTotalDimensions" : 15, "minVolume" : 0.001, "minWeight" : 0.1, "minWidth" : 1 } ], "parties" : [ { "mandatory" : false, "role" : "SENDER" } ], "pickupBooking" : { "acceptsDate" : false, "mandatory" : false, "supported" : false }, "portalReferences" : { "carrierId" : "00000000-0000-0000-0000-0000000003B6", "serviceId" : "00000000-0000-0000-0000-00000000245C" }, "pudoPoints" : { "cached" : { "externalReference" : "PostNord", "supported" : false }, "externalReference" : "PostNord", "operationTypes" : [ "locker", "shop" ], "roles" : [ "DELIVERY" ], "supported" : false }, "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "returnService" : { "id" : "2b71b8f1-6d27-4b63-8093-d31257d46d4f", "name" : "UPS", "code" : "UPS" }, "routes" : [ { "condition" : [ "POSTAL_CODE_BASED", "AGREEMENT_BASED" ], "domestic" : false, "dutiable" : false, "fromCountryCodes" : [ "US" ], "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "toCountryCodes" : [ "US" ] } ], "serials" : [ { "id" : "123e4567-e89b-12d3-a456-426614174000", "name" : "Standard Serial Type", "checkDigitMethod" : "MOD10", "code" : "SERIAL01", "pattern" : "^[A-Z]{2}[0-9]{8}$" } ], "shipmentValidations" : [ { "conditions" : [ { "addons" : [ "ADDON1", "ADDON2" ], "explicitRoutes" : false, "packingCodeTypes" : [ "PC", "GS" ], "routes" : [ { } ] } ], "maxParcels" : 10, "maxVolume" : 5.0, "maxWeight" : 100, "minParcels" : 1, "minVolume" : 0.01, "minWeight" : 0.1 } ], "terms" : { "code" : { "defaultValue" : "DAP", "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false } } }, "voiding" : { "limitation" : "QUEUE", "note" : "This feature is only applicable within the timeframe before EDI is sent to carrier (every 5min).", "supported" : false } } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] }, { "AdminToken" : [ ] } ] } }, "/v1/services/{service-id}" : { "get" : { "tags" : [ "Services" ], "summary" : "Fetch Service", "description" : "Fetches a specific Service.\nProvide the `service-id` returned from the List Carrier Services or List Services endpoint.\nInclude `route_from` and `route_to` for route-specific validation.\nReturns the Service.", "operationId" : "fetchService", "parameters" : [ { "name" : "service-id", "in" : "path", "description" : "Identifies the Service", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Service", "example" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82", "maxLength" : 36 }, "example" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82" }, { "name" : "route_from", "in" : "query", "description" : "Origin country code for route-specific validation", "required" : false, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/CountryCode", "example" : "US" }, "example" : "US" }, { "name" : "route_to", "in" : "query", "description" : "Destination country code for route-specific validation", "required" : false, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/CountryCode", "example" : "CA" }, "example" : "CA" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceResponse" }, "example" : { "id" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82", "updatedAt" : "2024-07-01T00:00:00+00:00", "name" : "UPS", "access" : false, "addons" : [ { "id" : "2b71b8f1-6d27-4b63-8093-d31257d46d4f", "access" : false, "code" : "DLVNOPOD", "combine" : [ { "addons" : [ { "code" : "NOTSMS" } ], "allowed" : false } ], "description" : "Delivery without POD", "explicitRoutes" : false, "fields" : [ { "context" : "SHIPMENT", "defaultValue" : "PC", "description" : "Customer Number", "externalReference" : "custNo", "key" : "TEXT4", "route" : { "fromCountryCode" : "SE", "toCountryCode" : "DE" }, "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false, "maxLength" : 10, "minLength" : 2, "precision" : 2, "type" : "STRING" } } ], "obsolete" : false, "portalReferences" : { "addonId" : "345675" }, "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "routes" : [ { "condition" : [ "POSTAL_CODE_BASED", "AGREEMENT_BASED" ], "domestic" : false, "dutiable" : false, "fromCountryCodes" : [ "US" ], "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "toCountryCodes" : [ "US" ] } ] } ], "addressValidations" : [ { "companyIdentification" : [ { "context" : "SHIPMENT", "description" : "Delivery instructions", "externalReference" : "EXT-REF-123", "key" : "TEXT4", "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false, "maxLength" : 10, "minLength" : 2, "precision" : 2, "type" : "STRING" } } ], "conditions" : { "roles" : [ "SENDER", "RECEIVER" ] }, "maxLinesLength" : 35, "requiredCompanyName" : false, "requiredContactCareOf" : false, "requiredContactDoorCode" : false, "requiredContactEmail" : false, "requiredContactFax" : false, "requiredContactFirstName" : false, "requiredContactLastName" : false, "requiredContactMobile" : false, "requiredContactPhone" : false, "requiredLocationBuildingName" : false, "requiredLocationBuildingNumber" : false, "requiredLocationCity" : false, "requiredLocationCountryCode" : false, "requiredLocationFloor" : false, "requiredLocationLocality" : false, "requiredLocationPostalCode" : false, "requiredLocationRegion" : false, "requiredLocationStateCode" : false, "requiredLocationStreetName" : false, "requiredLocationStreetNumber" : false, "requiredLocationUnit" : false, "requiredReferencesExternal" : false, "requiredReferencesInternal" : false } ], "carrierCode" : "2b71b8f1", "carrierId" : "8c2b9506-043c-3adb-918b-e134d3c36bd6", "carrierRates" : { "supported" : true }, "classification" : { "crossborder" : false, "returnService" : false }, "code" : "UPS", "consolidation" : { "supported" : false }, "criteria" : { "addressValidations" : false, "customsValidations" : false, "itemValidations" : true, "parcelValidations" : false, "postalCodeValidation" : false, "routeValidation" : false, "shipmentValidations" : false }, "customs" : { "declarationTypes" : [ { "mandatory" : false, "type" : "CN22DHLECOM" } ], "supported" : true }, "customsDeclarationTypes" : [ { "id" : "019ad761-9247-79b3-8cda-416fc404bbe9", "access" : false, "addressValidations" : [ { "companyIdentification" : [ { "context" : "SHIPMENT", "description" : "Delivery instructions", "externalReference" : "EXT-REF-123", "key" : "TEXT4", "validations" : { "allowedValues" : [ ], "mandatory" : false, "maxLength" : 10, "minLength" : 2, "precision" : 2, "type" : "STRING" } } ], "conditions" : { "roles" : [ "SENDER", "RECEIVER" ] }, "maxLinesLength" : 35, "requiredCompanyName" : false, "requiredContactCareOf" : false, "requiredContactDoorCode" : false, "requiredContactEmail" : false, "requiredContactFax" : false, "requiredContactFirstName" : false, "requiredContactLastName" : false, "requiredContactMobile" : false, "requiredContactPhone" : false, "requiredLocationBuildingName" : false, "requiredLocationBuildingNumber" : false, "requiredLocationCity" : false, "requiredLocationCountryCode" : false, "requiredLocationFloor" : false, "requiredLocationLocality" : false, "requiredLocationPostalCode" : false, "requiredLocationRegion" : false, "requiredLocationStateCode" : false, "requiredLocationStreetName" : false, "requiredLocationStreetNumber" : false, "requiredLocationUnit" : false, "requiredReferencesExternal" : false, "requiredReferencesInternal" : false } ], "charges" : { "supportsDuty" : false, "supportsFreight" : false, "supportsInsurance" : false, "supportsInvoice" : false, "supportsOther" : false }, "comments" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "criteria" : { "addressValidations" : false, "itemValidations" : false }, "currencies" : [ "NOK", "SEK", "USD" ], "description" : "Bring VOEC", "documentTypes" : [ { "contentTypes" : [ { "description" : "Portable Document Format", "type" : "pdf" } ], "description" : "Bring VOEC", "mediaTypes" : [ { "description" : "Normal A4 paper", "type" : "laser-a4" } ], "type" : "CUSTOMS_DOCUMENT" } ], "invoice" : { "itemLimit" : false, "maxItems" : 1 }, "itemValidations" : [ { "conditions" : [ { "addons" : [ "ADDON1", "ADDON2" ], "explicitRoutes" : false, "packingCodeTypes" : [ "PC", "GS" ], "routes" : [ { } ] } ], "pricing" : { "countryOfOrigin" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "tariffNumber" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "unitPrice" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } } }, "product" : { "composition" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "description" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "identification" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "weight" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } } } } ], "paperless" : true, "parties" : [ { "mandatory" : false, "role" : "SENDER" } ], "purpose" : { "code" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false } }, "defaultValue" : "DEFAULT_DECLARATION", "description" : "Customs declaration for imported goods", "type" : "CUSTOMS_DECLARATION" }, "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "statements" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "terms" : { "code" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false } }, "defaultValue" : "DEFAULT_DECLARATION", "description" : "Customs declaration for imported goods", "type" : "CUSTOMS_DECLARATION" }, "type" : "BRINGEDI" } ], "dangerousGoods" : { "declarationTypes" : [ { "id" : "328af029-7629-3355-a6df-029593db9d82", "access" : false, "carrierId" : "123e4567-e89b-12d3-a456-426614174000", "code" : "ADR", "description" : "European Agreement concerning the International Carriage of Dangerous Goods by Road", "documentTypes" : [ { "contentTypes" : [ { "description" : "Portable Document Format", "type" : "pdf" } ], "description" : "Bring VOEC", "mediaTypes" : [ { "description" : "Normal A4 paper", "type" : "laser-a4" } ], "type" : "CUSTOMS_DOCUMENT" } ], "goods" : { "explicitTypes" : true, "itemLimit" : false, "maxItems" : 50, "maxParcels" : 10, "netQuantityMandatory" : true, "netQuantityUnits" : [ "example" ], "packingGroup" : { "validations" : { "allowedValues" : [ { } ], "mandatory" : false } }, "parcelLimit" : false, "types" : [ { "code" : "UN1950", "hazard" : { "code" : "F1", "environmental" : false, "flashPoint" : -20, "hazardClass" : "3" }, "notes" : [ "Handle with care" ], "packing" : { "group" : "II", "type" : "BOTTLE" }, "shippingName" : "Aerosols, flammable", "technicalName" : "Propane, Butane mixture", "transportation" : { "emergencyCode" : "2YE", "separation" : 3, "tunnelRestriction" : "D/E" }, "type" : "DG_01" } ] }, "handling" : { "items" : [ { "externalReference" : "example", "validations" : { "allowedValues" : [ ], "mandatory" : false } } ] }, "modal" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false } }, "paperless" : true, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "standard" : "example", "type" : "ADR" } ], "explicitRoutes" : false, "goods" : { "hazard" : { "code" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "environmental" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "flashPoint" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "hazardClass" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "itemLimit" : true, "maxItems" : 1, "maxParcels" : 1, "notes" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "packing" : { "group" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "type" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "parcelLimit" : true, "technicalName" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "transportation" : { "emergencyCode" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "separation" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "tunnelRestriction" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } } }, "packingCodeType" : { "code" : { "defaultValue" : "UPSTermsOfSale", "validations" : { "allowedValues" : [ { "description" : "Package", "value" : "PACKAGE" } ], "mandatory" : false } }, "type" : "GSPackageCode" }, "packingTypes" : [ { "description" : "Package", "type" : "PACKAGE" } ], "routes" : [ { "condition" : [ "POSTAL_CODE_BASED", "AGREEMENT_BASED" ], "domestic" : false, "dutiable" : false, "fromCountryCodes" : [ "US" ], "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "toCountryCodes" : [ "US" ] } ], "supported" : true }, "deliveryBooking" : { "date" : { "format" : "date", "mandatory" : false, "supported" : false }, "timeFrom" : { "format" : "date", "mandatory" : false, "supported" : false }, "timeTo" : { "format" : "date", "mandatory" : false, "supported" : false } }, "documentTypes" : [ { "contentTypes" : [ { "description" : "Portable Document Format", "type" : "pdf" } ], "description" : "Bring VOEC", "mediaTypes" : [ { "description" : "Normal A4 paper", "type" : "laser-a4" } ], "type" : "CUSTOMS_DOCUMENT" } ], "explicitRoutes" : false, "fields" : [ { "context" : "SHIPMENT", "defaultValue" : "PC", "description" : "Customer Number", "externalReference" : "custNo", "key" : "TEXT4", "route" : { "fromCountryCode" : "SE", "toCountryCode" : "DE" }, "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false, "maxLength" : 10, "minLength" : 2, "precision" : 2, "type" : "STRING" } } ], "itemValidations" : [ { "conditions" : { "dangerousGoodsDeclarationTypes" : [ "example" ] }, "dangerousGoods" : { "netQuantity" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "netQuantityUnit" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "quantity" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "type" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } } } } ], "manifest" : { "supported" : false, "types" : [ { "description" : "Portable Document Format", "documentTypes" : [ { "contentTypes" : [ { "description" : "Portable Document Format", "type" : "pdf" } ], "description" : "Bring VOEC", "mediaTypes" : [ { "description" : "Normal A4 paper", "type" : "laser-a4" } ], "type" : "CUSTOMS_DOCUMENT" } ], "type" : "PDF" } ] }, "meta" : { "key1" : "value1", "key2" : "value2" }, "obsolete" : false, "packingCodeType" : { "code" : { "defaultValue" : "UPSTermsOfSale", "validations" : { "allowedValues" : [ { "description" : "Package", "value" : "PACKAGE" } ], "mandatory" : false } }, "type" : "GSPackageCode" }, "packingTypes" : [ { "description" : "Package", "type" : "PACKAGE" } ], "parcelValidations" : [ { "conditions" : [ { "addons" : [ "ADDON1", "ADDON2" ], "explicitRoutes" : false, "packingCodeTypes" : [ "PC", "GS" ], "routes" : [ { "condition" : [ "POSTAL_CODE_BASED", "AGREEMENT_BASED" ], "domestic" : false, "dutiable" : false, "fromCountryCodes" : [ "US" ], "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "toCountryCodes" : [ "US" ] } ] } ], "maxHeight" : 80, "maxLength" : 120, "maxTotalDimensions" : 300, "maxVolume" : 2.5, "maxWeight" : 30, "maxWidth" : 100, "minHeight" : 1, "minLength" : 1, "minTotalDimensions" : 15, "minVolume" : 0.001, "minWeight" : 0.1, "minWidth" : 1 } ], "parties" : [ { "mandatory" : false, "role" : "SENDER" } ], "pickupBooking" : { "acceptsDate" : false, "mandatory" : false, "supported" : false }, "portalReferences" : { "carrierId" : "00000000-0000-0000-0000-0000000003B6", "serviceId" : "00000000-0000-0000-0000-00000000245C" }, "pudoPoints" : { "cached" : { "externalReference" : "PostNord", "supported" : false }, "externalReference" : "PostNord", "operationTypes" : [ "locker", "shop" ], "roles" : [ "DELIVERY" ], "supported" : false }, "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "returnService" : { "id" : "2b71b8f1-6d27-4b63-8093-d31257d46d4f", "name" : "UPS", "code" : "UPS" }, "routes" : [ { "condition" : [ "POSTAL_CODE_BASED", "AGREEMENT_BASED" ], "domestic" : false, "dutiable" : false, "fromCountryCodes" : [ "US" ], "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "toCountryCodes" : [ "US" ] } ], "serials" : [ { "id" : "123e4567-e89b-12d3-a456-426614174000", "name" : "Standard Serial Type", "checkDigitMethod" : "MOD10", "code" : "SERIAL01", "pattern" : "^[A-Z]{2}[0-9]{8}$" } ], "shipmentValidations" : [ { "conditions" : [ { "addons" : [ "ADDON1", "ADDON2" ], "explicitRoutes" : false, "packingCodeTypes" : [ "PC", "GS" ], "routes" : [ { "condition" : [ "POSTAL_CODE_BASED", "AGREEMENT_BASED" ], "domestic" : false, "dutiable" : false, "fromCountryCodes" : [ "US" ], "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "toCountryCodes" : [ "US" ] } ] } ], "maxParcels" : 10, "maxVolume" : 5.0, "maxWeight" : 100, "minParcels" : 1, "minVolume" : 0.01, "minWeight" : 0.1 } ], "terms" : { "code" : { "defaultValue" : "DAP", "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false } } }, "voiding" : { "limitation" : "QUEUE", "note" : "This feature is only applicable within the timeframe before EDI is sent to carrier (every 5min).", "supported" : false } } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] }, { "AdminToken" : [ ] } ] } }, "/v1/services/{service-id}/routes" : { "get" : { "tags" : [ "Services" ], "summary" : "Fetch Service Route", "description" : "Fetches route-specific information for a Service.\nProvide the `service-id` returned from the List Carrier Services or List Services endpoint, along with `route_from` and `route_to`.\nReturns whether the route is supported, plus the dutiable and domestic flags of the matched route entry.", "operationId" : "fetchServiceRoute", "parameters" : [ { "name" : "service-id", "in" : "path", "description" : "Identifies the Service", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Service", "example" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82", "maxLength" : 36 }, "example" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82" }, { "name" : "route_from", "in" : "query", "description" : "Origin country code for route-specific validation", "required" : true, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/CountryCode", "example" : "US" }, "example" : "US" }, { "name" : "route_to", "in" : "query", "description" : "Destination country code for route-specific validation", "required" : true, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/CountryCode", "example" : "CA" }, "example" : "CA" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceRouteResponse" }, "example" : { "customsClearance" : { "mandatory" : false, "regions" : { "fromCode" : "EUCU", "toCode" : "GB_CU" } }, "domestic" : false, "dutiable" : false, "fromCountryCode" : "US", "serviceRoute" : "SUPPORTED", "toCountryCode" : "CA" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] }, { "AdminToken" : [ ] } ] } }, "/v1/serial-types" : { "get" : { "tags" : [ "Serial Types" ], "summary" : "List Serials", "description" : "Lists Serial Numbers", "operationId" : "listSerialTypes", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SerialTypesListResponse" }, "example" : { "items" : [ { "id" : "123e4567-e89b-12d3-a456-426614174000", "name" : "Standard Serial Type", "checkDigitMethod" : "MOD10", "code" : "SERIAL01", "pattern" : "^[A-Z]{2}[0-9]{8}$" } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] }, { "AdminToken" : [ ] } ] } }, "/v1/customs-declaration-types" : { "get" : { "tags" : [ "Customs Declaration Types" ], "summary" : "List Customs Declaration Types", "description" : "Lists Customs Declaration Types. Returns a paginated list of Customs Declaration Types.\n", "operationId" : "listCustomsDeclarationTypes", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomsDeclarationTypeListResponse" }, "example" : { "items" : [ { "id" : "019ad761-9247-79b3-8cda-416fc404bbe9", "access" : false, "addressValidations" : [ { "companyIdentification" : [ { "context" : "SHIPMENT", "description" : "Delivery instructions", "externalReference" : "EXT-REF-123", "key" : "TEXT4", "validations" : { "allowedValues" : [ ], "mandatory" : false, "maxLength" : 10, "minLength" : 2, "precision" : 2, "type" : "STRING" } } ], "conditions" : { "roles" : [ "SENDER", "RECEIVER" ] }, "maxLinesLength" : 35, "requiredCompanyName" : false, "requiredContactCareOf" : false, "requiredContactDoorCode" : false, "requiredContactEmail" : false, "requiredContactFax" : false, "requiredContactFirstName" : false, "requiredContactLastName" : false, "requiredContactMobile" : false, "requiredContactPhone" : false, "requiredLocationBuildingName" : false, "requiredLocationBuildingNumber" : false, "requiredLocationCity" : false, "requiredLocationCountryCode" : false, "requiredLocationFloor" : false, "requiredLocationLocality" : false, "requiredLocationPostalCode" : false, "requiredLocationRegion" : false, "requiredLocationStateCode" : false, "requiredLocationStreetName" : false, "requiredLocationStreetNumber" : false, "requiredLocationUnit" : false, "requiredReferencesExternal" : false, "requiredReferencesInternal" : false } ], "charges" : { "supportsDuty" : false, "supportsFreight" : false, "supportsInsurance" : false, "supportsInvoice" : false, "supportsOther" : false }, "comments" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "criteria" : { "addressValidations" : false, "itemValidations" : false }, "currencies" : [ "NOK", "SEK", "USD" ], "description" : "Bring VOEC", "documentTypes" : [ { "contentTypes" : [ { "description" : "Portable Document Format", "type" : "pdf" } ], "description" : "Bring VOEC", "mediaTypes" : [ { "description" : "Normal A4 paper", "type" : "laser-a4" } ], "type" : "CUSTOMS_DOCUMENT" } ], "invoice" : { "itemLimit" : false, "maxItems" : 1 }, "itemValidations" : [ { "conditions" : [ { "addons" : [ "ADDON1", "ADDON2" ], "explicitRoutes" : false, "packingCodeTypes" : [ "PC", "GS" ], "routes" : [ { } ] } ], "pricing" : { "countryOfOrigin" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "tariffNumber" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "unitPrice" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } } }, "product" : { "composition" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "description" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "identification" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "weight" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } } } } ], "paperless" : true, "parties" : [ { "mandatory" : false, "role" : "SENDER" } ], "purpose" : { "code" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false } }, "defaultValue" : "DEFAULT_DECLARATION", "description" : "Customs declaration for imported goods", "type" : "CUSTOMS_DECLARATION" }, "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "statements" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "terms" : { "code" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false } }, "defaultValue" : "DEFAULT_DECLARATION", "description" : "Customs declaration for imported goods", "type" : "CUSTOMS_DECLARATION" }, "type" : "BRINGEDI" } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] }, { "AdminToken" : [ ] } ] } }, "/v1/customs-declaration-types/{customs-declaration-type-id}" : { "get" : { "tags" : [ "Customs Declaration Types" ], "summary" : "Fetch Customs Declaration Type", "description" : "Fetches a specific Customs Declaration Type. Provide `customs-declaration-type-id`. \nReturns the Customs Declaration Type.\n", "operationId" : "fetchCustomsDeclarationType", "parameters" : [ { "name" : "customs-declaration-type-id", "in" : "path", "description" : "Customs declaration type id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomsDeclarationTypeResponse" }, "example" : { "id" : "019ad761-9247-79b3-8cda-416fc404bbe9", "access" : false, "addressValidations" : [ { "companyIdentification" : [ { "context" : "SHIPMENT", "description" : "Delivery instructions", "externalReference" : "EXT-REF-123", "key" : "TEXT4", "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false, "maxLength" : 10, "minLength" : 2, "precision" : 2, "type" : "STRING" } } ], "conditions" : { "roles" : [ "SENDER", "RECEIVER" ] }, "maxLinesLength" : 35, "requiredCompanyName" : false, "requiredContactCareOf" : false, "requiredContactDoorCode" : false, "requiredContactEmail" : false, "requiredContactFax" : false, "requiredContactFirstName" : false, "requiredContactLastName" : false, "requiredContactMobile" : false, "requiredContactPhone" : false, "requiredLocationBuildingName" : false, "requiredLocationBuildingNumber" : false, "requiredLocationCity" : false, "requiredLocationCountryCode" : false, "requiredLocationFloor" : false, "requiredLocationLocality" : false, "requiredLocationPostalCode" : false, "requiredLocationRegion" : false, "requiredLocationStateCode" : false, "requiredLocationStreetName" : false, "requiredLocationStreetNumber" : false, "requiredLocationUnit" : false, "requiredReferencesExternal" : false, "requiredReferencesInternal" : false } ], "charges" : { "supportsDuty" : false, "supportsFreight" : false, "supportsInsurance" : false, "supportsInvoice" : false, "supportsOther" : false }, "comments" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "criteria" : { "addressValidations" : false, "itemValidations" : false }, "currencies" : [ "NOK", "SEK", "USD" ], "description" : "Bring VOEC", "documentTypes" : [ { "contentTypes" : [ { "description" : "Portable Document Format", "type" : "pdf" } ], "description" : "Bring VOEC", "mediaTypes" : [ { "description" : "Normal A4 paper", "type" : "laser-a4" } ], "type" : "CUSTOMS_DOCUMENT" } ], "invoice" : { "itemLimit" : false, "maxItems" : 1 }, "itemValidations" : [ { "conditions" : [ { "addons" : [ "ADDON1", "ADDON2" ], "explicitRoutes" : false, "packingCodeTypes" : [ "PC", "GS" ], "routes" : [ { "condition" : [ "POSTAL_CODE_BASED", "AGREEMENT_BASED" ], "domestic" : false, "dutiable" : false, "fromCountryCodes" : [ "US" ], "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "toCountryCodes" : [ "US" ] } ] } ], "pricing" : { "countryOfOrigin" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "tariffNumber" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "unitPrice" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } } }, "product" : { "composition" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "description" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "identification" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "weight" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } } } } ], "paperless" : true, "parties" : [ { "mandatory" : false, "role" : "SENDER" } ], "purpose" : { "code" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false } }, "defaultValue" : "DEFAULT_DECLARATION", "description" : "Customs declaration for imported goods", "type" : "CUSTOMS_DECLARATION" }, "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "statements" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "terms" : { "code" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false } }, "defaultValue" : "DEFAULT_DECLARATION", "description" : "Customs declaration for imported goods", "type" : "CUSTOMS_DECLARATION" }, "type" : "BRINGEDI" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] }, { "AdminToken" : [ ] } ] } }, "/v1/carriers" : { "get" : { "tags" : [ "Carriers" ], "summary" : "List Carriers", "description" : "Lists Carriers.\nProvide `route_from` and `route_to` for route-specific validation.\nReturns a paginated list of Carriers.", "operationId" : "listCarriers", "parameters" : [ { "name" : "route_from", "in" : "query", "description" : "Origin country code for route-specific validation", "required" : false, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/CountryCode", "example" : "US" }, "example" : "US" }, { "name" : "route_to", "in" : "query", "description" : "Destination country code for route-specific validation", "required" : false, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/CountryCode", "example" : "CA" }, "example" : "CA" }, { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CarrierListResponse" }, "example" : { "items" : [ { "id" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "updatedAt" : "2021-07-01T00:00:00+00:00", "name" : "UPS", "access" : false, "attributes" : [ "attribute1", "attribute2" ], "code" : "UPS", "connection" : { "type" : "API", "version" : "1.8.0" }, "grouping" : "DHL", "logo" : { "id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "description" : "DHL Germany logo", "format" : "png", "height" : 200, "supported" : false, "unit" : "px", "width" : 200 }, "meta" : { "key1" : "value1", "key2" : "value2" }, "mode" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ] } }, "monitoring" : { "id" : "019f5b2e-cd14-77aa-8b48-1c707f9ebe33" }, "portalCarrierId" : "1351", "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "settings" : [ { "context" : "SHIPMENT", "defaultValue" : "PC", "description" : "Customer Number", "externalReference" : "custNo", "key" : "TEXT4", "route" : { "fromCountryCode" : "SE", "toCountryCode" : "DE" }, "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false, "maxLength" : 10, "minLength" : 2, "precision" : 2, "type" : "STRING" } } ], "staging" : { "documentationUrl" : "https://docs.example.com/staging", "mandatory" : false, "onboardingUrl" : "https://onboarding.example.com" } } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] }, { "AdminToken" : [ ] } ] } }, "/v1/carriers/{carrier-id}" : { "get" : { "tags" : [ "Carriers" ], "summary" : "Fetch Carrier", "description" : "Fetches a specific Carrier.\nProvide the `carrier-id` returned from the List Carriers endpoint.\nReturns the Carrier.", "operationId" : "fetchCarrier", "parameters" : [ { "name" : "carrier-id", "in" : "path", "description" : "Identifies the Carrier", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Carrier", "example" : "8c2b9506-043c-3adb-918b-e134d3c36bd6", "maxLength" : 36 }, "example" : "8c2b9506-043c-3adb-918b-e134d3c36bd6" }, { "name" : "route_from", "in" : "query", "description" : "Origin country code for route-specific validation", "required" : false, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/CountryCode", "example" : "US" }, "example" : "US" }, { "name" : "route_to", "in" : "query", "description" : "Destination country code for route-specific validation", "required" : false, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/CountryCode", "example" : "CA" }, "example" : "CA" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CarrierResponse" }, "example" : { "id" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "updatedAt" : "2021-07-01T00:00:00+00:00", "name" : "UPS", "access" : false, "attributes" : [ "attribute1", "attribute2" ], "code" : "UPS", "connection" : { "type" : "API", "version" : "1.8.0" }, "grouping" : "DHL", "logo" : { "id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "description" : "DHL Germany logo", "format" : "png", "height" : 200, "supported" : false, "unit" : "px", "width" : 200 }, "meta" : { "key1" : "value1", "key2" : "value2" }, "mode" : { "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ] } }, "monitoring" : { "id" : "019f5b2e-cd14-77aa-8b48-1c707f9ebe33" }, "portalCarrierId" : "1351", "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "settings" : [ { "context" : "SHIPMENT", "defaultValue" : "PC", "description" : "Customer Number", "externalReference" : "custNo", "key" : "TEXT4", "route" : { "fromCountryCode" : "SE", "toCountryCode" : "DE" }, "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false, "maxLength" : 10, "minLength" : 2, "precision" : 2, "type" : "STRING" } } ], "staging" : { "documentationUrl" : "https://docs.example.com/staging", "mandatory" : false, "onboardingUrl" : "https://onboarding.example.com" } } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] }, { "AdminToken" : [ ] } ] } }, "/v1/carriers/{carrier-id}/services" : { "get" : { "tags" : [ "Carriers" ], "summary" : "List Services for a carrier", "description" : "Lists all Services for a Carrier.\nProvide the `carrier-id` returned from the List Carriers endpoint.\nProvide `route_from` and `route_to` for route-specific validation.\nReturns a paginated list of Services.", "operationId" : "listServicesByCarrier", "parameters" : [ { "name" : "carrier-id", "in" : "path", "description" : "Carrier id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "route_from", "in" : "query", "description" : "Route from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/CountryCode", "example" : "SE" }, "example" : "SE" }, { "name" : "route_to", "in" : "query", "description" : "Route to.", "required" : false, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/CountryCode", "example" : "SE" }, "example" : "SE" }, { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceListResponse" }, "example" : { "items" : [ { "id" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82", "updatedAt" : "2024-07-01T00:00:00+00:00", "name" : "UPS", "access" : false, "addons" : [ { "id" : "2b71b8f1-6d27-4b63-8093-d31257d46d4f", "access" : false, "code" : "DLVNOPOD", "combine" : [ { "addons" : [ { } ], "allowed" : false } ], "description" : "Delivery without POD", "explicitRoutes" : false, "fields" : [ { "context" : "SHIPMENT", "defaultValue" : "PC", "description" : "Customer Number", "externalReference" : "custNo", "key" : "TEXT4", "route" : { "fromCountryCode" : "SE", "toCountryCode" : "DE" }, "validations" : { "allowedValues" : [ ], "mandatory" : false, "maxLength" : 10, "minLength" : 2, "precision" : 2, "type" : "STRING" } } ], "obsolete" : false, "portalReferences" : { "addonId" : "345675" }, "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "routes" : [ { "condition" : [ "POSTAL_CODE_BASED", "AGREEMENT_BASED" ], "domestic" : false, "dutiable" : false, "fromCountryCodes" : [ "US" ], "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "toCountryCodes" : [ "US" ] } ] } ], "addressValidations" : [ { "companyIdentification" : [ { "context" : "SHIPMENT", "description" : "Delivery instructions", "externalReference" : "EXT-REF-123", "key" : "TEXT4", "validations" : { "allowedValues" : [ ], "mandatory" : false, "maxLength" : 10, "minLength" : 2, "precision" : 2, "type" : "STRING" } } ], "conditions" : { "roles" : [ "SENDER", "RECEIVER" ] }, "maxLinesLength" : 35, "requiredCompanyName" : false, "requiredContactCareOf" : false, "requiredContactDoorCode" : false, "requiredContactEmail" : false, "requiredContactFax" : false, "requiredContactFirstName" : false, "requiredContactLastName" : false, "requiredContactMobile" : false, "requiredContactPhone" : false, "requiredLocationBuildingName" : false, "requiredLocationBuildingNumber" : false, "requiredLocationCity" : false, "requiredLocationCountryCode" : false, "requiredLocationFloor" : false, "requiredLocationLocality" : false, "requiredLocationPostalCode" : false, "requiredLocationRegion" : false, "requiredLocationStateCode" : false, "requiredLocationStreetName" : false, "requiredLocationStreetNumber" : false, "requiredLocationUnit" : false, "requiredReferencesExternal" : false, "requiredReferencesInternal" : false } ], "carrierCode" : "2b71b8f1", "carrierId" : "8c2b9506-043c-3adb-918b-e134d3c36bd6", "carrierRates" : { "supported" : true }, "classification" : { "crossborder" : false, "returnService" : false }, "code" : "UPS", "consolidation" : { "supported" : false }, "criteria" : { "addressValidations" : false, "customsValidations" : false, "itemValidations" : true, "parcelValidations" : false, "postalCodeValidation" : false, "routeValidation" : false, "shipmentValidations" : false }, "customs" : { "declarationTypes" : [ { "mandatory" : false, "type" : "CN22DHLECOM" } ], "supported" : true }, "customsDeclarationTypes" : [ { "id" : "019ad761-9247-79b3-8cda-416fc404bbe9", "access" : false, "addressValidations" : [ { "companyIdentification" : [ { } ], "conditions" : { "roles" : [ "SENDER", "RECEIVER" ] }, "maxLinesLength" : 35, "requiredCompanyName" : false, "requiredContactCareOf" : false, "requiredContactDoorCode" : false, "requiredContactEmail" : false, "requiredContactFax" : false, "requiredContactFirstName" : false, "requiredContactLastName" : false, "requiredContactMobile" : false, "requiredContactPhone" : false, "requiredLocationBuildingName" : false, "requiredLocationBuildingNumber" : false, "requiredLocationCity" : false, "requiredLocationCountryCode" : false, "requiredLocationFloor" : false, "requiredLocationLocality" : false, "requiredLocationPostalCode" : false, "requiredLocationRegion" : false, "requiredLocationStateCode" : false, "requiredLocationStreetName" : false, "requiredLocationStreetNumber" : false, "requiredLocationUnit" : false, "requiredReferencesExternal" : false, "requiredReferencesInternal" : false } ], "charges" : { "supportsDuty" : false, "supportsFreight" : false, "supportsInsurance" : false, "supportsInvoice" : false, "supportsOther" : false }, "comments" : { "validations" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "criteria" : { "addressValidations" : false, "itemValidations" : false }, "currencies" : [ "NOK", "SEK", "USD" ], "description" : "Bring VOEC", "documentTypes" : [ { "contentTypes" : [ { } ], "description" : "Bring VOEC", "mediaTypes" : [ { } ], "type" : "CUSTOMS_DOCUMENT" } ], "invoice" : { "itemLimit" : false, "maxItems" : 1 }, "itemValidations" : [ { "conditions" : [ { } ], "pricing" : { "countryOfOrigin" : { }, "tariffNumber" : { }, "unitPrice" : { } }, "product" : { "composition" : { }, "description" : { }, "identification" : { }, "weight" : { } } } ], "paperless" : true, "parties" : [ { "mandatory" : false, "role" : "SENDER" } ], "purpose" : { "code" : { "validations" : { "allowedValues" : [ ], "mandatory" : false } }, "defaultValue" : "DEFAULT_DECLARATION", "description" : "Customs declaration for imported goods", "type" : "CUSTOMS_DECLARATION" }, "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "statements" : { "validations" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "terms" : { "code" : { "validations" : { "allowedValues" : [ ], "mandatory" : false } }, "defaultValue" : "DEFAULT_DECLARATION", "description" : "Customs declaration for imported goods", "type" : "CUSTOMS_DECLARATION" }, "type" : "BRINGEDI" } ], "dangerousGoods" : { "declarationTypes" : [ { "id" : "328af029-7629-3355-a6df-029593db9d82", "access" : false, "carrierId" : "123e4567-e89b-12d3-a456-426614174000", "code" : "ADR", "description" : "European Agreement concerning the International Carriage of Dangerous Goods by Road", "documentTypes" : [ { "contentTypes" : [ ], "description" : "Bring VOEC", "mediaTypes" : [ ], "type" : "CUSTOMS_DOCUMENT" } ], "goods" : { "explicitTypes" : true, "itemLimit" : false, "maxItems" : 50, "maxParcels" : 10, "netQuantityMandatory" : true, "netQuantityUnits" : [ "example" ], "packingGroup" : { "validations" : { } }, "parcelLimit" : false, "types" : [ ] }, "handling" : { "items" : [ { } ] }, "modal" : { "validations" : { "allowedValues" : [ ], "mandatory" : false } }, "paperless" : true, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "standard" : "example", "type" : "ADR" } ], "explicitRoutes" : false, "goods" : { "hazard" : { "code" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "environmental" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "flashPoint" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "hazardClass" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "itemLimit" : true, "maxItems" : 1, "maxParcels" : 1, "notes" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "packing" : { "group" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "type" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "parcelLimit" : true, "technicalName" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "transportation" : { "emergencyCode" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "separation" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" }, "tunnelRestriction" : { "allowedValues" : [ { } ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } } }, "packingCodeType" : { "code" : { "defaultValue" : "UPSTermsOfSale", "validations" : { "allowedValues" : [ { } ], "mandatory" : false } }, "type" : "GSPackageCode" }, "packingTypes" : [ { "description" : "Package", "type" : "PACKAGE" } ], "routes" : [ { "condition" : [ "POSTAL_CODE_BASED", "AGREEMENT_BASED" ], "domestic" : false, "dutiable" : false, "fromCountryCodes" : [ "US" ], "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "toCountryCodes" : [ "US" ] } ], "supported" : true }, "deliveryBooking" : { "date" : { "format" : "date", "mandatory" : false, "supported" : false }, "timeFrom" : { "format" : "date", "mandatory" : false, "supported" : false }, "timeTo" : { "format" : "date", "mandatory" : false, "supported" : false } }, "documentTypes" : [ { "contentTypes" : [ { "description" : "Portable Document Format", "type" : "pdf" } ], "description" : "Bring VOEC", "mediaTypes" : [ { "description" : "Normal A4 paper", "type" : "laser-a4" } ], "type" : "CUSTOMS_DOCUMENT" } ], "explicitRoutes" : false, "fields" : [ { "context" : "SHIPMENT", "defaultValue" : "PC", "description" : "Customer Number", "externalReference" : "custNo", "key" : "TEXT4", "route" : { "fromCountryCode" : "SE", "toCountryCode" : "DE" }, "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false, "maxLength" : 10, "minLength" : 2, "precision" : 2, "type" : "STRING" } } ], "itemValidations" : [ { "conditions" : { "dangerousGoodsDeclarationTypes" : [ "example" ] }, "dangerousGoods" : { "netQuantity" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "netQuantityUnit" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "quantity" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } }, "type" : { "validations" : { "allowedValues" : [ ], "extended" : "{\"customRule\": \"value\"}", "intervalOf" : 0.5, "mandatory" : false, "maxDecimals" : 2, "maxItems" : 10, "maxLength" : 100, "maxValue" : 999.99, "minDecimals" : 0, "minItems" : 1, "minLength" : 5, "minValue" : 0.01, "notEmpty" : false, "pattern" : "^[A-Z0-9]+$" } } } } ], "manifest" : { "supported" : false, "types" : [ { "description" : "Portable Document Format", "documentTypes" : [ { "contentTypes" : [ ], "description" : "Bring VOEC", "mediaTypes" : [ ], "type" : "CUSTOMS_DOCUMENT" } ], "type" : "PDF" } ] }, "meta" : { "key1" : "value1", "key2" : "value2" }, "obsolete" : false, "packingCodeType" : { "code" : { "defaultValue" : "UPSTermsOfSale", "validations" : { "allowedValues" : [ { "description" : "Package", "value" : "PACKAGE" } ], "mandatory" : false } }, "type" : "GSPackageCode" }, "packingTypes" : [ { "description" : "Package", "type" : "PACKAGE" } ], "parcelValidations" : [ { "conditions" : [ { "addons" : [ "ADDON1", "ADDON2" ], "explicitRoutes" : false, "packingCodeTypes" : [ "PC", "GS" ], "routes" : [ { } ] } ], "maxHeight" : 80, "maxLength" : 120, "maxTotalDimensions" : 300, "maxVolume" : 2.5, "maxWeight" : 30, "maxWidth" : 100, "minHeight" : 1, "minLength" : 1, "minTotalDimensions" : 15, "minVolume" : 0.001, "minWeight" : 0.1, "minWidth" : 1 } ], "parties" : [ { "mandatory" : false, "role" : "SENDER" } ], "pickupBooking" : { "acceptsDate" : false, "mandatory" : false, "supported" : false }, "portalReferences" : { "carrierId" : "00000000-0000-0000-0000-0000000003B6", "serviceId" : "00000000-0000-0000-0000-00000000245C" }, "pudoPoints" : { "cached" : { "externalReference" : "PostNord", "supported" : false }, "externalReference" : "PostNord", "operationTypes" : [ "locker", "shop" ], "roles" : [ "DELIVERY" ], "supported" : false }, "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "returnService" : { "id" : "2b71b8f1-6d27-4b63-8093-d31257d46d4f", "name" : "UPS", "code" : "UPS" }, "routes" : [ { "condition" : [ "POSTAL_CODE_BASED", "AGREEMENT_BASED" ], "domestic" : false, "dutiable" : false, "fromCountryCodes" : [ "US" ], "restrictions" : { "applied" : false, "note" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier." }, "toCountryCodes" : [ "US" ] } ], "serials" : [ { "id" : "123e4567-e89b-12d3-a456-426614174000", "name" : "Standard Serial Type", "checkDigitMethod" : "MOD10", "code" : "SERIAL01", "pattern" : "^[A-Z]{2}[0-9]{8}$" } ], "shipmentValidations" : [ { "conditions" : [ { "addons" : [ "ADDON1", "ADDON2" ], "explicitRoutes" : false, "packingCodeTypes" : [ "PC", "GS" ], "routes" : [ { } ] } ], "maxParcels" : 10, "maxVolume" : 5.0, "maxWeight" : 100, "minParcels" : 1, "minVolume" : 0.01, "minWeight" : 0.1 } ], "terms" : { "code" : { "defaultValue" : "DAP", "validations" : { "allowedValues" : [ { "description" : "Express shipment service", "value" : "EXPRESS_SHIPMENT" } ], "mandatory" : false } } }, "voiding" : { "limitation" : "QUEUE", "note" : "This feature is only applicable within the timeframe before EDI is sent to carrier (every 5min).", "supported" : false } } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] }, { "AdminToken" : [ ] } ] } }, "/v1/carrier-logos/{carrier-logo-id}" : { "get" : { "tags" : [ "Carrier Logos" ], "summary" : "Fetch Carrier Logo", "description" : "Fetches a carrier logo by its unique identifier. Returns the logo as a PNG image with caching headers.", "operationId" : "fetchCarrierLogo", "parameters" : [ { "name" : "carrier-logo-id", "in" : "path", "description" : "Unique identifier of the carrier logo", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier of the carrier logo", "example" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "maxLength" : 36 }, "example" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890" } ], "responses" : { "200" : { "description" : "Carrier logo image data retrieved", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "image/png" : { "schema" : { "type" : "string", "format" : "binary", "maxLength" : 10485760 }, "example" : "example" } } }, "401" : { "description" : "Unauthorized access", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal server error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] }, { "AdminToken" : [ ] } ] } }, "/v1/service-definitions/{service-definition-id}" : { "get" : { "tags" : [ "Service Definitions" ], "summary" : "Fetch Service Definition", "description" : "Fetches a specific Service Definition. Provide `service-definition-id`. Returns the Service Definition.", "operationId" : "fetchServiceDefinition", "parameters" : [ { "name" : "service-definition-id", "in" : "path", "description" : "Identifies the Service Definition", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Service Definition", "example" : "019a8cc2-7ecd-7b05-ae3d-a3e82ca19827", "maxLength" : 36 }, "example" : "019a8cc2-7ecd-7b05-ae3d-a3e82ca19827" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceDefinitionResponse" }, "example" : { "id" : "01991a00-07b3-7171-a245-177e15965608", "createdAt" : "2024-01-15T10:30:00Z", "updatedAt" : "2024-01-15T10:30:00Z", "name" : "DHL Express for domestic B2C use", "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "carrierId" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "group" : "Express", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "serviceId" : "2b0ca74b-08fa-3726-800b-a7c0e01f9fcf" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "put" : { "tags" : [ "Service Definitions" ], "summary" : "Update Service Definition", "description" : "Updates an existing Service Definition. Provide `service-definition-id` and updated values. Returns confirmation (`204 No Content`).", "operationId" : "replaceServiceDefinition", "parameters" : [ { "name" : "service-definition-id", "in" : "path", "description" : "Identifies the Service Definition", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Service Definition", "example" : "019a8cc2-7ecd-7b05-ae3d-a3e82ca19827", "maxLength" : 36 }, "example" : "019a8cc2-7ecd-7b05-ae3d-a3e82ca19827" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceDefinitionRequest" }, "example" : { "name" : "PostNord for domestic B2C use", "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "group" : "UPS_saver", "persistence" : { "type" : "example" }, "serviceId" : "d9214010-7bb6-3e78-bbd5-c7b39f584722" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "delete" : { "tags" : [ "Service Definitions" ], "summary" : "Delete Service Definition", "description" : "Deletes an existing Service Definition. Provide `service-definition-id`. Returns confirmation (`204 No Content`).", "operationId" : "removeServiceDefinition", "parameters" : [ { "name" : "service-definition-id", "in" : "path", "description" : "Identifies the Service Definition", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Service Definition", "example" : "019a8cc2-7ecd-7b05-ae3d-a3e82ca19827", "maxLength" : 36 }, "example" : "019a8cc2-7ecd-7b05-ae3d-a3e82ca19827" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/carrier-definitions/{carrier-definition-id}" : { "get" : { "tags" : [ "Carrier Definitions" ], "summary" : "Fetch Carrier Definition", "description" : "Fetches a specific Carrier Definition. Provide `carrier-definition-id`. Returns the Carrier Definition.", "operationId" : "fetchCarrierDefinition", "parameters" : [ { "name" : "carrier-definition-id", "in" : "path", "description" : "Identifies the Carrier Definition", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Carrier Definition", "example" : "019a8cb2-394a-7689-8a09-1c96ee3cea88", "maxLength" : 36 }, "example" : "019a8cb2-394a-7689-8a09-1c96ee3cea88" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CarrierDefinitionResponse" }, "example" : { "id" : "019ade48-9368-7577-990d-987fe9b34324", "createdAt" : "2024-01-15T10:30:00Z", "updatedAt" : "2024-01-15T10:30:00Z", "name" : "DHL Express", "carrierId" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "group" : "Express", "mode" : "STAGING", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "settings" : [ { "key" : "api-key", "value" : "5qqMQ5DhciBfJgBcGFyXYm66pl1lbgKV26v6ybKvcDkgMOO1BCv3iE68HDakvW9o" } ] } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "put" : { "tags" : [ "Carrier Definitions" ], "summary" : "Update Carrier Definition", "description" : "Updates an existing Carrier Definition. Provide `carrier-definition-id` and updated values. Returns confirmation (`204 No Content`).", "operationId" : "replaceCarrierDefinition", "parameters" : [ { "name" : "carrier-definition-id", "in" : "path", "description" : "Identifies the Carrier Definition", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Carrier Definition", "example" : "019a8cb2-394a-7689-8a09-1c96ee3cea88", "maxLength" : 36 }, "example" : "019a8cb2-394a-7689-8a09-1c96ee3cea88" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CarrierDefinitionRequest" }, "example" : { "name" : "DHL Home Delivery", "carrierId" : "24260549-47a1-390b-a211-da8989984a08", "group" : "UPS_saver", "mode" : "STAGING", "persistence" : { "type" : "example" }, "settings" : [ { "key" : "api-key", "value" : "5qqMQ5DhciBfJgBcGFyXYm66pl1lbgKV26v6ybKvcDkgMOO1BCv3iE68HDakvW9o" } ] } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "delete" : { "tags" : [ "Carrier Definitions" ], "summary" : "Delete Carrier Definition", "description" : "Deletes an existing Carrier Definition. Provide `carrier-definition-id`. Returns confirmation (`204 No Content`).", "operationId" : "removeCarrierDefinition", "parameters" : [ { "name" : "carrier-definition-id", "in" : "path", "description" : "Identifies the Carrier Definition", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Carrier Definition", "example" : "019a8cb2-394a-7689-8a09-1c96ee3cea88", "maxLength" : 36 }, "example" : "019a8cb2-394a-7689-8a09-1c96ee3cea88" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/service-definitions" : { "get" : { "tags" : [ "Service Definitions" ], "summary" : "List Service Definitions", "description" : "Lists Service Definitions. Returns a paginated list of Service Definitions.", "operationId" : "listServiceDefinitions", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "group", "in" : "query", "description" : "The group filtering criteria", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "UPS_saver", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "example" : "UPS_saver" }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "ASC" }, "example" : "ASC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceDefinitionListResponse" }, "example" : { "items" : [ { "id" : "01991a00-07b3-7171-a245-177e15965608", "createdAt" : "2024-01-15T10:30:00Z", "updatedAt" : "2024-01-15T10:30:00Z", "name" : "DHL Express for domestic B2C use", "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "carrierId" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "group" : "Express", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "serviceId" : "2b0ca74b-08fa-3726-800b-a7c0e01f9fcf" } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "post" : { "tags" : [ "Service Definitions" ], "summary" : "Create Service Definition", "description" : "Creates a new Service Definition. Provide `service-id`. Returns the `service-definition-id`.", "operationId" : "createServiceDefinition", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceDefinitionRequest" }, "example" : { "name" : "PostNord for domestic B2C use", "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "group" : "UPS_saver", "persistence" : { "type" : "example" }, "serviceId" : "d9214010-7bb6-3e78-bbd5-c7b39f584722" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BasicResponse" }, "example" : { "id" : "01991a03-c860-7000-bb91-5a9cb479f522" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/carrier-definitions" : { "get" : { "tags" : [ "Carrier Definitions" ], "summary" : "List Carrier Definitions", "description" : "Lists Carrier Definitions. Returns a paginated list of Carrier Definitions.", "operationId" : "listCarrierDefinitions", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "group", "in" : "query", "description" : "The group filtering criteria", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "UPS_saver", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "example" : "UPS_saver" }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "ASC" }, "example" : "ASC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CarrierDefinitionListResponse" }, "example" : { "items" : [ { "id" : "019ade48-9368-7577-990d-987fe9b34324", "createdAt" : "2024-01-15T10:30:00Z", "updatedAt" : "2024-01-15T10:30:00Z", "name" : "DHL Express", "carrierId" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "group" : "Express", "mode" : "STAGING", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "settings" : [ { "key" : "api-key", "value" : "5qqMQ5DhciBfJgBcGFyXYm66pl1lbgKV26v6ybKvcDkgMOO1BCv3iE68HDakvW9o" } ] } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "post" : { "tags" : [ "Carrier Definitions" ], "summary" : "Create Carrier Definition", "description" : "Creates a new Carrier Definition. Provide `carrier-id. Returns the `carrier-definition-id`.", "operationId" : "createCarrierDefinition", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CarrierDefinitionRequest" }, "example" : { "name" : "DHL Home Delivery", "carrierId" : "24260549-47a1-390b-a211-da8989984a08", "group" : "UPS_saver", "mode" : "STAGING", "persistence" : { "type" : "example" }, "settings" : [ { "key" : "api-key", "value" : "5qqMQ5DhciBfJgBcGFyXYm66pl1lbgKV26v6ybKvcDkgMOO1BCv3iE68HDakvW9o" } ] } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BasicResponse" }, "example" : { "id" : "01991a03-c860-7000-bb91-5a9cb479f522" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/trackers/{tracker-id}" : { "get" : { "tags" : [ "Trackers" ], "summary" : "Fetch Tracker", "description" : "Fetches a specific Tracker. Provide `tracker-id`. \nReturns the Tracker.\n", "operationId" : "fetchTracker", "parameters" : [ { "name" : "tracker-id", "in" : "path", "description" : "Tracker id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TrackerResponse" }, "example" : { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "status" : "BOOKED", "logs" : [ { "createdAt" : "2026-04-27T11:12:08Z", "category" : "example", "message" : "The document type LABEL failed to process, please try regenerating documents.", "payload" : { "id" : "019dcea3-b444-7073-bc96-9533c4ad830c", "normalizedStatus" : "example", "sourceEventCode" : "example", "tookPlaceAt" : "2026-01-01T10:00:00" }, "topic" : "DOCUMENTS", "type" : "ERROR" } ], "parcels" : [ { "status" : "BOOKED", "reference" : "#45678", "serial" : "473325380000006010", "link" : "https://track.example.com/?parcel=00001234567890123456" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "shipment" : { "status" : "BOOKED", "serial" : "00001234567890123456", "link" : "https://..." } } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "put" : { "tags" : [ "Trackers" ], "summary" : "Update Tracker", "description" : "Updates an existing Tracker. Provide `tracker-id` and updated parameters. \nReturns confirmation (`204 No Content`).\n", "operationId" : "replaceTracker", "parameters" : [ { "name" : "tracker-id", "in" : "path", "description" : "Tracker id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TrackerRequest" }, "example" : { "status" : "BOOKED", "parcels" : [ { "status" : "BOOKED", "reference" : "#45678", "serial" : "473325380000006010", "link" : "https://track.example.com/?parcel=00001234567890123456" } ], "persistence" : { "type" : "example" }, "shipment" : { "status" : "BOOKED", "serial" : "00001234567890123456", "link" : "https://..." } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "delete" : { "tags" : [ "Trackers" ], "summary" : "Delete Tracker", "description" : "Deletes an existing Tracker. Provide `tracker-id`. \nReturns confirmation (`204 No Content`).\n\n**Note:** This operation voids the tracker, sets its status to VOID, and triggers a DELETE call to remove the associated shipment.\n", "operationId" : "removeTracker", "parameters" : [ { "name" : "tracker-id", "in" : "path", "description" : "Tracker id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "403" : { "description" : "Returned when the caller is a `SHARED` account, which has no Delivery account to run this operation.", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipment-dispatches/{shipment-dispatch-id}" : { "get" : { "tags" : [ "Shipment Dispatches" ], "summary" : "Fetch Shipment Dispatch", "description" : "Fetches a specific Shipment Dispatch. Provide `shipment-dispatch-id`. Returns the Shipment Dispatch.\n", "operationId" : "fetchShipmentDispatch", "parameters" : [ { "name" : "shipment-dispatch-id", "in" : "path", "description" : "Shipment dispatch id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentDispatchResponse" }, "example" : { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "reference" : "DISPATCH-001", "carrierId" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "chargeables" : { "addons" : [ { "code" : "INSU" } ], "dimensionsUnit" : "CM", "palletCount" : 10, "pallets" : [ { "count" : 5, "type" : "EPAL-1" } ], "palletType" : "EPAL-1", "parcelCount" : 10, "shipmentCount" : 1, "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "KG" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "shipmentBookingIds" : [ "019c1dd1-5344-7d56-bb3d-dc338e80488a", "019c1dcb-0d63-7917-9c1d-00be28e7282b" ], "state" : { "finalized" : false, "manifested" : false }, "tracker" : { "id" : "00000000-0000-7000-8000-000000000000", "createdAt" : "2024-01-01T00:00:00Z", "updatedAt" : "2024-01-01T00:00:00Z", "status" : "BOOKED", "loadBearers" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ], "manifest" : { "serial" : "ABC123456789", "link" : "https://..." }, "motherShipment" : { "serial" : "ABC123456789", "link" : "https://..." }, "parcels" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ], "shipments" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ] } } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "put" : { "tags" : [ "Shipment Dispatches" ], "summary" : "Update Shipment Dispatch", "description" : "Updates an existing Shipment Dispatch. Provide `shipment-dispatch-id` and `shipmentBookingIds`, along with updated values. Returns confirmation (`204 No Content`).", "operationId" : "replaceShipmentDispatch", "parameters" : [ { "name" : "shipment-dispatch-id", "in" : "path", "description" : "Shipment dispatch id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentDispatchRequest" }, "example" : { "reference" : "S-12345", "persistence" : { "type" : "example" }, "shipmentBookingIds" : [ "019c1dd1-5344-7d56-bb3d-dc338e80488a", "019c1dcb-0d63-7917-9c1d-00be28e7282b" ] } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "delete" : { "tags" : [ "Shipment Dispatches" ], "summary" : "Delete Shipment Dispatch", "description" : "Deletes an existing Shipment Dispatch. Provide `shipment-dispatch-id`. Returns confirmation (`204 No Content`).", "operationId" : "removeShipmentDispatch", "parameters" : [ { "name" : "shipment-dispatch-id", "in" : "path", "description" : "Shipment dispatch id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipment-dispatch-trackers/{dispatch-tracker-id}" : { "get" : { "tags" : [ "Shipment Dispatch Trackers" ], "summary" : "Fetch Shipment Dispatch Tracker", "description" : "Fetches a specific Shipment Dispatch Tracker. Provide `dispatch-tracker-id`. Returns the Shipment Dispatch Tracker.", "operationId" : "fetchShipmentDispatchTracker", "parameters" : [ { "name" : "dispatch-tracker-id", "in" : "path", "description" : "Dispatch tracker id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentDispatchTracker" }, "example" : { "id" : "00000000-0000-7000-8000-000000000000", "createdAt" : "2024-01-01T00:00:00Z", "updatedAt" : "2024-01-01T00:00:00Z", "status" : "BOOKED", "loadBearers" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ], "manifest" : { "serial" : "ABC123456789", "link" : "https://..." }, "motherShipment" : { "serial" : "ABC123456789", "link" : "https://..." }, "parcels" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ], "shipments" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ] } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "put" : { "tags" : [ "Shipment Dispatch Trackers" ], "summary" : "Replace Shipment Dispatch Tracker", "description" : "Replaces an existing Shipment Dispatch Tracker. Provide `dispatch-tracker-id` and updated tracker data. Returns confirmation (`204 No Content`).", "operationId" : "replaceShipmentDispatchTracker", "parameters" : [ { "name" : "dispatch-tracker-id", "in" : "path", "description" : "Dispatch tracker id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentDispatchTrackerRequest" }, "example" : { "status" : "BOOKED", "loadBearers" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ], "manifest" : { "serial" : "ABC123456789", "link" : "https://..." }, "motherShipment" : { "serial" : "ABC123456789", "link" : "https://..." }, "parcels" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ], "persistence" : { "type" : "example" }, "shipments" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ] } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "delete" : { "tags" : [ "Shipment Dispatch Trackers" ], "summary" : "Void Shipment Dispatch Tracker", "description" : "Voids a Shipment Dispatch Tracker. Provide `dispatch-tracker-id`. Sets the tracker status to `VOID` and refreshes `updatedAt`; the record is not hard-deleted. This is a GO-only operation and does NOT trigger any Delivery call. Returns `204 No Content`. Returns `409 Conflict` if the tracker is already voided.", "operationId" : "voidShipmentDispatchTracker", "parameters" : [ { "name" : "dispatch-tracker-id", "in" : "path", "description" : "Dispatch tracker id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "409" : { "description" : "Conflict", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipment-channels/{shipment-channel-id}" : { "get" : { "tags" : [ "Shipment Channels" ], "summary" : "Fetch Shipment Channel", "description" : "Fetches a specific Shipment Channel. Provide `shipment-channel-id`. Returns the Shipment Channel.", "operationId" : "fetchShipmentChannel", "parameters" : [ { "name" : "shipment-channel-id", "in" : "path", "description" : "Shipment channel id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentChannelResponse" }, "example" : { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "name" : "My shipment channel", "documentRendering" : { "enabled" : false, "settings" : [ { "contentType" : "pdf", "documentType" : "LABEL", "enabled" : false, "mediaType" : "thermo-190", "offsetX" : 0.0, "offsetY" : 0.0, "options" : { "mode" : "DT" }, "pageBreak" : false } ] }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pickup" : { "enabled" : false, "slots" : [ { "name" : "Monday morning", "active" : false, "conditions" : { "carrierId" : "8c2b9506-043c-3adb-918b-e134d3c36bd6", "serviceId" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82" }, "description" : "example", "instructions" : [ "example" ], "leadTime" : 2, "recurrence" : { "timeFrom" : "08:00", "timeTo" : "10:00", "weekday" : "MO" } } ] }, "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" } } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "put" : { "tags" : [ "Shipment Channels" ], "summary" : "Update Shipment Channel", "description" : "Updates an existing Shipment Channel. Provide `shipment-channel-id` and updated values. Returns confirmation (`204 No Content`).", "operationId" : "replaceShipmentChannel", "parameters" : [ { "name" : "shipment-channel-id", "in" : "path", "description" : "Shipment channel id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentChannelRequest" }, "example" : { "name" : "My shipment channel", "documentRendering" : { "enabled" : false, "settings" : [ { "contentType" : "pdf", "documentType" : "LABEL", "enabled" : false, "mediaType" : "thermo-190", "offsetX" : 0.0, "offsetY" : 0.0, "options" : { "mode" : "DT" }, "pageBreak" : false } ] }, "persistence" : { "type" : "example" }, "pickup" : { "enabled" : false, "slots" : [ { "name" : "Monday morning", "active" : false, "conditions" : { "carrierId" : "8c2b9506-043c-3adb-918b-e134d3c36bd6", "serviceId" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82" }, "description" : "example", "instructions" : [ "example" ], "leadTime" : 2, "recurrence" : { "timeFrom" : "08:00", "timeTo" : "10:00", "weekday" : "MO" } } ] }, "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "delete" : { "tags" : [ "Shipment Channels" ], "summary" : "Delete Shipment Channel", "description" : "Deletes an existing Shipment Channel. Provide `shipment-channel-id`. Returns confirmation (`204 No Content`).", "operationId" : "removeShipmentChannel", "parameters" : [ { "name" : "shipment-channel-id", "in" : "path", "description" : "Shipment channel id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipment-dispatches" : { "get" : { "tags" : [ "Shipment Dispatches" ], "summary" : "List Shipment Dispatches", "description" : "Lists Shipment Dispatches. Returns a paginated list of Shipment Dispatches.", "operationId" : "listShipmentDispatches", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentDispatchListResponse" }, "example" : { "items" : [ { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "reference" : "DISPATCH-001", "carrierId" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "chargeables" : { "addons" : [ { "code" : "INSU" } ], "dimensionsUnit" : "CM", "palletCount" : 10, "pallets" : [ { "count" : 5, "type" : "EPAL-1" } ], "palletType" : "EPAL-1", "parcelCount" : 10, "shipmentCount" : 1, "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "KG" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "shipmentBookingIds" : [ "019c1dd1-5344-7d56-bb3d-dc338e80488a", "019c1dcb-0d63-7917-9c1d-00be28e7282b" ], "state" : { "finalized" : false, "manifested" : false }, "tracker" : { "id" : "00000000-0000-7000-8000-000000000000", "createdAt" : "2024-01-01T00:00:00Z", "updatedAt" : "2024-01-01T00:00:00Z", "status" : "BOOKED", "loadBearers" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ], "manifest" : { "serial" : "ABC123456789", "link" : "https://..." }, "motherShipment" : { "serial" : "ABC123456789", "link" : "https://..." }, "parcels" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ], "shipments" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ] } } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "post" : { "tags" : [ "Shipment Dispatches" ], "summary" : "Create Shipment Dispatch", "description" : "Creates a new Shipment Dispatch. Provide `shipmentBookingIds`. Returns the `shipment-dispatch-id`.\n", "operationId" : "createShipmentDispatch", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentDispatchRequest" }, "example" : { "reference" : "S-12345", "persistence" : { "type" : "example" }, "shipmentBookingIds" : [ "019c1dd1-5344-7d56-bb3d-dc338e80488a", "019c1dcb-0d63-7917-9c1d-00be28e7282b" ] } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BasicResponse" }, "example" : { "id" : "01991a03-c860-7000-bb91-5a9cb479f522" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipment-dispatches/{shipment-dispatch-id}/shipment-manifests" : { "post" : { "tags" : [ "Shipment Dispatches" ], "summary" : "Create Shipment Manifest", "description" : "Creates a new Shipment Manifest. Provide `shipment-dispatch-id`, `type`, and `shipmentChannelId`. Returns the `shipment-manifest-id`.\n", "operationId" : "createShipmentManifest", "parameters" : [ { "name" : "shipment-dispatch-id", "in" : "path", "description" : "Shipment dispatch id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentManifestRequest" }, "example" : { "reference" : "S-12345", "loadBearers" : [ { "group" : "Pallet" } ], "persistence" : { "type" : "example" }, "shipmentChannelId" : "00000000-0000-7000-8000-000000000000", "type" : "example" } } }, "required" : true }, "responses" : { "403" : { "description" : "Returned when the caller is a `SHARED` account, which has no Delivery account to run this operation.", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentManifestResponse" }, "example" : { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "reference" : "MANIFEST-001", "documents" : [ { "id" : "019ad95e-4b32-7a61-99fb-4367638dd836", "contentType" : "pdf", "documentType" : "LABEL", "mediaType" : "laser-a4", "pages" : 1 } ], "logs" : [ { "createdAt" : "2026-04-27T11:12:08Z", "category" : "example", "message" : "The document type LABEL failed to process, please try regenerating documents.", "payload" : { "id" : "019dcea3-b444-7073-bc96-9533c4ad830c", "normalizedStatus" : "example", "sourceEventCode" : "example", "tookPlaceAt" : "2026-01-01T10:00:00" }, "topic" : "DOCUMENTS", "type" : "ERROR" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "shipmentDispatch" : { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "reference" : "DISPATCH-001", "carrierId" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "chargeables" : { "addons" : [ { "code" : "INSU" } ], "dimensionsUnit" : "CM", "palletCount" : 10, "pallets" : [ { "count" : 5, "type" : "EPAL-1" } ], "palletType" : "EPAL-1", "parcelCount" : 10, "shipmentCount" : 1, "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "KG" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "shipmentBookingIds" : [ "019c1dd1-5344-7d56-bb3d-dc338e80488a", "019c1dcb-0d63-7917-9c1d-00be28e7282b" ], "state" : { "finalized" : false, "manifested" : false }, "tracker" : { "id" : "00000000-0000-7000-8000-000000000000", "createdAt" : "2024-01-01T00:00:00Z", "updatedAt" : "2024-01-01T00:00:00Z", "status" : "BOOKED", "loadBearers" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ], "manifest" : { "serial" : "ABC123456789", "link" : "https://..." }, "motherShipment" : { "serial" : "ABC123456789", "link" : "https://..." }, "parcels" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ], "shipments" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ] } }, "type" : "SBTL" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipment-dispatches/{shipment-dispatch-id}/shipment-manifests/inline" : { "post" : { "tags" : [ "Shipment Dispatches" ], "summary" : "Create Shipment Manifest (Inline)", "description" : "Creates a new Shipment Manifest using inline payload. Provide `shipment-dispatch-id`, `type`, and an embedded `shipmentChannel`. Returns the `shipment-manifest-id`.\n", "operationId" : "createInlineShipmentManifest", "parameters" : [ { "name" : "shipment-dispatch-id", "in" : "path", "description" : "Shipment dispatch id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InlineShipmentManifestRequest" }, "example" : { "reference" : "S-12345", "loadBearers" : [ { "group" : "Pallet" } ], "shipmentChannel" : { "name" : "My shipment channel", "documentRendering" : { "enabled" : false, "settings" : [ { "contentType" : "pdf", "documentType" : "LABEL", "enabled" : false, "mediaType" : "thermo-190", "offsetX" : 0.0, "offsetY" : 0.0, "options" : { "mode" : "DT" }, "pageBreak" : false } ] }, "pickup" : { "enabled" : false, "slots" : [ { "name" : "Monday morning", "active" : false, "conditions" : { "carrierId" : "8c2b9506-043c-3adb-918b-e134d3c36bd6", "serviceId" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82" }, "description" : "example", "instructions" : [ "example" ], "leadTime" : 2, "recurrence" : { "timeFrom" : "08:00", "timeTo" : "10:00", "weekday" : "MO" } } ] }, "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" } }, "type" : "example" } } }, "required" : true }, "responses" : { "403" : { "description" : "Returned when the caller is a `SHARED` account, which has no Delivery account to run this operation.", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentManifestResponse" }, "example" : { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "reference" : "MANIFEST-001", "documents" : [ { "id" : "019ad95e-4b32-7a61-99fb-4367638dd836", "contentType" : "pdf", "documentType" : "LABEL", "mediaType" : "laser-a4", "pages" : 1 } ], "logs" : [ { "createdAt" : "2026-04-27T11:12:08Z", "category" : "example", "message" : "The document type LABEL failed to process, please try regenerating documents.", "payload" : { "id" : "019dcea3-b444-7073-bc96-9533c4ad830c", "normalizedStatus" : "example", "sourceEventCode" : "example", "tookPlaceAt" : "2026-01-01T10:00:00" }, "topic" : "DOCUMENTS", "type" : "ERROR" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "shipmentDispatch" : { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "reference" : "DISPATCH-001", "carrierId" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "chargeables" : { "addons" : [ { "code" : "INSU" } ], "dimensionsUnit" : "CM", "palletCount" : 10, "pallets" : [ { "count" : 5, "type" : "EPAL-1" } ], "palletType" : "EPAL-1", "parcelCount" : 10, "shipmentCount" : 1, "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "KG" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "shipmentBookingIds" : [ "019c1dd1-5344-7d56-bb3d-dc338e80488a", "019c1dcb-0d63-7917-9c1d-00be28e7282b" ], "state" : { "finalized" : false, "manifested" : false }, "tracker" : { "id" : "00000000-0000-7000-8000-000000000000", "createdAt" : "2024-01-01T00:00:00Z", "updatedAt" : "2024-01-01T00:00:00Z", "status" : "BOOKED", "loadBearers" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ], "manifest" : { "serial" : "ABC123456789", "link" : "https://..." }, "motherShipment" : { "serial" : "ABC123456789", "link" : "https://..." }, "parcels" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ], "shipments" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ] } }, "type" : "SBTL" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipment-channels" : { "get" : { "tags" : [ "Shipment Channels" ], "summary" : "List Shipment Channels", "description" : "Lists Shipment Channels. Returns a paginated list of Shipment Channels.", "operationId" : "listShipmentChannels", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentChannelListResponse" }, "example" : { "items" : [ { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "name" : "My shipment channel", "documentRendering" : { "enabled" : false, "settings" : [ { "contentType" : "pdf", "documentType" : "LABEL", "enabled" : false, "mediaType" : "thermo-190", "offsetX" : 0.0, "offsetY" : 0.0, "options" : { "mode" : "DT" }, "pageBreak" : false } ] }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pickup" : { "enabled" : false, "slots" : [ { "name" : "Monday morning", "active" : false, "conditions" : { "carrierId" : "8c2b9506-043c-3adb-918b-e134d3c36bd6", "serviceId" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82" }, "description" : "example", "instructions" : [ "example" ], "leadTime" : 2, "recurrence" : { "timeFrom" : "08:00", "timeTo" : "10:00", "weekday" : "MO" } } ] }, "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" } } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "post" : { "tags" : [ "Shipment Channels" ], "summary" : "Create Shipment Channel", "description" : "Creates a new Shipment Channel.\nProvide `name` and `documentRendering`.\nReturns the `shipment-channel-id`.\n`accountId`", "operationId" : "createShipmentChannel", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentChannelRequest" }, "example" : { "name" : "My shipment channel", "documentRendering" : { "enabled" : false, "settings" : [ { "contentType" : "pdf", "documentType" : "LABEL", "enabled" : false, "mediaType" : "thermo-190", "offsetX" : 0.0, "offsetY" : 0.0, "options" : { "mode" : "DT" }, "pageBreak" : false } ] }, "persistence" : { "type" : "example" }, "pickup" : { "enabled" : false, "slots" : [ { "name" : "Monday morning", "active" : false, "conditions" : { "carrierId" : "8c2b9506-043c-3adb-918b-e134d3c36bd6", "serviceId" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82" }, "description" : "example", "instructions" : [ "example" ], "leadTime" : 2, "recurrence" : { "timeFrom" : "08:00", "timeTo" : "10:00", "weekday" : "MO" } } ] }, "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BasicResponse" }, "example" : { "id" : "01991a03-c860-7000-bb91-5a9cb479f522" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipment-bookings" : { "get" : { "tags" : [ "Shipment Bookings" ], "summary" : "List Shipment Bookings", "description" : "Lists Shipment Bookings. Returns a paginated list of Shipment Bookings.\n", "operationId" : "listShipmentBookings", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" }, { "name" : "channel_id", "in" : "query", "description" : "Channel id filtering criteria", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "parcel_id", "in" : "query", "description" : "Parcel id filtering criteria", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "shipment_serial", "in" : "query", "description" : "Shipment serial filtering criteria", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "parcel_serial", "in" : "query", "description" : "Parcel serial filtering criteria", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "document_id", "in" : "query", "description" : "Document id filtering criteria", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "parcel_portal_id", "in" : "query", "description" : "Parcel portal id filtering criteria", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentBookingListResponse" }, "example" : { "items" : [ { "id" : "019b26d6-73d6-7bf6-b1b6-4531af80e7d7", "createdAt" : "2026-01-22T10:30:00Z", "serial" : "6250112345", "carrierDefinition" : { "id" : "019ade48-9368-7577-990d-987fe9b34324", "createdAt" : "2024-01-15T10:30:00Z", "updatedAt" : "2024-01-15T10:30:00Z", "name" : "DHL Express", "carrierId" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "group" : "Express", "mode" : "STAGING", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "settings" : [ { "key" : "api-key", "value" : "5qqMQ5DhciBfJgBcGFyXYm66pl1lbgKV26v6ybKvcDkgMOO1BCv3iE68HDakvW9o" } ] }, "chargeables" : { "addons" : [ { "code" : "INSU" } ], "dimensionsUnit" : "CM", "palletCount" : 10, "pallets" : [ { "count" : 5, "type" : "EPAL-1" } ], "palletType" : "EPAL-1", "parcelCount" : 10, "shipmentCount" : 1, "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "KG" }, "customsDeclaration" : { "id" : "019ab521-5fc6-7836-8d3b-ba0f6e12e003", "reference" : "INV-2025-0001", "charges" : { "duty" : 75.0, "freight" : 250.0, "insurance" : 50.0, "invoice" : 1500.0, "other" : 20.0 }, "comments" : [ "Goods are samples and not for resale." ], "currency" : "EUR", "declarant" : { "city" : "Oslo", "firstName" : "John", "lastName" : "Doe", "title" : "Mr." }, "declaredAt" : "2024-07-01T00:00:00+00:00", "invoice" : { "items" : [ { "id" : "019ab5ae-7cbb-7665-94a8-86edb63c6191", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "ITEM-REF-001", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "number" : "INV-2025-0001" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "purpose" : { "code" : "GIFT" }, "statements" : [ "I hereby declare that the information contained in this declaration is true and complete to the best of my knowledge and belief." ], "terms" : { "code" : "DDP", "location" : "Rotterdam" }, "types" : [ "CN22" ] }, "dangerousGoods" : { "id" : "019c2076-1a28-7bee-a9b3-42312a50d1b0", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "DG-REF-12345", "declarant" : { "city" : "Stockholm", "firstName" : "John", "lastName" : "Doe", "title" : "Mr." }, "declaredAt" : "2021-09-01T12:00:00+02:00", "goods" : [ { "code" : "UN1950", "hazard" : { "code" : "F1", "environmental" : false, "flashPoint" : -20, "hazardClass" : "3" }, "notes" : [ "Handle with care" ], "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "group" : "II", "type" : "BOTTLE" }, "shippingName" : "Aerosols, flammable", "technicalName" : "Propane, Butane mixture", "transportation" : { "emergencyCode" : "2YE", "separation" : 3, "tunnelRestriction" : "D/E" }, "type" : "DG_01" } ], "goodsTypes" : [ "FLAMMABLE", "CORROSIVE" ], "handling" : [ "Aerosol containers are pressurized and may rupture if exposed to heat or physical damage.", "Handle carefully to prevent puncture, crushing, or leakage." ], "meta" : { "key1" : "value1", "key2" : "value2" }, "modal" : "ROAD", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "standard" : "IATA", "type" : "[\"SHIPPER\", \"MULTIMODAL\"]" }, "delivery" : { "instructions" : [ "Leave with the neighbour" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "08:00", "timeTo" : "16:00" } }, "documents" : [ { "id" : "019ad95e-4b32-7a61-99fb-4367638dd836", "contentType" : "pdf", "documentType" : "LABEL", "mediaType" : "laser-a4", "pages" : 1 } ], "info" : { "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "carrier" : { "reference" : "S-12345", "instructions" : [ "Leave parcel in reception" ] }, "delivery" : { "reference" : "S-12345", "instructions" : [ "Leave parcel in reception" ] }, "dispatch" : { "reference" : "S-12345", "instructions" : [ "Leave parcel in reception" ] }, "terms" : { "code" : "DDP", "location" : "Gothenburg" } }, "parcels" : [ { "id" : "019beadd-818c-792d-9bd4-ea04b0dbe23e", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "#45678", "serial" : "473325380000006010", "dangerousGoods" : [ { "netQuantity" : 10.5, "netQuantityUnit" : "KG", "quantity" : 5, "type" : "UN1950" } ], "description" : "This is a parcel description", "items" : [ { "id" : "019ab5ae-7cbb-7665-94a8-86edb63c6191", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "ITEM-REF-001", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "dimensionsUnit" : "M", "height" : 10.0, "length" : 10.0, "markings" : [ "THIS_SIDE_UP" ], "pallet" : { "group" : "GROUP-A", "type" : "EPAL-1" }, "type" : "PACKAGE", "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "G", "width" : 10.0 }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "weight" : 10.0, "weightUnit" : "G" } ], "parties" : [ { "address" : { "id" : "019b2766-8eb4-795c-899f-9ac8d5cc6a34", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "company" : { "name" : "nShift", "identification" : [ ] }, "contact" : { "careOf" : "Jane Smith", "doorCode" : "11", "email" : "jdoe@nshift.com", "fax" : "+46721234567", "firstName" : "John", "lastName" : "Doe", "mobile" : "+46721234567", "phone" : "+46721234567" }, "group" : "warehouse_1", "lines" : [ "John Doe c/o Mr Smith, nShift", "Schiller street 45, Neighborhood x", "Century Plaza 13, Floor 3, Apt 32", "District 4, DC, US-NY, US, 111111" ], "location" : { "buildingName" : "Skyline Towers", "buildingNumber" : "13", "city" : "Washington DC", "countryCode" : "US", "floor" : "2", "geoCoding" : { "latitude" : "38.8977", "longitude" : "-77.0365" }, "locality" : "Brooklyn", "postalCode" : "111111", "region" : "District of Columbia", "stateCode" : "US_WA", "streetName" : "Main Street", "streetNumber" : "5", "unit" : "4B" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "references" : { "external" : "987654-321", "internal" : "1234567-7890-12" }, "source" : "amber-falcon-river", "type" : "RESIDENTIAL" }, "roles" : [ "SENDER" ], "type" : "ADDRESS" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pickup" : { "instructions" : [ "Ring doorbell upon arrival" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "09:00", "timeTo" : "17:00" } }, "serviceDefinition" : { "id" : "01991a00-07b3-7171-a245-177e15965608", "createdAt" : "2024-01-15T10:30:00Z", "updatedAt" : "2024-01-15T10:30:00Z", "name" : "DHL Express for domestic B2C use", "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "carrierId" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "group" : "Express", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "serviceId" : "2b0ca74b-08fa-3726-800b-a7c0e01f9fcf" }, "shipmentChannel" : { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "name" : "My shipment channel", "documentRendering" : { "enabled" : false, "settings" : [ { "contentType" : "pdf", "documentType" : "LABEL", "enabled" : false, "mediaType" : "thermo-190", "offsetX" : 0.0, "offsetY" : 0.0, "options" : { "mode" : "DT" }, "pageBreak" : false } ] }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pickup" : { "enabled" : false, "slots" : [ { "name" : "Monday morning", "active" : false, "conditions" : { "carrierId" : "8c2b9506-043c-3adb-918b-e134d3c36bd6", "serviceId" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82" }, "description" : "example", "instructions" : [ "example" ], "leadTime" : 2, "recurrence" : { "timeFrom" : "08:00", "timeTo" : "10:00", "weekday" : "MO" } } ] }, "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" } }, "state" : { "consolidated" : false, "finalized" : false, "inbound" : false, "outbound" : false }, "tracker" : { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "status" : "BOOKED", "logs" : [ { "createdAt" : "2026-04-27T11:12:08Z", "category" : "example", "message" : "The document type LABEL failed to process, please try regenerating documents.", "payload" : { "id" : "019dcea3-b444-7073-bc96-9533c4ad830c", "normalizedStatus" : "example", "sourceEventCode" : "example", "tookPlaceAt" : "2026-01-01T10:00:00" }, "topic" : "DOCUMENTS", "type" : "ERROR" } ], "parcels" : [ { "status" : "BOOKED", "reference" : "#45678", "serial" : "473325380000006010", "link" : "https://track.example.com/?parcel=00001234567890123456" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "shipment" : { "status" : "BOOKED", "serial" : "00001234567890123456", "link" : "https://..." } } } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "post" : { "tags" : [ "Shipment Bookings" ], "summary" : "Create Shipment Booking", "description" : "Creates a new Shipment Booking. Provide `shipmentChannelId`, `parties`, `carrierDefinitionId`, `serviceDefinitionId`, and `parcelIds`. Returns the `shipment-booking-id`.", "operationId" : "createShipmentBooking", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentBookingRequest" }, "example" : { "carrierDefinitionId" : "019aa590-a84b-7000-89fe-2a0a157be008", "customsDeclarationId" : "019ab521-5fc6-7836-8d3b-ba0f6e12e003", "dangerousGoodsDeclarationId" : "019ab521-5fc6-7836-8d3b-ba0f6e12e003", "delivery" : { "instructions" : [ "Leave with the neighbour" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "08:00", "timeTo" : "16:00" } }, "info" : { "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "carrier" : { "reference" : "S-12345", "instructions" : [ "Leave parcel in reception" ] }, "delivery" : { "reference" : "S-12345", "instructions" : [ "Leave parcel in reception" ] }, "dispatch" : { "reference" : "S-12345", "instructions" : [ "Leave parcel in reception" ] }, "terms" : { "code" : "DDP", "location" : "Gothenburg" } }, "parcelIds" : [ "019b2e9f-ed2f-70d9-befb-f6bafa4377b7", "019b2e85-e47e-7911-92fd-d0897e6e3546" ], "parties" : [ { "type" : "ADDRESS", "roles" : [ "SENDER" ], "id" : "019b2766-8eb4-795c-899f-9ac8d5cc6a34" }, { "type" : "ADDRESS", "roles" : [ "RECEIVER" ], "id" : "019b0293-0db8-7c4f-9427-cf56154166c0" } ], "persistence" : { "type" : "example" }, "pickup" : { "instructions" : [ "Ring doorbell upon arrival" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "09:00", "timeTo" : "17:00" } }, "serviceDefinitionId" : "01991a00-07b3-7171-a245-177e15965608", "shipmentChannelId" : "019a8bcf-d773-7ee0-b72b-894b0c9dfc75" } } }, "required" : true }, "responses" : { "403" : { "description" : "Returned when the caller is a `SHARED` account, which has no Delivery account to run this operation.", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentBookingResponse" }, "example" : { "id" : "019b26d6-73d6-7bf6-b1b6-4531af80e7d7", "createdAt" : "2026-01-22T10:30:00Z", "serial" : "6250197719", "chargeables" : { "addons" : [ { "code" : "INSU" } ], "dimensionsUnit" : "CM", "palletCount" : 10, "pallets" : [ { "count" : 5, "type" : "EPAL-1" } ], "palletType" : "EPAL-1", "parcelCount" : 10, "shipmentCount" : 1, "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "KG" }, "delivery" : { "instructions" : [ "Leave with the neighbour" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "08:00", "timeTo" : "16:00" } }, "documents" : [ { "id" : "019ad95e-4b32-7a61-99fb-4367638dd836", "contentType" : "pdf", "documentType" : "LABEL", "mediaType" : "laser-a4", "pages" : 1 } ], "pickup" : { "instructions" : [ "Ring doorbell upon arrival" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "09:00", "timeTo" : "17:00" } }, "state" : { "consolidated" : false, "finalized" : false, "inbound" : false, "outbound" : false }, "tracker" : { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "status" : "BOOKED", "logs" : [ { "createdAt" : "2026-04-27T11:12:08Z", "category" : "example", "message" : "The document type LABEL failed to process, please try regenerating documents.", "payload" : { "id" : "019dcea3-b444-7073-bc96-9533c4ad830c", "normalizedStatus" : "example", "sourceEventCode" : "example", "tookPlaceAt" : "2026-01-01T10:00:00" }, "topic" : "DOCUMENTS", "type" : "ERROR" } ], "parcels" : [ { "status" : "BOOKED", "reference" : "#45678", "serial" : "473325380000006010", "link" : "https://track.example.com/?parcel=00001234567890123456" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "shipment" : { "status" : "BOOKED", "serial" : "00001234567890123456", "link" : "https://..." } } } } } } }, "security" : [ { "AccountToken" : [ ] } ], "x-emits-events" : [ { "topic" : "SHIPMENT_BOOKING", "when" : "On successful 201 response", "deliveredVia" : "webhooks.SHIPMENT_BOOKING" } ] } }, "/v1/shipment-bookings/{shipment-booking-id}/documents" : { "post" : { "tags" : [ "Shipment Bookings" ], "summary" : "Fetch Shipment Booking Documents", "description" : "Generates and fetches documents for a Shipment Booking. Optionally provide a `shipmentChannelId` to override the channel used for document rendering. Returns the list of generated documents.", "operationId" : "fetchDocuments", "parameters" : [ { "name" : "shipment-booking-id", "in" : "path", "description" : "Shipment booking id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FetchDocumentsRequest" }, "example" : { "shipmentChannelId" : "00000000-0000-7000-8000-000000000000" } } } }, "responses" : { "403" : { "description" : "Returned when the caller is a `SHARED` account, which has no Delivery account to run this operation.", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DocumentListResponse" }, "example" : { "items" : [ { "id" : "019ad95e-4b32-7a61-99fb-4367638dd836", "contentType" : "pdf", "documentType" : "LABEL", "mediaType" : "laser-a4", "pages" : 1 } ] } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipment-bookings/{shipment-booking-id}/documents/inline" : { "post" : { "tags" : [ "Shipment Bookings" ], "summary" : "Fetch Shipment Booking Documents inline", "description" : "Generates and fetches documents for a Shipment Booking using an inline Shipment Channel. Optionally provide an inline `shipmentChannel` to override the channel used for document rendering. Returns the list of generated documents.", "operationId" : "fetchDocumentsInline", "parameters" : [ { "name" : "shipment-booking-id", "in" : "path", "description" : "Shipment booking id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FetchInlineDocumentsRequest" }, "example" : { "shipmentChannel" : { "name" : "My shipment channel", "documentRendering" : { "enabled" : false, "settings" : [ { "contentType" : "pdf", "documentType" : "LABEL", "enabled" : false, "mediaType" : "thermo-190", "offsetX" : 0.0, "offsetY" : 0.0, "options" : { "mode" : "DT" }, "pageBreak" : false } ] }, "pickup" : { "enabled" : false, "slots" : [ { "name" : "Monday morning", "active" : false, "conditions" : { "carrierId" : "8c2b9506-043c-3adb-918b-e134d3c36bd6", "serviceId" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82" }, "description" : "example", "instructions" : [ "example" ], "leadTime" : 2, "recurrence" : { "timeFrom" : "08:00", "timeTo" : "10:00", "weekday" : "MO" } } ] }, "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" } } } } } }, "responses" : { "403" : { "description" : "Returned when the caller is a `SHARED` account, which has no Delivery account to run this operation.", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DocumentListResponse" }, "example" : { "items" : [ { "id" : "019ad95e-4b32-7a61-99fb-4367638dd836", "contentType" : "pdf", "documentType" : "LABEL", "mediaType" : "laser-a4", "pages" : 1 } ] } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipment-bookings/inline" : { "post" : { "tags" : [ "Shipment Bookings" ], "summary" : "Create Shipment Booking inline", "description" : "Creates a new Shipment Booking using an inline payload. Provide `shipmentChannel`, `parties` and `parcels` directly in the request, together with exactly one of `carrierDefinition` or `carrierDefinitionId` and exactly one of `serviceDefinition` or `serviceDefinitionId`.\nReturns the `shipmentBookingId`.", "operationId" : "createInlineShipmentBooking", "parameters" : [ { "name" : "validations", "in" : "query", "description" : "Comma-separated address validation toggles. Format: KEY or KEY:true/false. Supported: POSTALCODE, PHONENUMBER. Defaults: PHONENUMBER enabled, POSTALCODE disabled. Example: POSTALCODE:true,PHONENUMBER:false", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "example", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "example" : "example" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "allOf" : [ { "$ref" : "#/components/schemas/InlineShipmentBooking" }, { "oneOf" : [ { "required" : [ "carrierDefinition" ] }, { "required" : [ "carrierDefinitionId" ] } ] }, { "oneOf" : [ { "required" : [ "serviceDefinition" ] }, { "required" : [ "serviceDefinitionId" ] } ] } ] }, "example" : { "carrierDefinition" : { "name" : "DHL Home Delivery", "carrierId" : "24260549-47a1-390b-a211-da8989984a08", "group" : "UPS_saver", "mode" : "STAGING", "settings" : [ { "key" : "api-key", "value" : "5qqMQ5DhciBfJgBcGFyXYm66pl1lbgKV26v6ybKvcDkgMOO1BCv3iE68HDakvW9o" } ] }, "customsDeclaration" : { "reference" : "INV-2025-0001", "charges" : { "duty" : 75.0, "freight" : 250.0, "insurance" : 50.0, "invoice" : 1500.0, "other" : 20.0 }, "comments" : [ "Goods are samples and not for resale." ], "currency" : "EUR", "declarant" : { "city" : "Oslo", "firstName" : "John", "lastName" : "Doe", "title" : "Mr." }, "declaredAt" : "2024-07-01T00:00:00+00:00", "invoice" : { "items" : [ { "reference" : "ITEM-REF-12345", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ { "type" : "GTIN", "value" : "4006381333931" } ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "number" : "INV-2025-0001" }, "purpose" : { "code" : "GIFT" }, "statements" : [ "I hereby declare that the information contained in this declaration is true and complete to the best of my knowledge and belief." ], "terms" : { "code" : "DDP", "location" : "Rotterdam" }, "types" : [ "CN22" ] }, "dangerousGoodsDeclaration" : { "reference" : "DG-REF-12345", "declarant" : { "city" : "Stockholm", "firstName" : "John", "lastName" : "Doe", "title" : "Mr." }, "declaredAt" : "2021-09-01T12:00:00+02:00", "goods" : [ { "code" : "UN1950", "hazard" : { "code" : "F1", "environmental" : false, "flashPoint" : -20, "hazardClass" : "3" }, "notes" : [ "Handle with care" ], "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "group" : "II", "type" : "BOTTLE" }, "shippingName" : "Aerosols, flammable", "technicalName" : "Propane, Butane mixture", "transportation" : { "emergencyCode" : "2YE", "separation" : 3, "tunnelRestriction" : "D/E" }, "type" : "DG_01" } ], "goodsTypes" : [ "ADR", "DNG" ], "handling" : [ "Aerosol containers are pressurized and may rupture if exposed to heat or physical damage.", "Handle carefully to prevent puncture, crushing, or leakage." ], "meta" : { "key1" : "value1", "key2" : "value2" }, "modal" : "ROAD", "type" : "\"ADR\"" }, "delivery" : { "instructions" : [ "Leave with the neighbour" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "08:00", "timeTo" : "16:00" } }, "info" : { "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "carrier" : { "reference" : "S-12345", "instructions" : [ "Leave parcel in reception" ] }, "delivery" : { "reference" : "S-12345", "instructions" : [ "Leave parcel in reception" ] }, "dispatch" : { "reference" : "S-12345", "instructions" : [ "Leave parcel in reception" ] }, "terms" : { "code" : "DDP", "location" : "Gothenburg" } }, "parcels" : [ { "reference" : "#45678", "serial" : "473325380000006010", "dangerousGoods" : [ { "netQuantity" : 10.5, "netQuantityUnit" : "KG", "quantity" : 5, "type" : "UN1950" } ], "description" : "This is a parcel description", "items" : [ { "reference" : "ITEM-REF-12345", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ { "type" : "GTIN", "value" : "4006381333931" } ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "dimensionsUnit" : "M", "height" : 10.0, "length" : 10.0, "markings" : [ "THIS_SIDE_UP" ], "pallet" : { "group" : "GROUP-A", "type" : "EPAL-1" }, "type" : "PACKAGE", "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "G", "width" : 10.0 }, "weight" : 10.0, "weightUnit" : "G" } ], "parties" : [ { "id" : "019b220f-7d9b-7435-b352-f718eb22fa4a", "roles" : [ "SENDER" ], "source" : "amber-falcon-river", "type" : "ADDRESS" } ], "pickup" : { "instructions" : [ "Ring doorbell upon arrival" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "09:00", "timeTo" : "17:00" } }, "serviceDefinition" : { "name" : "PostNord for domestic B2C use", "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "group" : "UPS_saver", "serviceId" : "d9214010-7bb6-3e78-bbd5-c7b39f584722" }, "shipmentChannel" : { "name" : "My shipment channel", "documentRendering" : { "enabled" : false, "settings" : [ { "contentType" : "pdf", "documentType" : "LABEL", "enabled" : false, "mediaType" : "thermo-190", "offsetX" : 0.0, "offsetY" : 0.0, "options" : { "mode" : "DT" }, "pageBreak" : false } ] }, "pickup" : { "enabled" : false, "slots" : [ { "name" : "Monday morning", "active" : false, "conditions" : { "carrierId" : "8c2b9506-043c-3adb-918b-e134d3c36bd6", "serviceId" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82" }, "description" : "example", "instructions" : [ "example" ], "leadTime" : 2, "recurrence" : { "timeFrom" : "08:00", "timeTo" : "10:00", "weekday" : "MO" } } ] }, "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" } } } } }, "required" : true }, "responses" : { "403" : { "description" : "Returned when the caller is a `SHARED` account, which has no Delivery account to run this operation.", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentBookingResponse" }, "example" : { "id" : "019b26d6-73d6-7bf6-b1b6-4531af80e7d7", "createdAt" : "2026-01-22T10:30:00Z", "serial" : "6250197719", "chargeables" : { "addons" : [ { "code" : "INSU" } ], "dimensionsUnit" : "CM", "palletCount" : 10, "pallets" : [ { "count" : 5, "type" : "EPAL-1" } ], "palletType" : "EPAL-1", "parcelCount" : 10, "shipmentCount" : 1, "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "KG" }, "delivery" : { "instructions" : [ "Leave with the neighbour" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "08:00", "timeTo" : "16:00" } }, "documents" : [ { "id" : "019ad95e-4b32-7a61-99fb-4367638dd836", "contentType" : "pdf", "documentType" : "LABEL", "mediaType" : "laser-a4", "pages" : 1 } ], "pickup" : { "instructions" : [ "Ring doorbell upon arrival" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "09:00", "timeTo" : "17:00" } }, "state" : { "consolidated" : false, "finalized" : false, "inbound" : false, "outbound" : false }, "tracker" : { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "status" : "BOOKED", "logs" : [ { "createdAt" : "2026-04-27T11:12:08Z", "category" : "example", "message" : "The document type LABEL failed to process, please try regenerating documents.", "payload" : { "id" : "019dcea3-b444-7073-bc96-9533c4ad830c", "normalizedStatus" : "example", "sourceEventCode" : "example", "tookPlaceAt" : "2026-01-01T10:00:00" }, "topic" : "DOCUMENTS", "type" : "ERROR" } ], "parcels" : [ { "status" : "BOOKED", "reference" : "#45678", "serial" : "473325380000006010", "link" : "https://track.example.com/?parcel=00001234567890123456" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "shipment" : { "status" : "BOOKED", "serial" : "00001234567890123456", "link" : "https://..." } } } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/trackers" : { "get" : { "tags" : [ "Trackers" ], "summary" : "List Trackers", "description" : "Lists Trackers. \nReturns a paginated list of Trackers.\n", "operationId" : "listTrackers", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TrackerListResponse" }, "example" : { "items" : [ { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "status" : "BOOKED", "logs" : [ { "createdAt" : "2026-04-27T11:12:08Z", "category" : "example", "message" : "The document type LABEL failed to process, please try regenerating documents.", "payload" : { "id" : "019dcea3-b444-7073-bc96-9533c4ad830c", "normalizedStatus" : "example", "sourceEventCode" : "example", "tookPlaceAt" : "2026-01-01T10:00:00" }, "topic" : "DOCUMENTS", "type" : "ERROR" } ], "parcels" : [ { "status" : "BOOKED", "reference" : "#45678", "serial" : "473325380000006010", "link" : "https://track.example.com/?parcel=00001234567890123456" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "shipment" : { "status" : "BOOKED", "serial" : "00001234567890123456", "link" : "https://..." } } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipment-manifests" : { "get" : { "tags" : [ "Shipment Manifests" ], "summary" : "List Shipment Manifests", "description" : "Lists Shipment Manifests. Returns a paginated list of Shipment Manifests.", "operationId" : "listShipmentManifests", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentManifestListResponse" }, "example" : { "items" : [ { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "reference" : "MANIFEST-001", "documents" : [ { "id" : "019ad95e-4b32-7a61-99fb-4367638dd836", "contentType" : "pdf", "documentType" : "LABEL", "mediaType" : "laser-a4", "pages" : 1 } ], "logs" : [ { "createdAt" : "2026-04-27T11:12:08Z", "category" : "example", "message" : "The document type LABEL failed to process, please try regenerating documents.", "payload" : { "id" : "019dcea3-b444-7073-bc96-9533c4ad830c", "normalizedStatus" : "example", "sourceEventCode" : "example", "tookPlaceAt" : "2026-01-01T10:00:00" }, "topic" : "DOCUMENTS", "type" : "ERROR" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "shipmentDispatch" : { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "reference" : "DISPATCH-001", "carrierId" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "chargeables" : { "addons" : [ { "code" : "INSU" } ], "dimensionsUnit" : "CM", "palletCount" : 10, "pallets" : [ { "count" : 5, "type" : "EPAL-1" } ], "palletType" : "EPAL-1", "parcelCount" : 10, "shipmentCount" : 1, "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "KG" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "shipmentBookingIds" : [ "019c1dd1-5344-7d56-bb3d-dc338e80488a", "019c1dcb-0d63-7917-9c1d-00be28e7282b" ], "state" : { "finalized" : false, "manifested" : false }, "tracker" : { "id" : "00000000-0000-7000-8000-000000000000", "createdAt" : "2024-01-01T00:00:00Z", "updatedAt" : "2024-01-01T00:00:00Z", "status" : "BOOKED", "loadBearers" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ], "manifest" : { "serial" : "ABC123456789", "link" : "https://..." }, "motherShipment" : { "serial" : "ABC123456789", "link" : "https://..." }, "parcels" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ], "shipments" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ] } }, "type" : "SBTL" } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipment-manifests/{shipment-manifest-id}" : { "get" : { "tags" : [ "Shipment Manifests" ], "summary" : "Fetch Shipment Manifest", "description" : "Fetches a specific Shipment Manifest. Provide `shipment-manifest-id`. Returns the Shipment Manifest.\n", "operationId" : "fetchShipmentManifest", "parameters" : [ { "name" : "shipment-manifest-id", "in" : "path", "description" : "Shipment manifest id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentManifestResponse" }, "example" : { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "reference" : "MANIFEST-001", "documents" : [ { "id" : "019ad95e-4b32-7a61-99fb-4367638dd836", "contentType" : "pdf", "documentType" : "LABEL", "mediaType" : "laser-a4", "pages" : 1 } ], "logs" : [ { "createdAt" : "2026-04-27T11:12:08Z", "category" : "example", "message" : "The document type LABEL failed to process, please try regenerating documents.", "payload" : { "id" : "019dcea3-b444-7073-bc96-9533c4ad830c", "normalizedStatus" : "example", "sourceEventCode" : "example", "tookPlaceAt" : "2026-01-01T10:00:00" }, "topic" : "DOCUMENTS", "type" : "ERROR" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "shipmentDispatch" : { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "reference" : "DISPATCH-001", "carrierId" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "chargeables" : { "addons" : [ { "code" : "INSU" } ], "dimensionsUnit" : "CM", "palletCount" : 10, "pallets" : [ { "count" : 5, "type" : "EPAL-1" } ], "palletType" : "EPAL-1", "parcelCount" : 10, "shipmentCount" : 1, "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "KG" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "shipmentBookingIds" : [ "019c1dd1-5344-7d56-bb3d-dc338e80488a", "019c1dcb-0d63-7917-9c1d-00be28e7282b" ], "state" : { "finalized" : false, "manifested" : false }, "tracker" : { "id" : "00000000-0000-7000-8000-000000000000", "createdAt" : "2024-01-01T00:00:00Z", "updatedAt" : "2024-01-01T00:00:00Z", "status" : "BOOKED", "loadBearers" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ], "manifest" : { "serial" : "ABC123456789", "link" : "https://..." }, "motherShipment" : { "serial" : "ABC123456789", "link" : "https://..." }, "parcels" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ], "shipments" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ] } }, "type" : "SBTL" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipment-dispatch-trackers" : { "get" : { "tags" : [ "Shipment Dispatch Trackers" ], "summary" : "List Shipment Dispatch Trackers", "description" : "Lists Shipment Dispatch Trackers. Returns a paginated list of Shipment Dispatch Trackers.", "operationId" : "listShipmentDispatchTrackers", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentDispatchTrackerListResponse" }, "example" : { "items" : [ { "id" : "00000000-0000-7000-8000-000000000000", "createdAt" : "2024-01-01T00:00:00Z", "updatedAt" : "2024-01-01T00:00:00Z", "status" : "BOOKED", "loadBearers" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ], "manifest" : { "serial" : "ABC123456789", "link" : "https://..." }, "motherShipment" : { "serial" : "ABC123456789", "link" : "https://..." }, "parcels" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ], "shipments" : [ { "reference" : "REF-001", "serial" : "DEF987654321" } ] } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipment-bookings/{shipment-booking-id}" : { "get" : { "tags" : [ "Shipment Bookings" ], "summary" : "Fetch Shipment Booking", "description" : "Fetches a specific Shipment Booking. Provide `shipment-booking-id`. Returns the Shipment Booking.\n\n", "operationId" : "fetchShipmentBooking", "parameters" : [ { "name" : "shipment-booking-id", "in" : "path", "description" : "Shipment booking id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "expand", "in" : "query", "description" : "Optional comma-separated list of relations to expand on the response. Supported values: `documents` (refreshes the document metadata from document-service). If omitted, the persisted document list is returned without a document-service call.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "example" : [ "example" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000, "uniqueItems" : true }, "example" : [ "example" ] } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentBookingExtendedResponse" }, "example" : { "id" : "019b26d6-73d6-7bf6-b1b6-4531af80e7d7", "createdAt" : "2026-01-22T10:30:00Z", "serial" : "6250112345", "carrierDefinition" : { "id" : "019ade48-9368-7577-990d-987fe9b34324", "createdAt" : "2024-01-15T10:30:00Z", "updatedAt" : "2024-01-15T10:30:00Z", "name" : "DHL Express", "carrierId" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "group" : "Express", "mode" : "STAGING", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "settings" : [ { "key" : "api-key", "value" : "5qqMQ5DhciBfJgBcGFyXYm66pl1lbgKV26v6ybKvcDkgMOO1BCv3iE68HDakvW9o" } ] }, "chargeables" : { "addons" : [ { "code" : "INSU" } ], "dimensionsUnit" : "CM", "palletCount" : 10, "pallets" : [ { "count" : 5, "type" : "EPAL-1" } ], "palletType" : "EPAL-1", "parcelCount" : 10, "shipmentCount" : 1, "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "KG" }, "customsDeclaration" : { "id" : "019ab521-5fc6-7836-8d3b-ba0f6e12e003", "reference" : "INV-2025-0001", "charges" : { "duty" : 75.0, "freight" : 250.0, "insurance" : 50.0, "invoice" : 1500.0, "other" : 20.0 }, "comments" : [ "Goods are samples and not for resale." ], "currency" : "EUR", "declarant" : { "city" : "Oslo", "firstName" : "John", "lastName" : "Doe", "title" : "Mr." }, "declaredAt" : "2024-07-01T00:00:00+00:00", "invoice" : { "items" : [ { "id" : "019ab5ae-7cbb-7665-94a8-86edb63c6191", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "ITEM-REF-001", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ { "type" : "GTIN", "value" : "4006381333931" } ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "number" : "INV-2025-0001" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "purpose" : { "code" : "GIFT" }, "statements" : [ "I hereby declare that the information contained in this declaration is true and complete to the best of my knowledge and belief." ], "terms" : { "code" : "DDP", "location" : "Rotterdam" }, "types" : [ "CN22" ] }, "dangerousGoods" : { "id" : "019c2076-1a28-7bee-a9b3-42312a50d1b0", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "DG-REF-12345", "declarant" : { "city" : "Stockholm", "firstName" : "John", "lastName" : "Doe", "title" : "Mr." }, "declaredAt" : "2021-09-01T12:00:00+02:00", "goods" : [ { "code" : "UN1950", "hazard" : { "code" : "F1", "environmental" : false, "flashPoint" : -20, "hazardClass" : "3" }, "notes" : [ "Handle with care" ], "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "group" : "II", "type" : "BOTTLE" }, "shippingName" : "Aerosols, flammable", "technicalName" : "Propane, Butane mixture", "transportation" : { "emergencyCode" : "2YE", "separation" : 3, "tunnelRestriction" : "D/E" }, "type" : "DG_01" } ], "goodsTypes" : [ "FLAMMABLE", "CORROSIVE" ], "handling" : [ "Aerosol containers are pressurized and may rupture if exposed to heat or physical damage.", "Handle carefully to prevent puncture, crushing, or leakage." ], "meta" : { "key1" : "value1", "key2" : "value2" }, "modal" : "ROAD", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "standard" : "IATA", "type" : "[\"SHIPPER\", \"MULTIMODAL\"]" }, "delivery" : { "instructions" : [ "Leave with the neighbour" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "08:00", "timeTo" : "16:00" } }, "documents" : [ { "id" : "019ad95e-4b32-7a61-99fb-4367638dd836", "contentType" : "pdf", "documentType" : "LABEL", "mediaType" : "laser-a4", "pages" : 1 } ], "info" : { "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "carrier" : { "reference" : "S-12345", "instructions" : [ "Leave parcel in reception" ] }, "delivery" : { "reference" : "S-12345", "instructions" : [ "Leave parcel in reception" ] }, "dispatch" : { "reference" : "S-12345", "instructions" : [ "Leave parcel in reception" ] }, "terms" : { "code" : "DDP", "location" : "Gothenburg" } }, "parcels" : [ { "id" : "019beadd-818c-792d-9bd4-ea04b0dbe23e", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "#45678", "serial" : "473325380000006010", "dangerousGoods" : [ { "netQuantity" : 10.5, "netQuantityUnit" : "KG", "quantity" : 5, "type" : "UN1950" } ], "description" : "This is a parcel description", "items" : [ { "id" : "019ab5ae-7cbb-7665-94a8-86edb63c6191", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "ITEM-REF-001", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ { "type" : "GTIN", "value" : "4006381333931" } ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "dimensionsUnit" : "M", "height" : 10.0, "length" : 10.0, "markings" : [ "THIS_SIDE_UP" ], "pallet" : { "group" : "GROUP-A", "type" : "EPAL-1" }, "type" : "PACKAGE", "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "G", "width" : 10.0 }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "weight" : 10.0, "weightUnit" : "G" } ], "parties" : [ { "address" : { "id" : "019b2766-8eb4-795c-899f-9ac8d5cc6a34", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "company" : { "name" : "nShift", "identification" : [ { "type" : "VAT", "value" : "SE556546371701" } ] }, "contact" : { "careOf" : "Jane Smith", "doorCode" : "11", "email" : "jdoe@nshift.com", "fax" : "+46721234567", "firstName" : "John", "lastName" : "Doe", "mobile" : "+46721234567", "phone" : "+46721234567" }, "group" : "warehouse_1", "lines" : [ "John Doe c/o Mr Smith, nShift", "Schiller street 45, Neighborhood x", "Century Plaza 13, Floor 3, Apt 32", "District 4, DC, US-NY, US, 111111" ], "location" : { "buildingName" : "Skyline Towers", "buildingNumber" : "13", "city" : "Washington DC", "countryCode" : "US", "floor" : "2", "geoCoding" : { "latitude" : "38.8977", "longitude" : "-77.0365" }, "locality" : "Brooklyn", "postalCode" : "111111", "region" : "District of Columbia", "stateCode" : "US_WA", "streetName" : "Main Street", "streetNumber" : "5", "unit" : "4B" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "references" : { "external" : "987654-321", "internal" : "1234567-7890-12" }, "source" : "amber-falcon-river", "type" : "RESIDENTIAL" }, "roles" : [ "SENDER" ], "type" : "ADDRESS" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pickup" : { "instructions" : [ "Ring doorbell upon arrival" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "09:00", "timeTo" : "17:00" } }, "serviceDefinition" : { "id" : "01991a00-07b3-7171-a245-177e15965608", "createdAt" : "2024-01-15T10:30:00Z", "updatedAt" : "2024-01-15T10:30:00Z", "name" : "DHL Express for domestic B2C use", "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "carrierId" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "group" : "Express", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "serviceId" : "2b0ca74b-08fa-3726-800b-a7c0e01f9fcf" }, "shipmentChannel" : { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "name" : "My shipment channel", "documentRendering" : { "enabled" : false, "settings" : [ { "contentType" : "pdf", "documentType" : "LABEL", "enabled" : false, "mediaType" : "thermo-190", "offsetX" : 0.0, "offsetY" : 0.0, "options" : { "mode" : "DT" }, "pageBreak" : false } ] }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pickup" : { "enabled" : false, "slots" : [ { "name" : "Monday morning", "active" : false, "conditions" : { "carrierId" : "8c2b9506-043c-3adb-918b-e134d3c36bd6", "serviceId" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82" }, "description" : "example", "instructions" : [ "example" ], "leadTime" : 2, "recurrence" : { "timeFrom" : "08:00", "timeTo" : "10:00", "weekday" : "MO" } } ] }, "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" } }, "state" : { "consolidated" : false, "finalized" : false, "inbound" : false, "outbound" : false }, "tracker" : { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "status" : "BOOKED", "logs" : [ { "createdAt" : "2026-04-27T11:12:08Z", "category" : "example", "message" : "The document type LABEL failed to process, please try regenerating documents.", "payload" : { "id" : "019dcea3-b444-7073-bc96-9533c4ad830c", "normalizedStatus" : "example", "sourceEventCode" : "example", "tookPlaceAt" : "2026-01-01T10:00:00" }, "topic" : "DOCUMENTS", "type" : "ERROR" } ], "parcels" : [ { "status" : "BOOKED", "reference" : "#45678", "serial" : "473325380000006010", "link" : "https://track.example.com/?parcel=00001234567890123456" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "shipment" : { "status" : "BOOKED", "serial" : "00001234567890123456", "link" : "https://..." } } } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/event-channels/{event-channel-id}" : { "get" : { "tags" : [ "Event Channels" ], "summary" : "Fetch Event Channel", "description" : "Fetches a specific Event Channel. Provide `event-channel-id`. Returns the Event Channel.", "operationId" : "fetchEventChannel", "parameters" : [ { "name" : "event-channel-id", "in" : "path", "description" : "Event channel id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventChannelResponse" }, "example" : { "id" : "01958a2d-b90d-7261-a795-000000000000", "createdAt" : "2025-02-25T14:53:04+0200", "updatedAt" : "2025-02-25T14:53:04+0200", "name" : "My event channel", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "topics" : [ "ACCOUNT" ], "webhook" : { "secret" : "example", "url" : "https://example.com/webhook" } } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] } ] }, "put" : { "tags" : [ "Event Channels" ], "summary" : "Update Event Channel", "description" : "Updates an existing Event Channel. Provide `event-channel-id`, `name`, `topics`, and `webhook`, along with updated values. Returns confirmation (`204 No Content`).", "operationId" : "replaceEventChannel", "parameters" : [ { "name" : "event-channel-id", "in" : "path", "description" : "Event channel id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventChannelRequest" }, "example" : { "name" : "My event channel", "persistence" : { "type" : "example" }, "topics" : [ "ACCOUNT" ], "webhook" : { "secret" : "example", "url" : "https://example.com/webhook" } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] } ], "x-emits-events" : [ { "topic" : "EVENT_CHANNEL", "when" : "On successful 204 response", "deliveredVia" : "webhooks.EVENT_CHANNEL" } ] }, "delete" : { "tags" : [ "Event Channels" ], "summary" : "Delete Event Channel", "description" : "Deletes an existing Event Channel. Provide `event-channel-id`. Returns confirmation (`204 No Content`).", "operationId" : "removeEventChannel", "parameters" : [ { "name" : "event-channel-id", "in" : "path", "description" : "Event channel id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] } ], "x-emits-events" : [ { "topic" : "EVENT_CHANNEL", "when" : "On successful 204 response", "deliveredVia" : "webhooks.EVENT_CHANNEL" } ] } }, "/v1/event-channels" : { "get" : { "tags" : [ "Event Channels" ], "summary" : "List Event Channels", "description" : "Lists Event Channels. Returns a paginated list of Event Channels.", "operationId" : "listEventChannels", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventChannelListResponse" }, "example" : { "items" : [ { "id" : "01958a2d-b90d-7261-a795-000000000000", "createdAt" : "2025-02-25T14:53:04+0200", "updatedAt" : "2025-02-25T14:53:04+0200", "name" : "My event channel", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "topics" : [ "ACCOUNT" ], "webhook" : { "secret" : "example", "url" : "https://example.com/webhook" } } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] } ] }, "post" : { "tags" : [ "Event Channels" ], "summary" : "Create Event Channel", "description" : "Creates a new Event Channel. Provide `name`, `topics`, and `webhook`.\nReturns the `event-channel-id`.", "operationId" : "createEventChannel", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventChannelRequest" }, "example" : { "name" : "My event channel", "persistence" : { "type" : "example" }, "topics" : [ "ACCOUNT" ], "webhook" : { "secret" : "example", "url" : "https://example.com/webhook" } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BasicResponse" }, "example" : { "id" : "01991a03-c860-7000-bb91-5a9cb479f522" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] } ], "x-emits-events" : [ { "topic" : "EVENT_CHANNEL", "when" : "On successful 201 response", "deliveredVia" : "webhooks.EVENT_CHANNEL" } ] } }, "/v1/event-channels/events" : { "post" : { "tags" : [ "Mock Events" ], "summary" : "Create Mock Event", "description" : "Creates mock event. Provide `topic`, `type`, and `payload`. Returns the mock event.", "operationId" : "createEvents", "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MockEventRequest" }, "maxItems" : 1000 }, "example" : [ { "payload" : { "id" : "019aa590-a84b-7c80-a469-e9c65dc58f3b" }, "topic" : "ACCOUNT", "type" : "CREATE" } ] } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] } ] } }, "/v1/delivery-options/{delivery-option-id}" : { "get" : { "tags" : [ "Delivery Options" ], "summary" : "Fetch Delivery Option", "description" : "Fetches a specific Delivery Option. Provide `delivery-option-id`. \nReturns the Delivery Option.\n", "operationId" : "fetchDeliveryOption", "parameters" : [ { "name" : "delivery-option-id", "in" : "path", "description" : "Delivery option id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeliveryOptionResponse" }, "example" : { "id" : "019c2038-9e20-7000-8193-7c08db53a87f", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "name" : "Standard Shipping", "carrierDefinitionId" : "019a8cb2-394a-7689-8a09-1c96ee3cea88", "description" : "Standard shipping with 3-5 business days delivery", "enabled" : false, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "priority" : 0, "rates" : [ { "carrierRate" : { "enabled" : false, "fallbackPrice" : 1.0 }, "conditions" : [ { "comparator" : "EQUAL", "parameter" : "WEIGHT", "value" : "10" } ], "currency" : "EUR", "price" : 10.0, "priority" : 1 } ], "serviceDefinitionId" : "019a8cc2-7ecd-7b05-ae3d-a3e82ca19827", "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" }, "zones" : [ { "id" : "019b266c-0504-7f31-8f27-e216b1744ed6", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "name" : "European Union", "countries" : [ { "name" : "Germany", "code" : "DE" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" } } ] } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "put" : { "tags" : [ "Delivery Options" ], "summary" : "Update Delivery Option", "description" : "Updates an existing Delivery Option. Provide `delivery-option-id` and updated parameters. \nReturns confirmation (`204 No Content`).\n", "operationId" : "replaceDeliveryOption", "parameters" : [ { "name" : "delivery-option-id", "in" : "path", "description" : "Delivery option id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeliveryOptionRequest" }, "example" : { "name" : "Home Delivery", "carrierDefinitionId" : "019a8cb2-394a-7689-8a09-1c96ee3cea88", "description" : "The shipment is delivered directly to your door.", "enabled" : false, "leadTimes" : [ { "datePattern" : "Coming soon...", "delivery" : 1, "dispatch" : 1, "fulfillment" : 1 } ], "persistence" : { "type" : "example" }, "priority" : 1, "rates" : [ { "carrierRate" : { "enabled" : false, "fallbackPrice" : 1.0 }, "conditions" : [ { "comparator" : "EQUAL", "parameter" : "WEIGHT", "value" : "10" } ], "currency" : "EUR", "price" : 10.0, "priority" : 1 } ], "serviceDefinitionId" : "01991a00-07b3-7171-a245-177e15965608", "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" }, "zoneIds" : [ "019b266c-0504-7f31-8f27-e216b1744ed6", "019a9e36-06ba-718e-b98e-e4907a7edfe7" ] } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "delete" : { "tags" : [ "Delivery Options" ], "summary" : "Delete Delivery Option", "description" : "Deletes an existing Delivery Option. Provide `delivery-option-id`. \nReturns confirmation (`204 No Content`).", "operationId" : "removeDeliveryOption", "parameters" : [ { "name" : "delivery-option-id", "in" : "path", "description" : "Delivery option id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/delivery-options/zones/{zone-id}" : { "get" : { "tags" : [ "Zones" ], "summary" : "Fetch Zone", "description" : "Fetches a specific Zone. Provide `zone-id`. \nReturns the Zone.\n", "operationId" : "fetchZone", "parameters" : [ { "name" : "zone-id", "in" : "path", "description" : "Zone id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZoneResponse" }, "example" : { "id" : "019b266c-0504-7f31-8f27-e216b1744ed6", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "name" : "European Union", "countries" : [ { "name" : "Germany", "code" : "DE" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" } } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "put" : { "tags" : [ "Zones" ], "summary" : "Update Zone", "description" : "Updates an existing Zone. Provide `zone-id` and updated parameters. \nReturns confirmation (`204 No Content`).\n", "operationId" : "replaceZone", "parameters" : [ { "name" : "zone-id", "in" : "path", "description" : "Zone id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZoneRequest" }, "example" : { "name" : "Europe", "countries" : [ { "name" : "Germany", "code" : "DE" } ], "persistence" : { "type" : "example" } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "delete" : { "tags" : [ "Zones" ], "summary" : "Delete Zone", "description" : "Deletes an existing Zone. Provide `zone-id`. \nReturns confirmation (`204 No Content`).\n\n**Note:** If the Zone is currently associated with a Delivery Option, the operation will be denied.\n", "operationId" : "removeZone", "parameters" : [ { "name" : "zone-id", "in" : "path", "description" : "Zone id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipping-quotes" : { "get" : { "tags" : [ "Shipping Quotes" ], "summary" : "List Shipping Quotes", "description" : "Lists Shipping Quotes. \nReturns a paginated list of Shipping Quotes.\n", "operationId" : "listShippingQuotes", "parameters" : [ { "name" : "checkout_id", "in" : "query", "description" : "Checkout id.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShippingQuoteListResponse" }, "example" : { "items" : [ { "id" : "019b45c5-6b7c-7000-92fd-6d6247de6372", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "carrierDefinition" : { "id" : "019ade48-9368-7577-990d-987fe9b34324", "createdAt" : "2024-01-15T10:30:00Z", "updatedAt" : "2024-01-15T10:30:00Z", "name" : "DHL Express", "carrierId" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "group" : "Express", "mode" : "STAGING", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "settings" : [ { "key" : "api-key", "value" : "5qqMQ5DhciBfJgBcGFyXYm66pl1lbgKV26v6ybKvcDkgMOO1BCv3iE68HDakvW9o" } ] }, "checkoutId" : "9d9e7256-45f0-4906-9c3e-8f8fa7a8214e", "deliveryOptionId" : "019c2038-9e20-7000-8193-7c08db53a87f", "meta" : { "key1" : "value1", "key2" : "value2" }, "parcels" : [ { "id" : "019beadd-818c-792d-9bd4-ea04b0dbe23e", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "#45678", "serial" : "473325380000006010", "dangerousGoods" : [ { "netQuantity" : 10.5, "netQuantityUnit" : "KG", "quantity" : 5, "type" : "UN1950" } ], "description" : "This is a parcel description", "items" : [ { "id" : "019ab5ae-7cbb-7665-94a8-86edb63c6191", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "ITEM-REF-001", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "dimensionsUnit" : "M", "height" : 10.0, "length" : 10.0, "markings" : [ "THIS_SIDE_UP" ], "pallet" : { "group" : "GROUP-A", "type" : "EPAL-1" }, "type" : "PACKAGE", "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "G", "width" : 10.0 }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "weight" : 10.0, "weightUnit" : "G" } ], "parties" : [ { "address" : { "id" : "019b2766-8eb4-795c-899f-9ac8d5cc6a34", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "company" : { "name" : "nShift", "identification" : [ ] }, "contact" : { "careOf" : "Jane Smith", "doorCode" : "11", "email" : "jdoe@nshift.com", "fax" : "+46721234567", "firstName" : "John", "lastName" : "Doe", "mobile" : "+46721234567", "phone" : "+46721234567" }, "group" : "warehouse_1", "lines" : [ "John Doe c/o Mr Smith, nShift", "Schiller street 45, Neighborhood x", "Century Plaza 13, Floor 3, Apt 32", "District 4, DC, US-NY, US, 111111" ], "location" : { "buildingName" : "Skyline Towers", "buildingNumber" : "13", "city" : "Washington DC", "countryCode" : "US", "floor" : "2", "geoCoding" : { "latitude" : "38.8977", "longitude" : "-77.0365" }, "locality" : "Brooklyn", "postalCode" : "111111", "region" : "District of Columbia", "stateCode" : "US_WA", "streetName" : "Main Street", "streetNumber" : "5", "unit" : "4B" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "references" : { "external" : "987654-321", "internal" : "1234567-7890-12" }, "source" : "amber-falcon-river", "type" : "RESIDENTIAL" }, "roles" : [ "SENDER" ], "type" : "ADDRESS" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "rate" : { "carrierPrice" : 10.0, "carrierRate" : { "enabled" : false, "fallbackPrice" : 1.0, "local" : { "currency" : "example", "price" : 1 }, "response" : { "message" : "Price calculated successfully.", "type" : "INFO" } }, "cartPrice" : 10.0, "currency" : "EUR", "price" : 10.0, "priceMargin" : 10.0, "priceTotal" : 10.0 }, "serviceDefinition" : { "id" : "01991a00-07b3-7171-a245-177e15965608", "createdAt" : "2024-01-15T10:30:00Z", "updatedAt" : "2024-01-15T10:30:00Z", "name" : "DHL Express for domestic B2C use", "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "carrierId" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "group" : "Express", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "serviceId" : "2b0ca74b-08fa-3726-800b-a7c0e01f9fcf" }, "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" } } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "post" : { "tags" : [ "Shipping Quotes" ], "summary" : "Create Shipping Quote", "description" : "Creates a new Shipping Quote. Provide required parameters. \nReturns the `shipping-quote-id`.\n\n**Note:** Shipping Quotes are valid for 24 hours.\n", "operationId" : "createShippingQuote", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShippingQuoteRequest" }, "example" : { "carrierDefinitionId" : "019ade48-9368-7577-990d-987fe9b34324", "checkoutId" : "9d9e7256-45f0-4906-9c3e-8f8fa7a8214e", "deliveryOptionId" : "019b266d-ee29-7000-824e-2a43c67c7ab0", "meta" : { "key1" : "value1", "key2" : "value2" }, "parcelIds" : [ "019beadd-e6df-7e4b-a0f6-54faf53e8f23", "019beadc-cee9-70b4-b880-55a84a0b6be6" ], "parties" : [ { "id" : "019b220f-7d9b-7435-b352-f718eb22fa4a", "roles" : [ "SENDER" ], "source" : "amber-falcon-river", "type" : "ADDRESS" }, { "id" : "019b220f-7d9b-7435-b352-f718eb22fa4a", "roles" : [ "SENDER" ], "source" : "amber-falcon-river", "type" : "ADDRESS" } ], "rate" : { "carrierRate" : { "enabled" : false, "fallbackPrice" : 1.0 }, "cartPrice" : 10.0, "currency" : "EUR", "price" : 10.0 }, "serviceDefinitionId" : "01991a00-07b3-7171-a245-177e15965608", "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BasicResponse" }, "example" : { "id" : "01991a03-c860-7000-bb91-5a9cb479f522" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipping-quotes/{shipping-quote-id}/shipment-bookings" : { "post" : { "tags" : [ "Shipping Quotes" ], "summary" : "Create Shipment Booking from Shipping Quote", "description" : "Creates a Shipment Booking from an existing Shipping Quote. Provide `shipping-quote-id` in the path and a `ShipmentBookingRequest` payload (with `shipmentChannelId`) in the request body. Carrier, service, parties and parcels are taken from the Shipping Quote. \nReturns the created Shipment Booking.\n", "operationId" : "createShipmentBookingFromQuote", "parameters" : [ { "name" : "shipping-quote-id", "in" : "path", "description" : "Shipping quote id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentBookingRequest" }, "example" : { "carrierDefinitionId" : "019aa590-a84b-7000-89fe-2a0a157be008", "customsDeclarationId" : "019ab521-5fc6-7836-8d3b-ba0f6e12e003", "dangerousGoodsDeclarationId" : "019ab521-5fc6-7836-8d3b-ba0f6e12e003", "delivery" : { "instructions" : [ "Leave with the neighbour" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "08:00", "timeTo" : "16:00" } }, "info" : { "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "carrier" : { "reference" : "S-12345", "instructions" : [ "Leave parcel in reception" ] }, "delivery" : { "reference" : "S-12345", "instructions" : [ "Leave parcel in reception" ] }, "dispatch" : { "reference" : "S-12345", "instructions" : [ "Leave parcel in reception" ] }, "terms" : { "code" : "DDP", "location" : "Gothenburg" } }, "parcelIds" : [ "019b2e9f-ed2f-70d9-befb-f6bafa4377b7", "019b2e85-e47e-7911-92fd-d0897e6e3546" ], "parties" : [ { "type" : "ADDRESS", "roles" : [ "SENDER" ], "id" : "019b2766-8eb4-795c-899f-9ac8d5cc6a34" }, { "type" : "ADDRESS", "roles" : [ "RECEIVER" ], "id" : "019b0293-0db8-7c4f-9427-cf56154166c0" } ], "persistence" : { "type" : "example" }, "pickup" : { "instructions" : [ "Ring doorbell upon arrival" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "09:00", "timeTo" : "17:00" } }, "serviceDefinitionId" : "01991a00-07b3-7171-a245-177e15965608", "shipmentChannelId" : "019a8bcf-d773-7ee0-b72b-894b0c9dfc75" } } }, "required" : true }, "responses" : { "403" : { "description" : "Returned when the caller is a `SHARED` account, which has no Delivery account to run this operation.", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentBookingResponse" }, "example" : { "id" : "019b26d6-73d6-7bf6-b1b6-4531af80e7d7", "createdAt" : "2026-01-22T10:30:00Z", "serial" : "6250197719", "chargeables" : { "addons" : [ { "code" : "INSU" } ], "dimensionsUnit" : "CM", "palletCount" : 10, "pallets" : [ { "count" : 5, "type" : "EPAL-1" } ], "palletType" : "EPAL-1", "parcelCount" : 10, "shipmentCount" : 1, "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "KG" }, "delivery" : { "instructions" : [ "Leave with the neighbour" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "08:00", "timeTo" : "16:00" } }, "documents" : [ { "id" : "019ad95e-4b32-7a61-99fb-4367638dd836", "contentType" : "pdf", "documentType" : "LABEL", "mediaType" : "laser-a4", "pages" : 1 } ], "pickup" : { "instructions" : [ "Ring doorbell upon arrival" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "09:00", "timeTo" : "17:00" } }, "state" : { "consolidated" : false, "finalized" : false, "inbound" : false, "outbound" : false }, "tracker" : { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "status" : "BOOKED", "logs" : [ { "createdAt" : "2026-04-27T11:12:08Z", "category" : "example", "message" : "The document type LABEL failed to process, please try regenerating documents.", "payload" : { "id" : "019dcea3-b444-7073-bc96-9533c4ad830c", "normalizedStatus" : "example", "sourceEventCode" : "example", "tookPlaceAt" : "2026-01-01T10:00:00" }, "topic" : "DOCUMENTS", "type" : "ERROR" } ], "parcels" : [ { "status" : "BOOKED", "reference" : "#45678", "serial" : "473325380000006010", "link" : "https://track.example.com/?parcel=00001234567890123456" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "shipment" : { "status" : "BOOKED", "serial" : "00001234567890123456", "link" : "https://..." } } } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipping-quotes/{shipping-quote-id}/shipment-bookings/inline" : { "post" : { "tags" : [ "Shipping Quotes" ], "summary" : "Create Shipment Booking from Shipping Quote (Inline)", "description" : "Creates an inline Shipment Booking from an existing Shipping Quote. Provide `shipping-quote-id` in the path and an `InlineShipmentBooking` payload in the request body. Any field missing from the request falls back to the corresponding value on the Shipping Quote. \nReturns the created Shipment Booking.\n", "operationId" : "createInlineShipmentBookingFromQuote", "parameters" : [ { "name" : "shipping-quote-id", "in" : "path", "description" : "Shipping quote id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "validations", "in" : "query", "description" : "Comma-separated address validation toggles. Format: KEY or KEY:true/false. Supported: POSTALCODE, PHONENUMBER. Defaults: PHONENUMBER enabled, POSTALCODE disabled. Example: POSTALCODE:true,PHONENUMBER:false", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "example", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "example" : "example" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InlineShipmentBooking" }, "example" : { "carrierDefinition" : { "name" : "DHL Home Delivery", "carrierId" : "24260549-47a1-390b-a211-da8989984a08", "group" : "UPS_saver", "mode" : "STAGING", "settings" : [ { "key" : "api-key", "value" : "5qqMQ5DhciBfJgBcGFyXYm66pl1lbgKV26v6ybKvcDkgMOO1BCv3iE68HDakvW9o" } ] }, "customsDeclaration" : { "reference" : "INV-2025-0001", "charges" : { "duty" : 75.0, "freight" : 250.0, "insurance" : 50.0, "invoice" : 1500.0, "other" : 20.0 }, "comments" : [ "Goods are samples and not for resale." ], "currency" : "EUR", "declarant" : { "city" : "Oslo", "firstName" : "John", "lastName" : "Doe", "title" : "Mr." }, "declaredAt" : "2024-07-01T00:00:00+00:00", "invoice" : { "items" : [ { "reference" : "ITEM-REF-12345", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ { "type" : "GTIN", "value" : "4006381333931" } ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "number" : "INV-2025-0001" }, "purpose" : { "code" : "GIFT" }, "statements" : [ "I hereby declare that the information contained in this declaration is true and complete to the best of my knowledge and belief." ], "terms" : { "code" : "DDP", "location" : "Rotterdam" }, "types" : [ "CN22" ] }, "dangerousGoodsDeclaration" : { "reference" : "DG-REF-12345", "declarant" : { "city" : "Stockholm", "firstName" : "John", "lastName" : "Doe", "title" : "Mr." }, "declaredAt" : "2021-09-01T12:00:00+02:00", "goods" : [ { "code" : "UN1950", "hazard" : { "code" : "F1", "environmental" : false, "flashPoint" : -20, "hazardClass" : "3" }, "notes" : [ "Handle with care" ], "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "group" : "II", "type" : "BOTTLE" }, "shippingName" : "Aerosols, flammable", "technicalName" : "Propane, Butane mixture", "transportation" : { "emergencyCode" : "2YE", "separation" : 3, "tunnelRestriction" : "D/E" }, "type" : "DG_01" } ], "goodsTypes" : [ "ADR", "DNG" ], "handling" : [ "Aerosol containers are pressurized and may rupture if exposed to heat or physical damage.", "Handle carefully to prevent puncture, crushing, or leakage." ], "meta" : { "key1" : "value1", "key2" : "value2" }, "modal" : "ROAD", "type" : "\"ADR\"" }, "delivery" : { "instructions" : [ "Leave with the neighbour" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "08:00", "timeTo" : "16:00" } }, "info" : { "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "carrier" : { "reference" : "S-12345", "instructions" : [ "Leave parcel in reception" ] }, "delivery" : { "reference" : "S-12345", "instructions" : [ "Leave parcel in reception" ] }, "dispatch" : { "reference" : "S-12345", "instructions" : [ "Leave parcel in reception" ] }, "terms" : { "code" : "DDP", "location" : "Gothenburg" } }, "parcels" : [ { "reference" : "#45678", "serial" : "473325380000006010", "dangerousGoods" : [ { "netQuantity" : 10.5, "netQuantityUnit" : "KG", "quantity" : 5, "type" : "UN1950" } ], "description" : "This is a parcel description", "items" : [ { "reference" : "ITEM-REF-12345", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ { "type" : "GTIN", "value" : "4006381333931" } ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "dimensionsUnit" : "M", "height" : 10.0, "length" : 10.0, "markings" : [ "THIS_SIDE_UP" ], "pallet" : { "group" : "GROUP-A", "type" : "EPAL-1" }, "type" : "PACKAGE", "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "G", "width" : 10.0 }, "weight" : 10.0, "weightUnit" : "G" } ], "parties" : [ { "id" : "019b220f-7d9b-7435-b352-f718eb22fa4a", "roles" : [ "SENDER" ], "source" : "amber-falcon-river", "type" : "ADDRESS" } ], "pickup" : { "instructions" : [ "Ring doorbell upon arrival" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "09:00", "timeTo" : "17:00" } }, "serviceDefinition" : { "name" : "PostNord for domestic B2C use", "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "group" : "UPS_saver", "serviceId" : "d9214010-7bb6-3e78-bbd5-c7b39f584722" }, "shipmentChannel" : { "name" : "My shipment channel", "documentRendering" : { "enabled" : false, "settings" : [ { "contentType" : "pdf", "documentType" : "LABEL", "enabled" : false, "mediaType" : "thermo-190", "offsetX" : 0.0, "offsetY" : 0.0, "options" : { "mode" : "DT" }, "pageBreak" : false } ] }, "pickup" : { "enabled" : false, "slots" : [ { "name" : "Monday morning", "active" : false, "conditions" : { "carrierId" : "8c2b9506-043c-3adb-918b-e134d3c36bd6", "serviceId" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82" }, "description" : "example", "instructions" : [ "example" ], "leadTime" : 2, "recurrence" : { "timeFrom" : "08:00", "timeTo" : "10:00", "weekday" : "MO" } } ] }, "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" } } } } }, "required" : true }, "responses" : { "403" : { "description" : "Returned when the caller is a `SHARED` account, which has no Delivery account to run this operation.", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShipmentBookingResponse" }, "example" : { "id" : "019b26d6-73d6-7bf6-b1b6-4531af80e7d7", "createdAt" : "2026-01-22T10:30:00Z", "serial" : "6250197719", "chargeables" : { "addons" : [ { "code" : "INSU" } ], "dimensionsUnit" : "CM", "palletCount" : 10, "pallets" : [ { "count" : 5, "type" : "EPAL-1" } ], "palletType" : "EPAL-1", "parcelCount" : 10, "shipmentCount" : 1, "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "KG" }, "delivery" : { "instructions" : [ "Leave with the neighbour" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "08:00", "timeTo" : "16:00" } }, "documents" : [ { "id" : "019ad95e-4b32-7a61-99fb-4367638dd836", "contentType" : "pdf", "documentType" : "LABEL", "mediaType" : "laser-a4", "pages" : 1 } ], "pickup" : { "instructions" : [ "Ring doorbell upon arrival" ], "slot" : { "date" : "2024-12-01", "timeFrom" : "09:00", "timeTo" : "17:00" } }, "state" : { "consolidated" : false, "finalized" : false, "inbound" : false, "outbound" : false }, "tracker" : { "id" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "status" : "BOOKED", "logs" : [ { "createdAt" : "2026-04-27T11:12:08Z", "category" : "example", "message" : "The document type LABEL failed to process, please try regenerating documents.", "payload" : { "id" : "019dcea3-b444-7073-bc96-9533c4ad830c", "normalizedStatus" : "example", "sourceEventCode" : "example", "tookPlaceAt" : "2026-01-01T10:00:00" }, "topic" : "DOCUMENTS", "type" : "ERROR" } ], "parcels" : [ { "status" : "BOOKED", "reference" : "#45678", "serial" : "473325380000006010", "link" : "https://track.example.com/?parcel=00001234567890123456" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "shipment" : { "status" : "BOOKED", "serial" : "00001234567890123456", "link" : "https://..." } } } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipping-quotes/inline" : { "post" : { "tags" : [ "Shipping Quotes" ], "summary" : "Create Shipping Quote inline", "description" : "Creates a new Shipping Quote using inline shipment details, including embedded addresses. Provide required parameters. \nReturns the `shipping-quote-id`.\n\n**Note:** Shipping Quotes are valid for 24 hours.", "operationId" : "createInlineShippingQuote", "parameters" : [ { "name" : "validations", "in" : "query", "description" : "Comma-separated address validation toggles. Format: KEY or KEY:true/false. Supported: POSTALCODE, PHONENUMBER. Defaults: PHONENUMBER enabled, POSTALCODE disabled. Example: POSTALCODE:true,PHONENUMBER:false", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "example", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "example" : "example" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InlineShippingQuoteRequest" }, "example" : { "carrierDefinition" : { "name" : "DHL Home Delivery", "carrierId" : "24260549-47a1-390b-a211-da8989984a08", "group" : "UPS_saver", "mode" : "STAGING", "settings" : [ { "key" : "api-key", "value" : "5qqMQ5DhciBfJgBcGFyXYm66pl1lbgKV26v6ybKvcDkgMOO1BCv3iE68HDakvW9o" } ] }, "checkoutId" : "9d9e7256-45f0-4906-9c3e-8f8fa7a8214e", "deliveryOptionId" : "019b266d-ee29-7000-824e-2a43c67c7ab0", "meta" : { "key1" : "value1", "key2" : "value2" }, "parcels" : [ { "reference" : "#45678", "serial" : "473325380000006010", "dangerousGoods" : [ { "netQuantity" : 10.5, "netQuantityUnit" : "KG", "quantity" : 5, "type" : "UN1950" } ], "description" : "This is a parcel description", "items" : [ { "reference" : "ITEM-REF-12345", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ { "type" : "GTIN", "value" : "4006381333931" } ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "dimensionsUnit" : "M", "height" : 10.0, "length" : 10.0, "markings" : [ "THIS_SIDE_UP" ], "pallet" : { "group" : "GROUP-A", "type" : "EPAL-1" }, "type" : "PACKAGE", "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "G", "width" : 10.0 }, "weight" : 10.0, "weightUnit" : "G" } ], "parties" : [ { "id" : "019b220f-7d9b-7435-b352-f718eb22fa4a", "roles" : [ "SENDER" ], "source" : "amber-falcon-river", "type" : "ADDRESS" }, { "id" : "019b220f-7d9b-7435-b352-f718eb22fa4a", "roles" : [ "SENDER" ], "source" : "amber-falcon-river", "type" : "ADDRESS" } ], "rate" : { "carrierRate" : { "enabled" : false, "fallbackPrice" : 1.0 }, "cartPrice" : 10.0, "currency" : "EUR", "price" : 10.0 }, "serviceDefinition" : { "name" : "PostNord for domestic B2C use", "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "group" : "UPS_saver", "serviceId" : "d9214010-7bb6-3e78-bbd5-c7b39f584722" }, "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BasicResponse" }, "example" : { "id" : "01991a03-c860-7000-bb91-5a9cb479f522" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/delivery-options" : { "get" : { "tags" : [ "Delivery Options" ], "summary" : "List Delivery Options", "description" : "Lists Delivery Options. \nReturns a paginated list of Delivery Options.\n", "operationId" : "listDeliveryOptions", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeliveryOptionListResponse" }, "example" : { "items" : [ { "id" : "019c2038-9e20-7000-8193-7c08db53a87f", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "name" : "Standard Shipping", "carrierDefinitionId" : "019a8cb2-394a-7689-8a09-1c96ee3cea88", "description" : "Standard shipping with 3-5 business days delivery", "enabled" : false, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "priority" : 0, "rates" : [ { "carrierRate" : { "enabled" : false, "fallbackPrice" : 1.0 }, "conditions" : [ { "comparator" : "EQUAL", "parameter" : "WEIGHT", "value" : "10" } ], "currency" : "EUR", "price" : 10.0, "priority" : 1 } ], "serviceDefinitionId" : "019a8cc2-7ecd-7b05-ae3d-a3e82ca19827", "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" }, "zones" : [ { "id" : "019b266c-0504-7f31-8f27-e216b1744ed6", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "name" : "European Union", "countries" : [ { "name" : "Germany", "code" : "DE" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" } } ] } ], "nextCursor" : "019b0595-4d32-7000-96b7-3c435889aeff" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "post" : { "tags" : [ "Delivery Options" ], "summary" : "Create Delivery Option", "description" : "Creates a new Delivery Option. Provide required parameters. \nReturns the `delivery-option-id`.\n\n**Note:** Zones must be created and associated with the Delivery Option.", "operationId" : "createDeliveryOption", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeliveryOptionRequest" }, "example" : { "name" : "Home Delivery", "carrierDefinitionId" : "019a8cb2-394a-7689-8a09-1c96ee3cea88", "description" : "The shipment is delivered directly to your door.", "enabled" : false, "leadTimes" : [ { "datePattern" : "Coming soon...", "delivery" : 1, "dispatch" : 1, "fulfillment" : 1 } ], "persistence" : { "type" : "example" }, "priority" : 1, "rates" : [ { "carrierRate" : { "enabled" : false, "fallbackPrice" : 1.0 }, "conditions" : [ { "comparator" : "EQUAL", "parameter" : "WEIGHT", "value" : "10" } ], "currency" : "EUR", "price" : 10.0, "priority" : 1 } ], "serviceDefinitionId" : "01991a00-07b3-7171-a245-177e15965608", "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" }, "zoneIds" : [ "019b266c-0504-7f31-8f27-e216b1744ed6", "019a9e36-06ba-718e-b98e-e4907a7edfe7" ] } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BasicResponse" }, "example" : { "id" : "01991a03-c860-7000-bb91-5a9cb479f522" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/delivery-options/zones" : { "get" : { "tags" : [ "Zones" ], "summary" : "List Zones", "description" : "Lists Zones. \nReturns a paginated list of Zones.\n", "operationId" : "listZones", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZoneListResponse" }, "example" : { "items" : [ { "id" : "019b266c-0504-7f31-8f27-e216b1744ed6", "createdAt" : "2026-01-22T10:30:00Z", "updatedAt" : "2026-01-22T10:30:00Z", "name" : "European Union", "countries" : [ { "name" : "Germany", "code" : "DE" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" } } ], "nextCursor" : "019a9e36-06ba-718e-b98e-e4907a7edfe7" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "post" : { "tags" : [ "Zones" ], "summary" : "Create Zone", "description" : "Creates a new Zone. Provide required parameters. \nReturns the `zone-id`.\n\n", "operationId" : "createZone", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ZoneRequest" }, "example" : { "name" : "Europe", "countries" : [ { "name" : "Germany", "code" : "DE" } ], "persistence" : { "type" : "example" } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BasicResponse" }, "example" : { "id" : "01991a03-c860-7000-bb91-5a9cb479f522" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/delivery-options/shipping-quotes" : { "post" : { "tags" : [ "Delivery Options" ], "summary" : "Generate Shipping Quotes", "description" : "Generates Shipping Quotes by evaluating all active Delivery Options for the provided payload. \nReturns a batch of Shipping Quotes and a `purchase-id` for later reference.\n\n**Note:** Shipping Quotes are valid for 24 hours.\n", "operationId" : "generateShippingQuotes", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShippingQuotesRequest" }, "example" : { "checkoutId" : "1d17df8e-9945-4449-8eb8-54e658159c5a", "currency" : "EUR", "deliveryOptionIds" : [ "019c2038-9e20-7000-8193-7c08db53a87f", "019b0595-4d32-7000-96b7-3c435889aeff" ], "parcelIds" : [ "019beadd-e6df-7e4b-a0f6-54faf53e8f23", "019beadc-cee9-70b4-b880-55a84a0b6be6" ], "parties" : [ { "id" : "019b220f-7d9b-7435-b352-f718eb22fa4a", "roles" : [ "SENDER" ], "source" : "amber-falcon-river", "type" : "ADDRESS" }, { "id" : "019b220f-7d9b-7435-b352-f718eb22fa4a", "roles" : [ "SENDER" ], "source" : "amber-falcon-river", "type" : "ADDRESS" } ], "persistence" : { "type" : "example" } } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShippingQuoteGeneratedListResponse" }, "example" : { "items" : [ { "id" : "019b45c5-6b7c-7000-92fd-6d6247de6372", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "carrierDefinition" : { "id" : "019ade48-9368-7577-990d-987fe9b34324", "createdAt" : "2024-01-15T10:30:00Z", "updatedAt" : "2024-01-15T10:30:00Z", "name" : "DHL Express", "carrierId" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "group" : "Express", "mode" : "STAGING", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "settings" : [ { "key" : "api-key", "value" : "5qqMQ5DhciBfJgBcGFyXYm66pl1lbgKV26v6ybKvcDkgMOO1BCv3iE68HDakvW9o" } ] }, "checkoutId" : "9d9e7256-45f0-4906-9c3e-8f8fa7a8214e", "deliveryOptionId" : "019c2038-9e20-7000-8193-7c08db53a87f", "meta" : { "key1" : "value1", "key2" : "value2" }, "parcels" : [ { "id" : "019beadd-818c-792d-9bd4-ea04b0dbe23e", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "#45678", "serial" : "473325380000006010", "dangerousGoods" : [ { "netQuantity" : 10.5, "netQuantityUnit" : "KG", "quantity" : 5, "type" : "UN1950" } ], "description" : "This is a parcel description", "items" : [ { "id" : "019ab5ae-7cbb-7665-94a8-86edb63c6191", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "ITEM-REF-001", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "dimensionsUnit" : "M", "height" : 10.0, "length" : 10.0, "markings" : [ "THIS_SIDE_UP" ], "pallet" : { "group" : "GROUP-A", "type" : "EPAL-1" }, "type" : "PACKAGE", "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "G", "width" : 10.0 }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "weight" : 10.0, "weightUnit" : "G" } ], "parties" : [ { "address" : { "id" : "019b2766-8eb4-795c-899f-9ac8d5cc6a34", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "company" : { "name" : "nShift", "identification" : [ ] }, "contact" : { "careOf" : "Jane Smith", "doorCode" : "11", "email" : "jdoe@nshift.com", "fax" : "+46721234567", "firstName" : "John", "lastName" : "Doe", "mobile" : "+46721234567", "phone" : "+46721234567" }, "group" : "warehouse_1", "lines" : [ "John Doe c/o Mr Smith, nShift", "Schiller street 45, Neighborhood x", "Century Plaza 13, Floor 3, Apt 32", "District 4, DC, US-NY, US, 111111" ], "location" : { "buildingName" : "Skyline Towers", "buildingNumber" : "13", "city" : "Washington DC", "countryCode" : "US", "floor" : "2", "geoCoding" : { "latitude" : "38.8977", "longitude" : "-77.0365" }, "locality" : "Brooklyn", "postalCode" : "111111", "region" : "District of Columbia", "stateCode" : "US_WA", "streetName" : "Main Street", "streetNumber" : "5", "unit" : "4B" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "references" : { "external" : "987654-321", "internal" : "1234567-7890-12" }, "source" : "amber-falcon-river", "type" : "RESIDENTIAL" }, "roles" : [ "SENDER" ], "type" : "ADDRESS" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "rate" : { "carrierPrice" : 10.0, "carrierRate" : { "enabled" : false, "fallbackPrice" : 1.0, "local" : { "currency" : "example", "price" : 1 }, "response" : { "message" : "Price calculated successfully.", "type" : "INFO" } }, "cartPrice" : 10.0, "currency" : "EUR", "price" : 10.0, "priceMargin" : 10.0, "priceTotal" : 10.0 }, "serviceDefinition" : { "id" : "01991a00-07b3-7171-a245-177e15965608", "createdAt" : "2024-01-15T10:30:00Z", "updatedAt" : "2024-01-15T10:30:00Z", "name" : "DHL Express for domestic B2C use", "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "carrierId" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "group" : "Express", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "serviceId" : "2b0ca74b-08fa-3726-800b-a7c0e01f9fcf" }, "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" } } ] } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/delivery-options/shipping-quotes/inline" : { "post" : { "tags" : [ "Delivery Options" ], "summary" : "Generate Shipping Quotes inline", "description" : "Generates Shipping Quotes by evaluating all active Delivery Options for the provided inline payload, including embedded addresses.\nReturns a batch of Shipping Quotes and a `purchase-id` for later reference.\n\n**Note:** Shipping Quotes are valid for 24 hours.\n", "operationId" : "generateInlineShippingQuotes", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InlineShippingQuotesRequest" }, "example" : { "checkoutId" : "1d17df8e-9945-4449-8eb8-54e658159c5a", "currency" : "EUR", "deliveryOptionIds" : [ "019c2038-9e20-7000-8193-7c08db53a87f", "019b0595-4d32-7000-96b7-3c435889aeff" ], "parcels" : [ { "reference" : "#45678", "serial" : "473325380000006010", "dangerousGoods" : [ { "netQuantity" : 10.5, "netQuantityUnit" : "KG", "quantity" : 5, "type" : "UN1950" } ], "description" : "This is a parcel description", "items" : [ { "reference" : "ITEM-REF-12345", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ { "type" : "GTIN", "value" : "4006381333931" } ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "dimensionsUnit" : "M", "height" : 10.0, "length" : 10.0, "markings" : [ "THIS_SIDE_UP" ], "pallet" : { "group" : "GROUP-A", "type" : "EPAL-1" }, "type" : "PACKAGE", "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "G", "width" : 10.0 }, "weight" : 10.0, "weightUnit" : "G" } ], "parties" : [ { "id" : "019b220f-7d9b-7435-b352-f718eb22fa4a", "roles" : [ "SENDER" ], "source" : "amber-falcon-river", "type" : "ADDRESS" }, { "id" : "019b220f-7d9b-7435-b352-f718eb22fa4a", "roles" : [ "SENDER" ], "source" : "amber-falcon-river", "type" : "ADDRESS" } ] } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShippingQuoteGeneratedListResponse" }, "example" : { "items" : [ { "id" : "019b45c5-6b7c-7000-92fd-6d6247de6372", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "carrierDefinition" : { "id" : "019ade48-9368-7577-990d-987fe9b34324", "createdAt" : "2024-01-15T10:30:00Z", "updatedAt" : "2024-01-15T10:30:00Z", "name" : "DHL Express", "carrierId" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "group" : "Express", "mode" : "STAGING", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "settings" : [ { "key" : "api-key", "value" : "5qqMQ5DhciBfJgBcGFyXYm66pl1lbgKV26v6ybKvcDkgMOO1BCv3iE68HDakvW9o" } ] }, "checkoutId" : "9d9e7256-45f0-4906-9c3e-8f8fa7a8214e", "deliveryOptionId" : "019c2038-9e20-7000-8193-7c08db53a87f", "meta" : { "key1" : "value1", "key2" : "value2" }, "parcels" : [ { "id" : "019beadd-818c-792d-9bd4-ea04b0dbe23e", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "#45678", "serial" : "473325380000006010", "dangerousGoods" : [ { "netQuantity" : 10.5, "netQuantityUnit" : "KG", "quantity" : 5, "type" : "UN1950" } ], "description" : "This is a parcel description", "items" : [ { "id" : "019ab5ae-7cbb-7665-94a8-86edb63c6191", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "ITEM-REF-001", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "dimensionsUnit" : "M", "height" : 10.0, "length" : 10.0, "markings" : [ "THIS_SIDE_UP" ], "pallet" : { "group" : "GROUP-A", "type" : "EPAL-1" }, "type" : "PACKAGE", "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "G", "width" : 10.0 }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "weight" : 10.0, "weightUnit" : "G" } ], "parties" : [ { "address" : { "id" : "019b2766-8eb4-795c-899f-9ac8d5cc6a34", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "company" : { "name" : "nShift", "identification" : [ ] }, "contact" : { "careOf" : "Jane Smith", "doorCode" : "11", "email" : "jdoe@nshift.com", "fax" : "+46721234567", "firstName" : "John", "lastName" : "Doe", "mobile" : "+46721234567", "phone" : "+46721234567" }, "group" : "warehouse_1", "lines" : [ "John Doe c/o Mr Smith, nShift", "Schiller street 45, Neighborhood x", "Century Plaza 13, Floor 3, Apt 32", "District 4, DC, US-NY, US, 111111" ], "location" : { "buildingName" : "Skyline Towers", "buildingNumber" : "13", "city" : "Washington DC", "countryCode" : "US", "floor" : "2", "geoCoding" : { "latitude" : "38.8977", "longitude" : "-77.0365" }, "locality" : "Brooklyn", "postalCode" : "111111", "region" : "District of Columbia", "stateCode" : "US_WA", "streetName" : "Main Street", "streetNumber" : "5", "unit" : "4B" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "references" : { "external" : "987654-321", "internal" : "1234567-7890-12" }, "source" : "amber-falcon-river", "type" : "RESIDENTIAL" }, "roles" : [ "SENDER" ], "type" : "ADDRESS" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "rate" : { "carrierPrice" : 10.0, "carrierRate" : { "enabled" : false, "fallbackPrice" : 1.0, "local" : { "currency" : "example", "price" : 1 }, "response" : { "message" : "Price calculated successfully.", "type" : "INFO" } }, "cartPrice" : 10.0, "currency" : "EUR", "price" : 10.0, "priceMargin" : 10.0, "priceTotal" : 10.0 }, "serviceDefinition" : { "id" : "01991a00-07b3-7171-a245-177e15965608", "createdAt" : "2024-01-15T10:30:00Z", "updatedAt" : "2024-01-15T10:30:00Z", "name" : "DHL Express for domestic B2C use", "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "carrierId" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "group" : "Express", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "serviceId" : "2b0ca74b-08fa-3726-800b-a7c0e01f9fcf" }, "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" } } ] } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/shipping-quotes/{shipping-quote-id}" : { "get" : { "tags" : [ "Shipping Quotes" ], "summary" : "Fetch Shipping Quote", "description" : "Fetches a specific Shipping Quote. Provide `shipping-quote-id`. \nReturns the Shipping Quote.\n", "operationId" : "fetchShippingQuote", "parameters" : [ { "name" : "shipping-quote-id", "in" : "path", "description" : "Shipping quote id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ShippingQuoteResponse" }, "example" : { "id" : "019b45c5-6b7c-7000-92fd-6d6247de6372", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "carrierDefinition" : { "id" : "019ade48-9368-7577-990d-987fe9b34324", "createdAt" : "2024-01-15T10:30:00Z", "updatedAt" : "2024-01-15T10:30:00Z", "name" : "DHL Express", "carrierId" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "group" : "Express", "mode" : "STAGING", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "settings" : [ { "key" : "api-key", "value" : "5qqMQ5DhciBfJgBcGFyXYm66pl1lbgKV26v6ybKvcDkgMOO1BCv3iE68HDakvW9o" } ] }, "checkoutId" : "9d9e7256-45f0-4906-9c3e-8f8fa7a8214e", "deliveryOptionId" : "019c2038-9e20-7000-8193-7c08db53a87f", "meta" : { "key1" : "value1", "key2" : "value2" }, "parcels" : [ { "id" : "019beadd-818c-792d-9bd4-ea04b0dbe23e", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "#45678", "serial" : "473325380000006010", "dangerousGoods" : [ { "netQuantity" : 10.5, "netQuantityUnit" : "KG", "quantity" : 5, "type" : "UN1950" } ], "description" : "This is a parcel description", "items" : [ { "id" : "019ab5ae-7cbb-7665-94a8-86edb63c6191", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "ITEM-REF-001", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ { "type" : "GTIN", "value" : "4006381333931" } ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "dimensionsUnit" : "M", "height" : 10.0, "length" : 10.0, "markings" : [ "THIS_SIDE_UP" ], "pallet" : { "group" : "GROUP-A", "type" : "EPAL-1" }, "type" : "PACKAGE", "volume" : 10.0, "volumeUnit" : "CM3", "weight" : 10.0, "weightUnit" : "G", "width" : 10.0 }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "weight" : 10.0, "weightUnit" : "G" } ], "parties" : [ { "address" : { "id" : "019b2766-8eb4-795c-899f-9ac8d5cc6a34", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "company" : { "name" : "nShift", "identification" : [ { "type" : "VAT", "value" : "SE556546371701" } ] }, "contact" : { "careOf" : "Jane Smith", "doorCode" : "11", "email" : "jdoe@nshift.com", "fax" : "+46721234567", "firstName" : "John", "lastName" : "Doe", "mobile" : "+46721234567", "phone" : "+46721234567" }, "group" : "warehouse_1", "lines" : [ "John Doe c/o Mr Smith, nShift", "Schiller street 45, Neighborhood x", "Century Plaza 13, Floor 3, Apt 32", "District 4, DC, US-NY, US, 111111" ], "location" : { "buildingName" : "Skyline Towers", "buildingNumber" : "13", "city" : "Washington DC", "countryCode" : "US", "floor" : "2", "geoCoding" : { "latitude" : "38.8977", "longitude" : "-77.0365" }, "locality" : "Brooklyn", "postalCode" : "111111", "region" : "District of Columbia", "stateCode" : "US_WA", "streetName" : "Main Street", "streetNumber" : "5", "unit" : "4B" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "references" : { "external" : "987654-321", "internal" : "1234567-7890-12" }, "source" : "amber-falcon-river", "type" : "RESIDENTIAL" }, "roles" : [ "SENDER" ], "type" : "ADDRESS" } ], "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "rate" : { "carrierPrice" : 10.0, "carrierRate" : { "enabled" : false, "fallbackPrice" : 1.0, "local" : { "currency" : "example", "price" : 1 }, "response" : { "message" : "Price calculated successfully.", "type" : "INFO" } }, "cartPrice" : 10.0, "currency" : "EUR", "price" : 10.0, "priceMargin" : 10.0, "priceTotal" : 10.0 }, "serviceDefinition" : { "id" : "01991a00-07b3-7171-a245-177e15965608", "createdAt" : "2024-01-15T10:30:00Z", "updatedAt" : "2024-01-15T10:30:00Z", "name" : "DHL Express for domestic B2C use", "addons" : [ { "code" : "DLVIN", "fields" : [ { "key" : "mobile", "value" : "+467012367890" } ] } ], "carrierId" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "group" : "Express", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "serviceId" : "2b0ca74b-08fa-3726-800b-a7c0e01f9fcf" }, "units" : { "dimensions" : "CM", "volume" : "CM3", "weight" : "KG" } } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/documents/{document-id}" : { "get" : { "tags" : [ "Documents" ], "summary" : "Fetch Document", "description" : "Fetches a specific Document. Provide `document-id`. Returns the Document.", "operationId" : "fetchDocument", "parameters" : [ { "name" : "document-id", "in" : "path", "description" : "Document id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "page", "in" : "query", "description" : "Page.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 1 }, "example" : 1 }, { "name" : "group_id", "in" : "query", "description" : "Group id.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DocumentResponse" }, "example" : { "id" : "019b26d1-6ef4-7331-b628-11fd3dfda3dd", "data" : "JVBERi0xLjQKJeLjz9MKNCAwIG9iago8PC9MZW5ndGgg...", "metadata" : { "createdAt" : "2026-01-22T10:30:00Z", "contentType" : "pdf", "documentType" : "LABEL", "groupId" : "019b26d1-6ef4-7331-b628-11fd3dfda3dd", "mediaType" : "laser-a4", "pages" : 3 }, "pages" : [ { "reference" : "#45678", "data" : "JVBERi0xLjQKJeLjz9MKNCAwIG9iago8PC9MZW5ndGgg...", "page" : 1 } ] } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/documents/{document-id}/meta-data" : { "get" : { "tags" : [ "Documents" ], "summary" : "Fetch Document Metadata", "description" : "Fetches metadata for an existing Document. Provide `document-id`. Returns the Document metadata.", "operationId" : "fetchDocumentMetaData", "parameters" : [ { "name" : "document-id", "in" : "path", "description" : "Document id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "group_id", "in" : "query", "description" : "Group id.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DocumentMetadataResponse" }, "example" : { "id" : "019b26d1-6ef4-7331-b628-11fd3dfda3dd", "metaData" : { "createdAt" : "2026-01-22T10:30:00Z", "contentType" : "pdf", "documentType" : "LABEL", "groupId" : "019b26d1-6ef4-7331-b628-11fd3dfda3dd", "mediaType" : "laser-a4", "pages" : 3 } } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/documents/{document-id}/data" : { "get" : { "tags" : [ "Documents" ], "summary" : "Fetch Document Data", "description" : "Fetches document data. Provide `document-id`. Returns the document data.", "operationId" : "fetchDocumentData", "parameters" : [ { "name" : "document-id", "in" : "path", "description" : "Document id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "page", "in" : "query", "description" : "Page.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 1 }, "example" : 1 }, { "name" : "group_id", "in" : "query", "description" : "Group id.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "Accept", "in" : "header", "description" : "Accept.", "required" : false, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : "example", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "example" : "example" } ], "responses" : { "200" : { "description" : "Raw document data retrieved", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/octet-stream" : { "schema" : { "type" : "string", "format" : "binary", "maxLength" : 10485760 }, "example" : "example" } } }, "401" : { "description" : "Unauthorized access", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "406" : { "description" : "Not acceptable", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal server error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/documents/meta-data" : { "get" : { "tags" : [ "Documents" ], "summary" : "List Document Metadata", "description" : "Lists metadata for Documents.\nProvide `groupId` to filter by related entity.\nReturns a paginated list of Document metadata.", "operationId" : "listDocumentsMetaData", "parameters" : [ { "name" : "group_id", "in" : "query", "description" : "Group id.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DocumentMetadataListResponse" }, "example" : { "items" : [ { "id" : "019b26d1-6ef4-7331-b628-11fd3dfda3dd", "metaData" : { "createdAt" : "2026-01-22T10:30:00Z", "contentType" : "pdf", "documentType" : "LABEL", "groupId" : "019b26d1-6ef4-7331-b628-11fd3dfda3dd", "mediaType" : "laser-a4", "pages" : 3 } } ] } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/api-docs" : { "get" : { "tags" : [ "Documentation" ], "summary" : "Fetch API Documentation", "description" : "Fetch the Base64-encoded content of a documentation document.", "operationId" : "downloadDocumentation", "responses" : { "200" : { "description" : "OK", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "example" : "example" } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } } } } }, "/v1/dangerous-goods-declarations/{dangerous-goods-declaration-id}" : { "get" : { "tags" : [ "Dangerous Goods Declarations" ], "summary" : "Fetch Dangerous Goods Declaration", "description" : "Fetches a specific Dangerous Goods Declaration. Provide `dangerous-goods-declaration-id`. Returns the Dangerous Goods Declaration.\n", "operationId" : "fetchDangerousGoodsDeclaration", "parameters" : [ { "name" : "dangerous-goods-declaration-id", "in" : "path", "description" : "Identifies the Dangerous Goods Declaration", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Dangerous Goods Declaration", "example" : "019ab521-5fc6-7836-8d3b-ba0f6e12e003", "maxLength" : 36 }, "example" : "019ab521-5fc6-7836-8d3b-ba0f6e12e003" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DangerousGoodsDeclarationResponse" }, "example" : { "id" : "019c2076-1a28-7bee-a9b3-42312a50d1b0", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "DG-REF-12345", "declarant" : { "city" : "Stockholm", "firstName" : "John", "lastName" : "Doe", "title" : "Mr." }, "declaredAt" : "2021-09-01T12:00:00+02:00", "goods" : [ { "code" : "UN1950", "hazard" : { "code" : "F1", "environmental" : false, "flashPoint" : -20, "hazardClass" : "3" }, "notes" : [ "Handle with care" ], "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "group" : "II", "type" : "BOTTLE" }, "shippingName" : "Aerosols, flammable", "technicalName" : "Propane, Butane mixture", "transportation" : { "emergencyCode" : "2YE", "separation" : 3, "tunnelRestriction" : "D/E" }, "type" : "DG_01" } ], "goodsTypes" : [ "FLAMMABLE", "CORROSIVE" ], "handling" : [ "Aerosol containers are pressurized and may rupture if exposed to heat or physical damage.", "Handle carefully to prevent puncture, crushing, or leakage." ], "meta" : { "key1" : "value1", "key2" : "value2" }, "modal" : "ROAD", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "standard" : "IATA", "type" : "[\"SHIPPER\", \"MULTIMODAL\"]" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "put" : { "tags" : [ "Dangerous Goods Declarations" ], "summary" : "Update Dangerous Goods Declaration", "description" : "Updates an existing Dangerous Goods Declaration. Provide `dangerous-goods-declaration-id` and updated values. \nReturns confirmation (`204 No Content`).\n", "operationId" : "replaceDangerousGoodsDeclaration", "parameters" : [ { "name" : "dangerous-goods-declaration-id", "in" : "path", "description" : "Dangerous goods declaration id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DangerousGoodsDeclarationRequest" }, "example" : { "reference" : "DG-REF-12345", "declarant" : { "city" : "Stockholm", "firstName" : "John", "lastName" : "Doe", "title" : "Mr." }, "declaredAt" : "2021-09-01T12:00:00+02:00", "goods" : [ { "code" : "UN1950", "hazard" : { "code" : "F1", "environmental" : false, "flashPoint" : -20, "hazardClass" : "3" }, "notes" : [ "Handle with care" ], "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "group" : "II", "type" : "BOTTLE" }, "shippingName" : "Aerosols, flammable", "technicalName" : "Propane, Butane mixture", "transportation" : { "emergencyCode" : "2YE", "separation" : 3, "tunnelRestriction" : "D/E" }, "type" : "DG_01" } ], "goodsTypes" : [ "ADR", "DNG" ], "handling" : [ "Aerosol containers are pressurized and may rupture if exposed to heat or physical damage.", "Handle carefully to prevent puncture, crushing, or leakage." ], "meta" : { "key1" : "value1", "key2" : "value2" }, "modal" : "ROAD", "persistence" : { "type" : "example" }, "type" : "\"ADR\"" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "delete" : { "tags" : [ "Dangerous Goods Declarations" ], "summary" : "Delete Dangerous Goods Declaration", "description" : "Deletes an existing Dangerous Goods Declaration. Provide `dangerous-goods-declaration-id`. Returns confirmation (`204 No Content`).\n", "operationId" : "removeDangerousGoodsDeclaration", "parameters" : [ { "name" : "dangerous-goods-declaration-id", "in" : "path", "description" : "Dangerous goods declaration id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/customs-declarations/{customs-declaration-id}" : { "get" : { "tags" : [ "Customs Declarations" ], "summary" : "Fetch Customs Declaration", "description" : "Fetches a specific Customs Declaration. Provide `customs-declaration-id`. Returns the Customs Declaration.", "operationId" : "fetchCustomsDeclaration", "parameters" : [ { "name" : "customs-declaration-id", "in" : "path", "description" : "Identifies the Customs Declaration", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Customs Declaration", "example" : "019ab521-5fc6-7836-8d3b-ba0f6e12e003", "maxLength" : 36 }, "example" : "019ab521-5fc6-7836-8d3b-ba0f6e12e003" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomsDeclarationResponse" }, "example" : { "id" : "019ab521-5fc6-7836-8d3b-ba0f6e12e003", "reference" : "INV-2025-0001", "charges" : { "duty" : 75.0, "freight" : 250.0, "insurance" : 50.0, "invoice" : 1500.0, "other" : 20.0 }, "comments" : [ "Goods are samples and not for resale." ], "currency" : "EUR", "declarant" : { "city" : "Oslo", "firstName" : "John", "lastName" : "Doe", "title" : "Mr." }, "declaredAt" : "2024-07-01T00:00:00+00:00", "invoice" : { "items" : [ { "id" : "019ab5ae-7cbb-7665-94a8-86edb63c6191", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "ITEM-REF-001", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ { "type" : "GTIN", "value" : "4006381333931" } ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "number" : "INV-2025-0001" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "purpose" : { "code" : "GIFT" }, "statements" : [ "I hereby declare that the information contained in this declaration is true and complete to the best of my knowledge and belief." ], "terms" : { "code" : "DDP", "location" : "Rotterdam" }, "types" : [ "CN22" ] } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "put" : { "tags" : [ "Customs Declarations" ], "summary" : "Update Customs Declaration", "description" : "Updates an existing Customs Declaration. Provide `customs-declaration-id` and updated values. Returns confirmation (`204 No Content`).\n", "operationId" : "replaceCustomsDeclaration", "parameters" : [ { "name" : "customs-declaration-id", "in" : "path", "description" : "Customs declaration id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomsDeclarationRequest" }, "example" : { "reference" : "INV-2025-0001", "charges" : { "duty" : 75.0, "freight" : 250.0, "insurance" : 50.0, "invoice" : 1500.0, "other" : 20.0 }, "comments" : [ "Goods are samples and not for resale." ], "currency" : "EUR", "declarant" : { "city" : "Oslo", "firstName" : "John", "lastName" : "Doe", "title" : "Mr." }, "declaredAt" : "2024-07-01T00:00:00+00:00", "invoice" : { "itemIds" : [ "019ad961-2659-7bbb-9f64-939126000e08", "019ad961-7b90-7db4-bdd3-06bac2699064" ], "number" : "INV-2025-0001" }, "persistence" : { "type" : "example" }, "purpose" : { "code" : "GIFT" }, "statements" : [ "I hereby declare that the information contained in this declaration is true and complete to the best of my knowledge and belief." ], "terms" : { "code" : "DDP", "location" : "Rotterdam" }, "types" : [ "CN22" ] } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "delete" : { "tags" : [ "Customs Declarations" ], "summary" : "Delete Customs Declaration", "description" : "Deletes an existing Customs Declaration. Provide `customs-declaration-id`. Returns confirmation (`204 No Content`).\n", "operationId" : "removeCustomsDeclaration", "parameters" : [ { "name" : "customs-declaration-id", "in" : "path", "description" : "Customs declaration id.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "204" : { "description" : "No Content", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/dangerous-goods-declarations" : { "get" : { "tags" : [ "Dangerous Goods Declarations" ], "summary" : "List Dangerous Goods Declarations", "description" : "Lists Dangerous Goods Declarations. Returns a paginated list of Dangerous Goods Declarations.\n", "operationId" : "listDangerousGoodsDeclarations", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DangerousGoodsDeclarationListResponse" }, "example" : { "items" : [ { "id" : "019c2076-1a28-7bee-a9b3-42312a50d1b0", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "DG-REF-12345", "declarant" : { "city" : "Stockholm", "firstName" : "John", "lastName" : "Doe", "title" : "Mr." }, "declaredAt" : "2021-09-01T12:00:00+02:00", "goods" : [ { "code" : "UN1950", "hazard" : { "code" : "F1", "environmental" : false, "flashPoint" : -20, "hazardClass" : "3" }, "notes" : [ "Handle with care" ], "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "group" : "II", "type" : "BOTTLE" }, "shippingName" : "Aerosols, flammable", "technicalName" : "Propane, Butane mixture", "transportation" : { "emergencyCode" : "2YE", "separation" : 3, "tunnelRestriction" : "D/E" }, "type" : "DG_01" } ], "goodsTypes" : [ "FLAMMABLE", "CORROSIVE" ], "handling" : [ "Aerosol containers are pressurized and may rupture if exposed to heat or physical damage.", "Handle carefully to prevent puncture, crushing, or leakage." ], "meta" : { "key1" : "value1", "key2" : "value2" }, "modal" : "ROAD", "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "standard" : "IATA", "type" : "[\"SHIPPER\", \"MULTIMODAL\"]" } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "post" : { "tags" : [ "Dangerous Goods Declarations" ], "summary" : "Create Dangerous Goods Declaration", "description" : "Creates a new Dangerous Goods Declaration. Provide required parameters. \nReturns the `dangerous-goods-declaration-id`.", "operationId" : "createDangerousGoodsDeclaration", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DangerousGoodsDeclarationRequest" }, "example" : { "reference" : "DG-REF-12345", "declarant" : { "city" : "Stockholm", "firstName" : "John", "lastName" : "Doe", "title" : "Mr." }, "declaredAt" : "2021-09-01T12:00:00+02:00", "goods" : [ { "code" : "UN1950", "hazard" : { "code" : "F1", "environmental" : false, "flashPoint" : -20, "hazardClass" : "3" }, "notes" : [ "Handle with care" ], "packing" : { "codeType" : { "code" : "PC", "type" : "GSPackageCode" }, "group" : "II", "type" : "BOTTLE" }, "shippingName" : "Aerosols, flammable", "technicalName" : "Propane, Butane mixture", "transportation" : { "emergencyCode" : "2YE", "separation" : 3, "tunnelRestriction" : "D/E" }, "type" : "DG_01" } ], "goodsTypes" : [ "ADR", "DNG" ], "handling" : [ "Aerosol containers are pressurized and may rupture if exposed to heat or physical damage.", "Handle carefully to prevent puncture, crushing, or leakage." ], "meta" : { "key1" : "value1", "key2" : "value2" }, "modal" : "ROAD", "persistence" : { "type" : "example" }, "type" : "\"ADR\"" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BasicResponse" }, "example" : { "id" : "01991a03-c860-7000-bb91-5a9cb479f522" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/customs-declarations" : { "get" : { "tags" : [ "Customs Declarations" ], "summary" : "List Customs Declarations", "description" : "Lists Customs Declarations. Returns a paginated list of Customs Declarations.\n", "operationId" : "listCustomsDeclarations", "parameters" : [ { "name" : "cursor", "in" : "query", "description" : "The cursor to start from", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "uuid", "example" : "00000000-0000-7000-8000-000000000000", "maxLength" : 36 }, "example" : "00000000-0000-7000-8000-000000000000" }, { "name" : "limit", "in" : "query", "description" : "The number of items to return", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : 10, "maximum" : 1000, "minimum" : 1 }, "example" : 10 }, { "name" : "sort", "in" : "query", "description" : "Indicate sorting direction", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ASC", "DESC" ], "example" : "DESC" }, "example" : "DESC" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomsDeclarationListResponse" }, "example" : { "items" : [ { "id" : "019ab521-5fc6-7836-8d3b-ba0f6e12e003", "reference" : "INV-2025-0001", "charges" : { "duty" : 75.0, "freight" : 250.0, "insurance" : 50.0, "invoice" : 1500.0, "other" : 20.0 }, "comments" : [ "Goods are samples and not for resale." ], "currency" : "EUR", "declarant" : { "city" : "Oslo", "firstName" : "John", "lastName" : "Doe", "title" : "Mr." }, "declaredAt" : "2024-07-01T00:00:00+00:00", "invoice" : { "items" : [ { "id" : "019ab5ae-7cbb-7665-94a8-86edb63c6191", "createdAt" : "2021-09-01T12:00:00+02:00", "updatedAt" : "2021-09-01T12:00:00+02:00", "reference" : "ITEM-REF-001", "dangerousGoods" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "isReturnable" : false, "meta" : { "key1" : "value1", "key2" : "value2" }, "packing" : { "weight" : 10.0, "weightUnit" : "G" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "pricing" : { "countryOfOrigin" : "DE", "currency" : "EUR", "supplementaryQuantity" : 24, "supplementaryQuantityUnit" : "PCS", "tariffNumber" : "12345678", "unitPrice" : 10.5, "vatPercent" : 10.5 }, "product" : { "composition" : "wool, cotton, polyester", "description" : "Engine parts", "identification" : [ ], "isPhysical" : false, "location" : "", "sku" : "5678-678", "weight" : 10.5, "weightUnit" : "G" }, "quantity" : 2, "skipCustoms" : false, "weight" : 10.0, "weightUnit" : "G" } ], "number" : "INV-2025-0001" }, "persistence" : { "expiresAt" : "2024-01-01T00:00:00Z", "type" : "example" }, "purpose" : { "code" : "GIFT" }, "statements" : [ "I hereby declare that the information contained in this declaration is true and complete to the best of my knowledge and belief." ], "terms" : { "code" : "DDP", "location" : "Rotterdam" }, "types" : [ "CN22" ] } ], "nextCursor" : "01958a2d-b90d-7261-a795-000000000000" } } } } }, "security" : [ { "AccountToken" : [ ] } ] }, "post" : { "tags" : [ "Customs Declarations" ], "summary" : "Create Customs Declaration", "description" : "Creates a new Customs Declaration. Provide `types`, `declarant.firstName`, `declarant.lastName`, `declarant.city`, and `currency`. Returns the `customs-declaration`.", "operationId" : "createCustomsDeclaration", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomsDeclarationRequest" }, "example" : { "reference" : "INV-2025-0001", "charges" : { "duty" : 75.0, "freight" : 250.0, "insurance" : 50.0, "invoice" : 1500.0, "other" : 20.0 }, "comments" : [ "Goods are samples and not for resale." ], "currency" : "EUR", "declarant" : { "city" : "Oslo", "firstName" : "John", "lastName" : "Doe", "title" : "Mr." }, "declaredAt" : "2024-07-01T00:00:00+00:00", "invoice" : { "itemIds" : [ "019ad961-2659-7bbb-9f64-939126000e08", "019ad961-7b90-7db4-bdd3-06bac2699064" ], "number" : "INV-2025-0001" }, "persistence" : { "type" : "example" }, "purpose" : { "code" : "GIFT" }, "statements" : [ "I hereby declare that the information contained in this declaration is true and complete to the best of my knowledge and belief." ], "terms" : { "code" : "DDP", "location" : "Rotterdam" }, "types" : [ "CN22" ] } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "201" : { "description" : "Resource created successfully", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "uri", "maxLength" : 2048 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BasicResponse" }, "example" : { "id" : "01991a03-c860-7000-bb91-5a9cb479f522" } } } } }, "security" : [ { "AccountToken" : [ ] } ] } }, "/v1/reports" : { "get" : { "tags" : [ "Reports" ], "summary" : "List Reports", "description" : "Lists aggregated usage metrics for all Accounts associated with a Company, measured in tokens.\nProvide `type` (`usage_report` or `aggregated_report`) to select the report.\nOptionally provide `date_from` and `date_to` to scope the report to a date range.\nReturns the usage metrics for the matching reports.", "operationId" : "listReports", "parameters" : [ { "name" : "type", "in" : "query", "description" : "Type.", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : "example", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "example" : "example" }, { "name" : "date_from", "in" : "query", "description" : "Date from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "date-time", "example" : "2024-01-01T00:00:00Z", "maxLength" : 64 }, "example" : "2024-01-01T00:00:00Z" }, { "name" : "date_to", "in" : "query", "description" : "Date to.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "date-time", "example" : "2024-01-01T00:00:00Z", "maxLength" : 64 }, "example" : "2024-01-01T00:00:00Z" } ], "responses" : { "400" : { "description" : "Bad Request", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "401" : { "description" : "Unauthorized", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "429" : { "description" : "Too Many Requests", "headers" : { "Retry-After" : { "description" : "Seconds to wait before retrying", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "500" : { "description" : "Internal Server Error", "headers" : { "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "404" : { "description" : "Not Found", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemDetail" } } } }, "200" : { "description" : "Successful operation", "headers" : { "X-RateLimit-Limit" : { "description" : "Max requests allowed in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Remaining" : { "description" : "Requests remaining in the window", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "X-RateLimit-Reset" : { "description" : "Seconds until the window resets", "style" : "simple", "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 0 } }, "Access-Control-Allow-Origin" : { "description" : "Origins permitted to read the response (CORS).", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "maxLength" : 255, "pattern" : "^(\\*|null|https?://[a-zA-Z0-9.-]+(:[0-9]+)?)$" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReportsUsageMetricsResponse" }, "example" : { "grouping" : [ { "accountId" : "00000000-0000-7000-8000-000000000000", "companyId" : "00000000-0000-7000-8000-000000000000", "records" : [ { "events" : 1, "topic" : "example", "type" : "example" } ] } ], "totals" : { "accounts" : 1, "companies" : 1, "records" : [ { "events" : 1, "topic" : "example", "type" : "example" } ] }, "type" : "example" } } } } }, "security" : [ { "AccountToken" : [ ] }, { "CompanyToken" : [ ] }, { "AdminToken" : [ ] } ] } } }, "components" : { "schemas" : { "PackingTypeValidations" : { "type" : "object", "description" : "Validation rules for a packing type value", "properties" : { "allowedValues" : { "type" : "array", "description" : "Allowed values for the packing type", "items" : { "$ref" : "#/components/schemas/PackingTypeValues" }, "maxItems" : 1000 }, "mandatory" : { "type" : "boolean", "description" : "Indicates whether the packing type is mandatory", "example" : false } } }, "CarrierRateResponseInfo" : { "type" : "object", "description" : "Information about the carrier price calculation outcome (status type and descriptive message). Useful for diagnosing why carrier rates are missing or zero.", "properties" : { "message" : { "type" : "string", "description" : "Human-readable description of the carrier price calculation outcome.", "example" : "Price calculated successfully.", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "type" : { "type" : "string", "description" : "Outcome type of the carrier price calculation. ERROR when the call failed (timeout or carrier-side error); WARNING when the call succeeded but returned a zero price; INFO when the call succeeded with a non-zero price.", "enum" : [ "ERROR", "INFO", "WARNING" ], "example" : "INFO" } } }, "PersistenceRequest" : { "type" : "object", "description" : "The persistence configuration of the entity.", "properties" : { "type" : { "type" : "string", "description" : "The persistence type. Valid values depend on the entity type.", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "InlineCustomsDeclarationRequest" : { "type" : "object", "description" : "Customs declaration supplied inline within a shipment request", "properties" : { "reference" : { "type" : "string", "description" : "User-defined internal tracking reference", "example" : "INV-2025-0001", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "charges" : { "$ref" : "#/components/schemas/CustomsDeclarationCharges", "description" : "Declaration charges" }, "comments" : { "type" : "array", "description" : "Declaration comments", "example" : [ "Goods are samples and not for resale." ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 4, "minItems" : 1 }, "currency" : { "type" : "string", "description" : "Currency code", "example" : "EUR", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "declarant" : { "$ref" : "#/components/schemas/CustomsDeclarationDeclarant", "description" : "Declarant information" }, "declaredAt" : { "type" : "string", "format" : "date-time", "description" : "Customs Declaration timestamp. Must not be in the past. Defaults to current time if not provided.", "example" : "2024-07-01T00:00:00+00:00", "maxLength" : 64 }, "invoice" : { "$ref" : "#/components/schemas/InlineCustomsDeclarationInvoice", "description" : "Invoice information" }, "purpose" : { "$ref" : "#/components/schemas/CustomsDeclarationPurpose", "description" : "Customs declaration purpose" }, "statements" : { "type" : "array", "description" : "Declaration statements", "example" : [ "I hereby declare that the information contained in this declaration is true and complete to the best of my knowledge and belief." ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 2, "minItems" : 1 }, "terms" : { "$ref" : "#/components/schemas/CustomsDeclarationTerms", "description" : "Trade terms" }, "types" : { "type" : "array", "description" : "Customs Declaration types", "example" : [ "CN22" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 2147483647, "minItems" : 1 } }, "required" : [ "currency", "declarant", "invoice", "types" ] }, "SerialReferenceResponse" : { "type" : "object", "description" : "Serial number paired with its reference", "properties" : { "reference" : { "type" : "string", "description" : "Serial number reference", "example" : "REF-001", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "serial" : { "type" : "string", "description" : "Serial number", "example" : "DEF987654321", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "AccountCompany" : { "type" : "object", "description" : "Company details associated with the account", "properties" : { "name" : { "type" : "string", "description" : "Company name", "example" : "nShift AB", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "address" : { "type" : "string", "description" : "Company address", "example" : "Kungsgatan 1", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "city" : { "type" : "string", "description" : "Company city", "example" : "Stockholm", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "countryCode" : { "$ref" : "#/components/schemas/CountryCode", "description" : "Company country code", "example" : "SE" }, "postalCode" : { "type" : "string", "description" : "Company postal code", "example" : "11143", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "vatNumber" : { "type" : "string", "description" : "Company VAT number", "example" : "SE556546371701", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "TrackerRequest" : { "type" : "object", "description" : "Tracking state update for a shipment", "properties" : { "status" : { "type" : "string", "description" : "Harmonized tracker status", "enum" : [ "BOOKED", "DISPATCHED", "DELIVERED", "VOID" ] }, "parcels" : { "type" : "array", "description" : "Parcels with tracking information", "items" : { "$ref" : "#/components/schemas/TrackerParcel" }, "maxItems" : 1000 }, "persistence" : { "$ref" : "#/components/schemas/PersistenceRequest", "description" : "The persistence configuration of the entity." }, "shipment" : { "$ref" : "#/components/schemas/TrackerShipment", "description" : "Shipment tracking information" } }, "required" : [ "shipment", "status" ] }, "Product" : { "type" : "object", "description" : "Product details for an item in a parcel", "properties" : { "composition" : { "type" : "string", "description" : "Material composition of the product, forwarded to the carrier customs line", "example" : "wool, cotton, polyester", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : { "type" : "string", "description" : "Product description", "example" : "Engine parts", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "identification" : { "type" : "array", "description" : "Product identifiers of type SKU, EAN, ISBN, GTIN or OTHER, at most one per type. Some carriers require a product code for customs", "items" : { "$ref" : "#/components/schemas/ProductIdentification" }, "maxItems" : 1000 }, "isPhysical" : { "type" : "boolean", "default" : true, "description" : "Indicates if the product is physical. Defaults to true.", "example" : false }, "location" : { "type" : "string", "description" : "Product location", "example" : "", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "sku" : { "type" : "string", "description" : "Product SKU (Stock Keeping Unit)", "example" : "5678-678", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "weight" : { "type" : "number", "format" : "double", "description" : "Product weight", "example" : 10.5 }, "weightUnit" : { "type" : "string", "description" : "Product weight unit", "enum" : [ "G", "KG", "LB", "OZ" ] } }, "required" : [ "sku" ] }, "ServiceListResponse" : { "type" : "object", "description" : "Paginated list of carrier services", "properties" : { "items" : { "type" : "array", "description" : "Services", "items" : { "$ref" : "#/components/schemas/ServiceResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "Document" : { "type" : "object", "description" : "Document produced for a shipment", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Document", "example" : "019ad95e-4b32-7a61-99fb-4367638dd836", "maxLength" : 36 }, "contentType" : { "type" : "string", "description" : "Document format", "enum" : [ "pdf", "zpl", "png" ], "example" : "pdf" }, "documentType" : { "type" : "string", "description" : "Document type", "enum" : [ "CUSTOMS_DOCUMENT", "LABEL", "DANGEROUS_GOODS_DOCUMENT", "DOCUMENT", "MANIFEST_DOCUMENT" ], "example" : "LABEL" }, "mediaType" : { "type" : "string", "description" : "Document media type", "enum" : [ "laser-2x104x250", "laser-a4", "thermo-104", "thermo-148", "thermo-190", "thermo-4x6" ], "example" : "laser-a4" }, "pages" : { "type" : "integer", "format" : "int32", "description" : "Number of pages in the document", "example" : 1 } }, "required" : [ "documentType" ] }, "ModeValidations" : { "type" : "object", "description" : "Allowed values for the carrier mode field", "properties" : { "allowedValues" : { "type" : "array", "description" : "List of allowed mode values (STAGING, PRODUCTION, DEMO)", "items" : { "$ref" : "#/components/schemas/AllowedValue" }, "maxItems" : 1000 } } }, "DocumentTypeListResponse" : { "type" : "object", "description" : "Paginated list of document types", "properties" : { "items" : { "type" : "array", "description" : "Document Types", "items" : { "$ref" : "#/components/schemas/DocumentTypeResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "ValidationConditions" : { "type" : "object", "description" : "Conditions under which this validation applies", "properties" : { "addons" : { "type" : "array", "description" : "Add-on codes this validation applies to", "example" : [ "ADDON1", "ADDON2" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 }, "explicitRoutes" : { "type" : "boolean", "description" : "Whether the validation applies only to explicitly configured routes", "example" : false }, "packingCodeTypes" : { "type" : "array", "description" : "Packing code types this validation applies to", "example" : [ "PC", "GS" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 }, "routes" : { "type" : "array", "description" : "Routes this validation applies to", "items" : { "$ref" : "#/components/schemas/MultipleRoutes" }, "maxItems" : 1000 } } }, "DangerousGoodsHazard" : { "type" : "object", "description" : "Hazard information", "properties" : { "code" : { "type" : "string", "description" : "Hazard code", "example" : "F1", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "environmental" : { "type" : "boolean", "description" : "Indicates whether the goods are environmentally hazardous", "example" : false }, "flashPoint" : { "type" : "number", "format" : "double", "description" : "Flash point temperature in Celsius", "example" : -20 }, "hazardClass" : { "type" : "string", "description" : "Primary hazard class", "example" : "3", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "Validations" : { "type" : "object", "description" : "Validation rules for a field", "properties" : { "allowedValues" : { "type" : "array", "description" : "Allowed values for the field", "items" : { "$ref" : "#/components/schemas/AllowedValue" }, "maxItems" : 1000 }, "mandatory" : { "type" : "boolean", "description" : "Indicates whether the field is mandatory", "example" : false }, "maxLength" : { "type" : "integer", "format" : "int32", "description" : "Maximum length of input data", "example" : 10 }, "minLength" : { "type" : "integer", "format" : "int32", "description" : "Minimum length of input data", "example" : 2 }, "precision" : { "type" : "integer", "format" : "int32", "description" : "Number of decimals allowed if the field type is NUMBER", "example" : 2 }, "type" : { "type" : "string", "description" : "Field type", "enum" : [ "PHONE", "EMAIL", "DOUBLE", "NUMBER", "STRING" ], "example" : "STRING" } } }, "DocumentResponse" : { "type" : "object", "description" : "Document with its metadata and page content", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Document", "example" : "019b26d1-6ef4-7331-b628-11fd3dfda3dd", "maxLength" : 36 }, "data" : { "type" : "string", "description" : "Base64 encoded document data", "example" : "JVBERi0xLjQKJeLjz9MKNCAwIG9iago8PC9MZW5ndGgg...", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "metadata" : { "$ref" : "#/components/schemas/DocumentMetaData", "description" : "Document metadata" }, "pages" : { "type" : "array", "description" : "Document pages with page data", "items" : { "$ref" : "#/components/schemas/DocumentDataPageResponse" }, "maxItems" : 1000 } } }, "DeliveryOptionListResponse" : { "type" : "object", "description" : "Paginated list of delivery options", "properties" : { "items" : { "type" : "array", "description" : "Delivery Options", "items" : { "$ref" : "#/components/schemas/DeliveryOptionResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "019b0595-4d32-7000-96b7-3c435889aeff", "maxLength" : 36 } } }, "MediaType" : { "type" : "object", "description" : "Supported document media type", "properties" : { "description" : { "type" : "string", "description" : "Media type description", "example" : "Normal A4 paper", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "type" : { "type" : "string", "description" : "Media type", "example" : "laser-a4", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "DangerousGoodsTransportationValidations" : { "type" : "object", "description" : "Validation rules for transportation fields", "properties" : { "emergencyCode" : { "$ref" : "#/components/schemas/EnrichmentValidations", "description" : "Validation rules for the emergency response code field" }, "separation" : { "$ref" : "#/components/schemas/EnrichmentValidations", "description" : "Validation rules for the separation distance field" }, "tunnelRestriction" : { "$ref" : "#/components/schemas/EnrichmentValidations", "description" : "Validation rules for the tunnel restriction code field" } } }, "EventChannelTopic" : { "type" : "string", "description" : "Single source of truth for the event topics an Event Channel can subscribe to.", "enum" : [ "ACCOUNT", "ADDRESS", "COMPANY", "CARRIER_STATUS", "CARRIER_DEFINITION", "DELIVERY_OPTION", "DOCUMENT", "PARCEL_ITEM", "PARCEL", "SERVICE_DEFINITION", "SHIPMENT_BOOKING", "PUDO_POINT", "SHIPMENT_CHANNEL", "SHIPPING_QUOTE", "ZONE", "CARRIER_RATE", "CUSTOMS_DECLARATION", "DANGEROUS_GOODS_DECLARATION", "EVENT_CHANNEL", "SHIPMENT_DISPATCH", "SHIPMENT_MANIFEST", "TRACKER", "CARRIER", "SERVICE", "CARRIER_MONITOR" ] }, "ParcelRequest" : { "type" : "object", "description" : "Payload to create or update a parcel", "properties" : { "reference" : { "type" : "string", "description" : "Parcel reference", "example" : "#45678", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "serial" : { "type" : "string", "description" : "Parcel serial number", "example" : "473325380000006010", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "dangerousGoods" : { "type" : "array", "description" : "Dangerous goods associated with the parcel", "items" : { "$ref" : "#/components/schemas/DangerousGoodsParcel" }, "maxItems" : 1, "minItems" : 1 }, "description" : { "type" : "string", "description" : "Parcel description", "example" : "This is a parcel description", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "itemIds" : { "type" : "array", "description" : "Parcel items", "example" : [ "019beadd-818c-792d-9bd4-ea04b0dbe23e", "019beadc-8d6e-7031-8636-06c636e72d4f" ], "items" : { "type" : "string", "format" : "uuid", "maxLength" : 36 }, "maxItems" : 2147483647, "minItems" : 1 }, "meta" : { "type" : "object", "additionalProperties" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : "Additional metadata", "example" : { "key1" : "value1", "key2" : "value2" } }, "packing" : { "$ref" : "#/components/schemas/ParcelPacking", "description" : "Parcel packing information" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceRequest", "description" : "The persistence configuration of the entity." }, "weight" : { "type" : "number", "format" : "double", "description" : "Parcel weight", "example" : 10.0 }, "weightUnit" : { "type" : "string", "description" : "Parcel weight unit", "enum" : [ "G", "KG", "LB", "OZ" ] } } }, "DocumentTypeResponse" : { "type" : "object", "description" : "Document type definition for a carrier or service", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Document Type", "example" : "123e4567-e89b-12d3-a456-426614174000", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the document type was created", "example" : "2025-01-16T12:07:09Z", "maxLength" : 64 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the document type was last updated", "example" : "2025-01-16T12:07:09Z", "maxLength" : 64 }, "carrierId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the carrier", "example" : "123e4567-e89b-12d3-a456-426614174000", "maxLength" : 36 }, "contentTypes" : { "type" : "array", "description" : "Supported content types for this document type", "items" : { "$ref" : "#/components/schemas/ContentType" }, "maxItems" : 1000 }, "description" : { "type" : "string", "description" : "Document type description", "example" : "Shipping label for parcels", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "layouts" : { "type" : "array", "description" : "Supported layouts for this document type", "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 }, "mediaTypes" : { "type" : "array", "description" : "Supported media types for this document type", "items" : { "$ref" : "#/components/schemas/MediaType" }, "maxItems" : 1000 }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "serviceId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the service", "example" : "123e4567-e89b-12d3-a456-426614174001", "maxLength" : 36 }, "type" : { "type" : "string", "description" : "Document type", "example" : "LABEL", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "ManifestType" : { "type" : "object", "description" : "Manifest type and the document types it produces", "properties" : { "description" : { "type" : "string", "description" : "A description of the manifest type.", "example" : "Portable Document Format", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "documentTypes" : { "type" : "array", "description" : "A list of document types that the manifest type supports.", "items" : { "$ref" : "#/components/schemas/DocumentType" }, "maxItems" : 1000 }, "type" : { "type" : "string", "description" : "The type of manifest.", "example" : "PDF", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "CarrierDefinitionListResponse" : { "type" : "object", "description" : "Paginated list of carrier definitions", "properties" : { "items" : { "type" : "array", "description" : "Carrier Definitions", "items" : { "$ref" : "#/components/schemas/CarrierDefinitionResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "PackingTypesLesser" : { "type" : "object", "description" : "Simplified packing type reference with type and description", "properties" : { "description" : { "type" : "string", "description" : "Packing type description", "example" : "Package", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "type" : { "type" : "string", "description" : "Packing type", "example" : "PACKAGE", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "Code" : { "type" : "object", "description" : "Packing code default value and its validation rules", "properties" : { "defaultValue" : { "type" : "string", "description" : "Code that defines the allowed values", "example" : "UPSTermsOfSale", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "validations" : { "$ref" : "#/components/schemas/PackingTypeValidations", "description" : "Validation rules" } } }, "DocumentMetadataListResponse" : { "type" : "object", "description" : "List of document metadata entries", "properties" : { "items" : { "type" : "array", "description" : "Document metadata", "items" : { "$ref" : "#/components/schemas/DocumentMetadataResponse" }, "maxItems" : 1000 } } }, "DocumentRenderingType" : { "type" : "object", "description" : "Rendering settings for a single shipment document type", "properties" : { "contentType" : { "type" : "string", "description" : "Document format", "enum" : [ "pdf", "zpl", "png" ], "example" : "pdf" }, "documentType" : { "type" : "string", "description" : "Document type", "enum" : [ "CUSTOMS_DOCUMENT", "LABEL", "DANGEROUS_GOODS_DOCUMENT", "DOCUMENT", "MANIFEST_DOCUMENT" ], "example" : "LABEL" }, "enabled" : { "type" : "boolean", "default" : true, "description" : "Indicates whether the document type should be rendered", "example" : false }, "mediaType" : { "type" : "string", "description" : "Document media type", "enum" : [ "laser-2x104x250", "laser-a4", "thermo-104", "thermo-148", "thermo-190", "thermo-4x6" ], "example" : "thermo-190", "minLength" : 1 }, "offsetX" : { "type" : "number", "format" : "double", "default" : 0.0, "description" : "X-axis offset for the document", "example" : 0.0 }, "offsetY" : { "type" : "number", "format" : "double", "default" : 0.0, "description" : "Y-axis offset for the document", "example" : 0.0 }, "options" : { "type" : "object", "additionalProperties" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : "Document rendering settings", "example" : { "mode" : "DT" } }, "pageBreak" : { "type" : "boolean", "description" : "Indicates whether a page break should be inserted after this document", "example" : false } }, "required" : [ "contentType", "documentType", "mediaType" ] }, "UsageGrouping" : { "type" : "object", "description" : "Billable usage records grouped by company and account", "properties" : { "accountId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the account the usage records are grouped by", "maxLength" : 36 }, "companyId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the company the usage records are grouped by", "maxLength" : 36 }, "records" : { "type" : "array", "description" : "Usage records for this grouping", "items" : { "$ref" : "#/components/schemas/UsageRecord" }, "maxItems" : 1000 } } }, "PortalReferences" : { "type" : "object", "description" : "Portal identifiers for the carrier and service", "properties" : { "carrierId" : { "type" : "string", "description" : "nShift Portal carrier identifier for the Service", "example" : "00000000-0000-0000-0000-0000000003B6", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "serviceId" : { "type" : "string", "description" : "nShift Portal service identifier for the Service", "example" : "00000000-0000-0000-0000-00000000245C", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "AddonInfo" : { "type" : "object", "description" : "Key-value field configuring an add-on service", "properties" : { "key" : { "type" : "string", "description" : "The field's key", "example" : "mobile", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "value" : { "type" : "string", "description" : "The field's value", "example" : "+467012367890", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "ShipmentDispatchTracker" : { "type" : "object", "description" : "Tracking details for a dispatch and its contents", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "The unique identifier of the Shipment Dispatch Tracker", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Shipment Dispatch Tracker was created", "maxLength" : 64 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Shipment Dispatch Tracker was last updated", "maxLength" : 64 }, "status" : { "type" : "string", "description" : "The current status of the Shipment Dispatch Tracker", "enum" : [ "BOOKED", "DISPATCHED", "DELIVERED", "VOID" ] }, "loadBearers" : { "type" : "array", "description" : "Load bearer serials and references", "items" : { "$ref" : "#/components/schemas/SerialReferenceResponse" }, "maxItems" : 1000 }, "manifest" : { "$ref" : "#/components/schemas/SerialLinkResponse", "description" : "Shipment manifest details" }, "motherShipment" : { "$ref" : "#/components/schemas/SerialLinkResponse", "description" : "Mother shipment details" }, "parcels" : { "type" : "array", "description" : "Parcel serials and references", "items" : { "$ref" : "#/components/schemas/SerialReferenceResponse" }, "maxItems" : 1000 }, "shipments" : { "type" : "array", "description" : "Shipment serials and references", "items" : { "$ref" : "#/components/schemas/SerialReferenceResponse" }, "maxItems" : 1000 } } }, "AddressRequest" : { "type" : "object", "description" : "An address provides a standardized data model used by our different services. This means that an address will appear the same whether it's used in an Order or Shipment booking. However, providing specific roles to addresses will limit them to the extent they can be used or by what processes they are used. Roles can also be composites of other roles.\nYou can create as many addresses as you need and store them for later usage. This way you only need to keep track of their identifiers when you want to use them.", "properties" : { "company" : { "$ref" : "#/components/schemas/Company", "description" : "Company information associated with the address" }, "contact" : { "$ref" : "#/components/schemas/Contact", "description" : "Contact information associated with the address" }, "group" : { "type" : "string", "description" : "Address group", "example" : "warehouse_A", "maxLength" : 256, "minLength" : 0, "pattern" : "^\\w+$" }, "lines" : { "type" : "array", "description" : "Address lines. If omitted, lines are auto-generated from location properties. If partially provided, missing lines are auto-generated.", "example" : [ "John Doe c/o Mr Smith, nShift", "Schiller street 45, Neighborhood x", "Century Plaza 13, Floor 3, Apt 32", "District 4, DC, US-NY, US, 111111" ], "items" : { "type" : "string", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 4, "minItems" : 0 }, "location" : { "$ref" : "#/components/schemas/Location", "description" : "Address location" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceRequest", "description" : "The persistence configuration of the entity." }, "references" : { "$ref" : "#/components/schemas/References", "description" : "Address reference information" }, "type" : { "type" : "string", "description" : "Address type. RESIDENTIAL requires contact.firstName and contact.lastName. COMMERCIAL requires company.name.", "example" : "RESIDENTIAL", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "location" ] }, "ServiceDefinitionRequest" : { "type" : "object", "description" : "The entity being created or replaced", "properties" : { "name" : { "type" : "string", "description" : "The name of the Service Definition", "example" : "PostNord for domestic B2C use", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "addons" : { "type" : "array", "description" : "The list of Service specific Addons.", "items" : { "$ref" : "#/components/schemas/Addon" }, "maxItems" : 1000 }, "group" : { "type" : "string", "description" : "The group of the Service Definition", "example" : "UPS_saver", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceRequest", "description" : "The persistence configuration of the entity." }, "serviceId" : { "type" : "string", "format" : "uuid", "description" : "The unique identifier of the Service", "example" : "d9214010-7bb6-3e78-bbd5-c7b39f584722", "maxLength" : 36, "minLength" : 1 } }, "required" : [ "name", "serviceId" ] }, "Identification" : { "type" : "object", "description" : "Tax or organization identifier for a party", "properties" : { "type" : { "type" : "string", "description" : "Identification type", "enum" : [ "VAT", "EORI", "ORGANIZATION", "IOSS", "CUSTOMER_NUMBER", "UKIMS", "PID" ], "example" : "VAT", "maxLength" : 256, "minLength" : 0 }, "value" : { "type" : "string", "description" : "Identification value", "example" : "SE556546371701", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "type", "value" ] }, "CustomsDeclarationDeclarant" : { "type" : "object", "description" : "Person declaring the goods to customs", "properties" : { "city" : { "type" : "string", "description" : "Declarant city", "example" : "Oslo", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "firstName" : { "type" : "string", "description" : "Declarant first name", "example" : "John", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "lastName" : { "type" : "string", "description" : "Declarant last name", "example" : "Doe", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "title" : { "type" : "string", "description" : "Declarant title or salutation", "example" : "Mr.", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "city", "firstName", "lastName" ] }, "ProblemDetail" : { "type" : "object", "description" : "Problem Detail (RFC 9457)", "properties" : { "type" : { "type" : "string", "format" : "uri", "description" : "A URI reference that identifies the problem type.", "maxLength" : 2048 }, "title" : { "type" : "string", "description" : "A short, human-readable summary of the problem type.", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "status" : { "type" : "integer", "format" : "int32", "description" : "The HTTP status code generated for this occurrence of the problem.", "maximum" : 599, "minimum" : 100 }, "detail" : { "type" : "string", "description" : "A human-readable explanation specific to this occurrence of the problem.", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "instance" : { "type" : "string", "format" : "uri", "description" : "A URI reference that identifies the specific occurrence of the problem.", "maxLength" : 2048 }, "properties" : { "type" : "object", "description" : "Additional problem-specific extension members (RFC 9457 §3.2)." } } }, "TrackerLogPayload" : { "type" : "object", "description" : "Additional context for the log entry", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifier of the entity the log entry relates to", "example" : "019dcea3-b444-7073-bc96-9533c4ad830c", "maxLength" : 36 }, "normalizedStatus" : { "type" : "string", "description" : "Normalized Portal status code for the event", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "sourceEventCode" : { "type" : "string", "description" : "Original carrier-specific event code before normalization", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "tookPlaceAt" : { "type" : "string", "description" : "Local date and time when the carrier event took place, as reported by the carrier, without a UTC offset", "example" : "2026-01-01T10:00:00", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "AddonField" : { "type" : "object", "description" : "Input field definition for a carrier add-on service", "properties" : { "context" : { "type" : "string", "description" : "Context of the field where it applies", "example" : "SHIPMENT", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : { "type" : "string", "description" : "Human-readable description of the field", "example" : "Delivery instructions", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "externalReference" : { "type" : "string", "description" : "External reference identifier for the field", "example" : "EXT-REF-123", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "key" : { "type" : "string", "description" : "The field key identifier", "example" : "TEXT4", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "validations" : { "$ref" : "#/components/schemas/Validations", "description" : "Validation rules" } } }, "AddonResponse" : { "type" : "object", "description" : "Value-added service applied to the shipment", "properties" : { "code" : { "type" : "string", "description" : "Add-on code", "example" : "INSU", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "ServiceResponse" : { "type" : "object", "description" : "Carrier service definition and its capabilities", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Service", "example" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82", "maxLength" : 36 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Service was last updated", "example" : "2024-07-01T00:00:00+00:00", "maxLength" : 64 }, "name" : { "type" : "string", "description" : "Service name", "example" : "UPS", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "access" : { "type" : "boolean", "description" : "Indicates whether the user has access to the Service", "example" : false }, "addons" : { "type" : "array", "description" : "Add-ons for the Service", "items" : { "$ref" : "#/components/schemas/ServiceAddon" }, "maxItems" : 1000 }, "addressValidations" : { "type" : "array", "description" : "List of address validation rules for this service", "items" : { "$ref" : "#/components/schemas/AddressValidation" }, "maxItems" : 1000 }, "carrierCode" : { "type" : "string", "description" : "Carrier code", "example" : "2b71b8f1", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "carrierId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Carrier", "example" : "8c2b9506-043c-3adb-918b-e134d3c36bd6", "maxLength" : 36 }, "carrierRates" : { "$ref" : "#/components/schemas/EnrichmentCarrierRates", "description" : "Enrichment carrier rates configuration for the service" }, "classification" : { "$ref" : "#/components/schemas/Classification", "description" : "Service support information" }, "code" : { "type" : "string", "description" : "Service code", "example" : "UPS", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "consolidation" : { "$ref" : "#/components/schemas/Consolidation", "description" : "Consolidation settings" }, "criteria" : { "$ref" : "#/components/schemas/Criteria", "description" : "Service-defined criteria" }, "customs" : { "$ref" : "#/components/schemas/Customs", "description" : "Customs declaration configuration for the service" }, "customsDeclarationTypes" : { "type" : "array", "description" : "Supported Customs Declaration Types", "items" : { "$ref" : "#/components/schemas/CustomsDeclarationTypeResponse" }, "maxItems" : 1000 }, "dangerousGoods" : { "$ref" : "#/components/schemas/DangerousGoods", "description" : "Dangerous goods configuration for the service" }, "deliveryBooking" : { "$ref" : "#/components/schemas/DeliveryBooking", "description" : "Delivery date and time-window settings" }, "documentTypes" : { "type" : "array", "description" : "Supported document types", "items" : { "$ref" : "#/components/schemas/DocumentType" }, "maxItems" : 1000 }, "explicitRoutes" : { "type" : "boolean", "description" : "The service has explicit routes.", "example" : false }, "fields" : { "type" : "array", "description" : "Defined input settings for the Carrier", "items" : { "$ref" : "#/components/schemas/Field" }, "maxItems" : 1000, "uniqueItems" : true }, "itemValidations" : { "type" : "array", "description" : "Item validations for dangerous goods items", "items" : { "$ref" : "#/components/schemas/ServiceItemValidation" }, "maxItems" : 1000 }, "manifest" : { "$ref" : "#/components/schemas/Manifest", "description" : "Shipment manifest settings" }, "meta" : { "type" : "object", "additionalProperties" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : "Additional metadata", "example" : { "key1" : "value1", "key2" : "value2" } }, "obsolete" : { "type" : "boolean", "description" : "Indicates whether the carrier has retired the Service. A retired Service stays listed but can never be booked, and this cannot be overridden by an enrichment", "example" : false, "readOnly" : true }, "packingCodeType" : { "$ref" : "#/components/schemas/PackingCodeType", "description" : "Supported Packing Code Type" }, "packingTypes" : { "type" : "array", "description" : "Supported Packing Types", "items" : { "$ref" : "#/components/schemas/PackingTypesLesser" }, "maxItems" : 1000 }, "parcelValidations" : { "type" : "array", "description" : "List of parcel validation rules for this service", "items" : { "$ref" : "#/components/schemas/ParcelValidation" }, "maxItems" : 1000 }, "parties" : { "type" : "array", "description" : "Parties involved in the service", "items" : { "$ref" : "#/components/schemas/ServiceParty" }, "maxItems" : 1000 }, "pickupBooking" : { "$ref" : "#/components/schemas/Pickup", "description" : "Pickup booking settings" }, "portalReferences" : { "$ref" : "#/components/schemas/PortalReferences", "description" : "nShift Portal references" }, "pudoPoints" : { "$ref" : "#/components/schemas/PudoPoints", "description" : "PUDO point information" }, "restrictions" : { "$ref" : "#/components/schemas/Restrictions", "description" : "Restriction information for this service" }, "returnService" : { "$ref" : "#/components/schemas/ReturnService", "description" : "Return service information" }, "routes" : { "type" : "array", "description" : "A list of valid routes that the Service can be used for.", "items" : { "$ref" : "#/components/schemas/MultipleRoutes" }, "maxItems" : 1000, "uniqueItems" : true }, "serials" : { "type" : "array", "description" : "Supported Serial Types", "items" : { "$ref" : "#/components/schemas/SerialResponse" }, "maxItems" : 1000 }, "shipmentValidations" : { "type" : "array", "description" : "List of shipment validation rules for this service", "items" : { "$ref" : "#/components/schemas/ShipmentValidation" }, "maxItems" : 1000 }, "terms" : { "$ref" : "#/components/schemas/Terms", "description" : "Terms configuration for this service" }, "voiding" : { "$ref" : "#/components/schemas/Voiding", "description" : "Voiding support information for this service" } } }, "Party" : { "type" : "object", "description" : "Shipment party referenced by stored address identifier", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Party", "example" : "019b220f-7d9b-7435-b352-f718eb22fa4a", "maxLength" : 36 }, "roles" : { "type" : "array", "description" : "Roles associated with the Party", "items" : { "type" : "string", "enum" : [ "SENDER", "RECEIVER", "DELIVERY", "DISPATCH", "RETURN", "FREIGHT_PAYER", "TAX_PAYER", "CUSTOMS_PAYER", "IMPORTER", "EXPORTER" ] }, "maxItems" : 1000, "minItems" : 1 }, "source" : { "type" : "string", "description" : "Alias of a shared account to resolve `id` in, instead of the caller's own Account. Allowed only together with `id`.", "example" : "amber-falcon-river", "maxLength" : 255, "pattern" : "^[a-z0-9][a-z0-9-]{2,39}$" }, "type" : { "type" : "string", "description" : "Party type", "enum" : [ "ADDRESS", "PUDO" ], "example" : "ADDRESS", "pattern" : "^(ADDRESS|PUDO)$" } }, "required" : [ "id", "roles", "type" ] }, "CarrierMonitoring" : { "type" : "object", "description" : "Reference to the carrier monitor tracking this carrier", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier of the carrier monitor", "example" : "019f5b2e-cd14-77aa-8b48-1c707f9ebe33", "maxLength" : 36 } } }, "DangerousGoodsValidations" : { "type" : "object", "description" : "Validation rules for dangerous goods declarations", "properties" : { "hazard" : { "$ref" : "#/components/schemas/DangerousGoodsHazardValidations", "description" : "Validation rules for hazard fields" }, "itemLimit" : { "type" : "boolean", "description" : "Indicates whether there is a limit on the number of dangerous goods items per parcel" }, "maxItems" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of dangerous goods items allowed per parcel" }, "maxParcels" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of parcels allowed per dangerous goods declaration" }, "notes" : { "$ref" : "#/components/schemas/EnrichmentValidations", "description" : "Validation rules for the notes field" }, "packing" : { "$ref" : "#/components/schemas/DangerousGoodsPackingValidations", "description" : "Validation rules for packing fields" }, "parcelLimit" : { "type" : "boolean", "description" : "Indicates whether there is a limit on the number of parcels per dangerous goods declaration" }, "technicalName" : { "$ref" : "#/components/schemas/EnrichmentValidations", "description" : "Validation rules for the technical name field" }, "transportation" : { "$ref" : "#/components/schemas/DangerousGoodsTransportationValidations", "description" : "Validation rules for transportation fields" } } }, "SerialLinkResponse" : { "type" : "object", "description" : "Serial number paired with its tracking link", "properties" : { "serial" : { "type" : "string", "description" : "Serial number", "example" : "ABC123456789", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "link" : { "type" : "string", "description" : "Tracking link URL", "example" : "https://...", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "ReportsUsageMetricsResponse" : { "type" : "object", "description" : "Aggregated billable usage metrics grouped by company and account", "properties" : { "grouping" : { "type" : "array", "description" : "Usage metrics grouped by company and account", "items" : { "$ref" : "#/components/schemas/UsageGrouping" }, "maxItems" : 1000 }, "totals" : { "$ref" : "#/components/schemas/UsageTotals", "description" : "Aggregated totals across all groupings" }, "type" : { "type" : "string", "description" : "The type of usage metrics report", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "DocumentMetaData" : { "type" : "object", "description" : "Descriptive metadata for a document", "properties" : { "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Document was created", "example" : "2026-01-22T10:30:00Z", "maxLength" : 64 }, "contentType" : { "type" : "string", "description" : "Document format", "enum" : [ "pdf", "zpl", "png" ], "example" : "pdf" }, "documentType" : { "type" : "string", "description" : "Document type", "enum" : [ "CUSTOMS_DOCUMENT", "LABEL", "DANGEROUS_GOODS_DOCUMENT", "DOCUMENT", "MANIFEST_DOCUMENT" ], "example" : "LABEL" }, "groupId" : { "type" : "string", "format" : "uuid", "description" : "Documents group", "example" : "019b26d1-6ef4-7331-b628-11fd3dfda3dd", "maxLength" : 36 }, "mediaType" : { "type" : "string", "description" : "Document media type", "enum" : [ "laser-2x104x250", "laser-a4", "thermo-104", "thermo-148", "thermo-190", "thermo-4x6" ], "example" : "laser-a4" }, "pages" : { "type" : "integer", "format" : "int32", "description" : "Total number of pages in the document", "example" : 3 } }, "required" : [ "documentType" ] }, "ParcelPacking" : { "type" : "object", "description" : "Physical packing dimensions and weight of a parcel", "properties" : { "codeType" : { "$ref" : "#/components/schemas/CodeType", "description" : "Packing code type" }, "dimensionsUnit" : { "type" : "string", "description" : "Parcel packing dimensions unit", "enum" : [ "M", "DM", "CM", "MM", "IN", "FT", "YD" ] }, "height" : { "type" : "number", "format" : "double", "description" : "Parcel packing height", "example" : 10.0 }, "length" : { "type" : "number", "format" : "double", "description" : "Parcel length", "example" : 10.0 }, "markings" : { "type" : "array", "description" : "Parcel markings", "items" : { "type" : "string", "description" : "Handling marking applied to a parcel", "enum" : [ "THIS_SIDE_UP", "FRAGILE", "KEEP_DRY", "HUMIDITY_LIMITATION", "ATMOSPHERE_PRESSURE_LIMITATION", "TEMPERATURE_LIMITATION", "PROTECT_FROM_RADIATION", "PROTECT_FROM_HEAT_AND_RADIATION", "KEEP_AWAY_FROM_SUNLIGHT", "SLING_HERE", "DO_NOT_STACK", "DO_NOT_CLAMP_AS_INDICATED", "USE_NO_FORKS", "USE_NO_HOOKS", "DO_NOT_USE_HANDTRUCK", "STACKING_LIMIT_BY_MASS", "STACKING_LIMIT_BY_NUMBER" ] }, "maxItems" : 1000 }, "pallet" : { "$ref" : "#/components/schemas/Pallet", "description" : "Pallet information" }, "type" : { "type" : "string", "description" : "User-defined parcel type", "example" : "PACKAGE", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "volume" : { "type" : "number", "format" : "double", "description" : "Parcel packing volume", "example" : 10.0 }, "volumeUnit" : { "type" : "string", "description" : "Parcel packing volume unit", "enum" : [ "CM3", "DM3", "M3", "IN3", "FT3" ] }, "weight" : { "type" : "number", "format" : "double", "description" : "Parcel packing weight", "example" : 10.0 }, "weightUnit" : { "type" : "string", "description" : "Parcel packing weight unit", "enum" : [ "G", "KG", "LB", "OZ" ] }, "width" : { "type" : "number", "format" : "double", "description" : "Parcel width", "example" : 10.0 } } }, "ShippingQuoteListResponse" : { "type" : "object", "description" : "Lists Shipping Quotes. \nReturns a paginated list of Shipping Quotes.\n", "properties" : { "items" : { "type" : "array", "description" : "The list of shipping quotes", "items" : { "$ref" : "#/components/schemas/ShippingQuoteResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "HandlingItem" : { "type" : "object", "description" : "A single dangerous goods handling requirement", "properties" : { "externalReference" : { "type" : "string", "description" : "Index of the handling entry in the declaration to apply these validation rules to", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "validations" : { "$ref" : "#/components/schemas/CommonValidations", "description" : "Validation rules for the handling entry at the specified index" } } }, "ParcelResponse" : { "type" : "object", "description" : "Parcel within a shipment", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Parcel", "example" : "019beadd-818c-792d-9bd4-ea04b0dbe23e", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Parcel was created", "example" : "2021-09-01T12:00:00+02:00", "maxLength" : 64 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Parcel was last updated", "example" : "2021-09-01T12:00:00+02:00", "maxLength" : 64 }, "reference" : { "type" : "string", "description" : "Parcel reference", "example" : "#45678", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "serial" : { "type" : "string", "description" : "Identifies the Serial Number", "example" : "473325380000006010", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "dangerousGoods" : { "type" : "array", "description" : "Dangerous goods associated with the parcel", "items" : { "$ref" : "#/components/schemas/DangerousGoodsParcel" }, "maxItems" : 1000 }, "description" : { "type" : "string", "description" : "Parcel description", "example" : "This is a parcel description", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "items" : { "type" : "array", "description" : "List of parcel items", "items" : { "$ref" : "#/components/schemas/ParcelItemResponse" }, "maxItems" : 1000 }, "meta" : { "type" : "object", "additionalProperties" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : "Additional metadata", "example" : { "key1" : "value1", "key2" : "value2" } }, "packing" : { "$ref" : "#/components/schemas/ParcelPacking", "description" : "Parcel packing details" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "weight" : { "type" : "number", "format" : "double", "description" : "Parcel weight", "example" : 10.0 }, "weightUnit" : { "type" : "string", "description" : "Parcel weight unit", "enum" : [ "G", "KG", "LB", "OZ" ] } } }, "UsageTotals" : { "type" : "object", "description" : "Aggregated billable usage totals across all groupings", "properties" : { "accounts" : { "type" : "integer", "format" : "int32", "description" : "Total number of accounts included in the metrics" }, "companies" : { "type" : "integer", "format" : "int32", "description" : "Total number of companies included in the metrics" }, "records" : { "type" : "array", "description" : "Aggregated usage records across the metrics", "items" : { "$ref" : "#/components/schemas/UsageRecord" }, "maxItems" : 1000 } } }, "DangerousGoodsDeclarationTypeListResponse" : { "type" : "object", "description" : "Paginated list of dangerous goods declaration types", "properties" : { "items" : { "type" : "array", "description" : "Dangerous Goods Declaration Types", "items" : { "$ref" : "#/components/schemas/DangerousGoodsDeclarationTypeResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "InlineShipmentManifestRequest" : { "type" : "object", "description" : "Request to create a shipment manifest", "properties" : { "reference" : { "type" : "string", "description" : "Shipment manifest reference", "example" : "S-12345", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "loadBearers" : { "type" : "array", "description" : "Load bearers for the manifest; the number of load bearers determines the number of manifest copies", "items" : { "$ref" : "#/components/schemas/LoadBearerRequest" }, "maxItems" : 1000 }, "shipmentChannel" : { "$ref" : "#/components/schemas/InlineShipmentChannelRequest", "description" : "Shipment Channel used for this manifest" }, "type" : { "type" : "string", "description" : "Shipment manifest type", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "shipmentChannel", "type" ] }, "DangerousGoodsParcel" : { "type" : "object", "description" : "Dangerous goods details declared for a parcel", "properties" : { "netQuantity" : { "type" : "number", "format" : "double", "description" : "Dangerous goods net quantity", "example" : 10.5 }, "netQuantityUnit" : { "type" : "string", "description" : "Net quantity unit", "enum" : [ "G", "KG", "LB", "OZ", "CM3", "DM3", "M3", "IN3", "FT3" ], "example" : "KG" }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "Dangerous goods quantity", "example" : 5, "minimum" : 1 }, "type" : { "type" : "string", "description" : "Dangerous goods type", "example" : "UN1950", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "netQuantity" ] }, "ZoneListResponse" : { "type" : "object", "description" : "Paginated list of delivery zones", "properties" : { "items" : { "type" : "array", "description" : "Zones", "items" : { "$ref" : "#/components/schemas/ZoneResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "019a9e36-06ba-718e-b98e-e4907a7edfe7", "maxLength" : 36 } } }, "CustomsDeclarationRequest" : { "type" : "object", "description" : "Request to create a customs declaration for a shipment", "properties" : { "reference" : { "type" : "string", "description" : "User-defined internal tracking reference", "example" : "INV-2025-0001", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "charges" : { "$ref" : "#/components/schemas/CustomsDeclarationCharges", "description" : "Declaration charges" }, "comments" : { "type" : "array", "description" : "Declaration comments", "example" : [ "Goods are samples and not for resale." ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 4, "minItems" : 1 }, "currency" : { "type" : "string", "description" : "Currency code", "example" : "EUR", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "declarant" : { "$ref" : "#/components/schemas/CustomsDeclarationDeclarant", "description" : "Declarant information" }, "declaredAt" : { "type" : "string", "format" : "date-time", "description" : "Customs Declaration timestamp. Must not be in the past. Defaults to current time if not provided.", "example" : "2024-07-01T00:00:00+00:00", "maxLength" : 64 }, "invoice" : { "$ref" : "#/components/schemas/CustomsDeclarationInvoice", "description" : "Invoice information" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceRequest", "description" : "The persistence configuration of the entity." }, "purpose" : { "$ref" : "#/components/schemas/CustomsDeclarationPurpose", "description" : "Customs declaration purpose" }, "statements" : { "type" : "array", "description" : "Declaration statements", "example" : [ "I hereby declare that the information contained in this declaration is true and complete to the best of my knowledge and belief." ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 2, "minItems" : 1 }, "terms" : { "$ref" : "#/components/schemas/CustomsDeclarationTerms", "description" : "Trade terms" }, "types" : { "type" : "array", "description" : "Customs Declaration types", "example" : [ "CN22" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 2147483647, "minItems" : 1 } }, "required" : [ "currency", "declarant", "invoice", "types" ] }, "TrackerListResponse" : { "type" : "object", "description" : "Paginated list of shipment trackers", "properties" : { "items" : { "type" : "array", "description" : "Trackers", "items" : { "$ref" : "#/components/schemas/TrackerResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "PackingCodeType" : { "type" : "object", "description" : "Packing code type and its code configuration", "properties" : { "code" : { "$ref" : "#/components/schemas/Code", "description" : "The code of the packing." }, "type" : { "type" : "string", "description" : "The type of the packing.", "example" : "GSPackageCode", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "PickupBookingRequest" : { "type" : "object", "description" : "Pickup booking with time slot and driver instructions", "properties" : { "instructions" : { "type" : "array", "description" : "Pickup instructions", "example" : [ "Ring doorbell upon arrival" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 }, "slot" : { "$ref" : "#/components/schemas/PickupBookingSlot", "description" : "The pickup time slot" } }, "required" : [ "slot" ] }, "Webhook" : { "type" : "object", "description" : "Webhook configuration", "properties" : { "secret" : { "type" : "string", "description" : "Auto-generated secret used to sign outbound webhook payloads with an HMAC-SHA256 signature (sent in the X-Nshift-Signature header). Generated on creation and returned on read; cannot be set by the client.", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$", "readOnly" : true }, "url" : { "type" : "string", "description" : "Webhook URL", "example" : "https://example.com/webhook", "maxLength" : 255, "minLength" : 3, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "url" ] }, "CarrierRate" : { "type" : "object", "description" : "Carrier rate configuration for a delivery option", "properties" : { "enabled" : { "type" : "boolean", "description" : "Indicates whether the carrier rate is active. Defaults to false.", "example" : false }, "fallbackPrice" : { "type" : "number", "format" : "double", "description" : "Carrier fallback price", "example" : 1.0 } }, "required" : [ "enabled" ] }, "CarrierRateLocalResponse" : { "type" : "object", "description" : "Carrier rate calculated locally", "properties" : { "currency" : { "type" : "string", "description" : "ISO 4217 currency code of the locally calculated carrier rate", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "price" : { "type" : "number", "format" : "double", "description" : "Price of the locally calculated carrier rate" } } }, "AddressValidationConditions" : { "type" : "object", "description" : "Conditions under which this address validation applies", "properties" : { "roles" : { "type" : "array", "description" : "Party roles that this address validation applies to", "example" : [ "SENDER", "RECEIVER" ], "items" : { "type" : "string", "description" : "Party role in a shipment", "enum" : [ "SENDER", "RECEIVER", "DELIVERY", "DISPATCH", "RETURN", "FREIGHT_PAYER", "TAX_PAYER", "CUSTOMS_PAYER", "IMPORTER", "EXPORTER" ] }, "maxItems" : 1000 } } }, "InlineParcel" : { "type" : "object", "description" : "Parcel supplied inline within a request", "properties" : { "reference" : { "type" : "string", "description" : "Parcel reference", "example" : "#45678", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "serial" : { "type" : "string", "description" : "Parcel serial number", "example" : "473325380000006010", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "dangerousGoods" : { "type" : "array", "description" : "Dangerous goods associated with the Parcel", "items" : { "$ref" : "#/components/schemas/DangerousGoodsParcel" }, "maxItems" : 1, "minItems" : 1 }, "description" : { "type" : "string", "description" : "Parcel description", "example" : "This is a parcel description", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "items" : { "type" : "array", "description" : "Parcel Items included in the Parcel", "items" : { "$ref" : "#/components/schemas/ParcelItemRequest" }, "maxItems" : 2147483647, "minItems" : 1 }, "meta" : { "type" : "object", "additionalProperties" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : "Additional metadata", "example" : { "key1" : "value1", "key2" : "value2" } }, "packing" : { "$ref" : "#/components/schemas/ParcelPacking", "description" : "Parcel packing information" }, "weight" : { "type" : "number", "format" : "double", "description" : "Parcel weight", "example" : 10.0 }, "weightUnit" : { "type" : "string", "description" : "Parcel weight unit", "enum" : [ "G", "KG", "LB", "OZ" ] } } }, "AuthorizationRequest" : { "type" : "object", "description" : "Client credentials grant request for authorization", "properties" : { "grantType" : { "type" : "string", "description" : "Grant type for authorization", "example" : "client_credentials", "maxLength" : 255, "pattern" : "^(client_credentials)$" } }, "required" : [ "grantType" ] }, "DocumentListResponse" : { "type" : "object", "description" : "List of documents", "properties" : { "items" : { "type" : "array", "description" : "List of documents", "items" : { "$ref" : "#/components/schemas/Document" }, "maxItems" : 1000 } } }, "CustomsItemPricing" : { "type" : "object", "description" : "Validation rules for customs item pricing fields", "properties" : { "countryOfOrigin" : { "$ref" : "#/components/schemas/FieldValidation", "description" : "Country of origin validation" }, "tariffNumber" : { "$ref" : "#/components/schemas/FieldValidation", "description" : "Tariff number validation" }, "unitPrice" : { "$ref" : "#/components/schemas/FieldValidation", "description" : "Unit price validation" } } }, "CarrierResponse" : { "type" : "object", "description" : "Carrier definition with capabilities and metadata", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Carrier", "example" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "maxLength" : 36 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Carrier was last updated", "example" : "2021-07-01T00:00:00+00:00", "maxLength" : 64 }, "name" : { "type" : "string", "description" : "Carrier name", "example" : "UPS", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "access" : { "type" : "boolean", "description" : "Indicates whether the user has access to the Carrier", "example" : false }, "attributes" : { "type" : "array", "description" : "List of attributes associated with this carrier", "example" : [ "attribute1", "attribute2" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 }, "code" : { "type" : "string", "description" : "Carrier code", "example" : "UPS", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "connection" : { "$ref" : "#/components/schemas/CarrierConnection", "description" : "How this carrier is integrated and which CDA version it runs. Absent when neither can be determined for the carrier" }, "grouping" : { "type" : "string", "description" : "Carrier grouping", "example" : "DHL", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "logo" : { "$ref" : "#/components/schemas/CarrierLogo", "description" : "Logo information for this carrier" }, "meta" : { "type" : "object", "additionalProperties" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : "Additional metadata", "example" : { "key1" : "value1", "key2" : "value2" } }, "mode" : { "$ref" : "#/components/schemas/ModeInfo", "description" : "Mode information with allowed values for carrier definition mode" }, "monitoring" : { "$ref" : "#/components/schemas/CarrierMonitoring", "description" : "The carrier monitor tracking this carrier's operational status. Absent when no monitor exists for the carrier" }, "portalCarrierId" : { "type" : "string", "description" : "nShift Portal carrier identifier for this carrier", "example" : "1351", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "restrictions" : { "$ref" : "#/components/schemas/Restrictions", "description" : "Restriction information for this carrier" }, "settings" : { "type" : "array", "description" : "Carrier settings", "items" : { "$ref" : "#/components/schemas/Field" }, "maxItems" : 1000, "uniqueItems" : true }, "staging" : { "$ref" : "#/components/schemas/CarrierStaging", "description" : "Staging and onboarding information for this carrier" } } }, "CustomsDeclarationListResponse" : { "type" : "object", "description" : "Paginated list of customs declarations", "properties" : { "items" : { "type" : "array", "description" : "Customs Declarations", "items" : { "$ref" : "#/components/schemas/CustomsDeclarationResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "CommonType" : { "type" : "object", "description" : "Typed customs field with default value and code validations", "properties" : { "code" : { "$ref" : "#/components/schemas/CommonCode", "description" : "Code" }, "defaultValue" : { "type" : "string", "description" : "Default value", "example" : "DEFAULT_DECLARATION", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : { "type" : "string", "description" : "Type description", "example" : "Customs declaration for imported goods", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "type" : { "type" : "string", "description" : "Identifies the Entity", "example" : "CUSTOMS_DECLARATION", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "DocumentRendering" : { "type" : "object", "description" : "Document rendering configuration for the shipment booking", "properties" : { "enabled" : { "type" : "boolean", "default" : true, "description" : "Indicates whether document generation is enabled", "example" : false }, "settings" : { "type" : "array", "description" : "Rendering settings", "items" : { "$ref" : "#/components/schemas/DocumentRenderingType" }, "maxItems" : 4, "minItems" : 1 } } }, "DeliveryBookingSlot" : { "type" : "object", "description" : "The requested delivery time slot", "properties" : { "date" : { "type" : "string", "format" : "date", "description" : "The requested delivery date", "example" : "2024-12-01", "maxLength" : 10 }, "timeFrom" : { "type" : "string", "description" : "The earliest delivery time in HH:mm format, between 00:00 and 23:59. Must not be later than timeTo.", "example" : "08:00", "maxLength" : 5, "pattern" : "^([01]\\d|2[0-3]):[0-5]\\d$" }, "timeTo" : { "type" : "string", "description" : "The latest delivery time in HH:mm format, between 00:00 and 23:59.", "example" : "16:00", "maxLength" : 5, "pattern" : "^([01]\\d|2[0-3]):[0-5]\\d$" } } }, "CarrierRateResponse" : { "type" : "object", "description" : "Carrier rate settings and computed result", "properties" : { "enabled" : { "type" : "boolean", "description" : "Indicates whether the carrier rate is active. Defaults to false.", "example" : false }, "fallbackPrice" : { "type" : "number", "format" : "double", "description" : "Carrier fallback price", "example" : 1.0 }, "local" : { "$ref" : "#/components/schemas/CarrierRateLocalResponse", "description" : "Carrier rate calculated locally" }, "response" : { "$ref" : "#/components/schemas/CarrierRateResponseInfo", "description" : "Information about the carrier price calculation outcome (status type and descriptive message). Useful for diagnosing why carrier rates are missing or zero." } } }, "DangerousGoodsTransportation" : { "type" : "object", "description" : "Transportation information", "properties" : { "emergencyCode" : { "type" : "string", "description" : "Emergency response code", "example" : "2YE", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "separation" : { "type" : "number", "format" : "double", "description" : "Separation distance requirements", "example" : 3 }, "tunnelRestriction" : { "type" : "string", "description" : "Tunnel restriction code for road transport", "example" : "D/E", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "CommonValidations" : { "type" : "object", "description" : "Common validation rules for a field", "properties" : { "allowedValues" : { "type" : "array", "description" : "Allowed values for the field type", "items" : { "$ref" : "#/components/schemas/AllowedValue" }, "maxItems" : 1000 }, "mandatory" : { "type" : "boolean", "description" : "Indicates whether the field is mandatory", "example" : false } } }, "ShippingQuotesRequest" : { "type" : "object", "description" : "Request to retrieve shipping quotes for a shipment", "properties" : { "checkoutId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Checkout", "example" : "1d17df8e-9945-4449-8eb8-54e658159c5a", "maxLength" : 36 }, "currency" : { "type" : "string", "description" : "Currency code", "example" : "EUR", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "deliveryOptionIds" : { "type" : "array", "description" : "Delivery option references", "example" : [ "019c2038-9e20-7000-8193-7c08db53a87f", "019b0595-4d32-7000-96b7-3c435889aeff" ], "items" : { "type" : "string", "format" : "uuid", "maxLength" : 36 }, "maxItems" : 1000 }, "parcelIds" : { "type" : "array", "description" : "Parcel information", "example" : [ "019beadd-e6df-7e4b-a0f6-54faf53e8f23", "019beadc-cee9-70b4-b880-55a84a0b6be6" ], "items" : { "type" : "string", "format" : "uuid", "maxLength" : 36 }, "maxItems" : 2147483647, "minItems" : 1 }, "parties" : { "type" : "array", "description" : "Shipment parties", "items" : { "$ref" : "#/components/schemas/Party" }, "maxItems" : 2147483647, "minItems" : 2 }, "persistence" : { "$ref" : "#/components/schemas/PersistenceRequest", "description" : "The persistence configuration of the entity." } }, "required" : [ "currency", "parcelIds", "parties" ] }, "BasicResponse" : { "type" : "object", "description" : "Minimal response carrying the affected resource identifier", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the entity", "example" : "01991a03-c860-7000-bb91-5a9cb479f522", "maxLength" : 36 } } }, "CustomsDeclarationResponseInvoice" : { "type" : "object", "description" : "Invoice information", "properties" : { "items" : { "type" : "array", "description" : "Item IDs included in the invoice", "items" : { "$ref" : "#/components/schemas/ParcelItemResponse" }, "maxItems" : 1000 }, "number" : { "type" : "string", "description" : "Invoice number", "example" : "INV-2025-0001", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "number" ] }, "MockEventRequest" : { "type" : "object", "description" : "Request body for creating a mock event", "properties" : { "payload" : { "$ref" : "#/components/schemas/MockEventPayload", "description" : "Event payload" }, "topic" : { "$ref" : "#/components/schemas/EventChannelTopic" }, "type" : { "type" : "string", "description" : "Event type", "enum" : [ "CREATE", "UPDATE", "DELETE", "CONSUME", "QUERY", "GENERATE" ], "example" : "CREATED" } }, "required" : [ "payload", "topic", "type" ] }, "CarrierDefinitionRequest" : { "type" : "object", "description" : "The entity being created or replaced", "properties" : { "name" : { "type" : "string", "description" : "The name of the Carrier Definition", "example" : "DHL Home Delivery", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "carrierId" : { "type" : "string", "format" : "uuid", "description" : "The unique identifier of the Carrier.", "example" : "24260549-47a1-390b-a211-da8989984a08", "maxLength" : 36, "minLength" : 1 }, "group" : { "type" : "string", "description" : "The group of the Carrier Definition", "example" : "UPS_saver", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "mode" : { "type" : "string", "default" : "STAGING", "description" : "The mode environment of the Carrier Definition", "enum" : [ "STAGING", "PRODUCTION", "DEMO" ], "example" : "STAGING" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceRequest", "description" : "The persistence configuration of the entity." }, "settings" : { "type" : "array", "description" : "The Carrier related settings used for carrier connectivity etc.", "items" : { "$ref" : "#/components/schemas/Settings" }, "maxItems" : 1000 } }, "required" : [ "carrierId", "name" ] }, "ShipmentChannelListResponse" : { "type" : "object", "description" : "Paginated list of shipment channels", "properties" : { "items" : { "type" : "array", "description" : "Shipment Channels", "items" : { "$ref" : "#/components/schemas/ShipmentChannelResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "AccountContact" : { "type" : "object", "description" : "Contact person details for the account", "properties" : { "name" : { "type" : "string", "description" : "Contact name", "example" : "Doe", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "email" : { "type" : "string", "format" : "email", "description" : "Contact email address", "example" : "jdoe@nshift.com", "maxLength" : 254 }, "phone" : { "type" : "string", "description" : "Contact mobile phone number", "example" : "+46721234567", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "CarrierListResponse" : { "type" : "object", "description" : "Paginated list of available carriers", "properties" : { "items" : { "type" : "array", "description" : "Carriers", "items" : { "$ref" : "#/components/schemas/CarrierResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "ShipmentDispatchTrackerRequest" : { "type" : "object", "description" : "Tracking state update for a shipment dispatch", "properties" : { "status" : { "type" : "string", "description" : "The current status of the Shipment Dispatch Tracker", "enum" : [ "BOOKED", "DISPATCHED", "DELIVERED", "VOID" ] }, "loadBearers" : { "type" : "array", "description" : "Load bearer serials and references", "items" : { "$ref" : "#/components/schemas/SerialReferenceResponse" }, "maxItems" : 1000 }, "manifest" : { "$ref" : "#/components/schemas/SerialLinkResponse", "description" : "Shipment manifest details" }, "motherShipment" : { "$ref" : "#/components/schemas/SerialLinkResponse", "description" : "Mother shipment details" }, "parcels" : { "type" : "array", "description" : "Parcel serials and references", "items" : { "$ref" : "#/components/schemas/SerialReferenceResponse" }, "maxItems" : 1000 }, "persistence" : { "$ref" : "#/components/schemas/PersistenceRequest", "description" : "The persistence configuration of the entity." }, "shipments" : { "type" : "array", "description" : "Shipment serials and references", "items" : { "$ref" : "#/components/schemas/SerialReferenceResponse" }, "maxItems" : 1000 } }, "required" : [ "status" ] }, "PudoPoints" : { "type" : "object", "description" : "Pickup and drop-off point support configuration", "properties" : { "cached" : { "$ref" : "#/components/schemas/CachedPudoPoints", "description" : "Cached PUDO Point dataset support of the Service" }, "externalReference" : { "type" : "string", "description" : "Carrier external PUDO ID", "example" : "PostNord", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "operationTypes" : { "type" : "array", "description" : "Operation types supported by the carrier's Pudo2 configuration", "example" : [ "locker", "shop" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 }, "roles" : { "type" : "array", "description" : "PUDO point roles", "example" : [ "DELIVERY" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^(DELIVERY)$" }, "maxItems" : 1000 }, "supported" : { "type" : "boolean", "description" : "Indicates whether PUDO points are supported", "example" : false } } }, "CustomsClearance" : { "type" : "object", "description" : "Customs clearance requirements and applicable regions", "properties" : { "mandatory" : { "type" : "boolean", "description" : "Whether customs clearance is mandatory for the route", "example" : false }, "regions" : { "$ref" : "#/components/schemas/CustomsRegions", "description" : "Customs regions the clearance requirement applies to" } } }, "InlineCarrierDefinitionRequest" : { "type" : "object", "description" : "Carrier definition supplied inline within a request", "properties" : { "name" : { "type" : "string", "description" : "The name of the Carrier Definition", "example" : "DHL Home Delivery", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "carrierId" : { "type" : "string", "format" : "uuid", "description" : "The unique identifier of the Carrier.", "example" : "24260549-47a1-390b-a211-da8989984a08", "maxLength" : 36, "minLength" : 1 }, "group" : { "type" : "string", "description" : "The group of the Carrier Definition", "example" : "UPS_saver", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "mode" : { "type" : "string", "default" : "STAGING", "description" : "The mode environment of the Carrier Definition", "enum" : [ "STAGING", "PRODUCTION", "DEMO" ], "example" : "STAGING" }, "settings" : { "type" : "array", "description" : "The Carrier related settings used for carrier connectivity etc.", "items" : { "$ref" : "#/components/schemas/Settings" }, "maxItems" : 1000 } }, "required" : [ "carrierId" ] }, "PudoPointListResponse" : { "type" : "object", "description" : "List of pickup and drop-off points", "properties" : { "items" : { "type" : "array", "description" : "PUDO Points", "items" : { "$ref" : "#/components/schemas/PudoPointResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "TermsCode" : { "type" : "object", "description" : "Terms code configuration", "properties" : { "defaultValue" : { "type" : "string", "description" : "The default value for the terms code", "example" : "DAP", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "validations" : { "$ref" : "#/components/schemas/CommonValidations", "description" : "Validations for the terms code# ========================================" } } }, "LeadTime" : { "type" : "object", "description" : "Fulfillment, dispatch and delivery lead times", "properties" : { "datePattern" : { "type" : "string", "description" : "Date pattern for the lead time", "example" : "Coming soon...", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "delivery" : { "type" : "integer", "format" : "int64", "description" : "Delivery lead time in days", "example" : 1, "minimum" : 0 }, "dispatch" : { "type" : "integer", "format" : "int64", "description" : "Dispatch lead time in days", "example" : 1, "minimum" : 0 }, "fulfillment" : { "type" : "integer", "format" : "int64", "description" : "Fulfillment lead time in days", "example" : 1, "minimum" : 0 } }, "required" : [ "datePattern", "delivery", "dispatch", "fulfillment" ] }, "State" : { "type" : "object", "description" : "Lifecycle state flags of the shipment booking", "properties" : { "consolidated" : { "type" : "boolean", "description" : "Indicates whether the shipment is consolidated", "example" : false }, "finalized" : { "type" : "boolean", "description" : "Indicates whether the shipment is finalized", "example" : false }, "inbound" : { "type" : "boolean", "description" : "Indicates whether the shipment is inbound", "example" : false }, "outbound" : { "type" : "boolean", "description" : "Indicates whether the shipment is outbound", "example" : false } } }, "DocumentDataPageResponse" : { "type" : "object", "description" : "Single page of document content", "properties" : { "reference" : { "type" : "string", "description" : "Document page reference (parcel.reference)", "example" : "#45678", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "data" : { "type" : "string", "description" : "Base64 encoded document page data", "example" : "JVBERi0xLjQKJeLjz9MKNCAwIG9iago8PC9MZW5ndGgg...", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "page" : { "type" : "integer", "format" : "int32", "description" : "Document page number", "example" : 1 } } }, "ChannelPickup" : { "type" : "object", "description" : "Pickup booking configuration. When enabled, the earliest valid slot is selected automatically if the user omits a pickup time and the service supports pickup booking. When disabled, slots are used only to validate a manually provided pickup time. Ignored if the service does not support pickup booking.", "properties" : { "enabled" : { "type" : "boolean", "description" : "When true, the earliest valid slot is selected automatically if no pickup time is provided. When false, slots are used only to validate a manually provided pickup time.", "example" : false }, "slots" : { "type" : "array", "description" : "Pickup slot definitions. At least one slot is required when pickup is present.", "items" : { "$ref" : "#/components/schemas/ChannelPickupSlot" }, "maxItems" : 2147483647, "minItems" : 1 } }, "required" : [ "enabled", "slots" ] }, "ParcelItemResponse" : { "type" : "object", "description" : "Item contained within a parcel", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Parcel Item", "example" : "019ab5ae-7cbb-7665-94a8-86edb63c6191", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Parcel Item was created", "example" : "2021-09-01T12:00:00+02:00", "maxLength" : 64 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : " Timestamp when the Parcel Item was last updated", "example" : "2021-09-01T12:00:00+02:00", "maxLength" : 64 }, "reference" : { "type" : "string", "description" : "Parcel Item reference", "example" : "ITEM-REF-001", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "dangerousGoods" : { "type" : "array", "description" : "Dangerous goods associated with the Parcel Item", "example" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "items" : { "$ref" : "#/components/schemas/DangerousGoodsParcel" }, "maxItems" : 1000 }, "isReturnable" : { "type" : "boolean", "description" : "Indicates if the item is returnable. Defaults to false.", "example" : false }, "meta" : { "type" : "object", "additionalProperties" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : "Additional metadata", "example" : { "key1" : "value1", "key2" : "value2" } }, "packing" : { "$ref" : "#/components/schemas/ParcelItemPacking", "description" : "Parcel item packing details" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "pricing" : { "$ref" : "#/components/schemas/Pricing", "description" : "Parcel item pricing details" }, "product" : { "$ref" : "#/components/schemas/Product", "description" : "Parcel item product details" }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "Number of Parcel Items in the Parcel", "example" : 2 }, "skipCustoms" : { "type" : "boolean", "description" : "If true, this item is excluded when auto-aggregating parcel items into customs declaration invoice items. Defaults to false.", "example" : false }, "weight" : { "type" : "number", "format" : "double", "description" : " Parcel Item weight", "example" : 10.0 }, "weightUnit" : { "type" : "string", "description" : "Parcel Item weight unit", "enum" : [ "G", "KG", "LB", "OZ" ] } } }, "InlineShippingQuoteRequest" : { "type" : "object", "description" : "Request to create a shipping quote for a shipment", "properties" : { "carrierDefinition" : { "$ref" : "#/components/schemas/InlineCarrierDefinitionRequest", "description" : "Carrier Definition used for this booking" }, "checkoutId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Checkout", "example" : "9d9e7256-45f0-4906-9c3e-8f8fa7a8214e", "maxLength" : 36 }, "deliveryOptionId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Delivery Option", "example" : "019b266d-ee29-7000-824e-2a43c67c7ab0", "maxLength" : 36 }, "meta" : { "type" : "object", "additionalProperties" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : "Additional metadata", "example" : { "key1" : "value1", "key2" : "value2" } }, "parcels" : { "type" : "array", "description" : "Parcel information", "items" : { "$ref" : "#/components/schemas/InlineParcel" }, "maxItems" : 2147483647, "minItems" : 1 }, "parties" : { "type" : "array", "description" : "Shipment parties", "items" : { "$ref" : "#/components/schemas/InlineParty" }, "maxItems" : 2147483647, "minItems" : 2 }, "rate" : { "$ref" : "#/components/schemas/ShippingQuoteRequestRate", "description" : "Shipping Quote rate" }, "serviceDefinition" : { "$ref" : "#/components/schemas/InlineServiceDefinitionRequest", "description" : "Service Definition used for this booking" }, "units" : { "$ref" : "#/components/schemas/Units", "description" : "Unit settings for weight and dimensions" } }, "required" : [ "carrierDefinition", "parcels", "parties", "rate", "serviceDefinition" ] }, "GeoCoding" : { "type" : "object", "description" : "Geographic coordinates of a location", "properties" : { "latitude" : { "type" : "string", "description" : "Latitude. Must be provided if longitude is set.", "example" : "38.8977", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "longitude" : { "type" : "string", "description" : "Longitude. Must be provided if latitude is set.", "example" : "-77.0365", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "ShipmentBookingResponse" : { "type" : "object", "description" : "Booked shipment with its state, tracker and documents", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Shipment", "example" : "019b26d6-73d6-7bf6-b1b6-4531af80e7d7", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Shipment Booking was created", "example" : "2026-01-22T10:30:00Z", "maxLength" : 64 }, "serial" : { "type" : "string", "description" : "Serial number assigned by the carrier", "example" : "6250197719", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "chargeables" : { "$ref" : "#/components/schemas/Chargeable", "description" : "Chargeable dimensions and counts" }, "delivery" : { "$ref" : "#/components/schemas/DeliveryBookingRequest", "description" : "Requested delivery date and time window" }, "documents" : { "type" : "array", "description" : "Documents associated with the Shipment Booking", "items" : { "$ref" : "#/components/schemas/Document" }, "maxItems" : 1000 }, "pickup" : { "$ref" : "#/components/schemas/PickupBookingRequest", "description" : "Resolved pickup booking slot and instructions" }, "state" : { "$ref" : "#/components/schemas/State", "description" : "Shipment booking state" }, "tracker" : { "$ref" : "#/components/schemas/TrackerResponse", "description" : "Tracking information" } } }, "ShipmentDispatchRequest" : { "type" : "object", "description" : "Request to dispatch a group of booked shipments", "properties" : { "reference" : { "type" : "string", "description" : "Shipment manifest reference", "example" : "S-12345", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceRequest", "description" : "The persistence configuration of the entity." }, "shipmentBookingIds" : { "type" : "array", "description" : "Shipment Bookings", "example" : [ "019c1dd1-5344-7d56-bb3d-dc338e80488a", "019c1dcb-0d63-7917-9c1d-00be28e7282b" ], "items" : { "type" : "string", "format" : "uuid", "maxLength" : 36 }, "maxItems" : 1000, "minItems" : 1 } }, "required" : [ "shipmentBookingIds" ] }, "Combine" : { "type" : "object", "description" : "Rules for combining this addon with others", "properties" : { "addons" : { "type" : "array", "description" : "Add-ons that can be combined", "items" : { "$ref" : "#/components/schemas/CombineAddon" }, "maxItems" : 1000 }, "allowed" : { "type" : "boolean", "description" : "Indicates whether combining is allowed", "example" : false } } }, "ShippingQuoteRequestRate" : { "type" : "object", "description" : "Shipping Quote rate", "properties" : { "carrierRate" : { "$ref" : "#/components/schemas/CarrierRate", "description" : "Carrier rate price" }, "cartPrice" : { "type" : "number", "format" : "double", "description" : "Cart price", "example" : 10.0 }, "currency" : { "type" : "string", "description" : "Currency code", "example" : "EUR", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "price" : { "type" : "number", "format" : "double", "description" : "Standard rate price", "example" : 10.0 } }, "required" : [ "currency", "price" ] }, "ShipmentBookingInfo" : { "type" : "object", "description" : "Shipment information", "properties" : { "addons" : { "type" : "array", "description" : "Add-ons for the Service", "items" : { "$ref" : "#/components/schemas/Addon" }, "maxItems" : 1000 }, "carrier" : { "$ref" : "#/components/schemas/InfoParties", "description" : "Carrier information" }, "delivery" : { "$ref" : "#/components/schemas/InfoParties", "description" : "Receiver information" }, "dispatch" : { "$ref" : "#/components/schemas/InfoParties", "description" : "Sender information" }, "terms" : { "$ref" : "#/components/schemas/ShipmentBookingTerms", "description" : "Terms for the shipment booking" } }, "required" : [ "carrier", "delivery", "dispatch" ] }, "OpeningHours" : { "type" : "object", "description" : "Weekly opening hours schedule for a location", "properties" : { "weeklyOpening" : { "type" : "array", "description" : "Weekly opening times", "items" : { "$ref" : "#/components/schemas/WeeklyOpening" }, "maxItems" : 1000 } } }, "Field" : { "type" : "object", "description" : "Configurable carrier field with routing and validation rules", "properties" : { "context" : { "type" : "string", "description" : "Field context", "example" : "SHIPMENT", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "defaultValue" : { "type" : [ "string", "null" ], "description" : "Default value if omitted", "example" : "PC", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : { "type" : "string", "description" : "Field description", "example" : "Customer Number", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "externalReference" : { "type" : "string", "description" : "External field reference", "example" : "custNo", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "key" : { "type" : "string", "description" : "Field key", "example" : "TEXT4", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "route" : { "$ref" : "#/components/schemas/SingleRoute", "description" : "Route configuration" }, "validations" : { "$ref" : "#/components/schemas/Validations", "description" : "Validation rules" } }, "required" : [ "key", "route" ] }, "Consolidation" : { "type" : "object", "description" : "Whether shipment consolidation is supported", "properties" : { "supported" : { "type" : "boolean", "description" : "Indicates whether consolidation is supported", "example" : false } } }, "DeliveryOptionRequest" : { "type" : "object", "description" : "Payload to create or update a delivery option", "properties" : { "name" : { "type" : "string", "description" : "Delivery Option name", "example" : "Home Delivery", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "carrierDefinitionId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Carrier Definition", "example" : "019a8cb2-394a-7689-8a09-1c96ee3cea88", "maxLength" : 36 }, "description" : { "type" : "string", "description" : "Delivery Option description", "example" : "The shipment is delivered directly to your door.", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "enabled" : { "type" : "boolean", "description" : "Indicates whether the Delivery Option is active", "example" : false }, "leadTimes" : { "type" : "array", "description" : "Lead time configurations for the Delivery Option", "items" : { "$ref" : "#/components/schemas/LeadTime" }, "maxItems" : 1000 }, "persistence" : { "$ref" : "#/components/schemas/PersistenceRequest", "description" : "The persistence configuration of the entity." }, "priority" : { "type" : "integer", "format" : "int64", "description" : "Delivery Option priority", "example" : 1, "minimum" : 0 }, "rates" : { "type" : "array", "description" : "Rate configurations for the Delivery Option", "items" : { "$ref" : "#/components/schemas/Rate" }, "maxItems" : 1000, "minItems" : 1 }, "serviceDefinitionId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Service Definition", "example" : "01991a00-07b3-7171-a245-177e15965608", "maxLength" : 36 }, "units" : { "$ref" : "#/components/schemas/Units", "description" : "Unit settings for weight and dimensions" }, "zoneIds" : { "type" : "array", "description" : "Zones associated with the Delivery Option", "example" : [ "019b266c-0504-7f31-8f27-e216b1744ed6", "019a9e36-06ba-718e-b98e-e4907a7edfe7" ], "items" : { "type" : "string", "format" : "uuid", "maxLength" : 36 }, "maxItems" : 1000, "minItems" : 1 } }, "required" : [ "carrierDefinitionId", "enabled", "name", "priority", "rates", "serviceDefinitionId", "zoneIds" ] }, "FieldValidation" : { "type" : "object", "description" : "Validation rules applied to a single field", "properties" : { "validations" : { "$ref" : "#/components/schemas/EnrichmentValidations", "description" : "Validation rules for the field" } } }, "CustomsDeclarationResponse" : { "type" : "object", "description" : "Customs declaration for an international shipment", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Customs Declaration", "example" : "019ab521-5fc6-7836-8d3b-ba0f6e12e003", "maxLength" : 36 }, "reference" : { "type" : "string", "description" : "User-defined internal tracking reference", "example" : "INV-2025-0001", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "charges" : { "$ref" : "#/components/schemas/CustomsDeclarationCharges", "description" : "Declaration charges" }, "comments" : { "type" : "array", "description" : "Declaration comments", "example" : [ "Goods are samples and not for resale." ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 4, "minItems" : 1 }, "currency" : { "type" : "string", "description" : "Currency code", "example" : "EUR", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "declarant" : { "$ref" : "#/components/schemas/CustomsDeclarationDeclarant", "description" : "Declarant information" }, "declaredAt" : { "type" : "string", "format" : "date-time", "description" : "Customs Declaration timestamp. Must not be in the past. Defaults to current time if not provided.", "example" : "2024-07-01T00:00:00+00:00", "maxLength" : 64 }, "invoice" : { "$ref" : "#/components/schemas/CustomsDeclarationResponseInvoice", "description" : "Invoice information" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "purpose" : { "$ref" : "#/components/schemas/CustomsDeclarationPurpose", "description" : "Customs declaration purpose" }, "statements" : { "type" : "array", "description" : "Declaration statements", "example" : [ "I hereby declare that the information contained in this declaration is true and complete to the best of my knowledge and belief." ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 }, "terms" : { "$ref" : "#/components/schemas/CustomsDeclarationTerms", "description" : "Trade terms" }, "types" : { "type" : "array", "description" : "Customs Declaration types", "example" : [ "CN22" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 2147483647, "minItems" : 1 } }, "required" : [ "currency", "declarant", "invoice", "statements", "types" ] }, "GoEventEnvelope" : { "type" : "object", "description" : "Envelope POSTed to a subscriber's webhook endpoint when a subscribed event occurs. Serialized from the platform's ExternalGoEvent.", "properties" : { "correlationId" : { "type" : "string", "format" : "uuid", "description" : "Correlation identifier linking the event to the originating request.", "maxLength" : 36 }, "entityId" : { "type" : "string", "format" : "uuid", "description" : "Identifier of the entity the event is about.", "maxLength" : 36 }, "entityType" : { "type" : "string", "description" : "The type of the entity the event is about.", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "eventId" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier of the event.", "maxLength" : 36 }, "occurredAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp of when the event occurred.", "maxLength" : 64 }, "topic" : { "$ref" : "#/components/schemas/EventChannelTopic", "description" : "The event topic the delivered event belongs to." }, "type" : { "type" : "string", "description" : "The kind of change that produced the event.", "enum" : [ "CREATE", "UPDATE", "DELETE" ] } }, "required" : [ "correlationId", "entityId", "entityType", "eventId", "occurredAt", "topic", "type" ] }, "InlineShippingQuotesRequest" : { "type" : "object", "description" : "Request to retrieve shipping quotes for a shipment", "properties" : { "checkoutId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Checkout", "example" : "1d17df8e-9945-4449-8eb8-54e658159c5a", "maxLength" : 36 }, "currency" : { "type" : "string", "description" : "Currency code", "example" : "EUR", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "deliveryOptionIds" : { "type" : "array", "description" : "Delivery option references", "example" : [ "019c2038-9e20-7000-8193-7c08db53a87f", "019b0595-4d32-7000-96b7-3c435889aeff" ], "items" : { "type" : "string", "format" : "uuid", "maxLength" : 36 }, "maxItems" : 1000 }, "parcels" : { "type" : "array", "description" : "Parcel information", "items" : { "$ref" : "#/components/schemas/InlineParcel" }, "maxItems" : 2147483647, "minItems" : 1 }, "parties" : { "type" : "array", "description" : "Shipment parties", "items" : { "$ref" : "#/components/schemas/InlineParty" }, "maxItems" : 2147483647, "minItems" : 2 } }, "required" : [ "currency", "parcels", "parties" ] }, "Condition" : { "type" : "object", "description" : "Rule condition evaluated for a delivery option", "properties" : { "comparator" : { "type" : "string", "description" : "Condition comparator\n**Note:** Comparators are predefined and cannot be customized.", "enum" : [ "EQUAL", "NOT_EQUAL", "GREATER_THAN", "LESS_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN_OR_EQUAL" ] }, "parameter" : { "type" : "string", "description" : "Condition parameter\n**Note:** Parameters are predefined and cannot be customized.", "enum" : [ "WEIGHT", "ALL_PARCEL_WEIGHT", "ANY_PARCEL_WEIGHT", "PRICE", "PARCEL_QUANTITY", "TO_COUNTRY", "FROM_COUNTRY" ] }, "value" : { "type" : "string", "description" : "Condition value", "example" : "10", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "comparator", "parameter", "value" ] }, "CustomsDeclarationCharges" : { "type" : "object", "description" : "Monetary charges declared for customs", "properties" : { "duty" : { "type" : "number", "format" : "double", "description" : "Customs duty", "example" : 75.0 }, "freight" : { "type" : "number", "format" : "double", "description" : "Freight charge", "example" : 250.0 }, "insurance" : { "type" : "number", "format" : "double", "description" : "Insurance charge", "example" : 50.0 }, "invoice" : { "type" : "number", "format" : "double", "description" : "Invoice value", "example" : 1500.0 }, "other" : { "type" : "number", "format" : "double", "description" : "Other charges", "example" : 20.0 } } }, "Pickup" : { "type" : "object", "description" : "Pickup support and scheduling requirements", "properties" : { "acceptsDate" : { "type" : "boolean", "description" : "Indicates whether pickup accepts a specific date", "example" : false }, "mandatory" : { "type" : "boolean", "description" : "Indicates if pickup booking is mandatory for the service", "example" : false }, "supported" : { "type" : "boolean", "description" : "Indicates whether pickup is supported", "example" : false } } }, "CombineAddon" : { "type" : "object", "description" : "Addon that can be combined, identified by code", "properties" : { "code" : { "type" : "string", "description" : "Add-on code", "example" : "NOTSMS", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "ShipmentDispatchState" : { "type" : "object", "description" : "Finalized and manifested status of the dispatch", "properties" : { "finalized" : { "type" : "boolean", "description" : "When true, the Shipment Dispatch is locked from user-initiated edits. PUT requests against a finalized dispatch are rejected. Internal write-backs (e.g. carrier reference write-back) are not affected.", "example" : false }, "manifested" : { "type" : "boolean", "description" : "When true, at least one Shipment Manifest has been successfully created from this dispatch. Read-only; set automatically by the platform.", "example" : false } } }, "PudoPointResponse" : { "type" : "object", "description" : "Pickup or drop-off point details", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the PUDO Point", "example" : "019c17d0-7831-79bb-8cec-1a164bf2627a", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the PUDO Point was created", "example" : "2021-09-01T12:00:00+02:00", "maxLength" : 64 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : " Timestamp when the PUDO Point was last updated", "example" : "2021-09-01T12:00:00+02:00", "maxLength" : 64 }, "carrierId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the carrier that owns this PUDO Point", "maxLength" : 36 }, "company" : { "$ref" : "#/components/schemas/Company", "description" : "Company information" }, "contact" : { "$ref" : "#/components/schemas/Contact", "description" : "Contact information" }, "lines" : { "type" : "array", "description" : "Address lines. If omitted, lines are auto-generated from location properties. If partially provided, missing lines are auto-generated.", "example" : [ "John Doe c/o Mr Smith, nShift", "Schiller street 45, Neighborhood x", "Century Plaza 13, Floor 3, Apt 32", "District 4, DC, US-NY, US, 111111" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 }, "location" : { "$ref" : "#/components/schemas/Location", "description" : "Address location" }, "operations" : { "$ref" : "#/components/schemas/Operation", "description" : "Operational information" }, "references" : { "$ref" : "#/components/schemas/References", "description" : "PUDO point reference information" }, "source" : { "type" : "string", "description" : "Alias of the shared account the PUDO Point was read from. Present only when the PUDO Point was read with `source`.", "example" : "amber-falcon-river", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "DocumentType" : { "type" : "object", "description" : "Document type", "properties" : { "contentTypes" : { "type" : "array", "description" : "Supported document formats", "items" : { "$ref" : "#/components/schemas/ContentType" }, "maxItems" : 1000 }, "description" : { "type" : "string", "description" : "Document description", "example" : "Bring VOEC", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "mediaTypes" : { "type" : "array", "description" : "Supported media types", "items" : { "$ref" : "#/components/schemas/MediaType" }, "maxItems" : 1000 }, "type" : { "type" : "string", "description" : "Document type", "example" : "CUSTOMS_DOCUMENT", "maxLength" : 255, "pattern" : "^(CUSTOMS_DOCUMENT|LABEL|DOCUMENT|MANIFEST_DOCUMENT|DANGEROUS_GOODS_DOCUMENT)$" } } }, "TrackerShipment" : { "type" : "object", "description" : "Shipment tracking information", "properties" : { "status" : { "type" : "string", "description" : "Harmonized shipment status", "enum" : [ "BOOKED", "DISPATCHED", "DELIVERED", "VOID" ], "example" : "BOOKED" }, "serial" : { "type" : "string", "description" : "Shipment serial number", "example" : "00001234567890123456", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "link" : { "type" : "string", "description" : "Shipment tracking link", "example" : "https://...", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "DeliveryBooking" : { "type" : "object", "description" : "Delivery date and time-window support for the service", "properties" : { "date" : { "$ref" : "#/components/schemas/DeliveryBookingField", "description" : "Whether the carrier accepts a delivery date, and whether it is required" }, "timeFrom" : { "$ref" : "#/components/schemas/DeliveryBookingField", "description" : "Whether the carrier accepts an earliest delivery time, and whether it is required" }, "timeTo" : { "$ref" : "#/components/schemas/DeliveryBookingField", "description" : "Whether the carrier accepts a latest delivery time, and whether it is required" } } }, "CustomsRegions" : { "type" : "object", "description" : "Origin and destination regions for customs clearance", "properties" : { "fromCode" : { "type" : "string", "description" : "Customs union code the shipment is sent from", "example" : "EUCU", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "toCode" : { "type" : "string", "description" : "Customs union code the shipment is sent to", "example" : "GB_CU", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "SerialTypesListResponse" : { "type" : "object", "description" : "Paginated list of carrier serial number types", "properties" : { "items" : { "type" : "array", "description" : "Serial Types", "items" : { "$ref" : "#/components/schemas/SerialResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "CarrierDefinitionResponse" : { "type" : "object", "description" : "Configured carrier instance with its settings and mode", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Carrier Definition", "example" : "019ade48-9368-7577-990d-987fe9b34324", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Carrier Definition was created", "example" : "2024-01-15T10:30:00Z", "maxLength" : 64 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Carrier Definition was last updated", "example" : "2024-01-15T10:30:00Z", "maxLength" : 64 }, "name" : { "type" : "string", "description" : "Carrier Definition name", "example" : "DHL Express", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "carrierId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Carrier", "example" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "maxLength" : 36 }, "group" : { "type" : "string", "description" : "Carrier Definition group", "example" : "Express", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "mode" : { "type" : "string", "description" : "Environment mode", "enum" : [ "STAGING", "PRODUCTION" ], "example" : "STAGING" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "settings" : { "type" : "array", "description" : "Carrier-related settings", "items" : { "$ref" : "#/components/schemas/Settings" }, "maxItems" : 1000 } } }, "CodeType" : { "type" : "object", "description" : "Packing type and code identifier", "properties" : { "code" : { "type" : "string", "description" : "The code of the packing.", "example" : "PC", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "type" : { "type" : "string", "description" : "The type of the packing.", "example" : "GSPackageCode", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "code", "type" ] }, "PalletCount" : { "type" : "object", "description" : "Number of pallets of a given type", "properties" : { "count" : { "type" : "integer", "format" : "int64", "description" : "Number of pallets", "example" : 5 }, "type" : { "type" : "string", "description" : "Pallet type", "enum" : [ "EPAL-1", "EPAL-2", "EPAL-3", "EPAL-6" ] } } }, "QueryPudoPointRequest" : { "type" : "object", "description" : "Criteria to search for pickup and drop-off points", "properties" : { "addressLine" : { "type" : "string", "description" : "Address line", "example" : "Åvägen", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "cached" : { "type" : "boolean", "default" : false, "description" : "Queries the Service's cached PUDO Point dataset instead of a realtime carrier lookup. Requires `pudoPoints.cached.supported` on the Service. When true, `postalCode` is ignored. Cached queries are not available yet and return 501 Not Implemented. Default: false", "example" : false }, "city" : { "type" : "string", "description" : "City name used to narrow the search area", "example" : "Askim", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "countryCode" : { "$ref" : "#/components/schemas/CountryCode", "description" : "Country code", "example" : "DE" }, "maxDistance" : { "type" : "integer", "format" : "int32", "description" : "Maximum distance in kilometers to use as the upper limit of available PUDO Points", "example" : 20, "minimum" : 1 }, "maxResults" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of PUDO Points to return in the response. Default: 10, Maximum: 25", "example" : 10, "maximum" : 25, "minimum" : 1 }, "operationTypes" : { "type" : "array", "description" : "Optional filter restricting results to the given operation types", "example" : [ "shop", "locker" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 10, "minItems" : 0 }, "postalCode" : { "type" : "string", "description" : "Postal code", "example" : "41251", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "senderCountryCode" : { "$ref" : "#/components/schemas/CountryCode", "description" : "Sender country code", "example" : "DE" }, "serviceId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Service", "example" : "087a5c15-44af-3912-ab4b-8b11be3367c2", "maxLength" : 36, "minLength" : 1 } }, "required" : [ "countryCode", "serviceId" ] }, "Location" : { "type" : "object", "description" : "Structured postal address of a location", "properties" : { "buildingName" : { "type" : "string", "description" : "Building name", "example" : "Skyline Towers", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "buildingNumber" : { "type" : "string", "description" : "Building number", "example" : "13", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "city" : { "type" : "string", "description" : "City name. Autocompleted if omitted, based on `countryCode` and `postalCode` if possible.", "example" : "Washington DC", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "countryCode" : { "$ref" : "#/components/schemas/CountryCode", "description" : "Country code", "example" : "US" }, "floor" : { "type" : "string", "description" : "Floor number", "example" : "2", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "geoCoding" : { "$ref" : "#/components/schemas/GeoCoding", "description" : "Geocoding information" }, "locality" : { "type" : "string", "description" : "Locality name", "example" : "Brooklyn", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "postalCode" : { "type" : "string", "description" : "Postal code", "example" : "111111", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "region" : { "type" : "string", "description" : "Region or administrative division", "example" : "District of Columbia", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "stateCode" : { "type" : "string", "description" : "State code", "example" : "US_WA", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "streetName" : { "type" : "string", "description" : "Street name", "example" : "Main Street", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "streetNumber" : { "type" : "string", "description" : "Street number", "example" : "5", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "unit" : { "type" : "string", "description" : "Unit or apartment identifier", "example" : "4B", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "city", "countryCode", "postalCode", "streetName" ] }, "Handling" : { "type" : "object", "description" : "Dangerous goods handling requirements", "properties" : { "items" : { "type" : "array", "description" : "List of handling validation rules for the dangerous goods declaration type", "items" : { "$ref" : "#/components/schemas/HandlingItem" }, "maxItems" : 1000 } } }, "DangerousGoodsDeclarationDeclarant" : { "type" : "object", "description" : "Person declaring the dangerous goods", "properties" : { "city" : { "type" : "string", "description" : "Declarant city", "example" : "Stockholm", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "firstName" : { "type" : "string", "description" : "Declarant first name", "example" : "John", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "lastName" : { "type" : "string", "description" : "Declarant last name", "example" : "Doe", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "title" : { "type" : "string", "description" : "Declarant title", "example" : "Mr.", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "firstName", "lastName" ] }, "AccountListResponse" : { "type" : "object", "description" : "Paginated list of accounts", "properties" : { "items" : { "type" : "array", "description" : "Accounts", "items" : { "$ref" : "#/components/schemas/AccountResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "DangerousGoodsDeclarationResponse" : { "type" : "object", "description" : "Dangerous goods declaration for a shipment", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Dangerous Goods Declaration", "example" : "019c2076-1a28-7bee-a9b3-42312a50d1b0", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Dangerous Goods Declaration was created", "example" : "2021-09-01T12:00:00+02:00", "maxLength" : 64 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Dangerous Goods Declaration was last updated", "example" : "2021-09-01T12:00:00+02:00", "maxLength" : 64 }, "reference" : { "type" : "string", "description" : "Reference for the dangerous goods declaration", "example" : "DG-REF-12345", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "declarant" : { "$ref" : "#/components/schemas/DangerousGoodsDeclarationDeclarant", "description" : "Declarant information" }, "declaredAt" : { "type" : "string", "format" : "date-time", "description" : "Dangerous Goods Declaration timestamp. Must not be in the past. Defaults to current time if not provided.", "example" : "2021-09-01T12:00:00+02:00", "maxLength" : 64 }, "goods" : { "type" : "array", "description" : "Dangerous goods items included in the declaration", "items" : { "$ref" : "#/components/schemas/DangerousGoodsDeclarationGoods" }, "maxItems" : 1000 }, "goodsTypes" : { "type" : "array", "description" : "List of goods type codes referencing the carrier data declaration type goods configuration", "example" : [ "FLAMMABLE", "CORROSIVE" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 }, "handling" : { "type" : "array", "description" : "Special handling instructions", "example" : [ "Aerosol containers are pressurized and may rupture if exposed to heat or physical damage.", "Handle carefully to prevent puncture, crushing, or leakage." ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 }, "meta" : { "type" : "object", "additionalProperties" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : "Additional metadata", "example" : { "key1" : "value1", "key2" : "value2" } }, "modal" : { "type" : "string", "description" : "Transport mode", "example" : "ROAD", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "standard" : { "type" : "string", "description" : "The regulatory standard used for the dangerous goods declaration", "example" : "IATA", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "type" : { "type" : "string", "description" : "List of declaration types applicable for this dangerous goods declaration", "example" : "[\"SHIPPER\", \"MULTIMODAL\"]", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "declarant", "goods", "modal", "standard" ] }, "PackingTypeResponse" : { "type" : "object", "description" : "Packing type definition supported by the carrier", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Packing Type", "example" : "cfe26e72-bf79-3960-b38f-f3708982635a", "maxLength" : 36 }, "codeTypes" : { "type" : "array", "description" : "Code types associated with the packing type", "items" : { "$ref" : "#/components/schemas/CodeType" }, "maxItems" : 1000 }, "description" : { "type" : "string", "description" : "Packing type description", "example" : "Package", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "type" : { "type" : "string", "description" : "Packing type", "example" : "PACKAGE", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "CarrierLogo" : { "type" : "object", "description" : "Carrier logo availability, format and dimensions", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Unique identifier of the carrier logo", "example" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "maxLength" : 36 }, "description" : { "type" : "string", "description" : "Description of the logo", "example" : "DHL Germany logo", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "format" : { "type" : "string", "description" : "Image format of the logo", "example" : "png", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "height" : { "type" : "integer", "format" : "int32", "description" : "Height of the logo image", "example" : 200 }, "supported" : { "type" : "boolean", "description" : "Indicates whether a logo is available for this carrier", "example" : false }, "unit" : { "type" : "string", "description" : "Unit of measurement for dimensions", "example" : "px", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "width" : { "type" : "integer", "format" : "int32", "description" : "Width of the logo image", "example" : 200 } } }, "ContentType" : { "type" : "object", "description" : "Supported document content type", "properties" : { "description" : { "type" : "string", "description" : "Document format description", "example" : "Portable Document Format", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "type" : { "type" : "string", "description" : "Document format", "example" : "pdf", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "ServiceDefinitionListResponse" : { "type" : "object", "description" : "Paginated list of carrier service definitions", "properties" : { "items" : { "type" : "array", "description" : "Service Definitions", "items" : { "$ref" : "#/components/schemas/ServiceDefinitionResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "EnrichmentValidations" : { "type" : "object", "description" : "Validation rules constraining an enrichment setting value", "properties" : { "allowedValues" : { "type" : "array", "description" : "List of allowed values for this validation", "items" : { "$ref" : "#/components/schemas/AllowedValue" }, "maxItems" : 1000 }, "extended" : { "type" : "string", "description" : "Extended validation rules in JSON format", "example" : "{\"customRule\": \"value\"}", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "intervalOf" : { "type" : "number", "format" : "double", "description" : "Interval value for numeric fields", "example" : 0.5 }, "mandatory" : { "type" : "boolean", "description" : "Indicates whether this field is mandatory", "example" : false }, "maxDecimals" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of decimal places allowed", "example" : 2 }, "maxItems" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of items allowed", "example" : 10 }, "maxLength" : { "type" : "integer", "format" : "int32", "description" : "Maximum length allowed for string values", "example" : 100 }, "maxValue" : { "type" : "number", "format" : "double", "description" : "Maximum numeric value allowed", "example" : 999.99 }, "minDecimals" : { "type" : "integer", "format" : "int32", "description" : "Minimum number of decimal places required", "example" : 0 }, "minItems" : { "type" : "integer", "format" : "int32", "description" : "Minimum number of items required", "example" : 1 }, "minLength" : { "type" : "integer", "format" : "int32", "description" : "Minimum length required for string values", "example" : 5 }, "minValue" : { "type" : "number", "format" : "double", "description" : "Minimum numeric value required", "example" : 0.01 }, "notEmpty" : { "type" : "boolean", "description" : "Indicates whether empty values are not allowed", "example" : false }, "pattern" : { "type" : "string", "description" : "Regular expression pattern for validation", "example" : "^[A-Z0-9]+$", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "ShipmentDispatchListResponse" : { "type" : "object", "description" : "Paginated list of shipment dispatches", "properties" : { "items" : { "type" : "array", "description" : "Shipment Dispatches", "items" : { "$ref" : "#/components/schemas/ShipmentDispatchResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "Voiding" : { "type" : "object", "description" : "Label voiding support and limitations for the service", "properties" : { "limitation" : { "type" : "string", "description" : "The limitation type for voiding, if applicable", "enum" : [ "QUEUE", "REALTIME" ], "example" : "QUEUE" }, "note" : { "type" : "string", "description" : "Description of the voiding limitation", "example" : "This feature is only applicable within the timeframe before EDI is sent to carrier (every 5min).", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "supported" : { "type" : "boolean", "description" : "Indicates whether voiding is supported", "example" : false } } }, "Classification" : { "type" : "object", "description" : "Service classification flags such as return and cross-border", "properties" : { "crossborder" : { "type" : "boolean", "description" : "Indicates whether a route supports non-domestic shipping", "example" : false }, "returnService" : { "type" : "boolean", "description" : "Indicates whether the Service supports returns", "example" : false } } }, "ShipmentChannelResponse" : { "type" : "object", "description" : "Channel settings for document rendering, units and pickup", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "The unique identifier of the resource.", "example" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Shipment Channel was created", "example" : "2026-01-22T10:30:00Z", "maxLength" : 64 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Shipment Channel was last updated", "example" : "2026-01-22T10:30:00Z", "maxLength" : 64 }, "name" : { "type" : "string", "description" : "Shipment Channel name", "example" : "My shipment channel", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "documentRendering" : { "$ref" : "#/components/schemas/DocumentRendering", "description" : "Document rendering options" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "pickup" : { "$ref" : "#/components/schemas/ChannelPickup", "description" : "Pickup booking configuration for the Shipment Channel" }, "units" : { "$ref" : "#/components/schemas/Units", "description" : "Unit settings for weight, dimensions, and volume" } } }, "DeliveryBookingRequest" : { "type" : "object", "description" : "Requested delivery slot and delivery instructions. Unrelated to info.delivery, which carries the receiver reference.", "properties" : { "instructions" : { "type" : "array", "description" : "Delivery instructions for the carrier", "example" : [ "Leave with the neighbour" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 }, "slot" : { "$ref" : "#/components/schemas/DeliveryBookingSlot", "description" : "The requested delivery time slot" } }, "required" : [ "slot" ] }, "CustomDeclarationInvoice" : { "type" : "object", "description" : "Invoice item limits for a customs declaration", "properties" : { "itemLimit" : { "type" : "boolean", "description" : "Indicates whether an invoice item limit is set", "example" : false }, "maxItems" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of invoice items", "example" : 1 } } }, "Restrictions" : { "type" : "object", "description" : "Restrictions applied to the carrier entity", "properties" : { "applied" : { "type" : "boolean", "description" : "Indicates whether restrictions are applied", "example" : false }, "note" : { "type" : "string", "description" : "Describes the restriction requirement", "example" : "This carrier connection MUST only be used in conjunction with special agreement with the carrier.", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "Settings" : { "type" : "object", "description" : "Key-value carrier configuration setting", "properties" : { "key" : { "type" : "string", "description" : "The named setting", "example" : "api-key", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "value" : { "type" : "string", "description" : "The setting's value", "example" : "5qqMQ5DhciBfJgBcGFyXYm66pl1lbgKV26v6ybKvcDkgMOO1BCv3iE68HDakvW9o", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "InlineCustomsDeclarationInvoice" : { "type" : "object", "description" : "Commercial invoice with inline declared items", "properties" : { "items" : { "type" : "array", "description" : "Extra invoice items", "items" : { "$ref" : "#/components/schemas/ParcelItemRequest" }, "maxItems" : 1000 }, "number" : { "type" : "string", "description" : "Invoice number", "example" : "INV-2025-0001", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "number" ] }, "EventChannelRequest" : { "type" : "object", "description" : "Request body for creating an event channel", "properties" : { "name" : { "type" : "string", "description" : "Event Channel name", "example" : "My event channel", "maxLength" : 255, "minLength" : 3, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceRequest", "description" : "The persistence configuration of the entity." }, "topics" : { "type" : "array", "description" : "Topics for the Event Channel", "items" : { "$ref" : "#/components/schemas/EventChannelTopic" }, "maxItems" : 1000, "minItems" : 1 }, "webhook" : { "$ref" : "#/components/schemas/Webhook", "description" : "Webhook configuration" } }, "required" : [ "name", "topics", "webhook" ] }, "AddressResponse" : { "type" : "object", "description" : "Stored address details", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Address", "example" : "019b2766-8eb4-795c-899f-9ac8d5cc6a34", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Address was created", "example" : "2021-09-01T12:00:00+02:00", "maxLength" : 64 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Address was last updated", "example" : "2021-09-01T12:00:00+02:00", "maxLength" : 64 }, "company" : { "$ref" : "#/components/schemas/Company", "description" : "Company information" }, "contact" : { "$ref" : "#/components/schemas/Contact", "description" : "Contact information" }, "group" : { "type" : "string", "description" : "Address group", "example" : "warehouse_1", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "lines" : { "type" : "array", "description" : "Address lines. If omitted, lines are auto-generated from location properties. If partially provided, missing lines are auto-generated.", "example" : [ "John Doe c/o Mr Smith, nShift", "Schiller street 45, Neighborhood x", "Century Plaza 13, Floor 3, Apt 32", "District 4, DC, US-NY, US, 111111" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 }, "location" : { "$ref" : "#/components/schemas/Location", "description" : "Address location" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "references" : { "$ref" : "#/components/schemas/References", "description" : "Address reference information" }, "source" : { "type" : "string", "description" : "Alias of the shared account the Address was read from. Present only when the Address was read with `source`.", "example" : "amber-falcon-river", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "type" : { "type" : "string", "description" : "Address type", "example" : "RESIDENTIAL", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "PickupBookingSlot" : { "type" : "object", "description" : "The pickup time slot", "properties" : { "date" : { "type" : "string", "format" : "date", "description" : "The pickup date", "example" : "2024-12-01", "maxLength" : 10 }, "timeFrom" : { "type" : "string", "description" : "The pickup start time in HH:mm format", "example" : "09:00", "maxLength" : 5, "pattern" : "^([01]\\d|2[0-3]):[0-5]\\d$" }, "timeTo" : { "type" : "string", "description" : "The pickup end time in HH:mm format", "example" : "17:00", "maxLength" : 5, "pattern" : "^([01]\\d|2[0-3]):[0-5]\\d$" } }, "required" : [ "date" ] }, "EnrichmentCarrierRates" : { "type" : "object", "description" : "Whether carrier rate enrichment is supported", "properties" : { "supported" : { "type" : "boolean", "description" : "Whether enrichment carrier rates are supported.", "example" : true } } }, "Rate" : { "type" : "object", "description" : "Rate configurations for the Delivery Option", "properties" : { "carrierRate" : { "$ref" : "#/components/schemas/CarrierRate", "description" : "Carrier rate settings" }, "conditions" : { "type" : "array", "description" : "Rate conditions", "items" : { "$ref" : "#/components/schemas/Condition" }, "maxItems" : 1000 }, "currency" : { "type" : "string", "description" : "Currency code", "example" : "EUR", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "price" : { "type" : "number", "format" : "double", "description" : "Rate price", "example" : 10.0 }, "priority" : { "type" : "integer", "format" : "int64", "description" : "Rate priority", "example" : 1, "minimum" : 0 } }, "required" : [ "currency", "price", "priority" ] }, "ZoneRequest" : { "type" : "object", "description" : "Payload to create or update a delivery zone", "properties" : { "name" : { "type" : "string", "description" : "Zone name", "example" : "Europe", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "countries" : { "type" : "array", "description" : "Associated country codes", "items" : { "$ref" : "#/components/schemas/Country" }, "maxItems" : 1000, "minItems" : 1 }, "persistence" : { "$ref" : "#/components/schemas/PersistenceRequest", "description" : "The persistence configuration of the entity." } }, "required" : [ "countries", "name" ] }, "ShipmentDispatchResponse" : { "type" : "object", "description" : "Dispatch grouping shipment bookings for carrier handover", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "The unique identifier of the resource.", "example" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Shipment Dispatch was created", "example" : "2026-01-22T10:30:00Z", "maxLength" : 64 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Shipment Dispatch was last updated", "example" : "2026-01-22T10:30:00Z", "maxLength" : 64 }, "reference" : { "type" : "string", "description" : "Shipment Dispatch reference", "example" : "DISPATCH-001", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "carrierId" : { "type" : "string", "format" : "uuid", "description" : "The carrier ID common to all bookings in this dispatch", "example" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "maxLength" : 36 }, "chargeables" : { "$ref" : "#/components/schemas/Chargeable", "description" : "Chargeable dimensions and counts" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "shipmentBookingIds" : { "type" : "array", "description" : "Shipment Bookings", "example" : [ "019c1dd1-5344-7d56-bb3d-dc338e80488a", "019c1dcb-0d63-7917-9c1d-00be28e7282b" ], "items" : { "type" : "string", "format" : "uuid", "maxLength" : 36 }, "maxItems" : 1000 }, "state" : { "$ref" : "#/components/schemas/ShipmentDispatchState", "description" : "Shipment dispatch state. `finalized` indicates the dispatch is locked from further user-initiated edits (e.g. because a manifest has been created from it); internal processes may still update the entity. `manifest` indicates whether a Shipment Manifest has ever been created from this dispatch." }, "tracker" : { "$ref" : "#/components/schemas/ShipmentDispatchTracker", "description" : "Shipment dispatch tracking information" } } }, "Goods" : { "type" : "object", "description" : "Dangerous goods declaration content and limits", "properties" : { "explicitTypes" : { "type" : "boolean", "description" : "Indicates whether explicit dangerous goods types are defined", "readOnly" : true }, "itemLimit" : { "type" : "boolean", "description" : "Indicates if there is a limit on the number of items for dangerous goods", "example" : false }, "maxItems" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of parcel items allowed for dangerous goods", "example" : 50 }, "maxParcels" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of parcels allowed for dangerous goods", "example" : 10 }, "netQuantityMandatory" : { "type" : "boolean", "description" : "Indicates whether net quantity is mandatory for dangerous goods items of this declaration type" }, "netQuantityUnits" : { "type" : "array", "description" : "Allowed net quantity unit values for dangerous goods items of this declaration type", "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 }, "packingGroup" : { "$ref" : "#/components/schemas/PackingGroup", "deprecated" : true, "description" : "Packing group" }, "parcelLimit" : { "type" : "boolean", "description" : "Indicates whether there is a quantity limit for dangerous goods parcels", "example" : false }, "types" : { "type" : "array", "description" : "List of dangerous goods types", "items" : { "$ref" : "#/components/schemas/DangerousGoodsDeclarationGoods" }, "maxItems" : 1000 } } }, "CustomsDeclarationTypeListResponse" : { "type" : "object", "description" : "Paginated list of customs declaration types", "properties" : { "items" : { "type" : "array", "description" : "Customs Declaration Types", "items" : { "$ref" : "#/components/schemas/CustomsDeclarationTypeResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "ReplaceAffiliateConfigRequest" : { "type" : "object", "description" : "Full replacement of an Affiliate's Stripe Checkout redirect URLs and billing grace period. Omitted fields are cleared and fall back to nShift defaults.", "properties" : { "billingGracePeriodDays" : { "type" : "integer", "format" : "int32", "description" : "Grace period in days before suspension on a failed payment (1-90). Omit to clear and fall back to the global default.", "example" : 14, "maximum" : 90, "minimum" : 1 }, "checkoutUrlFailure" : { "type" : "string", "description" : "HTTPS URL Stripe redirects to on cancelled or failed payment. Omit to clear and fall back to the nShift default.", "example" : "https://example-affiliate.com/checkout/failure", "maxLength" : 255, "minLength" : 3, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "checkoutUrlSuccess" : { "type" : "string", "description" : "HTTPS URL Stripe redirects to on successful payment. Omit to clear and fall back to the nShift default.", "example" : "https://example-affiliate.com/checkout/success", "maxLength" : 255, "minLength" : 3, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "DangerousGoodsDeclarationGoods" : { "type" : "object", "description" : "Dangerous goods item declared for a shipment", "properties" : { "code" : { "type" : "string", "description" : "UN number or other code identifying the dangerous goods", "example" : "UN1950", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "hazard" : { "$ref" : "#/components/schemas/DangerousGoodsHazard", "description" : "Hazard information" }, "notes" : { "type" : "array", "description" : "Notes for the dangerous goods", "example" : [ "Handle with care" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1, "minItems" : 0 }, "packing" : { "$ref" : "#/components/schemas/DangerousGoodsPacking", "description" : "Packing information" }, "shippingName" : { "type" : "string", "description" : "Official shipping name of the dangerous goods type", "example" : "Aerosols, flammable", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "technicalName" : { "type" : "string", "description" : "Technical name of the dangerous goods type", "example" : "Propane, Butane mixture", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "transportation" : { "$ref" : "#/components/schemas/DangerousGoodsTransportation", "description" : "Transportation information" }, "type" : { "type" : "string", "description" : "Dangerous goods type", "example" : "DG_01", "maxLength" : 255, "pattern" : "^[A-Z0-9_]+$" } }, "required" : [ "code", "shippingName", "type" ] }, "CustomsDeclarationTerms" : { "type" : "object", "description" : "Incoterms governing the customs declaration", "properties" : { "code" : { "type" : "string", "description" : "Trade term code", "example" : "DDP", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "location" : { "type" : "string", "description" : "Trade term location", "example" : "Rotterdam", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "InlineServiceDefinitionRequest" : { "type" : "object", "description" : "Service definition supplied inline within a request", "properties" : { "name" : { "type" : "string", "description" : "The name of the Service Definition", "example" : "PostNord for domestic B2C use", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "addons" : { "type" : "array", "description" : "The list of Service specific Addons.", "items" : { "$ref" : "#/components/schemas/Addon" }, "maxItems" : 1000 }, "group" : { "type" : "string", "description" : "The group of the Service Definition", "example" : "UPS_saver", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "serviceId" : { "type" : "string", "format" : "uuid", "description" : "The unique identifier of the Service", "example" : "d9214010-7bb6-3e78-bbd5-c7b39f584722", "maxLength" : 36, "minLength" : 1 } }, "required" : [ "serviceId" ] }, "DangerousGoodsDeclarationListResponse" : { "type" : "object", "description" : "Paginated list of dangerous goods declarations", "properties" : { "items" : { "type" : "array", "description" : "Dangerous Goods Declarations", "items" : { "$ref" : "#/components/schemas/DangerousGoodsDeclarationResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "ServiceParty" : { "type" : "object", "description" : "Party role and whether it is mandatory for the service", "properties" : { "mandatory" : { "type" : "boolean", "description" : "Indicates whether the party is mandatory", "example" : false }, "role" : { "type" : "string", "description" : "Role of the party in the Service", "enum" : [ "SENDER", "RECEIVER", "DELIVERY", "DISPATCH", "RETURN", "FREIGHT_PAYER", "TAX_PAYER", "CUSTOMS_PAYER", "IMPORTER", "EXPORTER" ], "example" : "SENDER" } } }, "ShipmentBookingListResponse" : { "type" : "object", "description" : "Paginated list of shipment bookings", "properties" : { "items" : { "type" : "array", "description" : "Shipment Bookings", "items" : { "$ref" : "#/components/schemas/ShipmentBookingExtendedResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "ServiceAddon" : { "type" : "object", "description" : "Optional add-on service offered with a carrier service", "properties" : { "id" : { "type" : "string", "description" : "Identifies the add-on", "example" : "2b71b8f1-6d27-4b63-8093-d31257d46d4f", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "access" : { "type" : "boolean", "description" : "Indicates whether the user has access to the add-on", "example" : false }, "code" : { "type" : "string", "description" : "Add-on code that can be shared across multiple Carriers and Services", "example" : "DLVNOPOD", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "combine" : { "type" : "array", "description" : "Rules for combining the add-on with others", "items" : { "$ref" : "#/components/schemas/Combine" }, "maxItems" : 1000, "uniqueItems" : true }, "description" : { "type" : "string", "description" : "Add-on description", "example" : "Delivery without POD", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "explicitRoutes" : { "type" : "boolean", "description" : "The addon has specific routes", "example" : false }, "fields" : { "type" : "array", "description" : "Defined input settings for the add-on", "items" : { "$ref" : "#/components/schemas/Field" }, "maxItems" : 1000, "uniqueItems" : true }, "obsolete" : { "type" : "boolean", "description" : "Indicates whether the carrier has retired the add-on. A retired add-on stays listed but can never be booked, and this cannot be overridden by an enrichment", "example" : false, "readOnly" : true }, "portalReferences" : { "$ref" : "#/components/schemas/AddonPortalReference", "description" : "nShift Portal reference for the add-on" }, "restrictions" : { "$ref" : "#/components/schemas/Restrictions", "description" : "Restriction information for this addon" }, "routes" : { "type" : "array", "description" : "Valid routes for the add-on", "items" : { "$ref" : "#/components/schemas/MultipleRoutes" }, "maxItems" : 1000, "uniqueItems" : true } } }, "DeliveryBookingField" : { "type" : "object", "description" : "Support and requirement for a single delivery booking field", "properties" : { "format" : { "type" : "string", "description" : "The format this field must be supplied in", "example" : "date", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "mandatory" : { "type" : "boolean", "description" : "Indicates whether the carrier requires this field", "example" : false }, "supported" : { "type" : "boolean", "description" : "Indicates whether the carrier accepts this field", "example" : false } } }, "Country" : { "type" : "object", "description" : "Country name and code", "properties" : { "name" : { "type" : "string", "description" : "Country name", "example" : "Germany", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "code" : { "$ref" : "#/components/schemas/CountryCode", "description" : "Country code", "example" : "DE" } }, "required" : [ "code", "name" ] }, "InlineDangerousGoodsDeclarationRequest" : { "type" : "object", "description" : "Dangerous goods declaration supplied inline within a shipment request", "properties" : { "reference" : { "type" : "string", "description" : "Reference for the dangerous goods declaration", "example" : "DG-REF-12345", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "declarant" : { "$ref" : "#/components/schemas/DangerousGoodsDeclarationDeclarant", "description" : "Declarant information" }, "declaredAt" : { "type" : "string", "format" : "date-time", "description" : "Dangerous Goods Declaration timestamp. Must not be in the past. Defaults to current time if not provided.", "example" : "2021-09-01T12:00:00+02:00", "maxLength" : 64 }, "goods" : { "type" : "array", "description" : "Dangerous goods included in the declaration", "items" : { "$ref" : "#/components/schemas/DangerousGoodsDeclarationGoods" }, "maxItems" : 1000 }, "goodsTypes" : { "type" : "array", "description" : "List of dangerous goods type codes included in the declaration", "example" : [ "ADR", "DNG" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 }, "handling" : { "type" : "array", "description" : "Special handling instructions", "example" : [ "Aerosol containers are pressurized and may rupture if exposed to heat or physical damage.", "Handle carefully to prevent puncture, crushing, or leakage." ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 4, "minItems" : 0 }, "meta" : { "type" : "object", "additionalProperties" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : "Additional metadata", "example" : { "key1" : "value1", "key2" : "value2" } }, "modal" : { "type" : "string", "description" : "Transport mode", "example" : "ROAD", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "type" : { "type" : "string", "description" : "Dangerous Goods Declaration Type", "example" : "\"ADR\"", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "declarant", "modal", "type" ] }, "FetchInlineDocumentsRequest" : { "type" : "object", "description" : "Request to fetch documents for an inline shipment channel", "properties" : { "shipmentChannel" : { "$ref" : "#/components/schemas/InlineShipmentChannelRequest", "description" : "Optional inline Shipment Channel. If not provided, the channel from the Shipment Booking is used" } } }, "TrackerLog" : { "type" : "object", "description" : "Tracking event logged during shipment processing", "properties" : { "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the log entry was recorded", "example" : "2026-04-27T11:12:08Z", "maxLength" : 64 }, "category" : { "type" : "string", "description" : "Portal event category the log entry belongs to (e.g. System, In Transit, Delivered, Carrier Exception)", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "message" : { "type" : "string", "description" : "Human-readable description of what happened and how to mitigate it", "example" : "The document type LABEL failed to process, please try regenerating documents.", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "payload" : { "$ref" : "#/components/schemas/TrackerLogPayload", "description" : "Additional context for the log entry" }, "topic" : { "type" : "string", "description" : "Topic the log entry relates to", "example" : "DOCUMENTS", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "type" : { "type" : "string", "description" : "Type of the log entry", "example" : "ERROR", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "AddressListResponse" : { "type" : "object", "description" : "Paginated list of addresses", "properties" : { "items" : { "type" : "array", "description" : "Addresses", "items" : { "$ref" : "#/components/schemas/AddressResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "DangerousGoodsPacking" : { "type" : "object", "description" : "Packing information", "properties" : { "codeType" : { "$ref" : "#/components/schemas/CodeType", "description" : "Code type for the packaging" }, "group" : { "type" : "string", "description" : "Packing group classification", "example" : "II", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "type" : { "type" : "string", "description" : "Packing type", "example" : "BOTTLE", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "type" ] }, "Criteria" : { "type" : "object", "description" : "Validation criteria supported by the carrier service", "properties" : { "addressValidations" : { "type" : "boolean", "description" : "Indicates whether address validations are required", "example" : false }, "customsValidations" : { "type" : "boolean", "description" : "Indicates whether customs route validations are required", "example" : false }, "itemValidations" : { "type" : "boolean", "description" : "Indicates whether item validations are required" }, "parcelValidations" : { "type" : "boolean", "description" : "Indicates whether parcels validations are required", "example" : false }, "postalCodeValidation" : { "type" : "boolean", "description" : "Indicates whether postal code validation is required", "example" : false }, "routeValidation" : { "type" : "boolean", "description" : "Indicates whether route validation is required", "example" : false }, "shipmentValidations" : { "type" : "boolean", "description" : "Indicates whether shipment validations are required", "example" : false } } }, "ParcelItemRequest" : { "type" : "object", "description" : "Payload to create or update a parcel item", "properties" : { "reference" : { "type" : "string", "description" : "Parcel Item reference", "example" : "ITEM-REF-12345", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "dangerousGoods" : { "type" : "array", "description" : "Dangerous goods associated with the Parcel Item", "example" : [ { "type" : "DG_01", "quantity" : 5, "netQuantity" : 10.5, "netQuantityUnit" : "KG" } ], "items" : { "$ref" : "#/components/schemas/DangerousGoodsParcel" }, "maxItems" : 1, "minItems" : 1 }, "isReturnable" : { "type" : "boolean", "description" : "Indicates if the item is returnable. Defaults to false.", "example" : false }, "meta" : { "type" : "object", "additionalProperties" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : "Additional metadata", "example" : { "key1" : "value1", "key2" : "value2" } }, "packing" : { "$ref" : "#/components/schemas/ParcelItemPacking", "description" : "Parcel Item packing information" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceRequest", "description" : "The persistence configuration of the entity." }, "pricing" : { "$ref" : "#/components/schemas/Pricing", "description" : "Parcel item pricing information" }, "product" : { "$ref" : "#/components/schemas/Product", "description" : "Parcel item product information" }, "quantity" : { "type" : "integer", "format" : "int32", "description" : "Number of Parcel Items in the Parcel", "example" : 2, "minimum" : 1 }, "skipCustoms" : { "type" : "boolean", "description" : "If true, this item is excluded when auto-aggregating parcel items into customs declaration invoice items. Defaults to false.", "example" : false }, "weight" : { "type" : "number", "format" : "double", "description" : "Parcel Item weight", "example" : 10.0 }, "weightUnit" : { "type" : "string", "description" : "Parcel Item weight unit", "enum" : [ "G", "KG", "LB", "OZ" ] } }, "required" : [ "quantity" ] }, "DocumentMetadataResponse" : { "type" : "object", "description" : "Document metadata with its identifier", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Document", "example" : "019b26d1-6ef4-7331-b628-11fd3dfda3dd", "maxLength" : 36 }, "metaData" : { "$ref" : "#/components/schemas/DocumentMetaData", "description" : "Document metadata" } } }, "CustomsItemProduct" : { "type" : "object", "description" : "Validation rules for customs item product fields", "properties" : { "composition" : { "$ref" : "#/components/schemas/FieldValidation", "description" : "Product composition validation" }, "description" : { "$ref" : "#/components/schemas/FieldValidation", "description" : "Product description validation" }, "identification" : { "$ref" : "#/components/schemas/FieldValidation", "description" : "Product identification validation" }, "weight" : { "$ref" : "#/components/schemas/FieldValidation", "description" : "Net weight validation" } } }, "PackingTypesListResponse" : { "type" : "object", "description" : "Paginated list of packing types", "properties" : { "items" : { "type" : "array", "description" : "Packing Types", "items" : { "$ref" : "#/components/schemas/PackingTypeResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "CustomsDeclarationPurpose" : { "type" : "object", "description" : "Purpose of the customs declaration", "properties" : { "code" : { "type" : "string", "description" : "Purpose code", "example" : "GIFT", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "ParcelItemPacking" : { "type" : "object", "description" : "Packing weight details for a parcel item", "properties" : { "weight" : { "type" : "number", "format" : "double", "description" : "Parcel Item packing weight", "example" : 10.0 }, "weightUnit" : { "type" : "string", "description" : "Parcel Item packing weight unit", "enum" : [ "G", "KG", "LB", "OZ" ] } } }, "CustomsDeclarationInvoice" : { "type" : "object", "description" : "Commercial invoice referenced by the customs declaration", "properties" : { "itemIds" : { "type" : "array", "description" : "Item IDs included in the invoice", "example" : [ "019ad961-2659-7bbb-9f64-939126000e08", "019ad961-7b90-7db4-bdd3-06bac2699064" ], "items" : { "type" : "string", "format" : "uuid", "maxLength" : 36 }, "maxItems" : 1000 }, "number" : { "type" : "string", "description" : "Invoice number", "example" : "INV-2025-0001", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "number" ] }, "ServiceItemValidation" : { "type" : "object", "description" : "Item validation rules applied by a service", "properties" : { "conditions" : { "$ref" : "#/components/schemas/ServiceItemValidationConditions", "description" : "Conditions under which item validations apply" }, "dangerousGoods" : { "$ref" : "#/components/schemas/ServiceItemValidationDangerousGoods", "description" : "Dangerous goods field validations for items" } } }, "AddressValidation" : { "type" : "object", "description" : "Address field requirements enforced by a service", "properties" : { "companyIdentification" : { "type" : "array", "description" : "Map of company identification fields and whether they are required", "items" : { "$ref" : "#/components/schemas/AddonField" }, "maxItems" : 1000 }, "conditions" : { "$ref" : "#/components/schemas/AddressValidationConditions", "description" : "Conditions under which this address validation applies" }, "maxLinesLength" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of characters allowed per generated address line. When set and service.criteria.addressValidations is true, each address line is validated against this limit.", "example" : 35 }, "requiredCompanyName" : { "type" : "boolean", "description" : "Whether company name is required", "example" : false }, "requiredContactCareOf" : { "type" : "boolean", "description" : "Whether care of is required", "example" : false }, "requiredContactDoorCode" : { "type" : "boolean", "description" : "Whether contact door code is required", "example" : false }, "requiredContactEmail" : { "type" : "boolean", "description" : "Whether contact email is required", "example" : false }, "requiredContactFax" : { "type" : "boolean", "description" : "Whether contact fax is required", "example" : false }, "requiredContactFirstName" : { "type" : "boolean", "description" : "Whether contact first name is required", "example" : false }, "requiredContactLastName" : { "type" : "boolean", "description" : "Whether contact last name is required", "example" : false }, "requiredContactMobile" : { "type" : "boolean", "description" : "Whether contact mobile is required", "example" : false }, "requiredContactPhone" : { "type" : "boolean", "description" : "Whether contact phone is required", "example" : false }, "requiredLocationBuildingName" : { "type" : "boolean", "description" : "Whether building name is required", "example" : false }, "requiredLocationBuildingNumber" : { "type" : "boolean", "description" : "Whether building number is required", "example" : false }, "requiredLocationCity" : { "type" : "boolean", "description" : "Whether city is required", "example" : false }, "requiredLocationCountryCode" : { "type" : "boolean", "description" : "Whether country code is required", "example" : false }, "requiredLocationFloor" : { "type" : "boolean", "description" : "Whether floor is required", "example" : false }, "requiredLocationLocality" : { "type" : "boolean", "description" : "Whether locality is required", "example" : false }, "requiredLocationPostalCode" : { "type" : "boolean", "description" : "Whether postal code is required", "example" : false }, "requiredLocationRegion" : { "type" : "boolean", "description" : "Whether region is required", "example" : false }, "requiredLocationStateCode" : { "type" : "boolean", "description" : "Whether state code is required", "example" : false }, "requiredLocationStreetName" : { "type" : "boolean", "description" : "Whether street name is required", "example" : false }, "requiredLocationStreetNumber" : { "type" : "boolean", "description" : "Whether street number is required", "example" : false }, "requiredLocationUnit" : { "type" : "boolean", "description" : "Whether unit is required", "example" : false }, "requiredReferencesExternal" : { "type" : "boolean", "description" : "Whether external references are required", "example" : false }, "requiredReferencesInternal" : { "type" : "boolean", "description" : "Whether internal references are required", "example" : false } } }, "ModalValidations" : { "type" : "object", "description" : "Validation rules for the transport modal field", "properties" : { "validations" : { "$ref" : "#/components/schemas/CommonValidations", "description" : "Validation rules for the modal field." } } }, "ServiceRouteResponse" : { "type" : "object", "description" : "Service route support for a from/to country pair", "properties" : { "customsClearance" : { "$ref" : "#/components/schemas/CustomsClearance", "description" : "Customs clearance requirements for the matched route" }, "domestic" : { "type" : "boolean", "description" : "Domestic flag of the matched route entry; null if no route entry matched", "example" : false }, "dutiable" : { "type" : "boolean", "description" : "Dutiability of the matched route entry; null if the matched entry has no dutiable constraint or no route entry matched", "example" : false }, "fromCountryCode" : { "$ref" : "#/components/schemas/CountryCode", "description" : "Origin country code of the matched route", "example" : "US" }, "serviceRoute" : { "type" : "string", "description" : "Whether the service supports the requested route", "enum" : [ "SUPPORTED", "NOT_SUPPORTED", "UNKNOWN" ], "example" : "SUPPORTED" }, "toCountryCode" : { "$ref" : "#/components/schemas/CountryCode", "description" : "Destination country code of the matched route", "example" : "CA" } } }, "CustomsDeclarationTypeResponse" : { "type" : "object", "description" : "Customs declaration type definition and validations", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Customs Declaration Type", "example" : "019ad761-9247-79b3-8cda-416fc404bbe9", "maxLength" : 36 }, "access" : { "type" : "boolean", "description" : "Indicates whether the Customs Declaration Type is available", "example" : false }, "addressValidations" : { "type" : "array", "description" : "Address field validations scoped by party role", "items" : { "$ref" : "#/components/schemas/AddressValidation" }, "maxItems" : 1000 }, "charges" : { "$ref" : "#/components/schemas/CustomDeclarationCharge", "description" : "Charge settings" }, "comments" : { "$ref" : "#/components/schemas/FieldValidation", "description" : "General note comment constraints" }, "criteria" : { "$ref" : "#/components/schemas/CustomsDeclarationTypeCriteria", "description" : "Flags indicating which validation segments are populated" }, "currencies" : { "type" : "array", "description" : "Supported currency codes", "example" : [ "NOK", "SEK", "USD" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 }, "description" : { "type" : "string", "description" : "Customs declaration type description", "example" : "Bring VOEC", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "documentTypes" : { "type" : "array", "description" : "Supported document types for the customs declaration type", "items" : { "$ref" : "#/components/schemas/DocumentType" }, "maxItems" : 1000 }, "invoice" : { "$ref" : "#/components/schemas/CustomDeclarationInvoice", "description" : "Invoice constraints" }, "itemValidations" : { "type" : "array", "description" : "Item field validations", "items" : { "$ref" : "#/components/schemas/CustomsDeclarationTypeItemValidation" }, "maxItems" : 1000 }, "paperless" : { "type" : "boolean", "description" : "Indicates whether this customs declaration type supports no printed documents", "readOnly" : true }, "parties" : { "type" : "array", "description" : "Parties involved", "items" : { "$ref" : "#/components/schemas/ServiceParty" }, "maxItems" : 1000 }, "purpose" : { "$ref" : "#/components/schemas/CommonType", "description" : "Supported purposes" }, "restrictions" : { "$ref" : "#/components/schemas/Restrictions", "description" : "Restriction information for this customs declaration type" }, "statements" : { "$ref" : "#/components/schemas/FieldValidation", "description" : "Export declaration statement constraints" }, "terms" : { "$ref" : "#/components/schemas/CommonType", "description" : "Supported trade terms" }, "type" : { "type" : "string", "description" : "Customs Declaration type", "example" : "BRINGEDI", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "CarrierStaging" : { "type" : "object", "description" : "Carrier staging and onboarding requirements", "properties" : { "documentationUrl" : { "type" : "string", "description" : "URL to the carrier staging documentation", "example" : "https://docs.example.com/staging", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "mandatory" : { "type" : "boolean", "description" : "Indicates whether staging/testing is mandatory before going live", "example" : false }, "onboardingUrl" : { "type" : "string", "description" : "URL to the carrier onboarding portal", "example" : "https://onboarding.example.com", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "ParcelListResponse" : { "type" : "object", "description" : "Paginated list of parcels", "properties" : { "items" : { "type" : "array", "description" : "Parcels", "items" : { "$ref" : "#/components/schemas/ParcelResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "PartyResponse" : { "type" : "object", "description" : "Party involved in the shipment with its roles and address", "properties" : { "address" : { "$ref" : "#/components/schemas/AddressResponse", "description" : "Address associated with the party" }, "roles" : { "type" : "array", "description" : "Roles associated with the Party", "items" : { "type" : "string", "enum" : [ "SENDER", "RECEIVER", "DELIVERY", "DISPATCH", "RETURN", "FREIGHT_PAYER", "TAX_PAYER", "CUSTOMS_PAYER", "IMPORTER", "EXPORTER" ] }, "maxItems" : 1000 }, "type" : { "type" : "string", "description" : "Party type", "enum" : [ "ADDRESS", "PUDO" ], "example" : "ADDRESS" } }, "required" : [ "address" ] }, "TrackerParcel" : { "type" : "object", "description" : "Tracking status and link for a single parcel", "properties" : { "status" : { "type" : "string", "description" : "Harmonized parcel status", "enum" : [ "BOOKED", "DISPATCHED", "DELIVERED", "VOID" ], "example" : "BOOKED" }, "reference" : { "type" : "string", "description" : "Parcel reference", "example" : "#45678", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "serial" : { "type" : "string", "description" : "Parcel serial number", "example" : "473325380000006010", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "link" : { "type" : "string", "description" : "Parcel tracking link", "example" : "https://track.example.com/?parcel=00001234567890123456", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "ParcelValidation" : { "type" : "object", "description" : "Parcel dimension, weight and volume limits for a service", "properties" : { "conditions" : { "type" : "array", "description" : "Conditions under which this validation applies", "items" : { "$ref" : "#/components/schemas/ValidationConditions" }, "maxItems" : 1000 }, "maxHeight" : { "type" : "number", "format" : "double", "description" : "Maximum height in cm", "example" : 80 }, "maxLength" : { "type" : "number", "format" : "double", "description" : "Maximum length in cm", "example" : 120 }, "maxTotalDimensions" : { "type" : "number", "format" : "double", "description" : "Maximum total dimensions in cm", "example" : 300 }, "maxVolume" : { "type" : "number", "format" : "double", "description" : "Maximum volume in cubic meters", "example" : 2.5 }, "maxWeight" : { "type" : "number", "format" : "double", "description" : "Maximum weight in kg", "example" : 30 }, "maxWidth" : { "type" : "number", "format" : "double", "description" : "Maximum width in cm", "example" : 100 }, "minHeight" : { "type" : "number", "format" : "double", "description" : "Minimum height in cm", "example" : 1 }, "minLength" : { "type" : "number", "format" : "double", "description" : "Minimum length in cm", "example" : 1 }, "minTotalDimensions" : { "type" : "number", "format" : "double", "description" : "Minimum total dimensions in cm", "example" : 15 }, "minVolume" : { "type" : "number", "format" : "double", "description" : "Minimum volume in cubic meters", "example" : 0.001 }, "minWeight" : { "type" : "number", "format" : "double", "description" : "Minimum weight in kg", "example" : 0.1 }, "minWidth" : { "type" : "number", "format" : "double", "description" : "Minimum width in cm", "example" : 1 } } }, "Chargeable" : { "type" : "object", "description" : "Chargeable weight, volume and counts used for billing", "properties" : { "addons" : { "type" : "array", "description" : "Add-ons", "items" : { "$ref" : "#/components/schemas/AddonResponse" }, "maxItems" : 1000 }, "dimensionsUnit" : { "type" : "string", "description" : "Chargeable dimensions unit", "enum" : [ "M", "DM", "CM", "MM", "IN", "FT", "YD" ], "example" : "CM" }, "palletCount" : { "type" : "integer", "format" : "int64", "description" : "Total number of pallets", "example" : 10 }, "pallets" : { "type" : "array", "description" : "Pallet counts by type", "items" : { "$ref" : "#/components/schemas/PalletCount" }, "maxItems" : 1000 }, "palletType" : { "type" : "string", "description" : "Pallet type", "enum" : [ "EPAL-1", "EPAL-2", "EPAL-3", "EPAL-6" ] }, "parcelCount" : { "type" : "integer", "format" : "int64", "description" : "Total number of parcels", "example" : 10 }, "shipmentCount" : { "type" : "integer", "format" : "int64", "description" : "Total number of shipments", "example" : 1 }, "volume" : { "type" : "number", "format" : "double", "description" : "Chargeable volume. Volume used by the carrier for shipment charges.", "example" : 10.0 }, "volumeUnit" : { "type" : "string", "description" : "Chargeable volume unit", "enum" : [ "CM3", "DM3", "M3", "IN3", "FT3" ], "example" : "CM3" }, "weight" : { "type" : "number", "format" : "double", "description" : "Chargeable weight. Weight used by the carrier for shipment charges.", "example" : 10.0 }, "weightUnit" : { "type" : "string", "description" : "Chargeable weight unit", "enum" : [ "G", "KG", "LB", "OZ" ], "example" : "KG" } } }, "Customs" : { "type" : "object", "description" : "Customs declaration support for the carrier service", "properties" : { "declarationTypes" : { "type" : "array", "description" : "List of customs declaration types with mandatory flags.", "items" : { "$ref" : "#/components/schemas/CustomsDeclarationType" }, "maxItems" : 1000 }, "supported" : { "type" : "boolean", "description" : "Indicates if customs declarations are supported.", "example" : true } } }, "EventChannelResponse" : { "type" : "object", "description" : "Response body for event channel", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Event Channel", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Event Channel was created", "example" : "2025-02-25T14:53:04+0200", "maxLength" : 64 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Event Channel was last updated", "example" : "2025-02-25T14:53:04+0200", "maxLength" : 64 }, "name" : { "type" : "string", "description" : "Event Channel name", "example" : "My event channel", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "topics" : { "type" : "array", "description" : "Topics for the Event Channel", "items" : { "$ref" : "#/components/schemas/EventChannelTopic" }, "maxItems" : 1000 }, "webhook" : { "$ref" : "#/components/schemas/Webhook", "description" : "Webhook configuration" } } }, "InlineParty" : { "type" : "object", "allOf" : [ { "oneOf" : [ { "required" : [ "id" ] }, { "required" : [ "address" ] } ] } ], "description" : "Shipment party supplied inline with its full address", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "ID of an existing Address or PUDO Point. Exactly one of `id` or `address` is required.", "example" : "019b220f-7d9b-7435-b352-f718eb22fa4a", "maxLength" : 36 }, "address" : { "$ref" : "#/components/schemas/AddressRequest", "description" : "Address details" }, "roles" : { "type" : "array", "description" : "Roles associated with the Party", "items" : { "type" : "string", "enum" : [ "SENDER", "RECEIVER", "DELIVERY", "DISPATCH", "RETURN", "FREIGHT_PAYER", "TAX_PAYER", "CUSTOMS_PAYER", "IMPORTER", "EXPORTER" ] }, "maxItems" : 1000, "minItems" : 1 }, "source" : { "type" : "string", "description" : "Alias of a shared account to resolve `id` in, instead of the caller's own Account. Allowed only together with `id`.", "example" : "amber-falcon-river", "maxLength" : 255, "pattern" : "^[a-z0-9][a-z0-9-]{2,39}$" }, "type" : { "type" : "string", "description" : "Party type", "enum" : [ "ADDRESS", "PUDO" ], "example" : "ADDRESS", "pattern" : "^(ADDRESS|PUDO)$" } }, "required" : [ "roles", "type" ] }, "ShipmentBookingExtendedResponse" : { "type" : "object", "description" : "Complete shipment booking with all related details", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Shipment", "example" : "019b26d6-73d6-7bf6-b1b6-4531af80e7d7", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Shipment Booking was created", "example" : "2026-01-22T10:30:00Z", "maxLength" : 64 }, "serial" : { "type" : "string", "description" : "Serial number assigned by the carrier", "example" : "6250112345", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "carrierDefinition" : { "$ref" : "#/components/schemas/CarrierDefinitionResponse", "description" : "Carrier Definition details" }, "chargeables" : { "$ref" : "#/components/schemas/Chargeable", "description" : "Chargeable dimensions and counts" }, "customsDeclaration" : { "$ref" : "#/components/schemas/CustomsDeclarationResponse", "description" : "Customs declaration details" }, "dangerousGoods" : { "$ref" : "#/components/schemas/DangerousGoodsDeclarationResponse", "description" : "Dangerous goods declaration details" }, "delivery" : { "$ref" : "#/components/schemas/DeliveryBookingRequest", "description" : "Requested delivery date and time window" }, "documents" : { "type" : "array", "description" : "Documents associated with the Shipment Booking", "items" : { "$ref" : "#/components/schemas/Document" }, "maxItems" : 1000 }, "info" : { "$ref" : "#/components/schemas/ShipmentBookingInfo", "description" : "Shipment booking information" }, "parcels" : { "type" : "array", "description" : "Parcels associated with the Shipment Booking", "items" : { "$ref" : "#/components/schemas/ParcelResponse" }, "maxItems" : 1000 }, "parties" : { "type" : "array", "description" : "Parties involved in the shipment", "items" : { "$ref" : "#/components/schemas/PartyResponse" }, "maxItems" : 1000 }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "pickup" : { "$ref" : "#/components/schemas/PickupBookingRequest", "description" : "Resolved pickup booking slot and instructions" }, "serviceDefinition" : { "$ref" : "#/components/schemas/ServiceDefinitionResponse", "description" : "Service Definition details" }, "shipmentChannel" : { "$ref" : "#/components/schemas/ShipmentChannelResponse", "description" : "Shipment Channel details" }, "state" : { "$ref" : "#/components/schemas/State", "description" : "Shipment booking state" }, "tracker" : { "$ref" : "#/components/schemas/TrackerResponse", "description" : "Tracking information" } } }, "AccountCreateResponse" : { "type" : "object", "description" : "The created Account. `alias` is present only for a `SHARED` account, including an alias GO generated.", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the entity", "example" : "01991a03-c860-7000-bb91-5a9cb479f522", "maxLength" : 36 }, "alias" : { "type" : "string", "description" : "Alias of a `SHARED` account, unique within the Company", "example" : "amber-falcon-river", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "Company" : { "type" : "object", "description" : "Company information", "properties" : { "name" : { "type" : "string", "description" : "Company name", "example" : "nShift", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "identification" : { "type" : "array", "description" : "Company identification values", "items" : { "$ref" : "#/components/schemas/Identification" }, "maxItems" : 1000 } } }, "AllowedValue" : { "type" : "object", "description" : "Allowed value description", "properties" : { "description" : { "type" : "string", "description" : "Human-readable description of the allowed value", "example" : "Express shipment service", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "value" : { "type" : "string", "description" : "Allowed value for the field type", "example" : "EXPRESS_SHIPMENT", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "AddonPortalReference" : { "type" : "object", "description" : "Portal reference linking an add-on to its portal configuration", "properties" : { "addonId" : { "type" : "string", "description" : "Identifies the add-on", "example" : "345675", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "FetchDocumentsRequest" : { "type" : "object", "description" : "Request to fetch shipment documents by channel", "properties" : { "shipmentChannelId" : { "type" : "string", "format" : "uuid", "description" : "Optional Shipment Channel ID. If not provided, the channel from the Shipment Booking is used", "maxLength" : 36 } } }, "ShippingQuoteResponseRate" : { "type" : "object", "description" : "Shipping Quote rate", "properties" : { "carrierPrice" : { "type" : "number", "format" : "double", "description" : "Carrier price", "example" : 10.0 }, "carrierRate" : { "$ref" : "#/components/schemas/CarrierRateResponse", "description" : "Carrier rate price" }, "cartPrice" : { "type" : "number", "format" : "double", "description" : "Cart price", "example" : 10.0 }, "currency" : { "type" : "string", "description" : "Currency code", "enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ], "example" : "EUR" }, "price" : { "type" : "number", "format" : "double", "description" : "Standard rate price", "example" : 10.0 }, "priceMargin" : { "type" : "number", "format" : "double", "description" : "Price margin", "example" : 10.0 }, "priceTotal" : { "type" : "number", "format" : "double", "description" : "Total price", "example" : 10.0 } } }, "ChannelPickupSlot" : { "type" : "object", "description" : "Single pickup time slot configured on a shipment channel", "properties" : { "name" : { "type" : "string", "description" : "Free-text slot name, unique within the channel's slots.", "example" : "Monday morning", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "active" : { "type" : "boolean", "description" : "Whether the slot is active. Inactive slots are excluded from automatic selection and cannot be referenced manually.", "example" : false }, "conditions" : { "$ref" : "#/components/schemas/ChannelPickupConditions", "description" : "Optional scope filter. When provided, the slot is only considered when the booking's carrier and/or service match." }, "description" : { "type" : "string", "description" : "Free-text slot description.", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "instructions" : { "type" : "array", "description" : "Pickup instructions included with the slot.", "items" : { "type" : "string", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 }, "leadTime" : { "type" : "integer", "format" : "int32", "description" : "Number of hours from booking time before this slot becomes eligible.", "example" : 2, "minimum" : 0 }, "recurrence" : { "$ref" : "#/components/schemas/ChannelPickupRecurrence", "description" : "Recurrence definition for the slot." } }, "required" : [ "active", "name", "recurrence" ] }, "ZoneResponse" : { "type" : "object", "description" : "Delivery zone grouping destination countries", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Zone", "example" : "019b266c-0504-7f31-8f27-e216b1744ed6", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Zone was created", "example" : "2026-01-22T10:30:00Z", "maxLength" : 64 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Zone was last updated", "example" : "2026-01-22T10:30:00Z", "maxLength" : 64 }, "name" : { "type" : "string", "description" : "Zone name", "example" : "European Union", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "countries" : { "type" : "array", "description" : "Countries included in the zone", "items" : { "$ref" : "#/components/schemas/Country" }, "maxItems" : 1000 }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." } } }, "InlineShipmentChannelRequest" : { "type" : "object", "description" : "Shipment channel configuration for document rendering, units and pickup", "properties" : { "name" : { "type" : "string", "description" : "Shipment Channel name", "example" : "My shipment channel", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "documentRendering" : { "$ref" : "#/components/schemas/DocumentRendering", "description" : "Document rendering configuration" }, "pickup" : { "$ref" : "#/components/schemas/ChannelPickup", "description" : "Pickup booking configuration. When enabled, the earliest valid slot is selected automatically if the user omits a pickup time and the service supports pickup booking. When disabled, slots are used only to validate a manually provided pickup time. Ignored if the service does not support pickup booking." }, "units" : { "$ref" : "#/components/schemas/Units", "description" : "Unit settings for weight, dimensions, and volume" } }, "required" : [ "documentRendering" ] }, "InlineShipmentBooking" : { "type" : "object", "allOf" : [ { "not" : { "required" : [ "carrierDefinition", "carrierDefinitionId" ] } }, { "not" : { "required" : [ "serviceDefinition", "serviceDefinitionId" ] } } ], "description" : "Shipment booking with carrier, service and parcels defined inline", "properties" : { "carrierDefinition" : { "$ref" : "#/components/schemas/InlineCarrierDefinitionRequest", "description" : "Carrier Definition supplied inline for this booking. At most one of `carrierDefinition` or `carrierDefinitionId` may be supplied. Exactly one of them is required when creating a Shipment Booking; when booking from a Shipping Quote, omit both to use the quote's Carrier Definition." }, "carrierDefinitionId" : { "type" : "string", "format" : "uuid", "description" : "ID of an existing Carrier Definition to use for this booking. At most one of `carrierDefinition` or `carrierDefinitionId` may be supplied. Exactly one of them is required when creating a Shipment Booking; when booking from a Shipping Quote, omit both to use the quote's Carrier Definition.", "maxLength" : 36 }, "customsDeclaration" : { "$ref" : "#/components/schemas/InlineCustomsDeclarationRequest", "description" : "Inline customs declaration for the shipment" }, "dangerousGoodsDeclaration" : { "$ref" : "#/components/schemas/InlineDangerousGoodsDeclarationRequest", "description" : "Inline dangerous goods declaration for the shipment" }, "delivery" : { "$ref" : "#/components/schemas/DeliveryBookingRequest", "description" : "Requested delivery slot and instructions for the shipment. This is the delivery slot; it is unrelated to info.delivery, which carries the receiver reference." }, "info" : { "$ref" : "#/components/schemas/ShipmentBookingInfo", "description" : "Additional shipment booking information" }, "parcels" : { "type" : "array", "description" : "Shipment parcels", "items" : { "$ref" : "#/components/schemas/InlineParcel" }, "maxItems" : 1000, "minItems" : 1 }, "parties" : { "type" : "array", "description" : "Parties involved in the shipment, such as sender and receiver", "items" : { "$ref" : "#/components/schemas/InlineParty" }, "maxItems" : 1000, "minItems" : 1 }, "pickup" : { "$ref" : "#/components/schemas/PickupBookingRequest", "description" : "Pickup booking information for the shipment" }, "serviceDefinition" : { "$ref" : "#/components/schemas/InlineServiceDefinitionRequest", "description" : "Service Definition supplied inline for this booking. At most one of `serviceDefinition` or `serviceDefinitionId` may be supplied. Exactly one of them is required when creating a Shipment Booking; when booking from a Shipping Quote, omit both to use the quote's Service Definition." }, "serviceDefinitionId" : { "type" : "string", "format" : "uuid", "description" : "ID of an existing Service Definition to use for this booking. At most one of `serviceDefinition` or `serviceDefinitionId` may be supplied. Exactly one of them is required when creating a Shipment Booking; when booking from a Shipping Quote, omit both to use the quote's Service Definition.", "maxLength" : 36 }, "shipmentChannel" : { "$ref" : "#/components/schemas/InlineShipmentChannelRequest", "description" : "Shipment Channel used for this booking" } }, "required" : [ "parcels", "parties", "shipmentChannel" ] }, "PackingGroup" : { "type" : "object", "description" : "Validation rules for the packing group field", "properties" : { "validations" : { "$ref" : "#/components/schemas/CommonValidations", "description" : "Validation rules for the packing group." } } }, "AccountRequest" : { "type" : "object", "description" : "Payload to create or update an account", "properties" : { "alias" : { "type" : "string", "description" : "Alias of a `SHARED` account, unique within the Company: 3 to 40 lowercase letters, digits and `-`, starting with a letter or digit. If it isn't given, GO generates one. It can't be changed after the Account is created, and it isn't allowed on a `NORMAL` account.", "example" : "amber-falcon-river", "maxLength" : 255, "pattern" : "^[a-z0-9][a-z0-9-]{2,39}$" }, "company" : { "$ref" : "#/components/schemas/AccountCompany", "description" : "Company information associated with the Account" }, "contact" : { "$ref" : "#/components/schemas/AccountContact", "description" : "Contact information" }, "enabled" : { "type" : "boolean", "default" : true, "description" : "Indicates whether the Account is enabled", "example" : false }, "meta" : { "type" : "object", "additionalProperties" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : "Additional metadata", "example" : { "key1" : "value1", "key2" : "value2" } }, "persistence" : { "$ref" : "#/components/schemas/PersistenceRequest", "description" : "The persistence configuration of the entity." }, "sources" : { "type" : "array", "description" : "Aliases of the `SHARED` accounts in the same Company that this `NORMAL` account can read data from. Only a Company can set it. When omitted on an update, the current list is kept; an empty list removes all sources.", "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[a-z0-9][a-z0-9-]{2,39}$" }, "maxItems" : 25, "minItems" : 0 }, "type" : { "type" : "string", "description" : "Account type. An Account created without it is `NORMAL`; an update without it keeps the current type. Only a Company can create a `SHARED` account, and the type can't be changed after the Account is created.", "enum" : [ "NORMAL", "SHARED" ], "example" : "SHARED" } } }, "ShipmentValidation" : { "type" : "object", "description" : "Shipment-level parcel, weight and volume limits for a service", "properties" : { "conditions" : { "type" : "array", "description" : "Conditions under which this validation applies", "items" : { "$ref" : "#/components/schemas/ValidationConditions" }, "maxItems" : 1000 }, "maxParcels" : { "type" : "integer", "format" : "int32", "description" : "Maximum number of parcels", "example" : 10 }, "maxVolume" : { "type" : "number", "format" : "double", "description" : "Maximum volume in cubic meters", "example" : 5.0 }, "maxWeight" : { "type" : "number", "format" : "double", "description" : "Maximum weight in kg", "example" : 100 }, "minParcels" : { "type" : "integer", "format" : "int32", "description" : "Minimum number of parcels", "example" : 1 }, "minVolume" : { "type" : "number", "format" : "double", "description" : "Minimum volume in cubic meters", "example" : 0.01 }, "minWeight" : { "type" : "number", "format" : "double", "description" : "Minimum weight in kg", "example" : 0.1 } } }, "CarrierConnection" : { "type" : "object", "description" : "Carrier integration type and CDA version", "properties" : { "type" : { "type" : "string", "description" : "Integration type of the carrier connection. Absent when it has not been determined for the carrier", "enum" : [ "API", "EDI" ], "example" : "API" }, "version" : { "type" : "string", "description" : "CDA version the carrier runs. Absent when no version is known for the carrier", "example" : "1.8.0", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "CachedPudoPoints" : { "type" : "object", "description" : "Cached PUDO Point dataset configuration", "properties" : { "externalReference" : { "type" : "string", "description" : "Identifies the Service's cached PUDO Point dataset in Pudo2", "example" : "PostNord", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "supported" : { "type" : "boolean", "description" : "Indicates whether the Service supports querying a cached PUDO Point dataset instead of a realtime carrier lookup. False when the Service has no cached dataset.", "example" : false } } }, "ChannelPickupRecurrence" : { "type" : "object", "allOf" : [ { "oneOf" : [ { "required" : [ "weekday" ] }, { "required" : [ "date" ] } ] } ], "description" : "Recurring schedule defining when a pickup slot applies", "properties" : { "date" : { "type" : "integer", "format" : "int32", "description" : "Day of month (1-31) the slot recurs on. Exactly one of `weekday` or `date` is required.", "example" : 15, "maximum" : 31, "minimum" : 1 }, "timeFrom" : { "type" : "string", "description" : "Slot start time in HH:MM format.", "example" : "08:00", "maxLength" : 5, "pattern" : "^([01]\\d|2[0-3]):[0-5]\\d$" }, "timeTo" : { "type" : "string", "description" : "Slot end time in HH:MM format.", "example" : "10:00", "maxLength" : 5, "pattern" : "^([01]\\d|2[0-3]):[0-5]\\d$" }, "weekday" : { "type" : "string", "description" : "Day of week the slot recurs on. One of MO, TU, WE, TH, FR, SA, SU. Exactly one of `weekday` or `date` is required.", "enum" : [ "MO", "TU", "WE", "TH", "FR", "SA", "SU" ], "example" : "MO" } }, "required" : [ "timeFrom", "timeTo" ] }, "Terms" : { "type" : "object", "description" : "Terms of delivery configuration for the service", "properties" : { "code" : { "$ref" : "#/components/schemas/TermsCode", "description" : "Terms code configuration" } } }, "PersistenceResponse" : { "type" : "object", "description" : "The persistence configuration of the entity.", "properties" : { "expiresAt" : { "type" : "string", "format" : "date-time", "description" : "The date and time when the entity will expire based on its persistence type.", "maxLength" : 64 }, "type" : { "type" : "string", "description" : "The persistence type. Valid values depend on the entity type.", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "CustomsDeclarationTypeCriteria" : { "type" : "object", "description" : "Flags for which validations apply to the customs declaration type", "properties" : { "addressValidations" : { "type" : "boolean", "description" : "Indicates whether address validations are present", "example" : false }, "itemValidations" : { "type" : "boolean", "description" : "Indicates whether item validations are present", "example" : false } } }, "ParcelItemListResponse" : { "type" : "object", "description" : "Paginated list of parcel items", "properties" : { "items" : { "type" : "array", "description" : "Parcel Items", "items" : { "$ref" : "#/components/schemas/ParcelItemResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "Units" : { "type" : "object", "description" : "Measurement units for weight, dimensions and volume", "properties" : { "dimensions" : { "type" : "string", "description" : "Dimensions unit", "enum" : [ "M", "DM", "CM", "MM", "IN", "FT", "YD" ], "example" : "CM" }, "volume" : { "type" : "string", "description" : "Volume unit", "enum" : [ "CM3", "DM3", "M3", "IN3", "FT3" ], "example" : "CM3" }, "weight" : { "type" : "string", "description" : "Weight unit", "enum" : [ "G", "KG", "LB", "OZ" ], "example" : "KG" } }, "required" : [ "dimensions", "volume", "weight" ] }, "WeeklyOpening" : { "type" : "object", "description" : "Opening and closing times for a weekday", "properties" : { "closeTime" : { "type" : "string", "description" : "Closing time", "example" : "19:00", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "day" : { "type" : "string", "description" : "Day of the week", "example" : "Monday", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "openTime" : { "type" : "string", "description" : "Opening time", "example" : "10:00", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "ReturnService" : { "type" : "object", "description" : "Associated return Service information", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the return Service", "example" : "2b71b8f1-6d27-4b63-8093-d31257d46d4f", "maxLength" : 36 }, "name" : { "type" : "string", "description" : "Return Service name", "example" : "UPS", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "code" : { "type" : "string", "description" : "Service code", "example" : "UPS", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "SerialResponse" : { "type" : "object", "description" : "Serial number type definition for the carrier", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Serial Type", "example" : "123e4567-e89b-12d3-a456-426614174000", "maxLength" : 36 }, "name" : { "type" : "string", "description" : "Serial type name", "example" : "Standard Serial Type", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "checkDigitMethod" : { "type" : "string", "description" : "Serial number check digit method", "example" : "MOD10", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "code" : { "type" : "string", "description" : "Serial type code", "example" : "SERIAL01", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "pattern" : { "type" : "string", "description" : "Serial number pattern", "example" : "^[A-Z]{2}[0-9]{8}$", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "CustomsDeclarationTypeItemValidation" : { "type" : "object", "description" : "Item-level validation rules for a customs declaration type", "properties" : { "conditions" : { "type" : "array", "description" : "Conditions under which the item validations apply", "items" : { "$ref" : "#/components/schemas/ValidationConditions" }, "maxItems" : 1000 }, "pricing" : { "$ref" : "#/components/schemas/CustomsItemPricing", "description" : "Pricing field validations" }, "product" : { "$ref" : "#/components/schemas/CustomsItemProduct", "description" : "Product field validations" } } }, "ServiceItemValidationConditions" : { "type" : "object", "description" : "Conditions under which item validations apply", "properties" : { "dangerousGoodsDeclarationTypes" : { "type" : "array", "description" : "The dangerous goods declaration type codes these validations apply to", "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 } } }, "SingleRoute" : { "type" : "object", "description" : "A single from/to country route", "properties" : { "fromCountryCode" : { "$ref" : "#/components/schemas/CountryCode", "description" : "Allowed origin country code", "example" : "SE" }, "toCountryCode" : { "$ref" : "#/components/schemas/CountryCode", "description" : "Allowed destination country code", "example" : "DE" } } }, "ShipmentBookingRequest" : { "type" : "object", "description" : "Request to book a shipment for dispatch", "properties" : { "carrierDefinitionId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Carrier Definition", "example" : "019aa590-a84b-7000-89fe-2a0a157be008", "maxLength" : 36 }, "customsDeclarationId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Customs Declaration", "example" : "019ab521-5fc6-7836-8d3b-ba0f6e12e003", "maxLength" : 36 }, "dangerousGoodsDeclarationId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Dangerous Goods Declaration", "example" : "019ab521-5fc6-7836-8d3b-ba0f6e12e003", "maxLength" : 36 }, "delivery" : { "$ref" : "#/components/schemas/DeliveryBookingRequest", "description" : "Requested delivery slot and instructions for the shipment. This is the delivery slot; it is unrelated to info.delivery, which carries the receiver reference." }, "info" : { "$ref" : "#/components/schemas/ShipmentBookingInfo", "description" : "Shipment information" }, "parcelIds" : { "type" : "array", "description" : "Shipment parcels", "example" : [ "019b2e9f-ed2f-70d9-befb-f6bafa4377b7", "019b2e85-e47e-7911-92fd-d0897e6e3546" ], "items" : { "type" : "string", "format" : "uuid", "maxLength" : 36 }, "maxItems" : 1000, "minItems" : 1 }, "parties" : { "type" : "array", "description" : "Shipment parties", "example" : [ { "type" : "ADDRESS", "roles" : [ "SENDER" ], "id" : "019b2766-8eb4-795c-899f-9ac8d5cc6a34" }, { "type" : "ADDRESS", "roles" : [ "RECEIVER" ], "id" : "019b0293-0db8-7c4f-9427-cf56154166c0" } ], "items" : { "$ref" : "#/components/schemas/Party" }, "maxItems" : 2147483647, "minItems" : 2 }, "persistence" : { "$ref" : "#/components/schemas/PersistenceRequest", "description" : "The persistence configuration of the entity." }, "pickup" : { "$ref" : "#/components/schemas/PickupBookingRequest", "description" : "Pickup booking information for the shipment" }, "serviceDefinitionId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Service Definition", "example" : "01991a00-07b3-7171-a245-177e15965608", "maxLength" : 36 }, "shipmentChannelId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Shipment Channel", "example" : "019a8bcf-d773-7ee0-b72b-894b0c9dfc75", "maxLength" : 36 } }, "required" : [ "carrierDefinitionId", "parcelIds", "parties", "serviceDefinitionId", "shipmentChannelId" ] }, "ChannelPickupConditions" : { "type" : "object", "description" : "Carrier and service filter scoping a pickup slot", "properties" : { "carrierId" : { "type" : "string", "description" : "Optional carrier identifier the slot applies to.", "example" : "8c2b9506-043c-3adb-918b-e134d3c36bd6", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "serviceId" : { "type" : "string", "description" : "Optional service identifier the slot applies to.", "example" : "e7344aa1-b22d-3ff3-b73b-2abfa90f7d82", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "AccountResponse" : { "type" : "object", "description" : "Account details", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Account", "example" : "019a8bc4-f94b-725f-90ee-ffc91f7acea6", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Account was created", "example" : "2024-01-15T10:30:00Z", "maxLength" : 64 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Account was last updated", "example" : "2024-01-15T10:30:00Z", "maxLength" : 64 }, "alias" : { "type" : "string", "description" : "Alias of a `SHARED` account, unique within the Company", "example" : "amber-falcon-river", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "company" : { "$ref" : "#/components/schemas/AccountCompany", "description" : "Company information" }, "contact" : { "$ref" : "#/components/schemas/AccountContact", "description" : "Contact information" }, "enabled" : { "type" : "boolean", "default" : false, "description" : "Indicates whether API access is permitted for the Account. Defaults to true.", "example" : false }, "meta" : { "type" : "object", "additionalProperties" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : "Additional metadata", "example" : { "key1" : "value1", "key2" : "value2" } }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "sources" : { "type" : "array", "description" : "Aliases of the `SHARED` accounts this `NORMAL` account can read data from", "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 }, "type" : { "type" : "string", "description" : "Account type", "enum" : [ "NORMAL", "SHARED" ], "example" : "NORMAL" } } }, "ServiceDefinitionResponse" : { "type" : "object", "description" : "Configured carrier service with its addons", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Service Definition", "example" : "01991a00-07b3-7171-a245-177e15965608", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Service Definition was created", "example" : "2024-01-15T10:30:00Z", "maxLength" : 64 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Service Definition was last updated", "example" : "2024-01-15T10:30:00Z", "maxLength" : 64 }, "name" : { "type" : "string", "description" : "Service Definition name", "example" : "DHL Express for domestic B2C use", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "addons" : { "type" : "array", "description" : "Add-ons for the Service", "items" : { "$ref" : "#/components/schemas/Addon" }, "maxItems" : 1000 }, "carrierId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Carrier Definition", "example" : "7ff70e43-ef3f-3516-80e2-3cc48f4124ae", "maxLength" : 36 }, "group" : { "type" : "string", "description" : "Service Definition group", "example" : "Express", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "serviceId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Service", "example" : "2b0ca74b-08fa-3726-800b-a7c0e01f9fcf", "maxLength" : 36 } }, "required" : [ "id" ] }, "ShipmentManifestResponse" : { "type" : "object", "description" : "Manifest produced for a dispatch handed to the carrier", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "The unique identifier of the resource.", "example" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Shipment Manifest was created", "example" : "2026-01-22T10:30:00Z", "maxLength" : 64 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Shipment Manifest was last updated", "example" : "2026-01-22T10:30:00Z", "maxLength" : 64 }, "reference" : { "type" : "string", "description" : "Shipment manifest reference", "example" : "MANIFEST-001", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "documents" : { "type" : "array", "description" : "Shipment manifest documents", "items" : { "$ref" : "#/components/schemas/Document" }, "maxItems" : 1000 }, "logs" : { "type" : "array", "description" : "Error log entries recorded against the Shipment Manifest (e.g. failures processing documents)", "items" : { "$ref" : "#/components/schemas/TrackerLog" }, "maxItems" : 1000 }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "shipmentDispatch" : { "$ref" : "#/components/schemas/ShipmentDispatchResponse", "description" : "Shipment dispatch associated with the manifest" }, "type" : { "type" : "string", "description" : "Shipment manifest type", "example" : "SBTL", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "ShippingQuoteGeneratedListResponse" : { "type" : "object", "description" : "Shipping quotes generated for a delivery option", "properties" : { "items" : { "type" : "array", "description" : "Shipping Quotes", "items" : { "$ref" : "#/components/schemas/ShippingQuoteResponse" }, "maxItems" : 1000 } } }, "CustomsDeclarationType" : { "type" : "object", "description" : "Supported customs declaration type and whether it is mandatory", "properties" : { "mandatory" : { "type" : "boolean", "description" : "Indicates whether this customs declaration type is mandatory for the service", "example" : false }, "type" : { "type" : "string", "description" : "The customs declaration type code", "example" : "CN22DHLECOM", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "DangerousGoodsDeclarationRequest" : { "type" : "object", "description" : "Request to create a dangerous goods declaration", "properties" : { "reference" : { "type" : "string", "description" : "Reference for the dangerous goods declaration", "example" : "DG-REF-12345", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "declarant" : { "$ref" : "#/components/schemas/DangerousGoodsDeclarationDeclarant", "description" : "Declarant information" }, "declaredAt" : { "type" : "string", "format" : "date-time", "description" : "Dangerous Goods Declaration timestamp. Must not be in the past. Defaults to current time if not provided.", "example" : "2021-09-01T12:00:00+02:00", "maxLength" : 64 }, "goods" : { "type" : "array", "description" : "Dangerous goods items included in the declaration", "items" : { "$ref" : "#/components/schemas/DangerousGoodsDeclarationGoods" }, "maxItems" : 1000 }, "goodsTypes" : { "type" : "array", "description" : "List of dangerous goods type codes included in the declaration", "example" : [ "ADR", "DNG" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 }, "handling" : { "type" : "array", "description" : "Special handling instructions", "example" : [ "Aerosol containers are pressurized and may rupture if exposed to heat or physical damage.", "Handle carefully to prevent puncture, crushing, or leakage." ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 4, "minItems" : 0 }, "meta" : { "type" : "object", "additionalProperties" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : "Additional metadata", "example" : { "key1" : "value1", "key2" : "value2" } }, "modal" : { "type" : "string", "description" : "Transport mode", "example" : "ROAD", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceRequest", "description" : "The persistence configuration of the entity." }, "type" : { "type" : "string", "description" : "Dangerous Goods Declaration Type", "example" : "\"ADR\"", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "declarant", "modal", "type" ] }, "UsageRecord" : { "type" : "object", "description" : "Billable event count for a single topic and type", "properties" : { "events" : { "type" : "integer", "format" : "int64", "description" : "Number of events counted for this record" }, "topic" : { "type" : "string", "description" : "The topic of the usage record", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "type" : { "type" : "string", "description" : "The event type of the usage record", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "ServiceItemValidationDangerousGoods" : { "type" : "object", "description" : "Dangerous goods field validations for items", "properties" : { "netQuantity" : { "$ref" : "#/components/schemas/FieldValidation", "description" : "Net quantity field validation for dangerous goods items" }, "netQuantityUnit" : { "$ref" : "#/components/schemas/FieldValidation", "description" : "Net quantity unit field validation for dangerous goods items" }, "quantity" : { "$ref" : "#/components/schemas/FieldValidation", "description" : "Quantity field validation for dangerous goods items" }, "type" : { "$ref" : "#/components/schemas/FieldValidation", "description" : "Allowed dangerous goods type codes and whether the type field is mandatory" } } }, "Operation" : { "type" : "object", "description" : "Operation offered at a pickup point and its hours", "properties" : { "openingHours" : { "$ref" : "#/components/schemas/OpeningHours", "description" : "Opening hours for the operation" }, "type" : { "type" : "string", "description" : "Type of operation", "example" : "SERVICE_POINT", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "MockEventPayload" : { "type" : "object", "description" : "Event payload", "properties" : { "id" : { "type" : "string", "description" : "Identifies the Event", "example" : "019aa590-a84b-7c80-a469-e9c65dc58f3b", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "id" ] }, "Pallet" : { "type" : "object", "description" : "Pallet grouping and type for a parcel", "properties" : { "group" : { "type" : "string", "description" : "Pallet group", "example" : "GROUP-A", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "type" : { "type" : "string", "description" : "Pallet type", "enum" : [ "EPAL-1", "EPAL-2", "EPAL-3", "EPAL-6" ] } } }, "TrackerResponse" : { "type" : "object", "description" : "Tracking state of a shipment and its parcels", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "The unique identifier of the tracker.", "example" : "d290f1ee-6c54-4b01-90e6-d701748f0851", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Tracker was created", "example" : "2026-01-22T10:30:00Z", "maxLength" : 64 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Tracker was last updated", "example" : "2026-01-22T10:30:00Z", "maxLength" : 64 }, "status" : { "type" : "string", "description" : "Harmonized tracker status", "enum" : [ "BOOKED", "DISPATCHED", "DELIVERED", "VOID" ], "example" : "BOOKED" }, "logs" : { "type" : "array", "description" : "Error log entries recorded against the Tracker (e.g. failures processing documents)", "items" : { "$ref" : "#/components/schemas/TrackerLog" }, "maxItems" : 1000 }, "parcels" : { "type" : "array", "description" : "Parcels with tracking information", "items" : { "$ref" : "#/components/schemas/TrackerParcel" }, "maxItems" : 1000 }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "shipment" : { "$ref" : "#/components/schemas/TrackerShipment", "description" : "Shipment tracking information" } } }, "DangerousGoodsDeclarationTypeResponse" : { "type" : "object", "description" : "Dangerous goods declaration type supported by the carrier", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Dangerous Goods Declaration Type", "example" : "328af029-7629-3355-a6df-029593db9d82", "maxLength" : 36 }, "access" : { "type" : "boolean", "description" : "Indicates whether the user has access to this dangerous goods declaration type", "example" : false }, "carrierId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Carrier", "example" : "123e4567-e89b-12d3-a456-426614174000", "maxLength" : 36 }, "code" : { "type" : "string", "description" : "Dangerous goods declaration type code", "example" : "ADR", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : { "type" : "string", "description" : "Dangerous goods declaration type description", "example" : "European Agreement concerning the International Carriage of Dangerous Goods by Road", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "documentTypes" : { "type" : "array", "description" : "Document types associated with the dangerous goods declaration type", "items" : { "$ref" : "#/components/schemas/DocumentType" }, "maxItems" : 1000 }, "goods" : { "$ref" : "#/components/schemas/Goods", "description" : "Goods information for this dangerous goods declaration type" }, "handling" : { "$ref" : "#/components/schemas/Handling", "description" : "Handling validation rules for the dangerous goods declaration type" }, "modal" : { "$ref" : "#/components/schemas/ModalValidations", "description" : "Modal validation rules for the dangerous goods declaration type" }, "paperless" : { "type" : "boolean", "description" : "Indicates whether this dangerous goods declaration type supports no printed documents", "readOnly" : true }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "restrictions" : { "$ref" : "#/components/schemas/Restrictions", "description" : "Restriction information for this dangerous goods declaration type" }, "standard" : { "type" : "string", "description" : "Standard validation rules for the dangerous goods declaration type", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "type" : { "type" : "string", "description" : "Dangerous goods declaration type", "example" : "ADR", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "MultipleRoutes" : { "type" : "object", "description" : "Route conditions under which a service or addon applies", "properties" : { "condition" : { "type" : "array", "description" : "Defines coverage conditions", "example" : [ "POSTAL_CODE_BASED", "AGREEMENT_BASED" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000, "uniqueItems" : true }, "domestic" : { "type" : "boolean", "description" : "Shows the user whether domestic routes are applicable or not", "example" : false }, "dutiable" : { "type" : "boolean", "description" : "Constrains the route entry to dutiable (true) or duty-free (false) shipments; absent means no dutiability constraint", "example" : false }, "fromCountryCodes" : { "type" : "array", "description" : "Allowed origin country codes", "example" : [ "US" ], "items" : { "$ref" : "#/components/schemas/CountryCode" }, "maxItems" : 1000 }, "restrictions" : { "$ref" : "#/components/schemas/Restrictions", "description" : "Restriction information for this route" }, "toCountryCodes" : { "type" : "array", "description" : "Allowed destination country codes", "example" : [ "US" ], "items" : { "$ref" : "#/components/schemas/CountryCode" }, "maxItems" : 1000 } } }, "Pricing" : { "type" : "object", "description" : "Pricing and customs details for a parcel item", "properties" : { "countryOfOrigin" : { "$ref" : "#/components/schemas/CountryCode", "description" : "Product country of origin", "example" : "DE" }, "currency" : { "type" : "string", "description" : "Product currency", "enum" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ], "example" : "EUR" }, "supplementaryQuantity" : { "type" : "number", "format" : "double", "description" : "Supplementary quantity of the item, forwarded to the carrier customs line", "example" : 24 }, "supplementaryQuantityUnit" : { "type" : "string", "description" : "Unit of measure code for the supplementary quantity, 1 to 5 uppercase letters or digits. The accepted codes are carrier specific", "example" : "PCS", "maxLength" : 255, "pattern" : "^[A-Z0-9]{1,5}$" }, "tariffNumber" : { "type" : "string", "description" : "Product tariff number", "example" : "12345678", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "unitPrice" : { "type" : "number", "format" : "double", "description" : "Product unit price", "example" : 10.5 }, "vatPercent" : { "type" : "number", "format" : "double", "description" : "Product VAT percent", "example" : 10.5 } } }, "ShipmentDispatchTrackerListResponse" : { "type" : "object", "description" : "Paginated list of dispatch trackers", "properties" : { "items" : { "type" : "array", "description" : "Shipment Dispatch Trackers", "items" : { "$ref" : "#/components/schemas/ShipmentDispatchTracker" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "CountryCode" : { "type" : "string", "description" : "ISO 3166-1 alpha-2 country code", "enum" : [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW" ], "example" : "SE" }, "DangerousGoods" : { "type" : "object", "description" : "Dangerous goods configuration for the service", "properties" : { "declarationTypes" : { "type" : "array", "description" : "List of dangerous goods declaration types.", "items" : { "$ref" : "#/components/schemas/DangerousGoodsDeclarationTypeResponse" }, "maxItems" : 1000 }, "explicitRoutes" : { "type" : "boolean", "description" : "Indicates whether the service has dangerous goods specific routes", "example" : false }, "goods" : { "$ref" : "#/components/schemas/DangerousGoodsValidations", "description" : "Field-level validations for dangerous goods items on this service" }, "packingCodeType" : { "$ref" : "#/components/schemas/PackingCodeType", "description" : "Packing code type configuration for dangerous goods." }, "packingTypes" : { "type" : "array", "description" : "List of allowed packing types for dangerous goods.", "items" : { "$ref" : "#/components/schemas/PackingTypesLesser" }, "maxItems" : 1000 }, "routes" : { "type" : "array", "description" : "Dangerous goods routes for the service", "items" : { "$ref" : "#/components/schemas/MultipleRoutes" }, "maxItems" : 1000, "uniqueItems" : true }, "supported" : { "type" : "boolean", "description" : "Indicates if dangerous goods are supported.", "example" : true } } }, "DeliveryOptionResponse" : { "type" : "object", "description" : "Configured delivery option with its rates and zones", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Delivery Option", "example" : "019c2038-9e20-7000-8193-7c08db53a87f", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Delivery Option was created", "example" : "2026-01-22T10:30:00Z", "maxLength" : 64 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Delivery Option was last updated\n", "example" : "2026-01-22T10:30:00Z", "maxLength" : 64 }, "name" : { "type" : "string", "description" : "Delivery Option name", "example" : "Standard Shipping", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "carrierDefinitionId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Carrier Definition", "example" : "019a8cb2-394a-7689-8a09-1c96ee3cea88", "maxLength" : 36 }, "description" : { "type" : "string", "description" : "Delivery Option description", "example" : "Standard shipping with 3-5 business days delivery", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "enabled" : { "type" : "boolean", "description" : "Indicates whether the Delivery Option is active", "example" : false }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "priority" : { "type" : "integer", "format" : "int64", "description" : "Delivery Option priority level", "example" : 0 }, "rates" : { "type" : "array", "description" : "Delivery Option rates", "items" : { "$ref" : "#/components/schemas/Rate" }, "maxItems" : 1000 }, "serviceDefinitionId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Service Definition", "example" : "019a8cc2-7ecd-7b05-ae3d-a3e82ca19827", "maxLength" : 36 }, "units" : { "$ref" : "#/components/schemas/Units", "description" : "Unit settings for weight and dimensions" }, "zones" : { "type" : "array", "description" : "Zones associated with the Delivery Option", "items" : { "$ref" : "#/components/schemas/ZoneResponse" }, "maxItems" : 1000 } } }, "DangerousGoodsHazardValidations" : { "type" : "object", "description" : "Validation rules for hazard fields", "properties" : { "code" : { "$ref" : "#/components/schemas/EnrichmentValidations", "description" : "Validation rules for the hazard code field" }, "environmental" : { "$ref" : "#/components/schemas/EnrichmentValidations", "description" : "Validation rules for the environmental hazard field" }, "flashPoint" : { "$ref" : "#/components/schemas/EnrichmentValidations", "description" : "Validation rules for the flash point field" }, "hazardClass" : { "$ref" : "#/components/schemas/EnrichmentValidations", "description" : "Validation rules for the hazard class field" } } }, "Addon" : { "type" : "object", "description" : "Carrier add-on service with its configurable fields", "properties" : { "code" : { "type" : "string", "description" : "The Addon specific code.", "example" : "DLVIN", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "fields" : { "type" : "array", "description" : "The list of Addon specific field that can be defined.", "items" : { "$ref" : "#/components/schemas/AddonInfo" }, "maxItems" : 1000 } }, "required" : [ "code" ] }, "EventChannelListResponse" : { "type" : "object", "description" : "Paginated list of event channels", "properties" : { "items" : { "type" : "array", "description" : "Event Channels", "items" : { "$ref" : "#/components/schemas/EventChannelResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "DangerousGoodsPackingValidations" : { "type" : "object", "description" : "Validation rules for packing fields", "properties" : { "group" : { "$ref" : "#/components/schemas/EnrichmentValidations", "description" : "Validation rules for the packing group field" }, "type" : { "$ref" : "#/components/schemas/EnrichmentValidations", "description" : "Validation rules for the packing type field" } } }, "ProductIdentification" : { "type" : "object", "description" : "Identifier of a product, such as a GTIN, EAN or SKU", "properties" : { "type" : { "type" : "string", "description" : "Product identifier type: SKU, EAN, ISBN, GTIN or OTHER", "enum" : [ "SKU", "MPN", "OTHER", "GTIN", "EAN", "UPC", "ISBN" ], "example" : "GTIN", "minLength" : 1 }, "value" : { "type" : "string", "description" : "Product identifier value", "example" : "4006381333931", "maxLength" : 256, "minLength" : 0, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "type", "value" ] }, "Manifest" : { "type" : "object", "description" : "Manifest support and available manifest types", "properties" : { "supported" : { "type" : "boolean", "description" : "Indicates whether Shipment Manifest is supported", "example" : false }, "types" : { "type" : "array", "description" : "Supported shipment manifest types", "items" : { "$ref" : "#/components/schemas/ManifestType" }, "maxItems" : 1000 } } }, "AuthorizationResponse" : { "type" : "object", "description" : "Access token issued for authentication", "properties" : { "accessToken" : { "type" : "string", "description" : "JWT access token", "example" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "expiresAt" : { "type" : "integer", "format" : "int64", "description" : "Timestamp when the token expires, in milliseconds", "example" : 1705315800000 }, "tokenType" : { "type" : "string", "description" : "Token type", "example" : "Bearer", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "Contact" : { "type" : "object", "description" : "Contact information", "properties" : { "careOf" : { "type" : "string", "description" : "Care-of line", "example" : "Jane Smith", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "doorCode" : { "type" : "string", "description" : "Door code", "example" : "11", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "email" : { "type" : "string", "format" : "email", "description" : "Contact email address", "example" : "jdoe@nshift.com", "maxLength" : 254 }, "fax" : { "type" : "string", "description" : "Contact fax number", "example" : "+46721234567", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "firstName" : { "type" : "string", "description" : "Contact first name", "example" : "John", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "lastName" : { "type" : "string", "description" : "Contact last name", "example" : "Doe", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "mobile" : { "type" : "string", "description" : "Contact mobile phone number", "example" : "+46721234567", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "phone" : { "type" : "string", "description" : "Contact phone number", "example" : "+46721234567", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "ShipmentChannelRequest" : { "type" : "object", "description" : "Shipment Channel to create", "properties" : { "name" : { "type" : "string", "description" : "Shipment Channel name", "example" : "My shipment channel", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "documentRendering" : { "$ref" : "#/components/schemas/DocumentRendering", "description" : "Document rendering configuration" }, "persistence" : { "$ref" : "#/components/schemas/PersistenceRequest", "description" : "The persistence configuration of the entity." }, "pickup" : { "$ref" : "#/components/schemas/ChannelPickup", "description" : "Pickup booking configuration. When enabled, the earliest valid slot is selected automatically if the user omits a pickup time and the service supports pickup booking. When disabled, slots are used only to validate a manually provided pickup time. Ignored if the service does not support pickup booking." }, "units" : { "$ref" : "#/components/schemas/Units", "description" : "Unit settings for weight, dimensions, and volume" } }, "required" : [ "documentRendering", "name" ] }, "LoadBearerRequest" : { "type" : "object", "description" : "Load bearer grouping shipments within a manifest", "properties" : { "group" : { "type" : "string", "description" : "Load bearer group", "example" : "Pallet", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "group" ] }, "ShippingQuoteResponse" : { "type" : "object", "description" : "Shipping quote for a delivery option", "properties" : { "id" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Shipping Quote", "example" : "019b45c5-6b7c-7000-92fd-6d6247de6372", "maxLength" : 36 }, "createdAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Shipping Quote was created", "example" : "2021-09-01T12:00:00+02:00", "maxLength" : 64 }, "updatedAt" : { "type" : "string", "format" : "date-time", "description" : "Timestamp when the Shipping Quote was last updated", "example" : "2021-09-01T12:00:00+02:00", "maxLength" : 64 }, "carrierDefinition" : { "$ref" : "#/components/schemas/CarrierDefinitionResponse", "description" : "Carrier definition" }, "checkoutId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Checkout", "example" : "9d9e7256-45f0-4906-9c3e-8f8fa7a8214e", "maxLength" : 36 }, "deliveryOptionId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Delivery Option", "example" : "019c2038-9e20-7000-8193-7c08db53a87f", "maxLength" : 36 }, "meta" : { "type" : "object", "additionalProperties" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : "Additional metadata", "example" : { "key1" : "value1", "key2" : "value2" } }, "parcels" : { "type" : "array", "description" : "Parcel information", "items" : { "$ref" : "#/components/schemas/ParcelResponse" }, "maxItems" : 1000 }, "parties" : { "type" : "array", "description" : "Address information", "items" : { "$ref" : "#/components/schemas/PartyResponse" }, "maxItems" : 1000 }, "persistence" : { "$ref" : "#/components/schemas/PersistenceResponse", "description" : "The persistence configuration of the entity." }, "rate" : { "$ref" : "#/components/schemas/ShippingQuoteResponseRate", "description" : "Shipping Quote rate" }, "serviceDefinition" : { "$ref" : "#/components/schemas/ServiceDefinitionResponse", "description" : "Service Definition" }, "units" : { "$ref" : "#/components/schemas/Units", "description" : "Unit settings for weight and dimensions" } } }, "ModeInfo" : { "type" : "object", "description" : "Carrier mode configuration and validations", "properties" : { "validations" : { "$ref" : "#/components/schemas/ModeValidations", "description" : "Validation rules for mode field" } } }, "ShipmentManifestListResponse" : { "type" : "object", "description" : "Paginated list of shipment manifests", "properties" : { "items" : { "type" : "array", "description" : "Shipment Manifests", "items" : { "$ref" : "#/components/schemas/ShipmentManifestResponse" }, "maxItems" : 1000 }, "nextCursor" : { "type" : "string", "format" : "uuid", "description" : "Cursor for fetching the next page of results", "example" : "01958a2d-b90d-7261-a795-000000000000", "maxLength" : 36 } } }, "References" : { "type" : "object", "description" : "Reference values for internal and external systems", "properties" : { "external" : { "type" : "string", "description" : "External reference value", "example" : "987654-321", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "internal" : { "type" : "string", "description" : "Internal reference value", "example" : "1234567-7890-12", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "PackingTypeValues" : { "type" : "object", "description" : "Allowed packing type value and its description", "properties" : { "description" : { "type" : "string", "description" : "Packing type value description", "example" : "Package", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "value" : { "type" : "string", "description" : "Packing type value", "example" : "PACKAGE", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "InfoParties" : { "type" : "object", "description" : "Party reference and handling instructions for a shipment", "properties" : { "reference" : { "type" : "string", "description" : "Party reference", "example" : "S-12345", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "instructions" : { "type" : "array", "description" : "Handling instructions for the party", "example" : [ "Leave parcel in reception" ], "items" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "maxItems" : 1000 } } }, "CustomDeclarationCharge" : { "type" : "object", "description" : "Charge types supported on a customs declaration", "properties" : { "supportsDuty" : { "type" : "boolean", "description" : "Indicates whether duty is supported", "example" : false }, "supportsFreight" : { "type" : "boolean", "description" : "Indicates whether freight is supported", "example" : false }, "supportsInsurance" : { "type" : "boolean", "description" : "Indicates whether insurance is supported", "example" : false }, "supportsInvoice" : { "type" : "boolean", "description" : "Indicates whether invoice is supported", "example" : false }, "supportsOther" : { "type" : "boolean", "description" : "Indicates whether other charges are supported", "example" : false } } }, "ShipmentBookingTerms" : { "type" : "object", "description" : "Trade terms code and location for the shipment", "properties" : { "code" : { "type" : "string", "description" : "The terms code", "example" : "DDP", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "location" : { "type" : "string", "description" : "The terms location", "example" : "Gothenburg", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } } }, "CommonCode" : { "type" : "object", "description" : "Code field with its validation rules", "properties" : { "validations" : { "$ref" : "#/components/schemas/CommonValidations", "description" : "Validation rules" } } }, "ShipmentManifestRequest" : { "type" : "object", "description" : "Request to create a shipment manifest", "properties" : { "reference" : { "type" : "string", "description" : "Shipment manifest reference", "example" : "S-12345", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "loadBearers" : { "type" : "array", "description" : "Load bearers for the manifest; the number of load bearers determines the number of manifest copies", "items" : { "$ref" : "#/components/schemas/LoadBearerRequest" }, "maxItems" : 1000 }, "persistence" : { "$ref" : "#/components/schemas/PersistenceRequest", "description" : "The persistence configuration of the entity." }, "shipmentChannelId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Shipment Channel", "maxLength" : 36 }, "type" : { "type" : "string", "description" : "Shipment manifest type", "maxLength" : 255, "minLength" : 1, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" } }, "required" : [ "shipmentChannelId", "type" ] }, "ShippingQuoteRequest" : { "type" : "object", "description" : "Request to create a shipping quote for a shipment", "properties" : { "carrierDefinitionId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Carrier Definition", "example" : "019ade48-9368-7577-990d-987fe9b34324", "maxLength" : 36 }, "checkoutId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Checkout", "example" : "9d9e7256-45f0-4906-9c3e-8f8fa7a8214e", "maxLength" : 36 }, "deliveryOptionId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Delivery Option", "example" : "019b266d-ee29-7000-824e-2a43c67c7ab0", "maxLength" : 36 }, "meta" : { "type" : "object", "additionalProperties" : { "type" : "string", "maxLength" : 255, "pattern" : "^[^\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F]*$" }, "description" : "Additional metadata", "example" : { "key1" : "value1", "key2" : "value2" } }, "parcelIds" : { "type" : "array", "description" : "Parcel information", "example" : [ "019beadd-e6df-7e4b-a0f6-54faf53e8f23", "019beadc-cee9-70b4-b880-55a84a0b6be6" ], "items" : { "type" : "string", "format" : "uuid", "maxLength" : 36 }, "maxItems" : 2147483647, "minItems" : 1 }, "parties" : { "type" : "array", "description" : "Address information", "items" : { "$ref" : "#/components/schemas/Party" }, "maxItems" : 2147483647, "minItems" : 2 }, "rate" : { "$ref" : "#/components/schemas/ShippingQuoteRequestRate", "description" : "Shipping Quote rate" }, "serviceDefinitionId" : { "type" : "string", "format" : "uuid", "description" : "Identifies the Service Definition", "example" : "01991a00-07b3-7171-a245-177e15965608", "maxLength" : 36 }, "units" : { "$ref" : "#/components/schemas/Units", "description" : "Unit settings for weight and dimensions" } }, "required" : [ "carrierDefinitionId", "parcelIds", "parties", "rate", "serviceDefinitionId" ] } }, "securitySchemes" : { "AdminToken" : { "type" : "http", "description" : "Bearer token issued by /admins/tokens. Grants access to admin-level endpoints. The token is a JWS conforming to the JWT Best Current Practices (RFC8725).", "scheme" : "bearer", "bearerFormat" : "JWT" }, "ClientCredentials" : { "type" : "oauth2", "description" : "OAuth 2.0 client-credentials grant: the client authenticates with HTTP Basic credentials at a token endpoint (RFC6749 §2.3.1) to mint a short-lived bearer token — /admins/tokens, /affiliates/tokens, /companies/{company-id}/tokens, or /accounts/{account-id}/tokens. The token is a JWS conforming to the JWT Best Current Practices (RFC8725).", "flows" : { "clientCredentials" : { "tokenUrl" : "/v1/admins/tokens", "refreshUrl" : "/v1/admins/tokens", "scopes" : { } } } }, "AffiliateToken" : { "type" : "http", "description" : "Bearer token issued by /affiliates/tokens. Grants access to affiliate-level endpoints. The token is a JWS conforming to the JWT Best Current Practices (RFC8725).", "scheme" : "bearer", "bearerFormat" : "JWT" }, "webhookSignatureAuth" : { "type" : "apiKey", "description" : "HMAC-SHA256 signature of the raw request body, computed with the shared secret configured on the Event Channel's webhook. Subscribers must recompute the signature over the exact bytes received and compare it to this header to verify authenticity and integrity before processing the event.", "name" : "X-Nshift-Signature", "in" : "header" }, "CompanyToken" : { "type" : "http", "description" : "Bearer token issued by /companies/{company-id}/tokens. Grants access to company-level endpoints. The token is a JWS conforming to the JWT Best Current Practices (RFC8725).", "scheme" : "bearer", "bearerFormat" : "JWT" }, "AccountToken" : { "type" : "http", "description" : "Bearer token issued by /accounts/{account-id}/tokens. Grants access to account-level endpoints. The token is a JWS conforming to the JWT Best Current Practices (RFC8725).", "scheme" : "bearer", "bearerFormat" : "JWT" } } }, "webhooks" : { "EVENT_CHANNEL" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a EVENT_CHANNEL event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a EVENT_CHANNEL event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the EVENT_CHANNEL topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "EVENT_CHANNEL", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "EVENT_CHANNEL", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "SHIPMENT_CHANNEL" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a SHIPMENT_CHANNEL event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a SHIPMENT_CHANNEL event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the SHIPMENT_CHANNEL topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "SHIPMENT_CHANNEL", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "SHIPMENT_CHANNEL", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "CARRIER_DEFINITION" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a CARRIER_DEFINITION event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a CARRIER_DEFINITION event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the CARRIER_DEFINITION topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "CARRIER_DEFINITION", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "CARRIER_DEFINITION", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "SHIPPING_QUOTE" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a SHIPPING_QUOTE event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a SHIPPING_QUOTE event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the SHIPPING_QUOTE topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "SHIPPING_QUOTE", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "SHIPPING_QUOTE", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "CARRIER_MONITOR" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a CARRIER_MONITOR event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a CARRIER_MONITOR event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the CARRIER_MONITOR topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "CARRIER_MONITOR", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "CARRIER_MONITOR", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "ZONE" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a ZONE event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a ZONE event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the ZONE topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "ZONE", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "ZONE", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "CARRIER" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a CARRIER event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a CARRIER event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the CARRIER topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "CARRIER", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "CARRIER", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "DANGEROUS_GOODS_DECLARATION" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a DANGEROUS_GOODS_DECLARATION event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a DANGEROUS_GOODS_DECLARATION event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the DANGEROUS_GOODS_DECLARATION topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "DANGEROUS_GOODS_DECLARATION", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "DANGEROUS_GOODS_DECLARATION", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "ACCOUNT" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a ACCOUNT event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a ACCOUNT event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the ACCOUNT topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "ACCOUNT", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "ACCOUNT", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "SHIPMENT_MANIFEST" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a SHIPMENT_MANIFEST event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a SHIPMENT_MANIFEST event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the SHIPMENT_MANIFEST topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "SHIPMENT_MANIFEST", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "SHIPMENT_MANIFEST", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "DOCUMENT" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a DOCUMENT event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a DOCUMENT event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the DOCUMENT topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "DOCUMENT", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "DOCUMENT", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "PARCEL_ITEM" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a PARCEL_ITEM event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a PARCEL_ITEM event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the PARCEL_ITEM topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "PARCEL_ITEM", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "PARCEL_ITEM", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "SERVICE" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a SERVICE event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a SERVICE event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the SERVICE topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "SERVICE", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "SERVICE", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "SHIPMENT_BOOKING" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a SHIPMENT_BOOKING event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a SHIPMENT_BOOKING event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the SHIPMENT_BOOKING topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "SHIPMENT_BOOKING", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "SHIPMENT_BOOKING", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "DELIVERY_OPTION" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a DELIVERY_OPTION event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a DELIVERY_OPTION event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the DELIVERY_OPTION topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "DELIVERY_OPTION", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "DELIVERY_OPTION", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "CUSTOMS_DECLARATION" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a CUSTOMS_DECLARATION event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a CUSTOMS_DECLARATION event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the CUSTOMS_DECLARATION topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "CUSTOMS_DECLARATION", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "CUSTOMS_DECLARATION", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "COMPANY" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a COMPANY event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a COMPANY event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the COMPANY topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "COMPANY", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "COMPANY", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "SHIPMENT_DISPATCH" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a SHIPMENT_DISPATCH event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a SHIPMENT_DISPATCH event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the SHIPMENT_DISPATCH topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "SHIPMENT_DISPATCH", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "SHIPMENT_DISPATCH", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "PUDO_POINT" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a PUDO_POINT event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a PUDO_POINT event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the PUDO_POINT topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "PUDO_POINT", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "PUDO_POINT", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "PARCEL" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a PARCEL event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a PARCEL event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the PARCEL topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "PARCEL", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "PARCEL", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "CARRIER_RATE" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a CARRIER_RATE event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a CARRIER_RATE event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the CARRIER_RATE topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "CARRIER_RATE", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "CARRIER_RATE", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "TRACKER" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a TRACKER event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a TRACKER event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the TRACKER topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "TRACKER", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "TRACKER", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "CARRIER_STATUS" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a CARRIER_STATUS event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a CARRIER_STATUS event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the CARRIER_STATUS topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "CARRIER_STATUS", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "CARRIER_STATUS", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "ADDRESS" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a ADDRESS event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a ADDRESS event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the ADDRESS topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "ADDRESS", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "ADDRESS", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } }, "SERVICE_DEFINITION" : { "post" : { "tags" : [ "Webhooks" ], "summary" : "Delivery of a SERVICE_DEFINITION event", "description" : "nShift Go POSTs a GoEventEnvelope to the subscriber's configured webhook URL when a SERVICE_DEFINITION event occurs on a subscribed Event Channel.", "requestBody" : { "description" : "Event envelope delivered to the subscriber's webhook endpoint for the SERVICE_DEFINITION topic.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GoEventEnvelope" }, "example" : { "eventId" : "00000000-0000-7000-8000-000000000001", "correlationId" : "00000000-0000-7000-8000-000000000002", "topic" : "SERVICE_DEFINITION", "type" : "CREATE", "entityId" : "00000000-0000-7000-8000-000000000000", "entityType" : "SERVICE_DEFINITION", "occurredAt" : "2024-01-01T12:00:00.000Z" } } }, "required" : true }, "responses" : { "2XX" : { "description" : "Any 2XX response is treated as a successful delivery." } }, "security" : [ { "webhookSignatureAuth" : [ ] } ] } } } }