{"items":[{"type":"link","label":"Order Management APIs","link":"/openapi/ordermanagement","routeSlug":"/openapi/ordermanagement","content":{"contentType":"overview","meta":{"name":"Order Management APIs"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"ordermanagement.json","url":"/_bundle/openapi/ordermanagement.json?download"},{"kind":"download","label":"ordermanagement.yaml","url":"/_bundle/openapi/ordermanagement.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"PB Software License Agreement","url":"https://www.pitneybowes.com/us/support/account/pitney-bowes-terms-and-conditions.html"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Order Management APIs (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Management APIs provide capabilities to create, retrieve, update, search, and delete orders throughout the order lifecycle. These APIs support order processing by allowing you to manage customer, item, pricing, shipping, workflow status, and tagging information in a consistent way."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The APIs support the following services:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new order with customer, item, pricing, and shipping details"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve complete order details by order ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partially update an existing order"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update workflow status for multiple orders"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete an order or remove specific order items"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search orders using filter-based criteria"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add, update, or remove tags for single or multiple orders"},"children":[]}]}]}]}]}],"sectionId":"/openapi/ordermanagement"}],"sectionId":"/openapi/ordermanagement"}]}]}},{"type":"group","label":"Order","link":"/openapi/ordermanagement/order","routeSlug":"/openapi/ordermanagement/order","items":[{"label":"Create Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordermanagement/order/createorder","routeSlug":"/openapi/ordermanagement/order/createorder","metadata":{"seo":{"title":"Create Order","description":"This operation creates a new order in the Order Management System. This API accepts customer details, item information, pricing, and shipping-related data and generates a unique order identifier. The created order is initialized in an unfulfilled state and can be updated or progressed through subsequent OMS operations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrder","name":"Create Order","isWebhook":false,"pointer":"/paths/~1api~1v1~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation creates a new order in the Order Management System. This API accepts customer details, item information, pricing, and shipping-related data and generates a unique order identifier. The created order is initialized in an unfulfilled state and can be updated or progressed through subsequent OMS operations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isLTL","in":"query","schemaId":"schema_301","description":"This is the query parameter used to indicate whether the order being created is a Less-Than-Truckload (LTL) order. If set to true, the order will be processed as an LTL shipment, If not provided or set to false, the order will be processed as a standard parcel shipment.\n"}],"pointer":"/paths/~1api~1v1~1orders/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-LocationId","in":"header","schemaId":"schema_302","description":"This is the Location ID assigned based on the developer's and partner's parsed locations. If it is not provided, no Location ID is applied.\n"}],"pointer":"/paths/~1api~1v1~1orders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_303"}},"schemaId":"schema_303","pointer":"/paths/~1api~1v1~1orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/orders","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[{"name":"isLTL","in":"query","required":false,"schemaId":"schema_301"}],"querystring":[],"header":[{"name":"X-PB-LocationId","in":"header","required":false,"schemaId":"schema_302"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_303"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/orders","href":"order/createorder","openApiOperationId":"createOrder","summary":"Create Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"schema_303","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_303"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Order has been created Successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateOrderResponse"}},"schemaId":"components/schemas/CreateOrderResponse"},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateOrderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateOrderResponse"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/createorder"}],"panels":[]}]},"httpPath":"/api/v1/orders"},{"label":"Get Order by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordermanagement/order/getorderbyid","routeSlug":"/openapi/ordermanagement/order/getorderbyid","metadata":{"seo":{"title":"Get Order by ID","description":"This operation retrives the complete details of a specific order using its unique orderId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrderById","name":"Get Order by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1orders~1{orderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Order by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation retrives the complete details of a specific order using its unique orderId."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all order-related information for tracking or reporting."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify order contents and financials before fulfillment."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_302","description":"Unique identifier for the order.","required":true}],"pointer":"/paths/~1api~1v1~1orders~1{orderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/orders/{orderId}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/api/v1/orders/{orderId}","href":"order/getorderbyid","openApiOperationId":"getOrderById","summary":"Get Order by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order details retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_304"}},"schemaId":"schema_304"},{"code":"401","description":"The request could not be authorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}},"schemaId":"components/schemas/notFoundErrors"},{"code":"500","description":"The request could not be completed due to an internal error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1orders~1{orderId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_304","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_304"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"404","schemaId":"components/schemas/notFoundErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/getorderbyid"}],"panels":[]}]},"httpPath":"/api/v1/orders/{orderId}"},{"label":"Delete Order by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordermanagement/order/deleteorderbyid","routeSlug":"/openapi/ordermanagement/order/deleteorderbyid","metadata":{"seo":{"title":"Delete Order by ID","description":"This operation performs a soft delete of an order identified by orderId. The order is marked as deleted and is no longer available for processing or fulfillment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrderById","name":"Delete Order by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1orders~1{orderId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Order by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation performs a soft delete of an order identified by orderId. The order is marked as deleted and is no longer available for processing or fulfillment"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_302","description":"Unique identifier for the order","required":true}],"pointer":"/paths/~1api~1v1~1orders~1{orderId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/orders/{orderId}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/api/v1/orders/{orderId}","href":"order/deleteorderbyid","openApiOperationId":"deleteOrderById","summary":"Delete Order by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The specified order has been deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteOrderResponse"}},"schemaId":"components/schemas/DeleteOrderResponse"},{"code":"401","description":"The request could not be authorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}},"schemaId":"components/schemas/notFoundErrors"},{"code":"500","description":"The request could not be completed due to an internal error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1orders~1{orderId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteOrderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteOrderResponse"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"404","schemaId":"components/schemas/notFoundErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/deleteorderbyid"}],"panels":[]}]},"httpPath":"/api/v1/orders/{orderId}"},{"label":"Partial Order Update by OrderId","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordermanagement/order/partialupdateorderbyid","routeSlug":"/openapi/ordermanagement/order/partialupdateorderbyid","metadata":{"seo":{"title":"Partial Order Update by OrderId","description":"This operation updates one or more fields of an existing order.This API is used to modify order data after creation, such as adding items or updating order-level information, without replacing the entire order record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"partialUpdateOrderById","name":"Partial Order Update by OrderId","isWebhook":false,"pointer":"/paths/~1api~1v1~1orders~1{orderId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partial Order Update by OrderId","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation updates one or more fields of an existing order.This API is used to modify order data after creation, such as adding items or updating order-level information, without replacing the entire order record."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_302","description":"Unique identifier for the order","required":true}],"pointer":"/paths/~1api~1v1~1orders~1{orderId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateOrderRequest"}},"schemaId":"components/schemas/UpdateOrderRequest","pointer":"/paths/~1api~1v1~1orders~1{orderId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/orders/{orderId}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateOrderRequest"}},"responseCodes":["200","400","401","404","500"],"pointer":"/api/v1/orders/{orderId}","href":"order/partialupdateorderbyid","openApiOperationId":"partialUpdateOrderById","summary":"Partial Order Update by OrderId"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/UpdateOrderRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateOrderRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order updated successfully (partial)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PartialUpdateOrderResponse"}},"schemaId":"components/schemas/PartialUpdateOrderResponse"},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}},"schemaId":"components/schemas/notFoundErrors"},{"code":"500","description":"The request could not be completed due to an internal error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1orders~1{orderId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PartialUpdateOrderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PartialUpdateOrderResponse"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"404","schemaId":"components/schemas/notFoundErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/partialupdateorderbyid"}],"panels":[]}]},"httpPath":"/api/v1/orders/{orderId}"},{"label":"Update Bulk Orders Status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordermanagement/order/updateorderbyid","routeSlug":"/openapi/ordermanagement/order/updateorderbyid","metadata":{"seo":{"title":"Update Bulk Orders Status","description":"This API is used to Updates the status of multiple orders in a single request such as UNFULFILLED, ONHOLD, FULFILLED, or CANCELED, based on business or fulfillment actions. Use this API to apply the same status change to more than one order at once."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOrderById","name":"Update Bulk Orders Status","isWebhook":false,"pointer":"/paths/~1api~1v1~1orders~1bulk~1status/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Bulk Orders Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This API is used to Updates the status of multiple orders in a single request such as UNFULFILLED, ONHOLD, FULFILLED, or CANCELED, based on business or fulfillment actions. Use this API to apply the same status change to more than one order at once."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateOrderStatusRequest"}},"schemaId":"components/schemas/UpdateOrderStatusRequest","pointer":"/paths/~1api~1v1~1orders~1bulk~1status/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/orders/bulk/status","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateOrderStatusRequest"}},"responseCodes":["200","400","401","404","500"],"pointer":"/api/v1/orders/bulk/status","href":"order/updateorderbyid","openApiOperationId":"updateOrderById","summary":"Update Bulk Orders Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/UpdateOrderStatusRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateOrderStatusRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order status updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateOrderStatusResponse"}},"schemaId":"components/schemas/UpdateOrderStatusResponse"},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}},"schemaId":"components/schemas/notFoundErrors"},{"code":"500","description":"The request could not be completed due to an internal error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1orders~1bulk~1status/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateOrderStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateOrderStatusResponse"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"404","schemaId":"components/schemas/notFoundErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/updateorderbyid"}],"panels":[]}]},"httpPath":"/api/v1/orders/bulk/status"},{"label":"Delete Order Item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordermanagement/order/deleteorderitem","routeSlug":"/openapi/ordermanagement/order/deleteorderitem","metadata":{"seo":{"title":"Delete Order Item","description":"Deletes a specific item from an order using its SKU. This operation is used when an item is removed before fulfillment due to order changes or corrections."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrderItem","name":"Delete Order Item","isWebhook":false,"pointer":"/paths/~1api~1v1~1orders~1{orderId}~1items/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Order Item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a specific item from an order using its SKU. This operation is used when an item is removed before fulfillment due to order changes or corrections."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_302","description":"Unique identifier for the order","required":true}],"pointer":"/paths/~1api~1v1~1orders~1{orderId}~1items/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"itemId","in":"query","schemaId":"schema_302","description":"SKU of the item to be deleted.","required":true}],"pointer":"/paths/~1api~1v1~1orders~1{orderId}~1items/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/orders/{orderId}/items","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_302"}],"query":[{"name":"itemId","in":"query","required":true,"schemaId":"schema_302"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/api/v1/orders/{orderId}/items","href":"order/deleteorderitem","openApiOperationId":"deleteOrderItem","summary":"Delete Order Item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Item deleted successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteOrderItemResponse"}},"schemaId":"components/schemas/DeleteOrderItemResponse"},{"code":"401","description":"The request could not be authorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}},"schemaId":"components/schemas/notFoundErrors"},{"code":"500","description":"The request could not be completed due to an internal error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1orders~1{orderId}~1items/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteOrderItemResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteOrderItemResponse"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"404","schemaId":"components/schemas/notFoundErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/deleteorderitem"}],"panels":[]}]},"httpPath":"/api/v1/orders/{orderId}/items"},{"label":"Search Orders by OrderID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordermanagement/order/searchorders","routeSlug":"/openapi/ordermanagement/order/searchorders","metadata":{"seo":{"title":"Search Orders by OrderID","description":"This operation returns a list of orders that match the provided search criteria."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchOrders","name":"Search Orders by OrderID","isWebhook":false,"pointer":"/paths/~1api~1v1~1orders~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Orders by OrderID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation returns a list of orders that match the provided search criteria.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchRequest"}},"schemaId":"components/schemas/SearchRequest","pointer":"/paths/~1api~1v1~1orders~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/orders/search","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SearchRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/orders/search","href":"order/searchorders","openApiOperationId":"searchOrders","summary":"Search Orders by OrderID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"components/schemas/SearchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Requested order has been retrived sucessfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchOrdersResponse"}},"schemaId":"components/schemas/SearchOrdersResponse"},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}},"schemaId":"components/schemas/invalidErrors"},{"code":"401","description":"The request could not be authorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"500","description":"The request could not be completed due to an internal error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1orders~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchOrdersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchOrdersResponse"}}},{"code":"400","schemaId":"components/schemas/invalidErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invalidErrors"}}},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/searchorders"}],"panels":[]}]},"httpPath":"/api/v1/orders/search"}],"content":{"contentType":"group","meta":{"name":"Order"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order","showPageActions":true},{"nodeType":"markdoc","content":"APIs to create, retrieve, update, search, and delete orders, and to manage order items and workflow status throughout the order lifecycle."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/orders","summary":"Create Order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order/createorder","deprecated":false},{"title":"/api/v1/orders/{orderId}","summary":"Get Order by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order/getorderbyid","deprecated":false},{"title":"/api/v1/orders/{orderId}","summary":"Delete Order by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order/deleteorderbyid","deprecated":false},{"title":"/api/v1/orders/{orderId}","summary":"Partial Order Update by OrderId","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/order/partialupdateorderbyid","deprecated":false},{"title":"/api/v1/orders/bulk/status","summary":"Update Bulk Orders Status","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/order/updateorderbyid","deprecated":false},{"title":"/api/v1/orders/{orderId}/items","summary":"Delete Order Item","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order/deleteorderitem","deprecated":false},{"title":"/api/v1/orders/search","summary":"Search Orders by OrderID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order/searchorders","deprecated":false}]}]}]}]}},{"type":"group","label":"Tags","link":"/openapi/ordermanagement/tags","routeSlug":"/openapi/ordermanagement/tags","items":[{"label":"Update Tags for an Order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordermanagement/tags/updatetags","routeSlug":"/openapi/ordermanagement/tags/updatetags","metadata":{"seo":{"title":"Update Tags for an Order","description":"This operation is used to create, update or remove tags associated with a specific order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTags","name":"Update Tags for an Order","isWebhook":false,"pointer":"/paths/~1api~1v1~1orders~1{orderId}~1tags/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Tags for an Order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is used to create, update or remove tags associated with a specific order."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create or update tags, provide one or more values in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tagIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To remove previously assigned tags, provide an empty array for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tagIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v1~1orders~1{orderId}~1tags/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_306"}},"schemaId":"schema_306","pointer":"/paths/~1api~1v1~1orders~1{orderId}~1tags/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/orders/{orderId}/tags","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_305"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_306"}},"responseCodes":["200","401","404","500"],"pointer":"/api/v1/orders/{orderId}/tags","href":"tags/updatetags","openApiOperationId":"updateTags","summary":"Update Tags for an Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"schema_306","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_306"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The specified tag has been updated with the order."},{"code":"401","description":"The request could not be authorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}},"schemaId":"components/schemas/notFoundErrors"},{"code":"500","description":"The request could not be completed due to an internal error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1orders~1{orderId}~1tags/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"404","schemaId":"components/schemas/notFoundErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/updatetags"}],"panels":[]}]},"httpPath":"/api/v1/orders/{orderId}/tags"},{"label":"Update Tags for Bulk Orders","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordermanagement/tags/bulkupdatetags","routeSlug":"/openapi/ordermanagement/tags/bulkupdatetags","metadata":{"seo":{"title":"Update Tags for Bulk Orders","description":"This operation creates, updates, or removes tags for multiple orders in a single request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkUpdateTags","name":"Update Tags for Bulk Orders","isWebhook":false,"pointer":"/paths/~1api~1v1~1orders~1bulkTags/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Tags for Bulk Orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation creates, updates, or removes tags for multiple orders in a single request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create or update tags for bulk orders, provide one or more values in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tagIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To remove previously assigned tags for an specified order, provide an empty array for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tagIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_307"}},"schemaId":"schema_307","pointer":"/paths/~1api~1v1~1orders~1bulkTags/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/orders/bulkTags","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_307"}},"responseCodes":["200","401","404","500"],"pointer":"/api/v1/orders/bulkTags","href":"tags/bulkupdatetags","openApiOperationId":"bulkUpdateTags","summary":"Update Tags for Bulk Orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}],"schemaId":"schema_307","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_307"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The specified tags have been updated with the order."},{"code":"401","description":"The request could not be authorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}},"schemaId":"components/schemas/unauthorizedError"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}},"schemaId":"components/schemas/notFoundErrors"},{"code":"500","description":"The request could not be completed due to an internal error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}},"schemaId":"components/schemas/serverError"}],"pointer":"/paths/~1api~1v1~1orders~1bulkTags/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/unauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/unauthorizedError"}}},{"code":"404","schemaId":"components/schemas/notFoundErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notFoundErrors"}}},{"code":"500","schemaId":"components/schemas/serverError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/serverError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/bulkupdatetags"}],"panels":[]}]},"httpPath":"/api/v1/orders/bulkTags"}],"content":{"contentType":"group","meta":{"name":"Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tags","showPageActions":true},{"nodeType":"markdoc","content":"APIs to create, update, and remove tags for single or multiple orders."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/orders/{orderId}/tags","summary":"Update Tags for an Order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tags/updatetags","deprecated":false},{"title":"/api/v1/orders/bulkTags","summary":"Update Tags for Bulk Orders","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tags/bulkupdatetags","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/unauthorizedError":{"id":"components/schemas/unauthorizedError","kind":"json-schema","title":"unauthorizedError","data":{"type":"object","properties":{"errorCode":{"type":"string","example":"unauthorized_error","description":"Error code representing the unauthorized access error."},"message":{"type":"string","description":"This is HTTP 401 Unauthorized response status code, which indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.","example":"Unauthorized access. Valid authentication credentials are required."},"additionalInfo":{"type":"string","example":"Client request lacks valid authentication credentials.","description":"Additional information about the unauthorized error."}},"required":["errorCode","message"]}},"components/schemas/serverError":{"id":"components/schemas/serverError","kind":"json-schema","title":"serverError","data":{"type":"object","properties":{"errorCode":{"type":"string","example":"internal_server_error","description":"Error code representing the internal server error."},"message":{"type":"string","description":"This is HTTP 500 Internal Server Error response status code, which indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.","example":"A system error occurred. Please try again later."},"additionalInfo":{"type":"string","example":"Unexpected condition occurred on the server while processing the request.","description":"Additional information about the server error."}},"required":["errorCode","message"]}},"components/schemas/invalidErrors":{"id":"components/schemas/invalidErrors","kind":"json-schema","title":"invalidErrors","data":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code(s) that appear due to HTTP  400- Invalid or Bad Request, e.g., validation-error.","example":"INVALID_REQUEST"},"errorDescription":{"type":"string","description":"The HTTP 400 Bad Request response status code indicates that the server cannot process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","example":"Error decoding request body"},"additionalCode":{"type":"string","description":"A unique identifier for the error, for example ILP10010, or ILP10030.","example":"0100054"},"additionalInfo":{"type":"string","description":"This is an additional information about the error. This error 'Invalid Request' might appear due to invalid data, or if the information is missing.","example":"Invalid or missing required fields in the request payload"}}}}},"components/schemas/notFoundErrors":{"id":"components/schemas/notFoundErrors","kind":"json-schema","title":"notFoundErrors","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","example":"NOT_FOUND"},"errorDescription":{"type":"string","example":"order not found"}}}}}}},"components/schemas/packageNotFoundErrors":{"id":"components/schemas/packageNotFoundErrors","kind":"json-schema","title":"packageNotFoundErrors","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","example":"NOT_FOUND"},"errorDescription":{"type":"string","example":"Package with ID PB4807663 not found."}}}}}}},"components/schemas/shipmentNotFoundErrors":{"id":"components/schemas/shipmentNotFoundErrors","kind":"json-schema","title":"shipmentNotFoundErrors","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","example":"not_found"},"errorDescription":{"type":"string","example":"Document [PBJ4UK] not found"}}}}}}},"components/schemas/errors":{"id":"components/schemas/errors","kind":"json-schema","title":"errors","data":{"type":"array","description":"List of errors (if any) that occurred during order creation/processing.","items":{"properties":{"errorCode":{"type":"string","description":"Unique code identifying the error type.","example":"ERR001"},"errorDescription":{"type":"string","description":"Detailed description of the error.","example":"Invalid shipping address."},"additionalInfo":{"type":"string","description":"Extra details about the error, if available.","example":"The postal code provided does not match the city."},"additionalParameters":{"type":"array","description":"Optional list of additional parameters or context values related to the error.","items":{"type":"string","example":["city=Athens","postalCode=00000"]}}}}}},"components/schemas/CreateOrderRequest":{"id":"components/schemas/CreateOrderRequest","kind":"json-schema","title":"Order Request","data":{"title":"Order Request","type":"object","required":["orderNumber","toAddress","itemId"],"properties":{"orderNumber":{"type":"string","description":"The unique identifier for the order. The maximum supported length is 50 characters.","example":"ORD12346"},"orderMessage":{"type":"object","description":"An optional message added to an order, such as a gift note or a short greeting.\n","properties":{"type":{"type":"string","description":"The type for the message.","enum":["ANNIVERSARY","BIRTHDAY","GIFT"],"example":"GIFT"},"message":{"type":"string","description":"The message text shown with the order.\nMaximum length is 200 characters.\n","maxLength":200,"example":"Happy Birthday! Enjoy your gift."}}},"metadata":{"type":"array","description":"Additional metadata that needs to be stored for this order can be added here.","items":{"type":"object","properties":{"name":{"type":"string","example":"costAccountName"},"value":{"type":"string","example":"cost account 123"}}},"example":[{"name":"costAccountName","value":"costAccountName12"},{"name":"costAccountId","value":"costAccountId12"},{"name":"costAccountCode","value":"Code12"}]},"charges":{"$ref":"#/components/schemas/Charges"},"shippingReference":{"$ref":"#/components/schemas/ShippingReferences"},"customerInfo":{"type":"object","description":"End customer (buyer) profile for communication.","properties":{"firstName":{"type":"string","description":"First name of the customer.","example":"John"},"lastName":{"type":"string","description":"Last name of the customer.","example":"Doe"},"email":{"type":"string","description":"Buyer email","example":"john.doe@example.com"},"customerId":{"type":"string","description":"Your CRM/customer key.","example":"CUST12345"}}},"fromAddress":{"description":"The address from where the order is generated. While creating an order, fromAddress is conditionally optional.","allOf":[{"$ref":"#/components/schemas/Address"},{"example":{"name":"Warehouse A","company":"Company Name","addressLine1":"638 Manitoba Ave","addressLine2":"Apt 4B","cityTown":"Winnipeg","stateProvince":"MB","postalCode":"R2W 2H2","countryCode":"CA","phone":"1234567890","email":"warehouse@email.com","residential":false}}]},"toAddress":{"description":"The address where the order is destined to.","allOf":[{"$ref":"#/components/schemas/Address"},{"example":{"name":"Jane Smith","company":"Company ABC","addressLine1":"1822 Franklin Street","addressLine2":"3010 Summer Street","cityTown":"Vancouver","stateProvince":"BC","postalCode":"V5L 1P8","countryCode":"CA","phone":"9876543210","email":"jane.smith@email.com","residential":true}}]},"items":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of items in the order. To create an order, minimum one item is required. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: Either use customsProductId or item properties individually."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/Item"}},"additionalAddresses":{"allOf":[{"$ref":"#/components/schemas/additionalAddresses"},{"example":[{"address":{"addressLine1":"638 Manitoba Ave","cityTown":"Winnipeg","countryCode":"CA","name":"billing name","phone":"203-555-1213","postalCode":"R2W 2H2","company":"Pitney Bowes Inc.","stateProvince":"MB"},"addressType":"BILLING"}]}]},"shippingPreferences":{"allOf":[{"$ref":"#/components/schemas/ShippingPreferences"},{"type":"object","properties":{"dateOfShipment":{"type":"string","format":"date","description":"Planned shipment date for the order.","example":"2026-01-30"}}}]}}}},"components/schemas/CreateLTLOrderRequest":{"id":"components/schemas/CreateLTLOrderRequest","kind":"json-schema","title":"LTL Order Request","data":{"title":"LTL Order Request","type":"object","required":["orderNumber","toAddress","shippingPreferences"],"properties":{"orderNumber":{"type":"string","description":"The unique identifier for the LTL order. The maximum supported length is 50 characters.","example":"ORD-F-ORD12832p"},"orderMessage":{"type":"object","description":"An optional message added to an order, such as a gift note or short greeting.","properties":{"type":{"type":"string","description":"The type of message.","enum":["ANNIVERSARY","BIRTHDAY","GIFT"],"example":"GIFT"},"message":{"type":"string","description":"The message text shown with the order. Maximum length is 200 characters.","maxLength":200,"example":"Happy Birthday!"}}},"customerInfo":{"type":"object","description":"End customer profile for communication.","properties":{"firstName":{"type":"string","example":"John"},"lastName":{"type":"string","example":"Doe"},"email":{"type":"string","example":"john.doe@example.com"},"customerId":{"type":"string","example":"CUST12345"}}},"fromAddress":{"description":"The address from where the LTL order is generated.","allOf":[{"$ref":"#/components/schemas/Address"},{"example":{"name":"Warehouse A","company":"Company XYZ","addressLine1":"638 Manitoba Ave","cityTown":"Winnipeg","stateProvince":"MB","postalCode":"R2W 2H2","countryCode":"CA","phone":"1234567890","email":"warehouse@example.com","residential":false}}]},"toAddress":{"description":"The destination address for the LTL order.","allOf":[{"$ref":"#/components/schemas/Address"},{"example":{"name":"Jane Smith","company":"Company ABC","addressLine1":"1822 Franklin Street","cityTown":"Vancouver","stateProvince":"BC","postalCode":"V5L 1P8","countryCode":"CA","phone":"9876543210","email":"jane.smith@example.com","residential":true}}]},"additionalAddresses":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional addresses associated with the LTL shipment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported address types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FREIGHT_FORWARDER: Address of the freight forwarding company responsible for arranging transportation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ULTIMATE_CONSIGNEE: Final recipient or end party receiving the goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"THIRD_PARTY: Address of a third-party entity responsible for billing or payment."},"children":[]}]}]}]}],"allOf":[{"$ref":"#/components/schemas/additionalAddresses"},{"example":[{"address":{"addressLine1":"638 Manitoba Ave","cityTown":"Winnipeg","countryCode":"CA","name":"billing name","phone":"203-555-1213","postalCode":"R2W 2H2","company":"Pitney Bowes Inc.","stateProvince":"MB"},"addressType":"FREIGHT_FORWARDER"}]}]},"charges":{"$ref":"#/components/schemas/Charges"},"shippingReference":{"$ref":"#/components/schemas/ShippingReferences"},"metadata":{"type":"array","description":"Additional metadata that needs to be stored for this order.","items":{"type":"object","properties":{"name":{"type":"string","example":"costAccountName"},"value":{"type":"string","example":"costAccountName12"}}}},"shippingPreferences":{"$ref":"#/components/schemas/LTLShippingPreferences"}}}},"components/schemas/UpdateOrderRequest":{"id":"components/schemas/UpdateOrderRequest","kind":"json-schema","title":"UpdateOrderRequest","data":{"type":"object","properties":{"orderNumber":{"type":"string","description":"The unique identifier for the order. The maximum supported length is 50 characters.","example":"ORD12346"},"orderMessage":{"type":"object","description":"An optional message added to an order, such as a gift note or a short greeting.\n","properties":{"type":{"type":"string","description":"The type for the message.","enum":["ANNIVERSARY","BIRTHDAY","GIFT"],"example":"GIFT"},"message":{"type":"string","description":"The message text shown with the order.\nMaximum length is 200 characters.\n","maxLength":200,"example":"Happy Birthday! Enjoy your gift."}}},"charges":{"$ref":"#/components/schemas/Charges"},"shippingReference":{"$ref":"#/components/schemas/ShippingReferences"},"customerInfo":{"type":"object","description":"End customer (buyer) profile for communication.","properties":{"firstName":{"type":"string","description":"First name of the customer.","example":"John"},"lastName":{"type":"string","description":"Last name of the customer.","example":"Doe"},"email":{"type":"string","description":"Buyer email","example":"john.doe@example.com"},"customerId":{"type":"string","description":"Your CRM/customer key.","example":"CUST12345"}}},"fromAddress":{"description":"The address from where the order is generated.","allOf":[{"$ref":"#/components/schemas/Address"},{"example":{"name":"Warehouse A","company":"Company Name","addressLine1":"638 Manitoba Ave","addressLine2":"Apt 4B","cityTown":"Winnipeg","stateProvince":"MB","postalCode":"R2W 2H2","countryCode":"CA","phone":"1234567890","email":"warehouse@email.com","residential":false}}]},"toAddress":{"description":"The address where the order is destined to.","allOf":[{"$ref":"#/components/schemas/Address"},{"example":{"name":"Jane Smith","company":"Company ABC","addressLine1":"1822 Franklin Street","addressLine2":"3010 Summer Street","cityTown":"Vancouver","stateProvince":"BC","postalCode":"V5L 1P8","countryCode":"CA","phone":"9876543210","email":"jane.smith@email.com","residential":true}}]},"items":{"type":"array","description":"List of items in the order. To create an order, minimum one item is required.","items":{"$ref":"#/components/schemas/Item"}},"shippingPreferences":{"$ref":"#/components/schemas/ShippingPreferences"},"dateOfShipment":{"type":"string","format":"date","description":"Planned shipment date for the order.","example":"2026-01-30"}}}},"components/schemas/LTLShippingPreferences":{"id":"components/schemas/LTLShippingPreferences","kind":"json-schema","title":"LTLShippingPreferences","data":{"type":"object","properties":{"carrier":{"type":"string","description":"Carrier used for the LTL shipment.","example":"PUROLATORFREIGHT"},"service":{"type":"string","description":"Service code used for the LTL shipment.","example":"S"},"shipmentOptions":{"type":"object","description":"Additional shipment options supported by the carrier.","properties":{"additionalShipmentOptions":{"type":"array","description":"List of carrier-specific shipment options.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the shipment option.","example":"PICKUP_LOCATION_TYPE"},"value":{"type":"string","description":"Value associated with the shipment option.","example":"AIRPORT_LOCATION_TYPE"}}},"example":[{"name":"PICKUP_LOCATION_TYPE","value":"AIRPORT_LOCATION_TYPE"},{"name":"DELIVERY_LOCATION_TYPE","value":"FARM_LOCATION_TYPE"}]}}},"specialServices":{"type":"array","description":"Shipment-level special services.","items":{"type":"object","properties":{"specialServiceId":{"type":"string","example":"OFFDAY"}}}},"parcels":{"type":"array","description":"Parcel or freight handling units for the LTL order.","items":{"$ref":"#/components/schemas/LTLParcel"}},"customs":{"type":"object","description":"","properties":{"customsInfo":{"type":"object","description":"Contains customs declaration and regulatory details.","properties":{"certificateNumber":{"type":"string","description":"Certificate number associated with the shipment, if applicable.","example":"98788877"},"comments":{"type":"string","description":"Additional comments related to the customs declaration.","example":"string"},"currencyCode":{"type":"string","description":"Currency code used for customs values, in ISO 4217 format.","example":"USD"},"customsDeclaredValue":{"type":"number","format":"double","description":"Total declared value of the shipment for customs purposes.","example":0},"EELPFC":{"type":"string","description":"Electronic Export Information (EEI) or Proof of Filing Citation (PFC).","example":"NOEEI 30.36"},"fromCustomsReference":{"type":"string","description":"Customs reference number provided by the shipper.","example":"11111"},"importerCustomsReference":{"type":"string","description":"Customs reference number provided by the importer.","example":"987654"},"insuredAmount":{"type":"number","format":"double","description":"Insured value of the shipment.","example":0},"invoiceNumber":{"type":"string","description":"Commercial invoice number associated with the shipment.","example":"001189223"},"licenseNumber":{"type":"string","description":"Export or import license number, if applicable.","example":"456ABC123"},"reasonForExport":{"type":"string","description":"Reason for exporting the shipment.","example":"GIFT"}}}}},"dateOfShipment":{"type":"string","format":"date","description":"Planned shipment date for the LTL order.","example":"2026-06-09"},"shipmentProvider":{"type":"object","properties":{"shipViaCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/shipviacode/ship-via-code/createshipviacode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ship Via Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to identify the shipment provider.\""},"children":[]}]}]}],"example":"shipViaCode123"}}},"carrierPayments":{"type":"array","$ref":"#/components/schemas/carrierPaymentsForLTL"}}}},"components/schemas/LTLParcel":{"id":"components/schemas/LTLParcel","kind":"json-schema","title":"LTLParcel","data":{"type":"object","description":"List of freight handling units included in the shipment. Each parcel represents a pallet, skid, carton, or other freight unit and contains dimensional, weight, classification, and item details.","properties":{"parcel":{"$ref":"#/components/schemas/parcelV2"},"parcelId":{"type":"string","description":"Unique identifier assigned to the parcel within the shipment.","example":"Box"},"parcelType":{"type":"string","description":"Type of freight handling unit.","example":"Box"},"pieceCount":{"type":"string","description":"Number of pieces included in this freight handling unit.","example":"2"},"parcelBrandedName":{"type":"string","description":"Branded or commercial name associated with the parcel.","example":"Box Brand"},"parcelDescription":{"type":"string","description":"Description of the parcel contents or packaging.","example":"Box description"},"handlingInstruction":{"type":"string","description":"Special handling instructions for the parcel.","example":"Handle with Care"},"proNumber":{"type":"string","description":"Carrier-issued PRO number used to identify and track the freight shipment.","example":"proNumber123"},"purchaseOrderNumber":{"type":"string","description":"Purchase order number associated with the freight shipment.","example":"PO123"},"freightAccountNumber":{"type":"string","description":"Freight billing account number used for carrier invoicing.","example":"freightAccountNumber"},"freightClass":{"type":"string","description":"National Motor Freight Classification (NMFC) class assigned to the freight.","example":"CLASS200"},"nmfcCode":{"type":"string","description":"National Motor Freight Classification (NMFC) code that identifies the commodity being shipped.","example":"nmfcCode1"},"billableWeight":{"description":"Weight used by the carrier to calculate transportation charges.","$ref":"#/components/schemas/Weight"},"palletWeight":{"description":"Total weight of the pallet or freight handling unit.","$ref":"#/components/schemas/Weight"},"references":{"type":"object","description":"Additional parcel-level references and options.","properties":{"parcelOptions":{"type":"array","description":"List of parcel-specific options.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the parcel option.","example":"STACKABLE"},"value":{"type":"string","description":"Value associated with the parcel option.","example":"true"}}}}}},"specialServices":{"type":"array","description":"Special services requested for this parcel.","items":{"type":"object","properties":{"specialServiceId":{"type":"string","description":"Identifier of the special service requested for the parcel.","example":"2MEN"}}}},"items":{"type":"array","description":"List of items packed within the parcel.","items":{"$ref":"#/components/schemas/Item"}}}}},"components/schemas/ShippingReferences":{"id":"components/schemas/ShippingReferences","kind":"json-schema","title":"ShippingReferences","data":{"type":"object","description":"Contains additional reference fields that can be passed with the request.","properties":{"reference1":{"type":"string","example":"reference1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary reference field, printed on the coversheet under the label "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shipper Ref"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"reference2":{"type":"string","example":"reference2","description":"Secondary reference field."},"reference3":{"type":"string","example":"reference3","description":"Tertiary reference field."},"reference4":{"type":"string","example":"reference4","description":"Additional reference field."},"shipperReference":{"type":"string","example":"Shipper123","description":"Reference provided by the shipper."},"transportationReference":{"type":"string","example":"TransRef2025","description":"Reference related to transportation."},"shippingNotes":{"type":"string","example":"Handle with care","description":"Optional notes from the shipper."}}}},"components/schemas/CarrierProperties":{"id":"components/schemas/CarrierProperties","kind":"json-schema","title":"CarrierProperties","data":{"type":"object","description":"Carrier-specific properties used for processing the order.","properties":{"carrierAccountId":{"type":"string","description":"Unique identifier of the carrier account.","example":"abcd12"},"service":{"type":"string","description":"Service code used by the carrier.","example":"PM"},"serviceCategory":{"type":"string","description":"Category of the carrier service.","example":"Priority"},"serviceName":{"type":"string","description":"Human-readable name of the carrier service.","example":"Priority Mail"},"rateTypeId":{"type":"string","description":"Rate type identifier provided by the carrier (e.g., COMMERCIAL).","example":"COMMERCIAL"},"rateGroupId":{"type":"string","description":"Identifier for the rate group.","example":"GRP01"},"rateShopBy":{"type":"string","description":"Criteria for rate shopping (e.g., COST, TIME).","example":"COST"}}}},"components/schemas/ShippingPreferences":{"id":"components/schemas/ShippingPreferences","kind":"json-schema","title":"ShippingPreferences","data":{"type":"object","description":"Shipping-related preferences for an order.\n","properties":{"carrier":{"type":"string","description":"Carrier selected for shipping the order.","example":"UPS"},"parcelId":{"type":"string","description":"Identifier of the parcel used for shipment for the order.","example":"PKG-001"},"parcelType":{"type":"string","description":"Type of parcel used for shipping.","example":"PKG"},"service":{"type":"string","description":"Shipping service selected for the order.","example":"2DA"},"parcel":{"$ref":"#/components/schemas/parcelV2","description":"Parcel details."},"specialServices":{"type":"array","description":"It provides a carrier based special or extra service, which also varies as per selected service and parcel type.","items":{"$ref":"#/components/schemas/SpecialService"}},"customs":{"type":"object","description":"","properties":{"customsInfo":{"type":"object","description":"Contains customs declaration and regulatory details.","properties":{"certificateNumber":{"type":"string","description":"Certificate number associated with the shipment, if applicable.","example":"98788877"},"comments":{"type":"string","description":"Additional comments related to the customs declaration.","example":"string"},"currencyCode":{"type":"string","description":"Currency code used for customs values, in ISO 4217 format.","example":"USD"},"customsDeclaredValue":{"type":"number","format":"double","description":"Total declared value of the shipment for customs purposes.","example":0},"EELPFC":{"type":"string","description":"Electronic Export Information (EEI) or Proof of Filing Citation (PFC).","example":"NOEEI 30.36"},"fromCustomsReference":{"type":"string","description":"Customs reference number provided by the shipper.","example":"11111"},"importerCustomsReference":{"type":"string","description":"Customs reference number provided by the importer.","example":"987654"},"insuredAmount":{"type":"number","format":"double","description":"Insured value of the shipment.","example":0},"invoiceNumber":{"type":"string","description":"Commercial invoice number associated with the shipment.","example":"001189223"},"licenseNumber":{"type":"string","description":"Export or import license number, if applicable.","example":"456ABC123"},"reasonForExport":{"type":"string","description":"Reason for exporting the shipment.","example":"GIFT"}}}}},"shipmentProvider":{"type":"object","description":"","properties":{"shipViaCode":{"type":"string","description":"Code that identifies the shipping method or carrier routing to be used for the shipment.","example":"shipViaCode123"}}},"carrierPayments":{"type":"array","$ref":"#/components/schemas/carrierPayments"},"shipmentOptions":{"type":"object","description":"Additional shipment options.","properties":{"packageDescription":{"type":"string","description":"Description of the contents of the shipment.","example":"testpackageDescription"}}}}}},"components/schemas/Charges":{"id":"components/schemas/Charges","kind":"json-schema","title":"Charges","data":{"type":"object","description":"Financials and tender type information for the order.","properties":{"currency":{"type":"string","description":"Currency used for payment (ISO 4217 format).","example":"USD"},"billingStatus":{"type":"string","description":"Current billing status of the order (e.g., PAID, PENDING)","example":"Paid"},"gmv":{"type":"number","description":"Gross merchandise value of all items before discounts, tax, and shipping.","example":100},"subTotal":{"type":"number","description":"Subtotal amount of the order before shipping and taxes.","example":90},"totalPaid":{"type":"number","description":"Total amount paid for the order.","example":100},"paymentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of payment used for the order (e.g., credit_card, COD)."},"children":[]}]}]}],"example":"Credit Card"}}}},"components/schemas/carrierPayments":{"id":"components/schemas/carrierPayments","kind":"json-schema","title":"carrierPayments","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how carrier charges are billed to a third party. Use this field to specify"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account and charge type details for transportation and/or duties and taxes. This"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field is optional and currently supported for FedEx, UPS, DHL Express and Purolator."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"party"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (who will pay for TRANSPORTATION_CHARGES or duties and taxes) is explicitly specified during shipment creation, the charges will automatically default to the sender (shipper). To direct charges to a different party, the appropriate bill-to details must be provided in the request."},"children":[]}]}]}]}],"items":{"anyOf":[{"title":"FedEx Carrier Payment","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx Billing Rules:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no bill-to party (who will pay for TRANSPORTATION_CHARGES or duties and taxes) is explicitly defined, FedEx will default billing to the sender."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If sender provides the receiver's account number, Duties and taxes will be charged directly from the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no account number is provided, FedEx will attempt to collect payment from the receiver at the time of import."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case of DDU (Delivery Duty Unpaid) and no bill-to party provided:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pitney Bowes does not prompt for BILL_PARTY."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx attempts to collect duties and taxes in the destination country via its billing team."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In cases where FedEx is unable to collect these charges, the sender (in the origin country) will be billed as a fallback."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient must be an authorized collect recipient"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal code and country code are not required for any party."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FedEx Billing Scenarios:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Party"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal/Country Code"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COLLECT/CONSIGNEE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER_CONTRACT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender & Receiver split"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receiver pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receiver (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper & 3rd Party"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3rd Party pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3rd Party (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]}]}]}],"properties":{"accountNumber":{"type":"string","description":"The FedEx account number of the party to be billed.","example":"602684342"},"countryCode":{"type":"string","description":"Two-letter ISO country code of the party to be billed.","example":"US"},"postalCode":{"type":"string","description":"Postal code of the party to be billed.","example":"30305"},"party":{"type":"string","enum":["BILL_RECEIVER","BILL_SENDER","BILL_THIRD_PARTY","BILL_RECEIVER_CONTRACT"],"description":"Billing party for the shipment charges.","example":"BILL_RECEIVER"},"typeOfCharge":{"type":"string","enum":["TRANSPORTATION_CHARGES","DUTIES_AND_TAXES","ALL_CHARGES"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of charge billed to the specified party. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES: Transportation-related charges only. When billing transportation charges to the sender (BILL_SENDER), the accountNumber must match the account used to initiate the shipment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES: Duties and taxes only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES: All Shipment Charges (Transportatio and Duties and Taxes)Required when using BILL_RECEIVER_CONTRACT (FedEx COLLECT); includes all charges"},"children":[]}]}]}]}],"example":"ALL_CHARGES"}}},{"title":"UPS Carrier Payment","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Billing Rules:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When only sender or only receiver is specified as the payer, the same account number must be used for both TRANSPORTATION_CHARGES and duties/taxes."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no bill-to party (who will pay for TRANSPORTATION_CHARGES or duties and taxes) is explicitly defined, UPS will default billing to the sender/shipper."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case of DDU (Delivery Duty Unpaid) and no bill-to party provided:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pitney Bowes does not prompt for BILL_PARTY."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS attempts to collect duties and taxes in the destination country via its billing team or the ICOD (Import Collect on Delivery) process."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In cases where UPS is unable to collect these charges, the sender (in the origin country) will be billed as a fallback."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Third Party can be assigned to pay TRANSPORTATION_CHARGES charges only. Duties and taxes cannot be billed to a third party."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ALL_CHARGES billing type is not supported by UPS. Charges must be split explicitly between TRANSPORTATION_CHARGES and DUTIES_AND_TAXES."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPS Billing Scenarios:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Party"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal/Country Code"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COLLECT/CONSIGNEE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender & Receiver split"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receiver pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receiver (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal: Required"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country: Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper & 3rd Party"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal + Country"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3rd Party pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]}]}]}]}],"properties":{"accountNumber":{"type":"string","description":"The UPS account number of the party to be billed.","example":"1Z999AA10123456784"},"countryCode":{"type":"string","description":"Two-letter ISO country code of the party to be billed.","example":"US"},"postalCode":{"type":"string","description":"Postal code of the party to be billed.","example":"30305"},"party":{"type":"string","enum":["BILL_RECEIVER","BILL_SENDER","BILL_THIRD_PARTY"],"description":"Party to be billed.","example":"BILL_SENDER"},"typeOfCharge":{"type":"string","enum":["TRANSPORTATION_CHARGES","DUTIES_AND_TAXES"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of charge billed to the specified party. UPS requires split charges. ALL_CHARGES is not supported."},"children":[]}]}]}],"example":"TRANSPORTATION_CHARGES"}}},{"title":"DHL Express Carrier Payment","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express Billing Rules:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account number is required for all billing scenarios."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case of DDU (Delivery Duty Unpaid) and no bill-to party provided:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pitney Bowes does not prompt for BILL_PARTY."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL attempts to collect duties and taxes in the destination country via its billing team."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If DHL is unable to collect these charges from the receiver, the sender will be billed, and DHL may request instructions to deliver, return, or abandon the shipment."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid freight payer account required (Impex or origin match)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DHL Express Billing Scenarios:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Party"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal/Country Code"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COLLECT/CONSIGNEE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER_CONTRACT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender & Receiver split"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receiver pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receiver (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper & 3rd Party"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3rd Party pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3rd Party (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]}]}]}],"properties":{"accountNumber":{"type":"string","description":"The DHL Express account number of the party to be billed.","example":"DHL123456"},"countryCode":{"type":"string","description":"Two-letter ISO country code of the party to be billed.","example":"US"},"postalCode":{"type":"string","description":"Postal code of the party to be billed.","example":"30305"},"party":{"type":"string","enum":["BILL_RECEIVER","BILL_SENDER","BILL_THIRD_PARTY","BILL_RECEIVER_CONTRACT"],"description":"Billing party for DHL Express. Account number is required for all scenarios.","example":"BILL_THIRD_PARTY"},"typeOfCharge":{"type":"string","enum":["TRANSPORTATION_CHARGES","DUTIES_AND_TAXES","ALL_CHARGES"],"description":"The type of charge billed to the specified party.","example":"DUTIES_AND_TAXES"}}},{"title":"Purolator Carrier Payment","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purolator Billing Rules:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case of DDU (Delivery Duty Unpaid) and no bill-to party provided:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pitney Bowes does not prompt for BILL_PARTY."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Third Party"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can pay "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for both "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"domestic and international"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" shipments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receiver"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can pay "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"domestic shipments only"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For an "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"international shipment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if a third party is billed, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soldTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address must be included in the request payload."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If Purolator is unable to collect these charges from the receiver, the sender will be billed."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purolator Billing Scenarios:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scenario"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Party"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Charge"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal/Country Code"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender & Receiver split"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receiver pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receiver (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipper & 3rd Party"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3rd Party pays all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3rd Party (split charges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TRANSPORTATION_CHARGES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BILL_THIRD_PARTY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUTIES_AND_TAXES"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]}]}]}]}]}],"properties":{"accountNumber":{"type":"string","description":"The DHL Express account number of the party to be billed.","example":"DHL123456"},"countryCode":{"type":"string","description":"Two-letter ISO country code of the party to be billed.","example":"US"},"postalCode":{"type":"string","description":"Postal code of the party to be billed.","example":"30305"},"party":{"type":"string","enum":["BILL_RECEIVER","BILL_SENDER","BILL_THIRD_PARTY","BILL_RECEIVER_CONTRACT"],"description":"Billing party for DHL Express. Account number is required for all scenarios.","example":"BILL_THIRD_PARTY"},"typeOfCharge":{"type":"string","enum":["TRANSPORTATION_CHARGES","DUTIES_AND_TAXES","ALL_CHARGES"],"description":"The type of charge billed to the specified party.","example":"DUTIES_AND_TAXES"}}}]},"example":[{"accountNumber":"602684342","countryCode":"US","postalCode":"30305","party":"BILL_RECEIVER","typeOfCharge":"ALL_CHARGES"}]}},"components/schemas/carrierPaymentsForLTL":{"id":"components/schemas/carrierPaymentsForLTL","kind":"json-schema","title":"carrierPaymentsForLTL","data":{"type":"array","description":"Defines how carrier charges are billed to different parties. Use this field to specify\naccount and charge type details for transportation and/or duties and taxes. This\nfield is optional.\n","items":{"type":"object","properties":{"accountNumber":{"type":"string","description":"Account number of the party to be billed.","example":"602684342"},"countryCode":{"type":"string","description":"Two-letter ISO country code of the party to be billed.","example":"US"},"postalCode":{"type":"string","description":"Postal code of the party to be billed.","example":"30305"},"party":{"type":"string","description":"Billing party for the shipment charges.","enum":["BILL_RECEIVER","BILL_SENDER","BILL_THIRD_PARTY","BILL_RECEIVER_CONTRACT"],"example":"BILL_RECEIVER"},"typeOfCharge":{"type":"string","description":"The type of charge billed to the specified party.","enum":["TRANSPORTATION_CHARGES","DUTIES_AND_TAXES","ALL_CHARGES"],"example":"TRANSPORTATION_CHARGES"}}},"example":[{"accountNumber":"602684342","countryCode":"US","postalCode":"30305","party":"BILL_RECEIVER","typeOfCharge":"TRANSPORTATION_CHARGES"}]}},"components/schemas/parcelV2":{"id":"components/schemas/parcelV2","kind":"json-schema","title":"parcelV2","data":{"type":"object","required":["weightUnit"],"description":"The details of the Parcel.","properties":{"length":{"type":"number","format":"float","description":"Length is always the greatest of the three dimensions. The other two dimensions are used in the calculation of the girth.","example":2},"width":{"type":"number","format":"float","description":"There is no strict rule as to which element is the width or the height, but the width is the second greatest dimension of a parcel by convention.","example":1},"height":{"type":"number","format":"float","description":"By convention, the height is the smallest dimension of the parcel.","example":1},"dimUnit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DimUnit is a standard for measuring the physical quantities of specified dimension parameters."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The valid values are: Inch and Centimeter."},"children":[]}]}]}],"example":"IN","enum":["IN","CM"]},"weightUnit":{"type":"string","description":"WeightUnit is a standard for measuring the physical quantities of specified weight.","example":"OZ","enum":["OZ","GM"]},"weight":{"type":"number","format":"float","description":"Weight measures the heaviness of an object (how heavy an object is) .","example":2}}}},"components/schemas/additionalAddresses":{"id":"components/schemas/additionalAddresses","kind":"json-schema","title":"additionalAddresses","data":{"type":"array","description":"A list of additional addresses associated with the order.\n","items":{"type":"object","properties":{"address":{"type":"object","description":"The additional address details.","properties":{"residential":{"type":"boolean","example":false,"description":"If the address is residential."},"phone":{"type":"string","example":"732-443-1007","description":"Contact phone number for the address."},"countryCode":{"type":"string","example":"US","description":"The ISO 2-letter country code."},"company":{"type":"string","example":"ABC Company","description":"The name of the company associated with the address."},"postalCode":{"type":"string","example":"08810-1411","description":"ZIP or postal code."},"cityTown":{"type":"string","example":"DAYTON","description":"Name of the city or town."},"name":{"type":"string","example":"Warehouse Manager","description":"Name of the contact person."},"stateProvince":{"type":"string","example":"NJ","description":"State or province code."},"addressLine1":{"type":"string","example":"2270 US HIGHWAY 130","description":"Primary street address line."}}},"addressType":{"type":"string","example":"THIRD_PARTY","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the additional address (e.g., THIRD_PARTY). This is required if passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalAddresses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}}},"components/schemas/CreateOrderResponse":{"id":"components/schemas/CreateOrderResponse","kind":"json-schema","title":"CreateOrderResponse","data":{"type":"object","properties":{"orderId":{"type":"string","description":"Unique identifier assigned to the created order.","example":"PBcffM5ruasQ"},"orderNumber":{"type":"string","description":"The order number as provided in the request.","example":"ORD12346ORD12346"},"status":{"type":"string","description":"Current status of the order created.","example":"Success"},"transactionCreateDate":{"type":"string","format":"date-time","description":"Timestamp of when the order was created.","example":"2025-06-30T10:53:24.554Z"}}}},"components/schemas/GetOrderResponseGateway":{"id":"components/schemas/GetOrderResponseGateway","kind":"json-schema","title":"GetOrderResponseGateway","data":{"type":"object","description":"Complete order response containing order details and shipping information.","properties":{"orderInfo":{"type":"object","description":"Order-level details and metadata.","properties":{"orderId":{"type":"string","description":"Unique system-generated identifier for the order.","example":"PB5cNRrQZnCR"},"orderNumber":{"type":"string","description":"Client Provided order number.","example":"ORD12345"},"status":{"type":"string","description":"Current status of the order.","example":"UNFULFILLED"},"orderCreateDate":{"type":"string","format":"date-time","description":"Date and time when the order was created.","example":"2025-09-25T14:45:00Z"},"locationId":{"type":"string","description":"Identifier of the location where the order was processed.","example":"LOC987"},"locationName":{"type":"string","description":"Name of the processing location.","example":"Dallas Warehouse"},"sourceFlowType":{"type":"string","description":"Channel through which the order was created.","example":"API"},"updatedDateTime":{"type":"string","format":"date-time","description":"Date and time when the order was last updated.","example":"2026-01-20T05:47:53.473Z"},"updatedBy":{"type":"string","description":"Identifier of the user or that last updated the order.","example":"0oa2hlagtvtaETd8x0h8"},"deliveredDateTime":{"type":"string","format":"date-time","nullable":true,"description":"Date and time when the order was delivered."},"statusUpdatedDateTime":{"type":"string","format":"date-time","description":"Date and time when the order status last changed.","example":"2026-01-20T05:47:53.473Z"},"orderType":{"type":"string","description":"Business type of the order.","example":"ECOMMERCE"},"customerInfo":{"type":"object","description":"Customer associated with the order.","properties":{"customerId":{"type":"string","description":"Unique identifier of the customer.","example":"CUST123"},"firstName":{"type":"string","description":"Customer first name.","example":"John"},"lastName":{"type":"string","description":"Customer last name.","example":"Doe"},"email":{"type":"string","description":"Customer email address.","example":"john.doe@example.com"}}},"tags":{"type":"array","description":"Tags associated with the order.","items":{"type":"string"},"example":["PROMO2025","PRIORITY"]},"orderMessage":{"type":"object","description":"Optional message attached to the order.","properties":{"type":{"type":"string","description":"Type of order message.","enum":["ANNIVERSARY","BIRTHDAY","GIFT"],"example":"GIFT"},"message":{"type":"string","description":"Message text.","example":"Updated gift note for the order"}}},"international":{"type":"boolean","description":"Indicates whether the order is international.","example":false},"orderFulfilledManually":{"type":"boolean","description":"Indicates whether the order was fulfilled manually.","example":false},"items":{"$ref":"#/components/schemas/Items"},"charges":{"$ref":"#/components/schemas/Charges"}}},"orderShippingInfo":{"type":"object","description":"Shipping and fulfillment details for the order.","properties":{"shipments":{"type":"array","description":"List of shipments created for the order.","items":{"type":"object","properties":{"correlationId":{"type":"string","description":"Correlation identifier for the shipment.","example":"CORR-001"},"fromAddress":{"type":"object","description":"Origin address for the shipment.","properties":{"addressLine1":{"type":"string","description":"First line of the address.","example":"123 Warehouse Street"},"cityTown":{"type":"string","description":"City or town.","example":"Dallas"},"stateProvince":{"type":"string","description":"State or province.","example":"TX"},"postalCode":{"type":"string","description":"Postal or ZIP code.","example":"75001"},"countryCode":{"type":"string","description":"Country code.","example":"US"}}},"toAddress":{"type":"object","description":"Destination address for the shipment.","properties":{"addressLine1":{"type":"string","description":"First line of the address.","example":"456 Customer Ave"},"cityTown":{"type":"string","description":"City or town.","example":"Austin"},"stateProvince":{"type":"string","description":"State or province.","example":"TX"},"postalCode":{"type":"string","description":"Postal or ZIP code.","example":"73301"},"countryCode":{"type":"string","description":"Country code.","example":"US"},"residential":{"type":"boolean","description":"Indicates if the address is residential.","example":true}}},"parcelTrackingNumber":{"type":"string","description":"Carrier tracking number.","example":"1Z999AA10123456784"},"service":{"type":"string","description":"Carrier service used.","example":"PM"},"rates":{"type":"array","description":"Rates returned for the shipment.","items":{"type":"object","properties":{"carrier":{"type":"string","description":"Carrier name.","example":"UPS"},"currencyCode":{"type":"string","description":"Currency code.","example":"USD"},"baseCharge":{"type":"number","format":"double","description":"Base shipping charge.","example":5},"totalCarrierCharge":{"type":"number","format":"double","description":"Total charge from the carrier.","example":7.5},"totalTaxAmount":{"type":"number","format":"double","description":"Total tax amount.","example":0.5},"estimatedNumberOfDays":{"type":"integer","description":"Estimated delivery time in days.","example":3}}}},"shipmentId":{"type":"string","description":"Shipment identifier.","example":"SHIP12345"},"status":{"type":"string","description":"Current shipment status.","example":"SHIPPED"},"metadata":{"type":"array","description":"Additional metadata for the shipment.","items":{"type":"object","properties":{"name":{"type":"string","description":"Metadata key.","example":"WAREHOUSE"},"value":{"type":"string","description":"Metadata value.","example":"DALLAS"}}}}}}},"shippingCharges":{"type":"object","description":"Aggregate shipping charges.","properties":{"ccFee":{"type":"number","format":"double","description":"Credit card processing fee.","example":1.5},"totalPackageCharges":{"type":"number","format":"double","description":"Total package-level charges.","example":6},"totalCarrierCharges":{"type":"number","format":"double","description":"Total carrier charges.","example":7.5},"publishedTotalCharges":{"type":"number","format":"double","description":"Published total charges.","example":8}}},"shippingReference":{"type":"object","description":"Shipping reference details.","properties":{"reference1":{"type":"string","description":"Primary reference.","example":"REF-001"},"shipperReference":{"type":"string","description":"Shipper-provided reference.","example":"SHIP-REF-UPDATED"},"shippingNotes":{"type":"string","description":"Notes related to the shipment.","example":"Deliver after 5 PM"}}},"shippedDateTime":{"type":"string","format":"date-time","description":"Date and time when the shipment was shipped.","example":"2026-01-20T06:15:00Z"}}}}}},"components/schemas/GetOrderResponse":{"id":"components/schemas/GetOrderResponse","kind":"json-schema","title":"Order Response","data":{"title":"Order Response","type":"object","description":"Complete order response containing order details and shipping information.","properties":{"orderInfo":{"type":"object","description":"Order details and metadata.","properties":{"orderId":{"type":"string","description":"System-generated unique identifier for the order.","example":"PBqTYEhO31JY"},"orderNumber":{"type":"string","description":"Client provided order number.","example":"ORD123456"},"status":{"type":"string","description":"Current status of the order.","example":"UNFULFILLED"},"orderCreateDate":{"type":"string","format":"date-time","description":"Date and time when the order was created.","example":"0001-01-01T00:00:00Z"},"sourceFlowType":{"type":"string","description":"Channel through which the order was created.","example":"API"},"createdBy":{"type":"string","description":"Identifier of the user that created the order.","example":"0oa2hlagtvtaETd8x0h8"},"customerInfo":{"type":"object","description":"End customer (buyer) profile for communication.","properties":{"firstName":{"type":"string","description":"First name of the customer.","example":"John"},"lastName":{"type":"string","description":"Last name of the customer.","example":"Doe"},"email":{"type":"string","description":"Buyer email","example":"john.doe@example.com"},"customerId":{"type":"string","description":"Your CRM/customer key.","example":"CUST12345"}}},"orderMessage":{"type":"object","description":"An optional message added to an order, such as a gift note or a short greeting.\n","properties":{"type":{"type":"string","description":"The type for the message.","enum":["ANNIVERSARY","BIRTHDAY","GIFT"],"example":"GIFT"},"message":{"type":"string","description":"The message text shown with the order.\nMaximum length is 200 characters.\n","maxLength":200,"example":"Happy Birthday! Enjoy your gift."}}},"items":{"type":"array","description":"List of items in the order. To create an order, minimum one item is required.","items":{"$ref":"#/components/schemas/Item"}},"charges":{"$ref":"#/components/schemas/Charges"}}},"orderShippingInfo":{"type":"object","description":"","properties":{"shippingReference":{"$ref":"#/components/schemas/ShippingReferences"},"shippingPreferences":{"$ref":"#/components/schemas/ShippingPreferences"}}}}}},"components/schemas/GetLTLOrderResponse":{"id":"components/schemas/GetLTLOrderResponse","kind":"json-schema","title":"LTL Order Response","data":{"title":"LTL Order Response","type":"object","description":"Complete LTL order response containing order details and freight shipping information.","properties":{"orderInfo":{"type":"object","description":"Order details and metadata.","properties":{"orderId":{"type":"string","description":"System-generated unique identifier for the order.","example":"PB6a2f9f62e151c7ef97bdffe7"},"orderNumber":{"type":"string","description":"Client-provided order number.","example":"ORD-F-ORD12832D"},"status":{"type":"string","description":"Current status of the order.","example":"UNFULFILLED"},"orderCreateDate":{"type":"string","format":"date-time","description":"Date and time when the order was created."},"sourceFlowType":{"type":"string","description":"Channel through which the order was created.","example":"API"},"createdBy":{"type":"string","description":"Identifier of the user who created the order."},"orderType":{"type":"string","description":"Type of order.","example":"MANUAL"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"orderMessage":{"$ref":"#/components/schemas/OrderMessage"},"charges":{"$ref":"#/components/schemas/Charges"},"fromAddress":{"$ref":"#/components/schemas/Address"},"toAddress":{"$ref":"#/components/schemas/Address"}}},"orderShippingInfo":{"type":"object","properties":{"shippingReference":{"$ref":"#/components/schemas/ShippingReferences"},"shippingPreferences":{"$ref":"#/components/schemas/LTLShippingPreferences"},"metadata":{"type":"array","description":"Additional metadata for the shipment.","items":{"type":"object","properties":{"name":{"type":"string","description":"Metadata key.","example":"WAREHOUSE"},"value":{"type":"string","description":"Metadata value.","example":"DALLAS"}}}}}}}}},"components/schemas/DeleteOrderResponse":{"id":"components/schemas/DeleteOrderResponse","kind":"json-schema","title":"DeleteOrderResponse","data":{"type":"object","description":"Response payload returned after successfully deleting an order","properties":{"orderId":{"type":"string","description":"Unique system-generated identifier of the deleted order.","example":"PBM75CRknylo"},"status":{"type":"string","description":"Current status of the order.","example":"Deleted"},"transactionDateTime":{"type":"string","format":"date-time","description":"Timestamp when the delete operation was executed.","example":"2026-01-01T09:27:36.775Z"}}}},"components/schemas/UpdateOrderStatusRequest":{"id":"components/schemas/UpdateOrderStatusRequest","kind":"json-schema","title":"UpdateOrderStatusRequest","data":{"type":"object","required":["orders","status"],"properties":{"orders":{"type":"array","description":"List of orders whose status needs to be updated.","minItems":1,"items":{"type":"object","properties":{"orderId":{"type":"string","description":"Unique identifier of the order.","example":"PBqTYEhO31JY"}}}},"reason":{"type":"string","description":"Reason for performing the bulk status update.","example":"bulk status update"},"status":{"type":"string","description":"New status to be applied to the specified orders.","example":"ONHOLD","enum":["UNFULFILLED","FULFILLED","ONHOLD","CANCELED"]}}}},"components/schemas/UpdateOrderStatusResponse":{"id":"components/schemas/UpdateOrderStatusResponse","kind":"json-schema","title":"UpdateOrderStatusResponse","data":{"type":"object","properties":{"status":{"type":"string","description":"Current status of the order after update.","example":"ONHOLD"},"message":{"type":"string","description":"Confirmation message describing the outcome.","example":"Order status updated successfully."},"transactionDateTime":{"type":"string","format":"date-time","description":"Timestamp when the transaction took place in ISO 8601 format.","example":"2025-07-01T09:59:16.617Z"}}}},"components/schemas/GetAllOrdersPaginatedResponse":{"id":"components/schemas/GetAllOrdersPaginatedResponse","kind":"json-schema","title":"GetAllOrdersPaginatedResponse","data":{"type":"object","required":["data","pageInfo"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GetOrderResponse"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}}}},"components/schemas/PageInfo":{"id":"components/schemas/PageInfo","kind":"json-schema","title":"PageInfo","data":{"type":"object","properties":{"total":{"type":"integer","example":28},"pages":{"type":"integer","example":3},"page":{"type":"integer","example":1}}}},"components/schemas/OrderSummary":{"id":"components/schemas/OrderSummary","kind":"json-schema","title":"OrderSummary","data":{"type":"object","properties":{"_id":{"type":"string"},"batchId":{"type":"string"},"storeKey":{"type":"string"},"sourceFlowType":{"type":"string","example":"ECOM_CONNECTOR"},"orderId":{"type":"string"},"orderNumber":{"type":"string"},"additionalReferences":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalReference"}},"status":{"type":"string","example":"NEW"},"orderType":{"type":"string","example":"ECOMMERCE"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"toAddress":{"$ref":"#/components/schemas/Address"},"billingAddress":{"$ref":"#/components/schemas/Address"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}},"giftDetails":{"type":"object"},"paymentDetails":{"type":"object"},"packagingInfo":{"type":"object"},"holdDetails":{"type":"object"},"handlingDetails":{"type":"object"},"shipmentDetails":{"type":"object"},"createdDateTime":{"type":"string","format":"date-time"},"updatedDateTime":{"type":"string","format":"date-time"},"workFlowStatus":{"$ref":"#/components/schemas/WorkFlowStatus"}}}},"components/schemas/AdditionalReference":{"id":"components/schemas/AdditionalReference","kind":"json-schema","title":"AdditionalReference","data":{"type":"object","properties":{"type":{"type":"string","example":"Invoicexxxxxxxx3243243"},"value":{"type":"string","example":"INV12345xxxxxxx324424"}},"required":["type"]}},"components/schemas/CustomerInfo":{"id":"components/schemas/CustomerInfo","kind":"json-schema","title":"CustomerInfo","data":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"}}}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","required":["addressLine1","cityTown","countryCode","postalCode","stateProvince","phone"],"properties":{"name":{"type":"string","description":"Full name of the contact person or entity at this address (max 254 characters).","example":"John Doe "},"company":{"type":"string","description":"Company name associated with this address (max 100 characters).","example":"Company Name"},"addressLine1":{"type":"string","description":"Primary street address or building number (max 100 characters).","example":"123 Main Street"},"addressLine2":{"type":"string","description":"Additional address information (optional, max 100 characters).","example":"Suite 100"},"addressLine3":{"type":"string","description":"Third line of the address (optional, max 100 characters).","example":"Near City Park"},"cityTown":{"type":"string","description":"City or town name of the address (max 100 characters).","example":"New York"},"stateProvince":{"type":"string","description":"State, province, or region (max 100 characters).","example":"TX"},"postalCode":{"type":"string","description":"Postal/ZIP code for the address (max 25 characters).","example":"10001"},"countryCode":{"type":"string","description":"Two-letter ISO 3166-1 alpha-2 country code.","example":"US"},"phone":{"type":"string","description":"Phone number of the contact person at this address.","example":"1234567890"},"email":{"type":"string","format":"email","description":"Contact email address for this address (must be valid format).","example":"johndoe@example.com"},"residential":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if the address is residential ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or commercial ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":false}}}},"components/schemas/UnitWeight":{"id":"components/schemas/UnitWeight","kind":"json-schema","title":"UnitWeight","data":{"type":"object","properties":{"uom":{"type":"string"},"value":{"type":"number"}}}},"components/schemas/PriceDetails":{"id":"components/schemas/PriceDetails","kind":"json-schema","title":"PriceDetails","data":{"type":"object","properties":{"unitPrice":{"type":"number"},"shippingCost":{"type":"number"}}}},"components/schemas/AddOrderItemsRequest":{"id":"components/schemas/AddOrderItemsRequest","kind":"json-schema","title":"AddOrderItemsRequest","data":{"type":"object","required":["items"],"properties":{"items":{"minItems":1,"type":"array","description":"List of items being added to the existing order before fulfillment.","items":{"type":"object","required":["sku","quantity"],"properties":{"lineItemId":{"type":"string","description":"Unique identifier for the line item to be added.","example":"ITEM123"},"productId":{"type":"string","description":"Identifier of the product associated with the item.","example":"PROD001"},"variantId":{"type":"string","description":"Identifier for the specific product variant (e.g., color/size).","example":"VAR001"},"name":{"type":"string","description":"Human-readable name of the product.","example":"Wireless Mouse"},"url":{"type":"string","description":"URL to the product page.","example":"https://example.com/products/wireless-mouse"},"imageUrl":{"type":"array","description":"List of URLs for product images.","items":{"example":"https://example.com/images/mouse-front.jpg"}},"sku":{"type":"string","description":"Stock Keeping Unit identifier for the product.","example":"SKU12345"},"alternateSku":{"type":"string","description":"Alternate SKU identifier for the product, if applicable.","example":"ALT-SKU001"},"quantity":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity of this item in the order (must be > 0)."},"children":[]}]}]}],"example":2},"unitWeight":{"type":"object","description":"Weight details for the item.","properties":{"unitOfMeasurement":{"type":"string","description":"Unit of measurement for weight (e.g., kg, lb).","example":"kg"},"value":{"type":"number","description":"Numeric weight value.","example":0.5}}},"dimension":{"type":"object","description":"Dimension details of the item package.","properties":{"length":{"type":"number","description":"Length of the item/package.","example":25},"height":{"type":"number","description":"Height of the item/package.","example":10},"width":{"type":"number","description":"Width of the item/package.","example":15},"unitOfMeasurement":{"type":"string","description":"Unit of measurement for dimensions (e.g., cm, in).","example":"cm"}}},"hsCode":{"type":"string","description":"Harmonized System (HS) code used for customs classification.","example":"847160"},"country":{"type":"string","description":"Country of origin for the item.","example":"US"},"shipAlone":{"type":"boolean","description":"Indicates whether this item must be shipped separately.","example":false},"priceDetails":{"type":"object","description":"Price and cost breakdown for the item.","properties":{"unitPrice":{"type":"number","description":"Base price per unit of the item.","example":25},"salePrice":{"type":"number","description":"Discounted sale price per unit, if applicable.","example":20},"tax":{"type":"number","description":"Tax amount applied to the item.","example":2.5},"shippingCost":{"type":"number","description":"Shipping cost attributed to this item.","example":5},"discount":{"type":"number","description":"Discount applied to this item.","example":3},"subTotal":{"type":"number","description":"Subtotal cost for this item (after discount, before tax/shipping).","example":42.5}}},"customFields":{"type":"array","description":"Custom fields associated with this item.","items":{"$ref":"#/components/schemas/CustomField"}},"condition":{"type":"string","description":"Condition of the item (e.g., new, refurbished).","example":"new"},"fulfilled_quantity":{"type":"integer","description":"Number of units already fulfilled.","example":1},"unfulfilled_quantity":{"type":"integer","description":"Number of units pending fulfillment.","example":1}}}}}}},"components/schemas/AddOrderItemsResponse":{"id":"components/schemas/AddOrderItemsResponse","kind":"json-schema","title":"AddOrderItemsResponse","data":{"type":"object","properties":{"orderId":{"type":"string","description":"Unique identifier of the order that was updated.","example":"PBNB3liGzXvx"},"status":{"type":"string","description":"Status of the order after update (e.g., Updated).","example":"Updated"},"message":{"type":"string","description":"Confirmation message regarding the operation.","example":"Item(s) added successfully"},"transactionDateTime":{"type":"string","format":"date-time","description":"Timestamp when the operation was processed.","example":"2025-07-12T18:19:57.896Z"}}}},"components/schemas/DeleteOrderItemResponse":{"id":"components/schemas/DeleteOrderItemResponse","kind":"json-schema","title":"DeleteOrderItemResponse","data":{"type":"object","properties":{"orderId":{"type":"string","description":"Unique identifier of the order that was updated.","example":"PBksT3ctKT9M"},"status":{"type":"string","description":"Status of the order after the item was deleted.","example":"Updated"},"transactionDateTime":{"type":"string","format":"date-time","description":"Timestamp when the deletion was processed.","example":"2025-07-01T17:52:17.889Z"}}}},"components/schemas/UpdateOrderRequestFull":{"id":"components/schemas/UpdateOrderRequestFull","kind":"json-schema","title":"UpdateOrderRequestFull","data":{"type":"object","properties":{"sourceFlowType":{"type":"string","description":"Source through which the order originated (e.g., API, UI, marketplace).","example":"API"},"orderNumber":{"type":"string","description":"Client-provided unique order reference number.","example":"ORD123456xxxxxx3241234"},"AdditionalReference":{"type":"object","properties":{"type":{"type":"string","description":"Type/category of the reference.","example":"Invoice"},"value":{"type":"string","description":"Actual reference value/identifier corresponding to the type.","example":"INV12345xxxxxxx324424"}},"required":["type"]},"orderType":{"type":"string","description":"Type of order being updated (e.g., Ecommerce, Manual, Wholesale).","example":"Manual"},"customerInfo":{"type":"object","description":"End customer (buyer) profile for communication.","properties":{"name":{"type":"string","description":"Buyer name as seen on the storefront.","example":"John Doe"},"email":{"type":"string","description":"Buyer email","example":"john.doe@example.com"},"customerId":{"type":"string","description":"Your CRM/customer key.","example":"CUST12345"}}},"fromAddress":{"$ref":"#/components/schemas/Address","description":"The location the parcel ships from. Often your warehouse, store, or drop-shipper. Carriers use this for rating, label origin, and pickup eligibility."},"toAddress":{"$ref":"#/components/schemas/Address","description":"The location the parcel ships to. Set residential: true for home deliveries."},"billingAddress":{"$ref":"#/components/schemas/Address","description":"The address tied to payment (cardholder or invoicing party).If omitted, systems typically fall back to fromAddress depending on your billing flows."},"items":{"type":"array","description":"The SKUs/products on the order.","items":{"$ref":"#/components/schemas/Item"}},"giftDetails":{"type":"object","description":"gift Details","properties":{"isGift":{"type":"string","description":"Marks the order as a gift.","example":"true"},"message":{"type":"string","description":"Gift note to print.","example":"Happy Birthday!"}}},"customerNotes":{"type":"string","description":"Free-form notes from the buyer.","example":"Please deliver between 9 AM and 5 PM."},"internalNotes":{"type":"string","description":"Staff-only notes for operations.","example":"Priority customer."},"orderLink":{"type":"string","description":"A URL to view the order in your OMS.","example":"http://example.com/order/ORD12345"},"costAccount":{"type":"object","description":"Cost account details used for billing or chargebacks.","properties":{"code":{"type":"string","description":"Unique code for the cost account.","example":"Code123"},"description":{"type":"string","description":"Description of the cost account.","example":"Testing Cost Account"},"id":{"type":"string","description":"System-generated identifier for the cost account.","example":"ID123"},"name":{"type":"string","description":"Name of the cost account.","example":"testCostAccount"}}},"paymentDetails":{"type":"object","description":"Financials and tender type information for the order.","properties":{"currency":{"type":"string","description":"Currency code","example":"USD"},"billingStatus":{"type":"string","description":"Current billing status of the order.","example":"Paid"},"gmv":{"type":"number","description":"Gross merchandise value of all items before discounts, tax, and shipping.","example":100},"subTotal":{"type":"number","description":"Order value after item-level.","example":90},"totalPaid":{"type":"number","description":"Total amount paid for the order.","example":100},"shippingTotal":{"type":"number","description":"Total shipping charges applied to the order.","example":10},"paymentType":{"type":"string","description":"Method of payment.","example":"Credit Card"},"taxDetails":{"type":"object","description":"Taxes applied to the order.","properties":{"total":{"type":"number","description":"Total tax amount applied to the order (sum of all taxes).","example":5},"taxes":{"type":"array","description":"Detailed breakdown of each tax type applied to the order.","items":{"type":"object","properties":{"type":{"type":"string","description":"The category of tax applied (e.g., Sales Tax, VAT, GST).","example":"Sales Tax"},"amount":{"type":"number","description":"The monetary value of this tax component.","example":5},"percentage":{"type":"number","description":"The tax rate percentage applied to the taxable amount.","example":5}}}}}},"discountDetails":{"type":"object","description":"The total discount applied to the order.","properties":{"total":{"type":"number","format":"float","description":"Total discount applied to the order (sum of all discounts).","example":5},"discounts":{"type":"array","description":"Detailed breakdown of each discount type applied to the order.","items":{"type":"object","properties":{"type":{"type":"string","description":"The category of discount (e.g., Promotional, Loyalty, Seasonal).","example":"Promotional"},"amount":{"type":"number","description":"The monetary value of this discount component.","example":5},"name":{"type":"string","description":"A descriptive label or code for the discount.","example":"Promo Code"}}}}}}}},"packagingInfo":{"type":"object","description":"Defines default packaging details for the order.\nThese values are used for label generation if explicit packages are not created later.\nCan be overridden when creating packages/shipments.\n","properties":{"type":{"type":"string","description":"Packaging type selected for the order (e.g., Box, Envelope).","example":"Box"},"weight":{"type":"object","description":"Declared package-level weight.","properties":{"uom":{"type":"string","description":"Unit of measure for weight (kg, lb).","example":"kg"},"value":{"type":"number","description":"Numeric weight value of the package.","example":3}}},"dimensions":{"type":"object","description":"Declared physical dimensions of the package.","properties":{"uom":{"type":"string","description":"Unit of measure for dimensions (cm, in).","example":"cm"},"values":{"type":"object","properties":{"length":{"type":"number","description":"Length of the package.","example":30},"width":{"type":"number","description":"Width of the package.","example":20},"height":{"type":"number","description":"Height of the package.","example":10}}}}}}},"handlingDetails":{"type":"object","description":"Soft shipping preferences and SLA commitments.\nThese values guide service/rate selection but do not enforce strict validations.\n","properties":{"preferredShipping":{"type":"string","description":"Desired shipping preferences.","example":"Express"},"preferredCarrier":{"type":"string","description":"Suggested carrier name (e.g., FedEx, UPS).","example":"FedEx"},"promisedShipByDate":{"type":"string","description":"Expected date when the order should be shipped.","format":"date-time","example":"2025-06-15T00:00:00Z"},"promisedDeliveryByDate":{"type":"string","format":"date-time","description":"Expected date when the order should be delivered.","example":"2025-06-20T00:00:00Z"},"deliveryInstructions":{"type":"string","description":"Free-text delivery notes (e.g., Leave at front door, Gate code 1234).","example":"Leave at the front door."}}},"vasCodes":{"type":"array","description":"Extra services applied to the order when rating or generating shipping labels.\nSupported values depend on the selected carrier/service.\n","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of value-added service (e.g., Insurance, Signature).","example":"Insurance"},"details":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional details for the selected vas service (e.g., Coverage up to $500)."},"children":[]}]}]}],"example":"Coverage up to $500"}}}},"customFields":{"type":"array","description":"Extensible name/value pairs for tenant-specific metadata\n","items":{"$ref":"#/components/schemas/CustomField"}}}}},"components/schemas/Items":{"id":"components/schemas/Items","kind":"json-schema","title":"Items","data":{"type":"object","properties":{"productId":{"type":"string"},"variantId":{"type":"string"},"name":{"type":"string"},"sku":{"type":"string"},"quantity":{"type":"integer"},"unitWeight":{"$ref":"#/components/schemas/Weight"},"dimensions":{"$ref":"#/components/schemas/Dimension"},"priceDetails":{"$ref":"#/components/schemas/PriceDetails"},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}}}}},"components/schemas/OrderMessage":{"id":"components/schemas/OrderMessage","kind":"json-schema","title":"OrderMessage","data":{"type":"object","description":"An optional message added to an order, such as a gift note or a short greeting.\n","properties":{"type":{"type":"string","description":"The type for the message.","enum":["ANNIVERSARY","BIRTHDAY","GIFT"],"example":"GIFT"},"message":{"type":"string","description":"The message text shown with the order.\nMaximum length is 200 characters.\n","maxLength":200,"example":"Happy Birthday! Enjoy your gift."}}}},"components/schemas/TaxDetails":{"id":"components/schemas/TaxDetails","kind":"json-schema","title":"TaxDetails","data":{"type":"object","properties":{"total":{"type":"number","format":"float","example":5},"taxes":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"Sales Tax"},"amount":{"type":"number","example":5},"percentage":{"type":"number","example":5}}}}}}},"components/schemas/DiscountDetails":{"id":"components/schemas/DiscountDetails","kind":"json-schema","title":"DiscountDetails","data":{"type":"object","properties":{"total":{"type":"number","format":"float","example":5},"discounts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"Promotional"},"amount":{"type":"number","example":5},"name":{"type":"string","example":"Promo Code"}}}}}}},"components/schemas/PackagingInfo":{"id":"components/schemas/PackagingInfo","kind":"json-schema","title":"PackagingInfo","data":{"type":"object","properties":{"type":{"type":"string","example":"Promo Code"},"weight":{"$ref":"#/components/schemas/Weight"},"dimensions":{"$ref":"#/components/schemas/Dimension"}}}},"components/schemas/HandlingDetails":{"id":"components/schemas/HandlingDetails","kind":"json-schema","title":"HandlingDetails","data":{"type":"object","properties":{"preferredShipping":{"type":"string","example":"Express"},"preferredCarrier":{"type":"string","example":"FedEx"},"promisedShipByDate":{"type":"string","format":"date-time","example":"2025-06-15T00:00:00Z"},"promisedDeliveryByDate":{"type":"string","format":"date-time","example":"2025-06-20T00:00:00Z"},"deliveryInstructions":{"type":"string","example":"Leave at the front door."}}}},"components/schemas/Weight":{"id":"components/schemas/Weight","kind":"json-schema","title":"Weight","data":{"type":"object","properties":{"uom":{"type":"string","example":"kg"},"value":{"type":"number","example":3}}}},"components/schemas/Dimension":{"id":"components/schemas/Dimension","kind":"json-schema","title":"Dimension","data":{"type":"object","properties":{"uom":{"type":"string","example":"cm"},"values":{"type":"object","properties":{"length":{"type":"number","example":30},"width":{"type":"number","example":20},"height":{"type":"number","example":10}}}}}},"components/schemas/CustomFields":{"id":"components/schemas/CustomFields","kind":"json-schema","title":"CustomFields","data":{"type":"object","properties":{"name":{"type":"string","example":"CustomField1"},"value":{"type":"string","example":"CustomField1"}}}},"components/schemas/VASCode":{"id":"components/schemas/VASCode","kind":"json-schema","title":"VASCode","data":{"type":"object","properties":{"type":{"type":"string","example":"Insurance"},"details":{"type":"string","example":"Coverage up to $500"}}}},"components/schemas/OrderItemDetailed":{"id":"components/schemas/OrderItemDetailed","kind":"json-schema","title":"OrderItemDetailed","data":{"type":"object","properties":{"productId":{"type":"string"},"variantId":{"type":"string"},"name":{"type":"string"},"sku":{"type":"string"},"quantity":{"type":"integer"},"unitWeight":{"type":"object","properties":{"uom":{"type":"string"},"value":{"type":"number"}}},"dimensions":{"type":"object","properties":{"uom":{"type":"string"},"values":{"type":"object","properties":{"length":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}}}},"priceDetails":{"type":"object","properties":{"unitPrice":{"type":"number"},"salePrice":{"type":"number"},"tax":{"type":"number"},"shippingCost":{"type":"number"},"discount":{"type":"number"},"subTotal":{"type":"number"}}},"customFields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"paymentDetails":{"type":"object","properties":{"currency":{"type":"string"},"billingStatus":{"type":"string"},"gmv":{"type":"number"},"subTotal":{"type":"number"},"totalPaid":{"type":"number"},"shippingTotal":{"type":"number"},"paymentType":{"type":"string"},"taxDetails":{"type":"object","properties":{"total":{"type":"number","format":"float"},"taxes":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"amount":{"type":"number"},"percentage":{"type":"number"}}}}}}}},"discountDetails":{"type":"object","properties":{"total":{"type":"number"},"discounts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"amount":{"type":"number"},"name":{"type":"string"}}}}}},"packagingInfo":{"type":"object","properties":{"type":{"type":"string"},"weight":{"type":"object","properties":{"uom":{"type":"string"},"value":{"type":"number"}}},"dimensions":{"type":"object","properties":{"uom":{"type":"string"},"values":{"type":"object","properties":{"length":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}}}}}}},"handlingDetails":{"type":"object","properties":{"preferredShipping":{"type":"string"},"preferredCarrier":{"type":"string"},"promisedShipByDate":{"type":"string","format":"date-time"},"promisedDeliveryByDate":{"type":"string","format":"date-time"},"deliveryInstructions":{"type":"string"}}}}}},"components/schemas/UpdateFullOrderResponse":{"id":"components/schemas/UpdateFullOrderResponse","kind":"json-schema","title":"UpdateFullOrderResponse","data":{"type":"object","properties":{"orderId":{"type":"string","description":"System-generated unique identifier for the replaced order.","example":"PB6n8zVTgxZb"},"orderNumber":{"type":"string","description":"Client-provided order reference number used in the request.","example":"ORD123456xxxxxx3241234"},"status":{"type":"string","description":"Current state of the order after replacement.","example":"New"},"message":{"type":"string","description":"Confirmation message for the replace operation.","example":"Order replaced successfully"},"transactionDateTime":{"type":"string","format":"date-time","description":"Timestamp when the replacement operation occurred.","example":"2025-07-12T18:48:26.069Z"}}}},"components/schemas/CreatePackageRequest":{"id":"components/schemas/CreatePackageRequest","kind":"json-schema","title":"CreatePackageRequest","data":{"type":"object","properties":{"fromAddress":{"$ref":"#/components/schemas/Address"},"toAddress":{"$ref":"#/components/schemas/Address"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item","required":["fromAddress","toAddress","customerInfo","items"]}}}}},"components/schemas/PackageResponse":{"id":"components/schemas/PackageResponse","kind":"json-schema","title":"PackageResponse","data":{"type":"object","properties":{"id":{"type":"string"},"packageId":{"type":"string"},"shipRequestId":{"type":"string"},"orderIdentifiers":{"type":"string","nullable":true},"shipmentId":{"type":"string"},"status":{"type":"string"},"customerInfo":{"$ref":"#/components/schemas/CustomerInfo"},"fromAddress":{"$ref":"#/components/schemas/Address"},"toAddress":{"$ref":"#/components/schemas/Address"},"returnAddress":{"type":"object","properties":{"residential":{"type":"boolean"}}},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}},"shippingCost":{"type":"number"},"packageValue":{"type":"number"},"assignee":{"type":"string"},"preferredCarrierDetails":{"type":"object","properties":{"carrier":{"type":"string"},"service":{"type":"string"}}},"label":{"type":"string","nullable":true},"insuranceInfo":{"type":"object","properties":{"provider":{"type":"string"},"insuredValue":{"type":"number"}}},"handlingdetails":{"type":"object","properties":{"Prop1":{"type":"string"}}},"customFields":{"nullable":true,"type":"object"},"notes":{"nullable":true,"type":"string"},"shipByDate":{"type":"string","format":"date-time"},"activities":{"type":"array","items":{"$ref":"#/components/schemas/Activity"}},"createdDateTime":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedDateTime":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"}}}},"components/schemas/ItemsDuplicate":{"id":"components/schemas/ItemsDuplicate","kind":"json-schema","title":"ItemsDuplicate","data":{"type":"array","description":"Items included in the order.","items":{"type":"object","properties":{"customsProductId":{"type":"string","description":"Custom product identifier.","example":"CP001"},"itemId":{"type":"string","description":"Item identifier.","example":"ITEM12345"},"url":{"type":"string","description":"Product page URL.","example":"https://example.com/products/wireless-mouse"},"description":{"type":"string","description":"Product description.","example":"Wireless Mouse"},"hSTariffCode":{"type":"string","description":"HS tariff code for customs.","example":"847160"},"hSTariffCodeCountry":{"type":"string","description":"Country whose HS system is used.","example":"US"},"originCountryCode":{"type":"string","description":"Country of origin (ISO 2-letter).","example":"US"},"originStateProvince":{"type":"string","description":"State or province of origin.","example":"TX"},"quantity":{"type":"integer","description":"Quantity of the item.","example":2},"qualityUOM":{"type":"string","description":"Unit of measure for quantity.","example":"KG"},"unitPrice":{"type":"number","format":"double","description":"Price per unit.","example":25},"unitWeight":{"type":"object","description":"Weight of a single unit.","properties":{"unitOfMeasurement":{"type":"string","description":"Unit of weight.","example":"GM"},"weight":{"type":"number","format":"double","description":"Weight value.","example":500}}},"weightUnit":{"type":"string","description":"Unit used for total weight.","example":"GM"},"weight":{"type":"number","format":"double","description":"Total weight of the item.","example":1},"value":{"type":"number","format":"double","description":"Total value of the item.","example":50},"documentsOnly":{"type":"boolean","description":"Indicates if the item contains documents only.","example":false},"hazardous":{"type":"boolean","description":"Indicates if the item is hazardous.","example":false},"packageDetails":{"type":"object","description":"Packaging details for the item.","properties":{"packageType":{"type":"string","description":"Package type defined by the carrier.","example":"PKG"},"packageName":{"type":"string","description":"Name of the package.","example":"Small Box"},"packageDimension":{"type":"object","description":"Dimensions of the package.","properties":{"length":{"type":"number","description":"Package length.","example":25},"width":{"type":"number","description":"Package width.","example":15},"height":{"type":"number","description":"Package height.","example":10},"uom":{"type":"string","description":"Unit of measurement for dimensions.","example":"cm"}}},"packageWeight":{"type":"object","description":"Weight of the package.","properties":{"value":{"type":"number","description":"Package weight.","example":1000},"uom":{"type":"string","description":"Unit of weight.","example":"GM"},"weightHidden":{"type":"boolean","description":"Indicates if weight is hidden.","example":false}}},"packageId":{"type":"string","description":"Package identifier.","example":"PKG12345"},"thickOrRigid":{"type":"boolean","description":"Indicates if the package is thick or rigid.","example":false},"carrierParcelTypes":{"type":"array","description":"Carrier-specific parcel types.","items":{"type":"object","properties":{"carrier":{"type":"string","description":"Carrier name.","example":"UPS"},"parcelType":{"type":"string","description":"Parcel type for the carrier.","example":"PKG"}}}},"packageDescription":{"type":"string","description":"Description printed on labels or documents.","example":"Retail product packaging"},"isDocument":{"type":"boolean","description":"Indicates if the package contains documents.","example":false}}}}}}},"components/schemas/Item":{"id":"components/schemas/Item","kind":"json-schema","title":"Item","data":{"type":"object","required":["itemId"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents a single customs commodity item."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Either use customsProductId or item properties individually.\""},"children":[]}]}]}]}],"properties":{"customsProductId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this identifier to prefill customs item fields (HS tariff code, origin country, unit price, weight, quantity)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate custom product identifier using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/customproduct/customs-product/addcustomsproduct"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add Customs Product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: When creating an order, either provide customsProductId or individual values of an item within the item object."},"children":[]}]}]}]}],"type":"string"},"itemId":{"type":"string","description":" This is the unique identifier for the commodity (for example: sku).","example":"item1234"},"url":{"type":"string","description":"Commodity URL on merchant site.","example":"https://example.com/products/wireless-mouse"},"description":{"type":"string","description":" Detailed description of the commodity.","example":"Wireless mouse with USB receiver"},"hSTariffCode":{"type":"string","description":"Destination country's tariff-classification number for the commodity (HS tariff code). Max length: 14.","example":"847160"},"hSTariffCodeCountry":{"type":"string","description":"ISO 3166-1 alpha-2 country code supplying the HS code. Required if hSTariffCode is used.","example":"US","minLength":2,"maxLength":2},"originCountryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code where the order is originated.","example":"US"},"originStateProvince":{"type":"string","description":"ISO 3166-1 alpha-2 state code of the country where the order is originated.","example":""},"quantity":{"type":"integer","description":"Total number of items of this commodity.","example":2,"minimum":1},"unitPrice":{"type":"number","format":"double","description":"Price of one item of this commodity. Currency is declared under customsInfo.","example":25,"minimum":0},"weight":{"type":"number","format":"double","description":"Required. The parcel's weight.","example":12.5},"weightUnit":{"type":"string","description":"Weight and unit of measure of one item of the commodity.","example":"OZ","enum":["OZ","GM"]}}}},"components/schemas/Itemnotused":{"id":"components/schemas/Itemnotused","kind":"json-schema","title":"Itemnotused","data":{"type":"object","required":["sku"],"description":"Represents a single item in an order, including product details, pricing, and fulfillment info.","properties":{"lineItemId":{"type":"string","description":"Unique identifier for the line item within the order.","example":"ITEM123"},"productId":{"type":"string","description":"Identifier of the product associated with the item.","example":"PROD001"},"variantId":{"type":"string","description":"Identifier for the specific product variant (e.g., color/size).","example":"VAR001"},"name":{"type":"string","description":"Human-readable name of the product.","example":"Wireless Mouse"},"url":{"type":"string","description":"URL to the product page.","example":"https://example.com/products/wireless-mouse"},"imageUrl":{"type":"array","description":"List of URLs for product images.","items":{"example":"https://example.com/images/mouse-front.jpg"}},"sku":{"type":"string","description":"Stock Keeping Unit identifier for the product.","example":"SKU12345"},"alternateSku":{"type":"string","description":"Alternate SKU identifier for the product, if applicable.","example":"ALT-SKU001"},"quantity":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity of this item in the order (must be > 0)."},"children":[]}]}]}],"example":2},"unitWeight":{"type":"object","description":"Weight details for the item.","properties":{"unitOfMeasurement":{"type":"string","description":"Unit of measurement for weight (e.g., kg, lb).","example":"kg"},"value":{"type":"number","description":"Numeric weight value.","example":0.5}}},"dimension":{"type":"object","description":"Dimension details of the item package.","properties":{"length":{"type":"number","description":"Length of the item/package.","example":25},"height":{"type":"number","description":"Height of the item/package.","example":10},"width":{"type":"number","description":"Width of the item/package.","example":15},"unitOfMeasurement":{"type":"string","description":"Unit of measurement for dimensions (e.g., cm, in).","example":"cm"}}},"hsCode":{"type":"string","description":"Harmonized System (HS) code used for customs classification.","example":"847160"},"country":{"type":"string","description":"Country of origin for the item.","example":"US"},"shipAlone":{"type":"boolean","description":"Indicates whether this item must be shipped separately.","example":false},"priceDetails":{"type":"object","description":"Price and cost breakdown for the item.","properties":{"unitPrice":{"type":"number","description":"Base price per unit of the item.","example":25},"salePrice":{"type":"number","description":"Discounted sale price per unit, if applicable.","example":20},"tax":{"type":"number","description":"Tax amount applied to the item.","example":2.5},"shippingCost":{"type":"number","description":"Shipping cost attributed to this item.","example":5},"discount":{"type":"number","description":"Discount applied to this item.","example":3},"subTotal":{"type":"number","description":"Subtotal cost for this item (after discount, before tax/shipping).","example":42.5}}},"customFields":{"type":"array","description":"Custom fields associated with this item.","items":{"$ref":"#/components/schemas/CustomField"}},"condition":{"type":"string","description":"Condition of the item (e.g., new, refurbished).","example":"new"},"fulfilled_quantity":{"type":"integer","description":"Number of units already fulfilled.","example":1},"unfulfilled_quantity":{"type":"integer","description":"Number of units pending fulfillment.","example":1}}}},"components/schemas/Activity":{"id":"components/schemas/Activity","kind":"json-schema","title":"Activity","data":{"type":"object","properties":{"description":{"type":"string"},"activityType":{"type":"string","description":"The event type.","enum":["ORDER_CREATED","ORDER_IMPORTED","ORDER_UPDATED_PARTIAL","ORDER_UPDATED_FULL","ORDER_ITEM_ADDED","ORDER_ITEM_UPDATED","ORDER_ITEM_REMOVED","ORDER_DELETED","ORDER_STATUS_UPDATED"],"example":"ORDER_CREATED"},"transactionDateTime":{"type":"string","format":"date-time"},"transactionId":{"type":"string"},"user":{"type":"string"}}}},"components/schemas/AddItemsRequest":{"id":"components/schemas/AddItemsRequest","kind":"json-schema","title":"AddItemsRequest","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Sample Product"},"sku":{"type":"string","example":"PB17825962-1"},"quantity":{"type":"integer","example":1},"weight":{"type":"object","properties":{"unit":{"type":"string","example":"kg"},"value":{"type":"number","format":"float","example":1.5}}},"dimensions":{"type":"object","properties":{"unit":{"type":"string","example":"cm"},"length":{"type":"number","format":"float","example":30},"width":{"type":"number","format":"float","example":20},"height":{"type":"number","format":"float","example":10}}},"lotInfo":{"type":"string","example":"LOT124"},"hsCode":{"type":"string","example":"HS124"},"country":{"type":"string","example":"US"}},"required":["name","sku","quantity","weight","dimensions","country"]}}},"required":["items"]}},"components/schemas/AddItemsResponse":{"id":"components/schemas/AddItemsResponse","kind":"json-schema","title":"AddItemsResponse","data":{"type":"object","properties":{"packageId":{"type":"string","example":"PB17825962"},"status":{"type":"string","example":"Updated"},"message":{"type":"string","example":"Item(s) added successfully"},"createdDateTime":{"type":"string","format":"date-time","example":"2025-07-02T16:03:50.322613129Z"}},"required":["packageId","status","message","createdDateTime"]}},"components/schemas/RemoveItemResponse":{"id":"components/schemas/RemoveItemResponse","kind":"json-schema","title":"RemoveItemResponse","data":{"type":"object","properties":{"packageId":{"type":"string","example":"PB17825962"},"status":{"type":"string","example":"Updated"},"message":{"type":"string","example":"Item removed successfully"},"createdDateTime":{"type":"string","format":"date-time","example":"2025-07-02T16:28:40.480069221Z"}},"required":["packageId","status","message","createdDateTime"]}},"components/schemas/CustomField":{"id":"components/schemas/CustomField","kind":"json-schema","title":"CustomField","data":{"type":"object","description":"Represents a custom field for the order.","properties":{"name":{"type":"string","description":"Name of the custom field.","example":"priority"},"value":{"type":"string","description":"Value assigned to the custom field.","example":"high"}}}},"components/schemas/Note":{"id":"components/schemas/Note","kind":"json-schema","title":"Note","data":{"type":"object","properties":{"note":{"type":"string","example":"Handle with care"},"createdDate":{"type":"string","format":"date-time","example":"2025-05-23T10:00:00Z"},"createdBy":{"type":"string","example":"admin"}}}},"components/schemas/PartialUpdateOrderResponse":{"id":"components/schemas/PartialUpdateOrderResponse","kind":"json-schema","title":"PartialUpdateOrderResponse","data":{"type":"object","description":"Response after partially updating an order","properties":{"orderId":{"type":"string","description":"System-generated unique identifier of the updated order.","example":"PBNj9OB9zXvx"},"orderNumber":{"type":"string","description":"Updated reference number for the order.","example":"ORD123456"},"status":{"type":"string","description":"Current status of the order after update.","example":"Updated"},"transactionCreateDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the update transaction was processed.","example":"2025-07-02T18:27:48.172Z"}}}},"components/schemas/SearchRequest":{"id":"components/schemas/SearchRequest","kind":"json-schema","title":"SearchRequest","data":{"type":"object","properties":{"filters":{"type":"array","description":"Searches for orders based on the provided filter criteria.\nUse this request to retrieve one or more orders by orderId.\n","items":{"$ref":"#/components/schemas/Filter"}},"page":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zero-based page index to fetch."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the first page, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the second, etc."},"children":[]}]}]}]},"size":{"type":"integer","description":"Number of records per page. Choose a value that balances payload size and latency.\n"}}}},"components/schemas/Filter":{"id":"components/schemas/Filter","kind":"json-schema","title":"Filter","data":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","description":"Filter field name.","example":"orderId"},"value":{"type":"array","description":"List of values for the specified filter.","items":{"type":"string"},"example":["PBqTYEhO31JY"]}}}},"components/schemas/SearchOrdersResponse":{"id":"components/schemas/SearchOrdersResponse","kind":"json-schema","title":"SearchOrdersResponse","data":{"type":"object","description":"Paged search result containing matching orders.","properties":{"orders":{"type":"array","description":"List of orders that match the query criteria.","items":{"$ref":"#/components/schemas/GetOrderResponse"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}}}},"components/schemas/SpecialService":{"id":"components/schemas/SpecialService","kind":"json-schema","title":"SpecialService","data":{"type":"object","properties":{"inputParameters":{"type":"array","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parameters to set for the special service, such as an insurance value or a receipt-number format. This is required if the special service requires input parameters. If a special service does not require input parameters, you can either leave out the array or pass an empty array."},"children":[]}]}]}]}]}],"items":{"required":["name","value"],"type":"object","properties":{"name":{"type":"string","example":"INPUT_VALUE","description":"The name of the parameter i.e. key.","x-go-name":"Name"},"value":{"type":"string","example":"100","description":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter value is as per the carrier specifications. It provides blank value, when presence of parameter is sufficient, and no value is associated."},"children":[]}]}]}]}]}]}}}},"specialserviceId":{"type":"string","example":"Ins","description":"A unique identifier associate to the special service, which is to be applied.","x-go-name":"SpecialserviceId"}}}},"components/schemas/WorkFlowStatus":{"id":"components/schemas/WorkFlowStatus","kind":"json-schema","title":"WorkFlowStatus","data":{"type":"object","description":"Snapshot of key workflow gates for operational visibility.","properties":{"addressValidation":{"type":"string","description":"Address validation gate outcome.","enum":["PENDING","FAILED","SUCCESS"],"example":"SUCCESS"},"orderValidation":{"type":"string","description":"Business validation gate outcome.","enum":["PENDING","FAILED","SUCCESS"],"example":"PENDING"},"rulesExecution":{"type":"string","description":"Automation/rule engine gate outcome.","enum":["PENDING","FAILED","SUCCESS"],"example":"SUCCESS"}}}},"schema_301":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_301"},"schema_302":{"kind":"json-schema","data":{"type":"string"},"id":"schema_302"},"schema_303":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/CreateOrderRequest"},{"$ref":"#/components/schemas/CreateLTLOrderRequest"}]},"id":"schema_303"},"schema_304":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/GetOrderResponse"},{"$ref":"#/components/schemas/GetLTLOrderResponse"}]},"id":"schema_304"},"schema_305":{"kind":"json-schema","data":{"type":"string","description":"The orderId for the Order that needs to be updated."},"id":"schema_305"},"schema_306":{"kind":"json-schema","data":{"type":"object","required":["tagIds"],"properties":{"tagIds":{"type":"array","description":"List of tag identifiers to update for the Order.","items":{"type":"string"},"example":["Urgent"]}}},"id":"schema_306"},"schema_307":{"kind":"json-schema","data":{"type":"object","required":["tags"],"properties":{"tags":{"type":"array","description":"","items":{"type":"object","properties":{"tagIds":{"type":"array","description":"List of tag identifiers to update for the Order.","items":{"type":"string"},"example":["Urgent"]},"orderId":{"type":"string","description":"Identifier of the order which is assigned the tags.","example":"PBbqLxxxx"}}}}}},"id":"schema_307"}},"exampleStore":{},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer"}},"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/ordermanagement","description":"Production Server (uses live data)"},{"url":"https://api-ppd.shipping360.pitneybowes.com/ca/shipping","description":"Sandbox Server for Canada"},{"url":"https://api.shipping360.pitneybowes.com/ca/shipping","description":"Production Server for Canada"}]},"options":{"hideDownloadButtons":false,"hideInfoMetadata":true,"jsonSamplesExpandLevel":3,"layout":"three-panel","schemasExpansionLevel":2,"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Go"},{"lang":"Java"},{"lang":"C#"}]},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/ordermanagement.json?download"},{"url":"/_bundle/openapi/ordermanagement.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Order Management APIs","description":"Order Management APIs provide capabilities to create, retrieve, update, search, and delete orders throughout the order lifecycle. These APIs support order processing by allowing you to manage customer, item, pricing, shipping, workflow status, and tagging information in a consistent way.\n\nThe APIs support the following services:\n\n- Create a new order with customer, item, pricing, and shipping details\n- Retrieve complete order details by order ID\n- Partially update an existing order\n- Update workflow status for multiple orders\n- Delete an order or remove specific order items\n- Search orders using filter-based criteria\n- Add, update, or remove tags for single or multiple orders\n"}},"baseSlug":"/openapi/ordermanagement","routesMapping":{}}