Order

Update order information

put/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

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

Customer’s tax id if provided

order_urlstring

Url of confirmation page once order has been placed

Example request

{
  "total_value": 55.17,
  "currency_code": "USD",
  "order_name": "123123",
  "created": 1707811200,
  "value": 70.8,
  "items": [
    {
      "id": "123",
      "name": "Product #16787",
      "sku": "SKU456",
      "non_standard_manufacturer_product_id": "MFR-SKU-12345",
      "standard_manufacturer_product_id": "0012345678905",
      "requires_shipping": true,
      "value": 550,
      "value_discounted": 15,
      "quantity": 2,
      "hs_code": "125556.78",
      "country_of_origin": "FR",
      "country_of_fulfillment": "FR",
      "description": "Product description here",
      "weight": 88
    }
  ],
  "address_to": {
    "street1": "Georg",
    "city": "Weiden in der Oberpfalz",
    "country": "DE",
    "name": "Daniel Gauer",
    "email": "testorder@randomtest.com",
    "pudo_id": "PUDO-123456"
  },
  "shipping": {
    "id": 123456,
    "rate": 5,
    "duty": 3,
    "duty_source": "Passport",
    "tax": 2,
    "tax_source": "Passport",
    "service_code": "PassportPriorityDdpDelcon",
    "service_name": "PassportPriorityDdpDelcon"
  },
  "customer_tax_id": "test123",
  "order_url": "https://example.com"
}

Response

Success, order data has been successfully updated and saved;

Changes

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