Create receiver

Saves a receiver address for reuse in shipment requests.

Permission

ADDRESSES_WRITE

See Troubleshooting for authentication, access, rate-limit, and service errors.

POST/receivers

Authorization

AuthorizationBearer token · headerrequired

Required header: Authorization: Bearer <customer-api-key>. Use a Customer API key with the operation's required permission. Never use a dashboard or webshop token.

Header parameters

Idempotency-Keystringrequired

Unique operation key, at most 255 characters after trimming. Retry the same request with the same key; use a new key for a changed request.

min length 1 · max length 255

Request body

requiredapplication/json

Address details to save in this account's address book. Required fields and length limits are shown in the schema.

namestringrequired

Person or company name. Required and nonempty after trimming; see maxLength. Shipment services may impose a lower name limit.

min length 1 · max length 40

street1stringrequired

Primary street address, including house number. Required and nonempty after trimming; see maxLength and service fieldLimits.

min length 1 · max length 54

street2string | any

Optional additional address line. Omit or send null to clear it; see maxLength and service fieldLimits.

default: null

Show properties

Any of:

string

string

any

any

citystringrequired

Town or city. Required and nonempty after trimming; see maxLength.

min length 1 · max length 30

zipstringrequired

Postal code as text, preserving leading zeros. It must match the country for carrier shipments; see maxLength.

min length 1 · max length 10

countrystringrequired

Supported country code in two-letter uppercase ISO format, such as DK. The country and service must have an available route and price.

matches ^[A-Z]{2}$

addressTypestringrequired

RESIDENTIAL for a private address or COMMERCIAL for a business address.

Allowed:RESIDENTIALCOMMERCIAL

regionstring | any

Optional state, province, or region as text. Omit or send null to clear it.

default: null

Show properties

Any of:

string

string

any

any

attentionstring | any

Optional contact person or attention line. Omit or send null to clear it; see maxLength.

default: null

Show properties

Any of:

string

string

any

any

emailstring<email> | any

Valid contact email address, or null. Required for a shipment receiver when GET /services reports receiverEmailRequired.

default: null

Show properties

Any of:

string<email>

string<email>

any

any

phonestring | any

Telephone number in international E.164 format, such as +4512345678, or null. Required for a shipment receiver when receiverPhoneRequired is true.

default: null

Show properties

Any of:

string

string

any

any

mobilestring | any

Mobile number in international E.164 format, such as +4512345678, or null. Required for a shipment receiver when receiverMobileRequired is true.

default: null

Show properties

Any of:

string

string

any

any

Responses

201

Successful result

successanyrequired

messagestringrequired

dataAddressRecordrequired

Show properties

namestringrequired

Person or company name. Required and nonempty after trimming; see maxLength. Shipment services may impose a lower name limit.

min length 1 · max length 40

street1stringrequired

Primary street address, including house number. Required and nonempty after trimming; see maxLength and service fieldLimits.

min length 1 · max length 54

street2string | any

Optional additional address line. Omit or send null to clear it; see maxLength and service fieldLimits.

default: null

Show properties

Any of:

string

string

any

any

citystringrequired

Town or city. Required and nonempty after trimming; see maxLength.

min length 1 · max length 30

zipstringrequired

Postal code as text, preserving leading zeros. It must match the country for carrier shipments; see maxLength.

min length 1 · max length 10

countrystringrequired

Supported country code in two-letter uppercase ISO format, such as DK. The country and service must have an available route and price.

matches ^[A-Z]{2}$

addressTypestringrequired

RESIDENTIAL for a private address or COMMERCIAL for a business address.

Allowed:RESIDENTIALCOMMERCIAL

regionstring | any

Optional state, province, or region as text. Omit or send null to clear it.

default: null

Show properties

Any of:

string

string

any

any

attentionstring | any

Optional contact person or attention line. Omit or send null to clear it; see maxLength.

default: null

Show properties

Any of:

string

string

any

any

emailstring<email> | any

Valid contact email address, or null. Required for a shipment receiver when GET /services reports receiverEmailRequired.

default: null

Show properties

Any of:

string<email>

string<email>

any

any

phonestring | any

Telephone number in international E.164 format, such as +4512345678, or null. Required for a shipment receiver when receiverPhoneRequired is true.

default: null

Show properties

Any of:

string

