Delete receiver

Deletes a saved receiver address.

Prerequisites

The address must have no associated shipments.

Permission

ADDRESSES_WRITE

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

DELETE/receivers/{id}

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.

Path parameters

idstringrequired

ID of the receiver. Obtain it from a list or create response. Unavailable IDs return 404.

min length 1

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

Responses

200

Successful result

successanyrequired

messagestringrequired

dataanyrequired

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 DELETE "https://bookogsend.dk/api/v1/customer/receivers/%3Creceiver-id%3E" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Idempotency-Key: <unique-operation-key>"

const response = await fetch("https://bookogsend.dk/api/v1/customer/receivers/%3Creceiver-id%3E", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Idempotency-Key": "<unique-operation-key>"
  }
});

Response

{
  "success": true,
  "message": "Receiver deleted.",
  "data": null,
  "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
}