Create a sold_to_account

Method : POST 

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

Request Body Schema

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

alternate_name

string

No

Alternate name

city

string

Yes

City name

country

string

Yes

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

postal_code

string

Yes

Postal/ZIP code

company_name

string

No

Business or company name, can be empty

first_name

string

Yes

Customer's first name

last_name

string

Yes

Customer's last name

phone

string

No

Phone number with optional formatting

ship_to_accounts

array

yes

this array can be empty. the array should contain objects

state_region

string

yes

State/province/region code

200 Successful response example

PreviousOverviewNextCreate a ship_to_account

Last updated