string

any

any

mobilestring | any

Mobile number in international E.164 format, such as +4512345678, or null. Required for a shipment receiver when receiverMobileRequired is true.

default: null

Show properties

Any of:

string

string

any

any

idstringrequired

Saved address ID belonging to the authenticated account.

statusstringrequired

ACTIVE or ARCHIVED address-book status. On update, omit to retain the current status. Changing an address does not rewrite shipment snapshots.

Allowed:ACTIVEARCHIVED

createdAtstring<date-time>required

Timestamp when this saved address was created.

requestIdstringrequired

400

Invalid input or unsupported operation.

successanyrequired

messagestringrequired

dataanyrequired

requestIdstringrequired

errorCodestringrequired

errorsobject | anyrequired

Show properties

Any of:

object

fieldsobject[]

Show properties

Array of object

pathstringrequired

errorCodestringrequired

messagestringrequired

pricePrice

Show properties

currencystringrequired

baseAmountstringrequired

surchargeAmountstringrequired

palletExchangeAmountstringrequired

taxAmountstringrequired

totalAmountstringrequired

currentStatusstring

retryAfterSecondsinteger

min 1

any

any

404

Resource does not exist or belongs to another account.

successanyrequired

messagestringrequired

dataanyrequired

requestIdstringrequired

errorCodestringrequired

errorsobject | anyrequired

Show properties

Any of:

object

fieldsobject[]

Show properties

Array of object

pathstringrequired

errorCodestringrequired

messagestringrequired

pricePrice

Show properties

currencystringrequired

baseAmountstringrequired

surchargeAmountstringrequired

palletExchangeAmountstringrequired

taxAmountstringrequired

totalAmountstringrequired

currentStatusstring

retryAfterSecondsinteger

min 1

any

any

409

State, idempotency, price, or label conflict; inspect errorCode and errors.

successanyrequired

messagestringrequired

dataanyrequired

requestIdstringrequired

errorCodestringrequired

errorsobject | anyrequired

Show properties

Any of:

object

fieldsobject[]

Show properties

Array of object

pathstringrequired

errorCodestringrequired

messagestringrequired

pricePrice

Show properties

currencystringrequired

baseAmountstringrequired

surchargeAmountstringrequired

palletExchangeAmountstringrequired

taxAmountstringrequired

totalAmountstringrequired

currentStatusstring

retryAfterSecondsinteger

min 1

any

any

Request

curl -X POST "https://bookogsend.dk/api/v1/customer/receivers" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Idempotency-Key: <unique-operation-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example Company",
  "street1": "Østerbrogade 1",
  "city": "København Ø",
  "zip": "2100",
  "country": "DK",
  "addressType": "COMMERCIAL"
}'

const response = await fetch("https://bookogsend.dk/api/v1/customer/receivers", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Idempotency-Key": "<unique-operation-key>",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"Example Company\",\n  \"street1\": \"Østerbrogade 1\",\n  \"city\": \"København Ø\",\n  \"zip\": \"2100\",\n  \"country\": \"DK\",\n  \"addressType\": \"COMMERCIAL\"\n}"
});

Response

{
  "success": true,
  "message": "Receiver created.",
  "data": {
    "name": "Example Company",
    "street1": "Østerbrogade 1",
    "city": "København Ø",
    "zip": "2100",
    "country": "DK",
    "addressType": "COMMERCIAL",
    "street2": null,
    "region": null,
    "attention": null,
    "email": null,
    "phone": null,
    "mobile": null,
    "id": "<receiver-id>",
    "status": "ACTIVE",
    "createdAt": "2030-01-01T10:00:00.000Z"
  },
  "requestId": "<request-id>"
}

{
  "success": false,
  "message": "Invalid input or unsupported operation.",
  "data": null,
  "requestId": "request-id",
  "errorCode": "BAD_REQUEST",
  "errors": null
}

{
  "success": false,
  "message": "Resource does not exist or belongs to another account.",
  "data": null,
  "requestId": "request-id",
  "errorCode": "NOT_FOUND",
  "errors": null
}

{
  "success": false,
  "message": "State, idempotency, price, or label conflict; inspect errorCode and errors.",
  "data": null,
  "requestId": "request-id",
  "errorCode": "IDEMPOTENCY_KEY_REUSED",
  "errors": null
}