For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create a ship_to_account

Method : POST

https://os.vucustom.com/api/v1/ship_to_accounts
Example Request Body
{
    "ship_to_accounts": [
        {
        "account_number": "123",
        "address_1": "448 Test Street",
        "address_2": "",
        "alternate_name": "ATTN",
        "city": "Lawrence",
        "company_name": "",
        "country": "US",
        "email": "test@test.com",
        "first_name": "John",
        "last_name": "Doe",
        "parent_account_number": "1234",
        "phone": "(770) 210-4897",
        "postal_code": "66049",
        "state_region": "KS"
    }
    ]
}

Request Body Schema

Field Name
Type
Required
Description

parent_account_number

string

yes

Required to add this object to a sold_to_account

account_number

string

Yes

Unique identifier for the sold-to account

first_name

string

Yes

Customer's first name

last_name

string

Yes

Customer's last name

alternate_name

string

No

Can be empty.

address_1

string

Yes

Primary address line

address_2

string

No

Secondary address line, can be empty

city

string

Yes

City name

state_region

string

yes

State/province/region code

postal_code

string

Yes

Postal/ZIP code

country

string

Yes

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

company_name

string

No

Business or company name, can be empty

phone

string

No

Phone number with optional formatting

200 Successful Response Example

401 Unauthorized

The client doesn’t have correct authentication credentials.

403 Forbidden

The server is refusing to respond. This is typically caused by incorrect access.

404 Not Found

The requested resource was not found but could be available again in the future.

422 Unprocessable Entity

5xx Errors

An internal error occurred in VU Admin.

Last updated