--- title: "Create Order" method: POST path: "/dpi/shipping/v1/orders" tags: ["Orders"] --- # Create Order `POST /dpi/shipping/v1/orders` ## Request - Base URL: `https://api-sandbox.dhl.com` - URL: `https://api-sandbox.dhl.com/dpi/shipping/v1/orders` - Auth: none declared. Required headers: `Authorization` Creates a new order based on the given JSON data ## Headers - `Authorization` string, required - `ThirdPartyVendor-ID` string ## Request body - OrderData - `customerEkp` string, required: Deutsche Post Customer Account number (EKP) of the customer who wants to create an order. - `items` ItemData[]: The items associated with this order. A maximum of 2500 items per request are allowed. In case of "FINALIZE" at least one item is required. - `addressLine1` string, required: First line of address information of the recipient. No unicode replacement characters � or question mark is accepted. - `addressLine2` string: Second line of address information of the recipient. No unicode replacement characters � or question mark is accepted. - `addressLine3` string: Third line of address information of the recipient. No unicode replacement characters � or question mark is accepted. - `city` string, required: City of the recipient address. No unicode replacement characters � or question mark is accepted. - `contents` Content[]: The descriptions of the content pieces. - `contentPieceAmount` integer, required: Number of pieces. - `contentPieceDescription` string, required: The (short) description of this content. - `contentPieceHsCode` string: The HS code of this content. Only 6, 8 or 10 digits, with at most one leading zero. HS Code mandatory for all shipments requiring a CN22 customs declaration. - `contentPieceIndexNumber` integer: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice. - `contentPieceNetweight` integer, required: The net weight of all pieces of this content type. - `contentPieceOrigin` string, required: Country of origin, based on ISO-3166-1. - `contentPieceValue` string, required: Overall value of the content pieces of one type. 1 to 4 digits before the decimal point, 2 digits after the decimal point or 1 to 7 digits without decimal point - `custRef` string: Reference text up to customer's choice - `custRef2` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice. - `custRef3` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice. - `destinationCountry` string, required: Destination country of the item, based on ISO-3166-1. Please check https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 for further details. - `postalCode` string: Postal code of the recipient address. Consists of numbers, upper case letters, and one space or dash between characters No unicode replacement characters � or question mark is accepted. - `product` string, required: The product that is used for the shipment of this item. Available products are: GMP [Packet Priority/Prio (goods)], GPT [Packet Tracked/Tracked], GMM [Business Mail Priority/Prio (documents)], GMR [Business Mail Registered/Plus (documents)] - `importerTaxId` string: Customs reference number of the recipient, if required and applicable e.g. EORI number. - `recipient` string, required: Name of the recipient. No unicode replacement characters � and max. one question mark is accepted. - `recipientEmail` string: Email address of the recipient. Used for notification. recipientEmail OR recipientPhone required for interconnect countries! An e-mail address or phone number for the recipient must be provided. Many postal operators have implemented electronic pick-up notifications by e-mail or SMS and the provision of this information is essential to ensure the smooth delivery of your shipments. - `recipientFax` string: Fax number of the recipient - `recipientPhone` string: Phone number of the recipient recipientEmail OR recipientPhone required for interconnect countries! An e-mail address or phone number for the recipient must be provided. Many postal operators have implemented electronic pick-up notifications by e-mail or SMS and the provision of this information is essential to ensure the smooth delivery of your shipments. - `returnItemWanted` boolean: States if a return label should be created additionally. Requires a contract for Packet Return. - `senderAddressLine1` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice. - `senderAddressLine2` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice. - `senderCity` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice. - `senderCountry` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice. - `senderEmail` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice. - `senderName` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice. - `senderPhone` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice. - `senderPostalCode` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice. - `senderTaxId` string: Customs reference number of the sender, if applicable e.g. IOSS or VOEC number. - `serviceLevel` 'PRIORITY' | 'REGISTERED', required: The service level that is used for the shipment of this item. There are restrictions for use of service level: Registered is only available with product GMR and SalesChannel DPI - `shipmentAmount` number, double: Overall value of all content pieces of the item. - `shipmentCurrency` string: Currency code of the value, based on ISO-4217. Please check https://en.wikipedia.org/wiki/ISO_4217#Active_codes for further details. - `shipmentGrossWeight` integer, required: Gross weight of the item (in g). May not exceed 2000 g. - `shipmentNaturetype` 'SALE_GOODS' | 'RETURN_GOODS' | 'COMMERCIAL_SAMPLE' | 'DOCUMENTS' | 'MIXED_CONTENTS' | 'OTHERS': Nature of the pieces in this item. Mandatory for non-EU shipments: SALE_GOODS, RETURN_GOODS, COMMERCIAL_SAMPLE, DOCUMENTS, MIXED_CONTENTS, OTHERS. Mandatory for non-EU shipments. - `state` string: State of the recipient address. No unicode replacement characters � or question mark is accepted. An empty string is still allowed - `orderStatus` 'OPEN' | 'FINALIZE', required: The status of the order. It indicates if an order shall be held open to add more items at a later point in time. "OPEN" means items can be added later, "FINALIZE" means that the order shall be processed immediately. - `paperwork` Paperwork, required - `awbCopyCount` integer, required: Copies of AWB labels. One AWB per final receptacle required. Number between 1 and 99. - `contactName` string, required: Contact name for questions from operations or sales. - `jobReference` string: Job reference for the whole shipment. - `pickupType` 'CUSTOMER_DROP_OFF': Pickup type used in pickup information. Only "CUSTOMER_DROP_OFF" is available. - `telephoneNumber` string: Telephone number for paperwork. Mandatory for sales channel EXPRESS. ## Response `200` Data of created order. - unknown ## Other responses - `403`: User 'xxx' has no permission. - `404`: There is no customer matching the given EKP. - `422`: Data error, please check response message for details. - `500`: Internal error. --- [API](https://skmtc.dev/dhl/apis/deutsche-post-international-shipping-api.md) - [All operations](https://skmtc.dev/dhl/apis/deutsche-post-international-shipping-api/llms.txt) - [OpenAPI document](https://skmtc.dev/dhl/apis/deutsche-post-international-shipping-api/revisions/33ba987e477f?raw)