Create address

TypeScript

import { Configuration, AddressesApi } from "@zippendo/sdk"

const api = new AddressesApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.createAddress({ orgId: "...", createAddressRequest: { /* ... */ } })

import os
import zippendo

config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
    result = zippendo.AddressesApi(client).create_address("...", zippendo.CreateAddressRequest())

<?php
$config = Zippendo\Sdk\Configuration::getDefaultConfiguration()->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\AddressesApi(new GuzzleHttp\Client(), $config);
$result = $api->createAddress("...", new \Zippendo\Sdk\Model\CreateAddressRequest([]));

client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.AddressesAPI.CreateAddress(ctx, "...").CreateAddressRequest(*zippendo.NewCreateAddressRequest()).Execute()

curl --request POST \
  --url https://api.zippendo.com/orgs/{orgId}/addresses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Hovedlager",
  "attContact": "Mette Hansen",
  "address1": "Vesterbrogade 1",
  "zipcode": "1620",
  "city": "København",
  "phone": "+4533123456",
  "countryCode": "DK",
  "email": "[email protected]",
  "address2": "2. sal",
  "state": "",
  "customs": {
    "eori": "DK12345678"
  },
  "addressTypes": [
    "sender"
  ],
  "brandId": "brnd_8f3kd92ld0"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Hovedlager',
    attContact: 'Mette Hansen',
    address1: 'Vesterbrogade 1',
    zipcode: '1620',
    city: 'København',
    phone: '+4533123456',
    countryCode: 'DK',
    email: '[email protected]',
    address2: '2. sal',
    state: '',
    customs: {eori: 'DK12345678'},
    addressTypes: ['sender'],
    brandId: 'brnd_8f3kd92ld0'
  })
};

fetch('https://api.zippendo.com/orgs/{orgId}/addresses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.zippendo.com/orgs/{orgId}/addresses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Hovedlager\",\n  \"attContact\": \"Mette Hansen\",\n  \"address1\": \"Vesterbrogade 1\",\n  \"zipcode\": \"1620\",\n  \"city\": \"København\",\n  \"phone\": \"+4533123456\",\n  \"countryCode\": \"DK\",\n  \"email\": \"[email protected]\",\n  \"address2\": \"2. sal\",\n  \"state\": \"\",\n  \"customs\": {\n    \"eori\": \"DK12345678\"\n  },\n  \"addressTypes\": [\n    \"sender\"\n  ],\n  \"brandId\": \"brnd_8f3kd92ld0\"\n}")
  .asString();

{
  "id": "addr_01HZX9K2QF",
  "name": "Hovedlager",
  "attContact": "Mette Hansen",
  "address1": "Vesterbrogade 1",
  "address2": "2. sal",
  "zipcode": "1620",
  "city": "København",
  "phone": "+4533123456",
  "countryCode": "DK",
  "state": null,
  "email": "[email protected]",
  "addressTypes": [
    "sender"
  ],
  "orgId": "org_01HZX9K2QF",
  "brandId": "brnd_8f3kd92ld0",
  "createdAt": "2026-06-22T09:00:00.000Z",
  "updatedAt": "2026-06-22T09:00:00.000Z",
  "customs": {
    "eori": "DK12345678"
  }
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

POST

orgs

{orgId}

addresses

TypeScript

import { Configuration, AddressesApi } from "@zippendo/sdk"

const api = new AddressesApi(new Configuration({ accessToken: process.env.ZIPPENDO_API_TOKEN }))
const result = await api.createAddress({ orgId: "...", createAddressRequest: { /* ... */ } })

import os
import zippendo

config = zippendo.Configuration(access_token=os.environ["ZIPPENDO_API_TOKEN"])
with zippendo.ApiClient(config) as client:
    result = zippendo.AddressesApi(client).create_address("...", zippendo.CreateAddressRequest())

<?php
$config = Zippendo\Sdk\Configuration::getDefaultConfiguration()->setAccessToken(getenv("ZIPPENDO_API_TOKEN"));
$api = new Zippendo\Sdk\Api\AddressesApi(new GuzzleHttp\Client(), $config);
$result = $api->createAddress("...", new \Zippendo\Sdk\Model\CreateAddressRequest([]));

client := zippendo.NewAPIClient(zippendo.NewConfiguration())
ctx := context.WithValue(context.Background(), zippendo.ContextAccessToken, os.Getenv("ZIPPENDO_API_TOKEN"))
result, _, err := client.AddressesAPI.CreateAddress(ctx, "...").CreateAddressRequest(*zippendo.NewCreateAddressRequest()).Execute()

curl --request POST \
  --url https://api.zippendo.com/orgs/{orgId}/addresses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Hovedlager",
  "attContact": "Mette Hansen",
  "address1": "Vesterbrogade 1",
  "zipcode": "1620",
  "city": "København",
  "phone": "+4533123456",
  "countryCode": "DK",
  "email": "[email protected]",
  "address2": "2. sal",
  "state": "",
  "customs": {
    "eori": "DK12345678"
  },
  "addressTypes": [
    "sender"
  ],
  "brandId": "brnd_8f3kd92ld0"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Hovedlager',
    attContact: 'Mette Hansen',
    address1: 'Vesterbrogade 1',
    zipcode: '1620',
    city: 'København',
    phone: '+4533123456',
    countryCode: 'DK',
    email: '[email protected]',
    address2: '2. sal',
    state: '',
    customs: {eori: 'DK12345678'},
    addressTypes: ['sender'],
    brandId: 'brnd_8f3kd92ld0'
  })
};

