Order

Send order information

post/order

Request

  • Base URL: https://api-stg.passportshipping.com/custom/v1
  • URL: https://api-stg.passportshipping.com/custom/v1/order
  • Auth: none declared

Request body

total_valuenumber required

Total value of order in presentment currency

currency_codestring required

Currency code of the total_value

order_namestring required

Unique order identifier. We encourage this to be the same as the reference field used for shipments in the Rate API

creatednumber required

Order creation timestamp in UTC

valuenumber

Pre-discounted value (total_value + discounts). Currency should be the same as total_value.

customer_tax_idstring

Optional field to include the customer's tax ID if available. Used for customs clearance in certain countries where a local identification number is required (e.g., Brazil CPF/CNPJ, South Korea PCC, Chile RUT, etc.).

order_urlstring

Url of confirmation page once order has been placed

Example request

{
  "total_value": 100,
  "currency_code": "USD",
  "order_name": "<in your system>",
  "created": 1707811200,
  "value": 120,
  "items": [
    {
      "name": "Sample Product",
      "sku": "SKU123",
      "non_standard_manufacturer_product_id": "MFR-SKU-12345",
      "standard_manufacturer_product_id": "0012345678905",
      "requires_shipping": true,
      "value": 55,
      "value_discounted": 45,
      "quantity": 2,
      "hs_code": "1234.56.78",
      "country_of_origin": "US",
      "country_of_fulfillment": "US",
      "description": "Product description here",
      "weight": 123
    }
  ],
  "address_to": {
    "street1": "Georg-Leipold-Straße 5",
    "city": "Weiden in der Oberpfalz",
    "country": "DE",
    "name": "Daniel Gauer",
    "phone": "518-111-1111",
    "email": "daniel.gauer@web.de",
    "pudo_id": "PUDO-123456"
  },
  "shipping": {
    "id": 123456,
    "rate": 5,
    "duty": 3,
    "duty_source": "Passport",
    "tax": 2,
    "tax_source": "Passport",
    "service_name": "PassportPriorityDdpDelcon"
  },
  "customer_tax_id": "CHE-123.456.789 HR",
  "order_url": "https://passportglobal.com"
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.