Order

Get orders

get/order

Request

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

Query parameters

orderNamesstring required

Unique order identifier used to update an order. This is not case sensitive.

Response

Request successfully processed

order_namestring

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

creatednumber

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.).

integration_idnumber
presentment_currencystring

The currency to which all amounts should be converted to.

value_discounted_presentment_currencynumber

Example response

[
  {
    "order_name": "store1_order001",
    "created": 1707811200,
    "value": 120,
    "items": [
      {
        "name": "Sample Product",
        "sku": "SKU123",
        "requires_shipping": true,
        "value": 55,
        "value_discounted": 45,
        "quantity": 2,
        "hs_code": "1234.56.78",
        "country_of_origin": "US",
        "description": "Product description here",
        "weight": 123
      }
    ],
    "address_to": {
      "street1": "30 Rue de la Baie",
      "city": "Gatineau",
      "state": "QC",
      "zip": "J8T 3H5",
      "country": "CA",
      "name": "Daniel Gauer",
      "email": "test@test.test"
    },
    "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",
    "integration_id": 6,
    "presentment_currency": "USD",
    "value_discounted_presentment_currency": 150
  }
]

Changes

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