API reference Orders Take back delivered items

Take back delivered items

POST methodhttps://api.anyshop.io/v1/orders/{id}/take_back

For a payment refunded outside anyshop, such as crypto sent back from a wallet.

Scope orders:write
Idempotent with Idempotency-Key
Works while the store is suspended

Path parameters

idstring required

Headers

Idempotency-Keystring Up to 255 characters. A retry with the same key and request gets the first answer, without running twice (24 hours).

Example

as_live_ or as_test_

curl -X POST \
  https://api.anyshop.io/v1/orders/ord_01m3rt5x2c7q9f0a4d6k8h1n3p/take_back \
  -H "Authorization: Bearer $ANYSHOP_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

{
  "object": "take_back",
  "order": "ord_01m3rt5x2c7q9f0a4d6k8h1n3p",
  "keys": 1,
  "licenses": 0
}

The IDs and keys in these examples are made up. Every schema is in the OpenAPI document, served at https://api.anyshop.io/v1/openapi.json.

Returns

The take_back object.

Errors

Status and error.type

400invalid_requestThe request is not valid; error.param names the field
401authenticationNo API key, or it is not valid
403permissionThe key does not have the scope this needs, it is a test key where only a live key may act (the catalog), or the store is suspended (store_suspended)
404not_foundNot found in the key's store and mode
409conflictConflicts with the object's state (type conflict), or an Idempotency-Key reused for another request (type idempotency, code idempotency_key_reused)
429rate_limitedToo many requests; see Retry-After