shippingAddresses

Update or create a shipping address by reference (upsert)

Requires the SHIPPING_ADDRESS.CREATE or SHIPPING_ADDRESS.UPDATE permission.

put/v{version}/shipping-addresses

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/shipping-addresses
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Headers

x-platform-idstring

Platform ID.

Request body

object_typestring nullable
idstring nullable
referencestring required
customer_idstring required

The customer owning this address. Immutable after creation.

descriptionstring nullable
status'DRAFT' | 'ACTIVE' | 'DEPRECATED'
is_defaultboolean nullable

Only ACTIVE addresses can be default. Use set-as-default to select this address and clear the previous default for the customer.

created_atstring nullable
updated_atstring nullable

Response

OK

object_typestring nullable
idstring nullable
referencestring
customer_idstring

The customer owning this address. Immutable after creation.

descriptionstring nullable
status'DRAFT' | 'ACTIVE' | 'DEPRECATED'
is_defaultboolean nullable

Only ACTIVE addresses can be default. Use set-as-default to select this address and clear the previous default for the customer.

created_atstring nullable
updated_atstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.