Batch update ship_to_account

Method : POST

https://admin.vucustom.com/api/:api_version/sold_to_accounts/bulk

Example Request Body

curl --location 'https://admin.vucustom.com/api/v1/sold_to_accounts/bulk' \
--data-raw '{
    "sold_to_accounts": [
        {
            "account_number": "123",
            "address_1": "448 Test Street",
            "address_2": "",
            "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": "",
                    "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

sold_to_accounts

array

Yes

if an object which is present in this array and not present in the DB it will get added.

if an object which is present in this array and also present in the DB it will get updated with the information provided.

An array of ship_to_account objects should be present for each sold_to account.

ship_to_accounts

array

Yes

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": "(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",
        "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"
      }
    ],
    "state_region": "KS",
    "updated_at": "2022-10-31T01:54:56.271Z"
  }
}

401 Unauthorized

The client doesn’t have correct authentication credentials.

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

422 Unprocessable Entity

5xx Errors

An internal error occurred in VU Admin.

PreviousBatch update sold_to_account NextGet a list of sold_to_accounts

Last updated 5 months ago

curl --location 'https://admin.vucustom.com/api/v1/sold_to_accounts/bulk' \ --data-raw '{ "sold_to_accounts": [ { "account_number": "123", "address_1": "448 Test Street", "address_2": "", "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": "", "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" } ] }' }

{ "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": "(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", "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" } ], "state_region": "KS", "updated_at": "2022-10-31T01:54:56.271Z" } }