Update or create a shipping address by reference (upsert) | Solvimon

curl -X PUT https://test.api.solvimon.com/v1/shipping-addresses \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "reference": "austin_hq",
  "customer_id": "cust_UwDeeN0vxxHxMTCJeF1K",
  "recipient": {
    "type": "ORGANIZATION",
    "organization": {
      "company_name": "Northwind Robotics, Inc."
    },
    "phone_number": "+15125550142",
    "email": "facilities@northwind-robotics.example.com"
  },
  "address": {
    "line1": "1801 Congress Avenue",
    "line2": "Suite 400",
    "city": "Austin",
    "postal_code": "78701",
    "state": "TX",
    "country": "US"
  }
}'

{
  "object_type": "string",
  "id": "string",
  "reference": "string",
  "customer_id": "string",
  "description": "string",
  "status": "DRAFT",
  "recipient": {
    "type": "ORGANIZATION",
    "organization": {
      "company_name": "string",
      "attention_name": "string"
    },
    "individual": {
      "name": {
        "first_name": "string",
        "last_name": "string",
        "infix": "string"
      }
    },
    "phone_number": "string",
    "email": "string"
  },
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "postal_code": "string",
    "state": "string",
    "country": "AD"
  },
  "is_default": true,
  "created_at": "string",
  "updated_at": "string"
}

Requires the SHIPPING_ADDRESS.CREATE or SHIPPING_ADDRESS.UPDATE permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

Request

This endpoint expects an object.

referencestringRequiredformat: "^\S+$"0-256 characters

customer_idstringRequired

The customer owning this address. Immutable after creation.

recipientobjectRequired

addressobjectRequired

descriptionstring or nullOptionalformat: "^.*$"0-256 characters

Response

object_typestring or nullOptionalRead-only

idstring or nullOptionalRead-only

referencestringOptionalformat: "^\S+$"0-256 characters

customer_idstringOptional

The customer owning this address. Immutable after creation.

descriptionstring or nullOptionalformat: "^.*$"0-256 characters

statusenum or nullOptionalRead-only

Allowed values:

recipientobjectOptional

addressobjectOptional

is_defaultboolean or nullOptionalRead-only

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

created_atstring or nullOptionalRead-only

updated_atstring or nullOptionalRead-only

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors