Get an order

Method : GET

https://os.vucustom.com/api/:api_version/orders?id=&order_number=TEST45

URL Parameters

Field Name
Required
Description

id

conditional

fetch the order by id if you dont have the order number.

order_number

conditional

fetch the order by order_number if you don't have order id

Example Request
curl --location 'https://admin.vucustom.com/api/:api_version/orders?id=&order_number='

200 Successful response example

{
  "order": {
    "created_at": "2022-10-31T01:54:56.271Z",
    "currency": "USD",
    "custom_attributes": {},
    "id": 12345,
    "note": "Sample note.",
    "order_date": "2022-10-31T01:54:56.271Z",
    "order_lines": [
      {
        "custom_attributes": {},
        "customer_requested_date": "2024-03-31",
        "estimated_arrival_date": "2024-03-31",
        "ex_factory_date": {
          "current": "2024-03-09",
          "changes": [
            {
              "reason_code": "initial",
              "reason_description": "Initial Value",
              "created_at": "2024-02-23T08:00:40.773Z",
              "estimated_arrival_date": "2024-03-31",
              "ex_factory_date": "2024-03-09"
            }
          ]
        },
        "factory_code": "factory123",
        "id": 12345,
        "line_reference": "59861396",
        "price": 70,
        "product_description": "My Widget",
        "product_id": 12345,
        "quantity": 1,
        "recipe_token": "1609c0e8",
        "status": "new_order",
        "sku": "SKU123",
        "tags": [
          "tag1",
          "tag2"
        ],
        "upc": "UPC123",
        "traveler": "{{base_url}}/api/v1/order_lines/841/traveler_file",
		"production_files": [
					"{{base_url}}/api/v1/order_lines/841/production_file/DOD_tesst51s22s1_1abf1058_tst.png"
				],
        "fulfillments": [
          {
            "created_at": "2024-03-21T08:31:48.653Z",
            "updated_at": "2024-03-21T08:31:48.653Z",
            "quantity": 1,
            "id": 79,
            "tracking_number": "test1",
            "carrier_name": "test",
            "carrier_code": "test",
            "service_name": "test",
            "service_code": "test",
            "recipient_address_1": "test",
            "recipient_city": "test",
            "recipient_name": "test",
            "recipient_state_region": "test",
            "recipient_country": "test",
            "recipient_postal_code": "test",
            "recipient_phone": "test",
            "weight": 0,
            "width": 0,
            "height": 0,
            "length": 0
          }
        ]
      }
    ],
    "order_number": "ord-12345",
    "purchase_order_number": "po-12345",
    "sales_order_number": "so-12345",
    "ship_method_carrier": "UPS",
    "ship_method_code": "XY12",
    "ship_method_description": "UPS Ground Residential",
    "sales_channel": "b2b",
    "ship_to": {
      "account_number": "SHPTO123",
      "address_1": "123 Main St",
      "address_2": "",
      "city": "Ridgewood",
      "company_name": "VU Custom",
      "country": "US",
      "created_at": "2022-10-31T01:54:56.271Z",
      "email": "test@test.com",
      "first_name": "John",
      "id": 12345,
      "last_name": "Smith",
      "phone": "2011231234",
      "postal_code": "07450",
      "state_region": "NJ",
      "updated_at": "2022-10-31T01:54:56.271Z"
    },
    "sold_to": {
      "account_number": "SLDTO123",
      "address_1": "123 Main St",
      "address_2": "",
      "city": "Ridgewood",
      "company_name": "VU Custom",
      "country": "US",
      "created_at": "2022-10-31T01:54:56.271Z",
      "email": "test@test.com",
      "first_name": "John",
      "id": 12345,
      "last_name": "Smith",
      "phone": "2011231234",
      "postal_code": "07450",
      "state_region": "NJ",
      "updated_at": "2022-10-31T01:54:56.271Z"
    },
    "tags": [
      "tag1",
      "tag2"
    ],
    "updated_at": "2022-10-31T01:54:56.271Z"
  }
}
PreviousCreate an orderNextGet a list of orders

Last updated