fetch('https://api.zippendo.com/orgs/{orgId}/addresses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.zippendo.com/orgs/{orgId}/addresses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Hovedlager\",\n  \"attContact\": \"Mette Hansen\",\n  \"address1\": \"Vesterbrogade 1\",\n  \"zipcode\": \"1620\",\n  \"city\": \"København\",\n  \"phone\": \"+4533123456\",\n  \"countryCode\": \"DK\",\n  \"email\": \"[email protected]\",\n  \"address2\": \"2. sal\",\n  \"state\": \"\",\n  \"customs\": {\n    \"eori\": \"DK12345678\"\n  },\n  \"addressTypes\": [\n    \"sender\"\n  ],\n  \"brandId\": \"brnd_8f3kd92ld0\"\n}")
  .asString();

{
  "id": "addr_01HZX9K2QF",
  "name": "Hovedlager",
  "attContact": "Mette Hansen",
  "address1": "Vesterbrogade 1",
  "address2": "2. sal",
  "zipcode": "1620",
  "city": "København",
  "phone": "+4533123456",
  "countryCode": "DK",
  "state": null,
  "email": "[email protected]",
  "addressTypes": [
    "sender"
  ],
  "orgId": "org_01HZX9K2QF",
  "brandId": "brnd_8f3kd92ld0",
  "createdAt": "2026-06-22T09:00:00.000Z",
  "updatedAt": "2026-06-22T09:00:00.000Z",
  "customs": {
    "eori": "DK12345678"
  }
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

{
  "error": "Bad Request",
  "message": "Failed to create address",
  "code": "CARRIER_GLS_WRONG_ADDRESS"
}

Authorizations

Authorization

string

header

required

JWT access token or API token (prefixed with zipp_)

Path Parameters

orgId

string

required

Organization ID

Example:

"org_01HZX9K2QF"

Body

application/json

name

string

required

Name of the address

Minimum string length: 1

Example:

"Hovedlager"

attContact

string

required

Attention contact person

Minimum string length: 1

Example:

"Mette Hansen"

address1

string

required

Address line 1

Minimum string length: 1

Example:

"Vesterbrogade 1"

zipcode

string

required

Postal/ZIP code

Minimum string length: 1

Example:

"1620"

city

string

required

City

Minimum string length: 1

Example:

"København"

phone

string

required

Phone number

Minimum string length: 1

Example:

"+4533123456"

countryCode

string

required

Country code (ISO 2 or 3 letter)

Required string length: 2 - 3

Example:

"DK"

string<email>

required

Email address

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Example:

"[email protected]"

address2

string

Address line 2

Example:

"2. sal"

state

string

State/Province

Example:

""

customs

object

Customs identifiers (voec, eori, sprn, ioss, fda, duns)

Show child attributes

Example:

{ "eori": "DK12345678" }

addressTypes

enum<string>[]

Address types (sender, pickup, return)

Minimum array length: 1

Address type indicating how the address is used

Available options:

sender,

pickup,

return

Example:

["sender"]

brandId

string | null

Brand this record is assigned to; null (or omitted outside a brand session) keeps it organization-wide

Minimum string length: 1

Example:

"brnd_8f3kd92ld0"

Response

Default Response

string

required

Unique address identifier

Example:

"addr_01HZX9K2QF"

name

string

required

Name of the address

Example:

"Hovedlager"

attContact

string

required

Attention contact person

Example:

"Mette Hansen"

address1

string

required

Address line 1

Example:

"Vesterbrogade 1"

address2

string | null

required

Address line 2

Example:

"2. sal"

zipcode

string

required

Postal/ZIP code

Example:

"1620"

city

string

required

City

Example:

"København"

phone

string

required

Phone number

Example:

"+4533123456"

countryCode

string

required

ISO country code

Example:

"DK"

state

string | null

required

State/Province

Example:

null

string<email>

required

Email address

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Example:

"[email protected]"

addressTypes

enum<string>[]

required

Address types (sender, pickup, return)

Address type indicating how the address is used

Available options:

sender,

pickup,

return

Example:

["sender"]

orgId

string

required

Owning organization ID

Example:

"org_01HZX9K2QF"

brandId

string | null

required

Brand this record belongs to, or null when it is organization-wide

Example:

"brnd_8f3kd92ld0"

createdAt

string

required

Creation timestamp (ISO 8601)

Example:

"2026-06-22T09:00:00.000Z"

updatedAt

string

required

Last update timestamp (ISO 8601)

Example:

"2026-06-22T09:00:00.000Z"

customs

object | null

Customs identifiers keyed by type

Show child attributes

Example:

{ "eori": "DK12345678" }

Overview

SDKs

MCP server

System

Tokens

Orgs

Brands

Addresses

Carriers

Rules

Quotes

Shipments

Orders

Carrier Catalog

Billing

Webhooks

Authorizations

Path Parameters

Body

Response