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": "[phone]",
        "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": "[e-mail]",
                "first_name": "John",
                "last_name": "Doe",
                "phone": "[phone]",
                "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

200 Successful response example

{
  "sold_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",
    "first_name": "John",
    "id": 12345,
    "last_name": "Doe",
    "phone": "[phone]",
    "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",
        "created_at": "2022-10-31T01:54:56.271Z",
        "email": "[e-mail]",
        "first_name": "John",
        "id": 12345,
        "last_name": "Doe",
        "phone": "[phone]",
        "postal_code": "66049",
        "sold_to_account_number": "123",
        "state_region": "KS",
        "updated_at": "2022-10-31T01:54:56.271Z"
      }
    ],
    "state_region": "KS",
    "updated_at": "2022-10-31T01:54:56.271Z"
  }
}

401

401 Unauthorized

The client doesn’t have correct authentication credentials.

{
"errors": "[API] Invalid API key or secret (unrecognized login or wrong password)"
}

403

403 Forbidden

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

404

404 Not Found

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

422

422 Unprocessable Entity

5xx

5xx Errors

An internal error occurred in VU Admin.