Skip to main content

Update Address

PATCH /customers/{customer_id}/addresses/{customer_address_id}

Update an existing customer address.

Roles​

Users with the following roles may access this endoint:

Dispatcher

Breaking Changes​

No breaking changes.

Request​

PATCH /customers/{customer_id}/addresses/{customer_address_id}/
Authorization: Bearer {your-auth-token}
Content-Type: application/json
x-tenant-id: {your-tenant-id}
{
"country": "US",
"is_billing": false,
"is_shipping": false,
"latitude": 48.076273,
"line_1": "123 A Street 2",
"line_2": "Suite 34 3",
"line_3": "2nd Door on Left 1",
"line_4": "Blue slot 1",
"locality": "Sequim 1",
"longitude": -123.117185,
"postcode": "98369",
"region": "MT"
}

Path Parameters​

customer_address_id Integer, Required

Customer address identifier.

customer_id Integer, Required

Customer identifier.

Query Parameters​

note

No query parameters.

Request Headers​

Refer to StandardRequestHeadersModel for more details.

authorization String, Required

Authorization header (bearer with access token). See the Authentication Guide to get started.

  • Matches ^bearer [a-z0-9-_=]+.[a-z0-9-_=]+.?[a-z0-9-_.+/=]*$
  • No longer than 256 characters.
  • At least 1 characters long.

Content-Type String, Optional

Default Value: application/json

One of the following MIME types:

x-api-version String, Optional

Request identifier.

  • At least 1 and no more than 64 characters.
  • Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

x-tenant-id Integer, Required

Tenant identifier. Contact CRO Software for more info if you don't already have this id. See list tenant ids for info on listing the tenants you have access to.

Request Body​

Refer to UpdateCustomerAddressModel for more details.

country String, Required

Country code (ISO 3166-1 alpha 2).

  • 2 character country code.

is_billing Boolean, Required

If true, this is the customer's billing address.

  • One of 0, 1, True, False (case insensitive).

is_shipping Boolean, Required

Customer's shipping address if true.

  • One of 0, 1, True, False (case insensitive).

latitude Float, Required

Latitude.

  • Less than or equal to 90.
  • Greater than or equal to -90.

line_1 String, Required

Street address.

  • At least 1 and no more than 256 characters.

line_2 String, Optional

Street address line 2.

  • At least 0 and no more than 256 characters.

line_3 String, Optional

Street address line 3.

  • At least 0 and no more than 256 characters.

line_4 String, Optional

Street address line 4 (doubles as county).

  • At least 0 and no more than 256 characters.

locality String, Required

Address locality (e.g. city).

  • At least 1 and no more than 86 characters.

longitude Float, Required

longitude.

  • Less than or equal to 180.
  • Greater than or equal to -180.

postcode String, Required

Postal code (may include letters and symbols).

  • At least 1 and no more than 86 characters.

region String, Required

Address region (e.g. state).

  • At least 1 and no more than 32 characters.

Response​

Response Headers​

Refer to StandardResponseHeadersModel for more details.

Content-Type String, Optional

Default Value: application/json

One of the following MIME types:

x-api-version String

Request identifier.

  • At least 1 and no more than 64 characters.
  • Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

x-request-id String

Request identifier.

  • Valid UUID.

Response Body​

Refer to CustomerAddressModel for more details.

country String

Country code (ISO 3166-1 alpha 2).

  • 2 character country code.

id Integer

Customer address identifier.

is_active Boolean

Records marked inactive are treated as deleted (soft delete).

  • One of 0, 1, True, False (case insensitive).

is_billing Boolean

If true, this is the customer's billing address.

  • One of 0, 1, True, False (case insensitive).

is_physical Boolean

Physical address if true.

  • One of 0, 1, True, False (case insensitive).

is_shipping Boolean

Customer's shipping address if true.

  • One of 0, 1, True, False (case insensitive).

latitude Float

Latitude.

  • Less than or equal to 90.
  • Greater than or equal to -90.

line_1 String

Street address.

  • At least 1 and no more than 256 characters.

line_2 String

Street address line 2.

  • At least 0 and no more than 256 characters.

line_3 String

Street address line 3.

  • At least 0 and no more than 256 characters.

line_4 String

Street address line 4 (doubles as county).

  • At least 0 and no more than 256 characters.

locality String

Address locality (e.g. city).

  • At least 1 and no more than 86 characters.

longitude Float

longitude.

  • Less than or equal to 180.
  • Greater than or equal to -180.

postcode String

Postal code (may include letters and symbols).

  • At least 1 and no more than 86 characters.

region String

Address region (e.g. state).

  • At least 1 and no more than 32 characters.

Code Samples​

using System;
using System.Net;
using System.Collections.Specialized;

namespace CROSoftware
{
public class DemoClient
{
    static public void Main ()
    {
        WebClient client = new WebClient();

        // URL    
        String url = "/customers/{customer_id}/addresses/{customer_address_id}";

        // Headers
        client.Headers.Add("Authorization", "Bearer {your-auth-token}");
        client.Headers.Add("Content-Type", "application/json");
        client.Headers.Add("x-tenant-id", "{your-tenant-id}");

        // Body
        String body = "{\"country\": \"US\", \"is_billing\": false, \"is_shipping\": false, \"latitude\": 48.076273, \"line_1\": \"123 A Street 2\", \"line_2\": \"Suite 34 3\", \"line_3\": \"2nd Door on Left 1\", \"line_4\": \"Blue slot 1\", \"locality\": \"Sequim 1\", \"longitude\": -123.117185, \"postcode\": \"98369\", \"region\": \"MT\"}";

        String json = client.UploadString(url, "patch", body);
        Console.WriteLine(json);
    }
}
}