Overview

An order represents a customer's request to purchase one or more products in VU Custom. The Orders API provides comprehensive endpoints for creating, retrieving, updating, and managing order information, including associated order lines, fulfillments, and tags.

Core Concepts

Order Structure

Basic order information (order number, dates, currency)
B2B organization details
Shipping and billing information (sold-to and ship-to details)
Order lines containing product and customization details
Fulfillment information
Custom attributes and tags

Available Methods

Order Management

Create an Order
- POST /api/{version}/orders
- Creates a new order with product details and customer information
Retrieve Orders
- GET /api/{version}/orders
- List orders with optional filters:
  - Status
  - Tags (with/without)
  - Limit
  - Since ID
- GET /api/{version}/orders?id={id}
- Retrieve a specific order by ID or order number
Update an Order
- PUT /api/{version}/orders
- Update order details such as:
  - Purchase order number
  - Sales order number
  - Shipping method
  - Notes
  - Custom attributes
Delete an Order
- DELETE /api/{version}/orders
- Remove an order by ID or order number

Tag Management

Add Tags
- POST /api/{version}/orders/tags
- Add tags to a specific order
- POST /api/{version}/orders/tags/bulk
- Add tags to multiple orders
Delete Tags
- DELETE /api/{version}/orders/tags
- Remove tags from a specific order
- DELETE /api/{version}/orders/tags/bulk
- Remove tags from multiple orders

Key Features

Support for B2B and B2C orders
Comprehensive order tracking
Flexible customization through custom attributes
Detailed fulfillment tracking
Tag-based organization and filtering
Bulk operations for efficient management

Complete Response - Sample References

The following code sample demonstrates all response types that the API is capable of returning.

JSON Complete Sample

{
    "order": [
        {
            "b2b": {
                "individual": {
                    "first_name": "John",
                    "id": 12345,
                    "last_name": "Smith"
                },
                "organization": {
                    "organization_group": {
                        "league": {
                            "pro": "nhl"
                        }
                    },
                    "id": 12345,
                    "name": "ABC Company "
                },
                "customer":{
                    "id": 1,
                    "name": "Test"
                }
            },
            "created_at": "2022-10-31T01:54:56.271Z",
            "currency": "JPY",
            "custom_attributes": {"order_type": "BOOKING"},
            "id": 12345,
            "note": "Sample note updated.",
            "order_date": "2022-10-31T01:54:56.271Z",
            "order_lines": [
                {
                    "custom_attributes": {},
                    "customer_requested_date": "2024-03-09",
                    "estimated_arrival_date": "2024-03-09",
                    "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,
                    "purchase_order_number": "po-12345",
                    "quantity": 1,
                    "recipe_token": "1609c0e8",
                    "sales_order_number":"so-12345",
                    "sku": "SKU123",
                    "status": "new_order",
                    "tags": [
                        "tag1",
                        "tag2"
                    ],
                    "upc": "UPC123",
                     "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": "ups_standard",
            "ship_method_description": "Standard",
            "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"
        }
    ]
}

CURL complete sample

curl --location --request  JSON '' \
--data-raw '{
    "order": [
        {
            "b2b": {
                "individual": {
                    "first_name": "John",
                    "id": 12345,
                    "last_name": "Smith"
                },
                "organization": {
                    "organization_group": {
                        "league": {
                            "pro": "nhl"
                        }
                    },
                    "id": 12345,
                    "name": "ABC Company "
                },
                "customer":{
                    "id": 1,
                    "name": "Test"
                }
            },
            "created_at": "2022-10-31T01:54:56.271Z",
            "currency": "JPY",
            "custom_attributes": {"order_type": "BOOKING"},
            "id": 12345,
            "note": "Sample note updated.",
            "order_date": "2022-10-31T01:54:56.271Z",
            "order_lines": [
                {
                    "custom_attributes": {},
                    "customer_requested_date": "2024-03-09",
                    "estimated_arrival_date": "2024-03-09",
                    "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,
                    "purchase_order_number": "po-12345",
                    "quantity": 1,
                    "recipe_token": "1609c0e8",
                    "sales_order_number":"so-12345",
                    "sku": "SKU123",
                    "status": "new_order",
                    "tags": [
                        "tag1",
                        "tag2"
                    ],
                    "upc": "UPC123",
                     "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": "ups_standard",
            "ship_method_description": "Standard",
            "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"
        }
    ]
}'

PreviousDelete a ship_to_account NextCreate an order

Last updated 2 months ago