API ReferenceListings

Update listing overrides / resync

PATCH /rest/v1/listings/{id}

PATCH
/listings/{id}

Change per-channel overrides or attributes; the listing is re-synced to the channel. Sending an empty body triggers a plain resync.

AuthorizationBearer <token>

Authorization: Bearer nbl_live_... (or nbl_test_... for test mode). Test-mode writes are validated and simulated but never persisted and never touch channels; simulated results are marked simulated.

In: header

Path Parameters

id*string

Header Parameters

Idempotency-Key?string

Unique client-generated key (max 255 chars), stored 24h.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PATCH "https://example.com/listings/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "list_9ac2e",  "object": "listing",  "product_id": "string",  "channel_account_id": "string",  "channel": "string",  "status": "listed",  "id_on_channel": "string",  "url_on_channel": "http://example.com",  "site": "string",  "overrides": {    "title": "string",    "description": "string",    "category_id": "string"  },  "attributes": {},  "variants": [    {      "variant_id": "var_66a1f1",      "sku": "string",      "id_on_channel": "string",      "status": "string"    }  ],  "issues": [    {      "code": "photo_required_for_channel",      "severity": "error",      "message": "string",      "attribute_names": [        "string"      ]    }  ],  "operation_id": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Last updated on July 28, 2026

Need help?

The API is in private beta — email us and a human replies, usually within one business day.