Create a ship_to_account

Method : POST

https://admin.vucustom.com/api/:api_version/ship_to_accounts
Example Request Body
{
    "ship_to_account": {
        "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

{
  "ship_to_account": {
    "account_number": "123",
    "address_1": "448 Test Street",
    "address_2": "",
    "alternate_name": "ATTN",
    "city": "Lawrence",
    "company_name": "",
    "country": "US",
    "created_at": "2022-10-31T01:54:56.271Z",
    "email": "test@test.com",
    "first_name": "John",
    "id": 12345,
    "last_name": "Doe",
    "phone": "(770) 210-4897",
    "postal_code": "66049",
    "sold_to_account_number": "123",
    "state_region": "KS",
    "updated_at": "2022-10-31T01:54:56.271Z"
  }
}
PreviousCreate a sold_to_accountNextBatch update sold_to_account

Last updated