Create an order

Method : POST 

https://os.vucustom.com/api/:api_version/orders
Example Request 
curl --location 'https://admin.vucustom.com/api/:api_version/orders' \
--data '
{
    "order": {
        "currency": "USD",
        "custom_attributes": {},
        "note": "Sample note.",
        "order_date": "2022-10-31T01:54:56.271Z",
        "order_lines": [
            {
                "custom_attributes": {},
                "customer_requested_date": "2023-05-23",
                "factory_code": "factory123",
                "line_reference": "59861396",
                "price": 70,
                "product_description": "My Widget",
                "quantity": 1,
                "recipe_token": "1609c0e8",
                "sku": "SKU123",
                "tags": [
                    "tag1",
                    "tag2"
                ],
                "upc": "UPC123"
            }
        ],
        "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",
            "first_name": "John",
            "last_name": "Smith",
            "phone": "2011231234",
            "postal_code": "07450",
            "state_region": "NJ"
        },
        "sold_to": {
            "account_number": "SLDTO123",
            "address_1": "123 Main St",
            "address_2": "",
            "city": "Ridgewood",
            "company_name": "VU Custom",
            "country": "US",
            "first_name": "John",
            "last_name": "Smith",
            "phone": "2011231234",
            "postal_code": "07450",
            "state_region": "NJ"
        },
        "tags": [
            "tag1",
            "tag2"
        ]
    }
}

Request Body Schema (Order)

Field Name
Type
Required
Description

currency

string

Yes

Unique identifier for the sold-to account

custom_attributes

object

No

Key-value pairs of custom data. this can be empty

note

string

No

Order notes. this can be empty

order_date

string

Yes

ISO 8601 datetime

order_number

string

Yes

Unique order identifier

purchase_order_number

string

No

PO reference number. this can be empty

ship_method_carrier

string

Yes

Carrier code

ship_method_code

string

Yes

Service level code

ship_method_description

string

Yes

Service description

sales_channel

string

Yes

Channel type (b2b/b2c)

tags

array

No

Order tags

order_lines

array

Yes

Order line items

ship_to

object

Yes

Shipping details

sold_to

object

Yes

Billing details

b2b

object

Yes

B2B specific information. required only for b2b

Request Body Schema (Order lines)

Field Name
Type
Required
Description

custom_attributes

object

No

Line item custom data

customer_requested_date

string

No

Requested delivery date

factory_code

string

No

Manufacturing facility code

line_reference

string

No

External reference

price

Integer

yes

Unit price

product_description

string

Yes

Product description

quantity

Integer

Yes

Order quantity

recipe_token

string

Yes

Customization reference

sku

string

Yes

Product SKU

tags

array

No

Line item tags. this array an be empty

upc

string

No

Product UPC

Request Body Schema (ship_to) and (sold_to)

Field Name
Type
Required
Description

account_number

string

Yes

Unique identifier for the sold-to account

address_1

string

Yes

Primary address line

address_2

string

No

Secondary address line, can be empty

city

string

Yes

City name

company_name

string

No

Business or company name, can be empty

country

string

Yes

Two-letter country code (ISO 3166-1 alpha-2)

first_name

string

Yes

Customer's first name

last_name

string

Yes

Customer's last name

phone

string

No

Phone number with optional formatting

postal_code

string

Yes

Postal/ZIP code

state_region

string

Yes

State/province/region code

200 Successful response example

PreviousOverviewNextGet an order

Last updated