Create Listing Statuses

You call thislisting:self

POST

/v1/listing/status

const url = 'https://api.zentail.com/v1/listing/status';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"statuses":[{"listing_id":"example","sku":"example","status":"PUBLISHED","channel_variant_id":"example","channel_status":"example","listing_url":"example","buyable":true,"errors":[{"severity":"NOTICE","classification":"inventory","affected_attributes":["example"],"error":"missing_value","message":"example"}]}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.zentail.com/v1/listing/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "statuses": [ { "listing_id": "example", "sku": "example", "status": "PUBLISHED", "channel_variant_id": "example", "channel_status": "example", "listing_url": "example", "buyable": true, "errors": [ { "severity": "NOTICE", "classification": "inventory", "affected_attributes": [ "example" ], "error": "missing_value", "message": "example" } ] } ] }'

This endpoint is restricted to developers who have registered an application with Zentail. Please refer to our guide on building a sales channel integration to learn more about the registration process and how to use the listing endpoint.

Authorizations

zentail_oauth
listing:self

Request Body^required

application/json

object

statuses

required

Array<object>

object

listing_id

The listing status Id

string

sku

required

The product sku

string

status

required

The status of the listing must be one of [‘PUBLISHED’, ‘UNPUBLISHED’, ‘SUPPRESSED’, ‘RETIRED’]

string

Allowed values: PUBLISHED UNPUBLISHED SUPPRESSED RETIRED

channel_variant_id

A unique identifier for this variant on the channel

string

channel_status

The raw status of the listing as reported by the channel

string

listing_url

Location of the listing

string

buyable

required

Whether the listing is buyable. This means it has inventory available and can be purchased on the channel.

boolean

errors

required

Any errors to display to the user

Array<object>

object

severity

required

string

Allowed values: NOTICE WARNING ERROR

classification

string

default: other

Allowed values: inventory images grouping listing_data other

affected_attributes

required

Array<string>

error

string

default: other

Allowed values: missing_value invalid_value restricted_value other

message

required

string

Responses

200

Success

*/*

object

errors

Array<object>

object

listing_id

string

sku

string

messages

Array<string>

400

Bad Request

*/*

object

errorCode

number

Example

errorMessages

Array<string>

referenceId

string format: uuid

403

Permission Denied

*/*

object

errorCode

number

Example

errorMessages

Array<string>

referenceId

string format: uuid

404

Not Found

*/*

object

errorCode

number

Example

errorMessages

Array<string>

referenceId

string format: uuid

500

Zentail Error

*/*

object

errorCode

number

Example

errorMessages

Array<string>

referenceId

string format: uuid

errorMessage

string

503

Zentail Error

*/*

object

errorCode

number

Example

errorMessages

Array<string>

referenceId

string format: uuid

API changelog

Create Listing Statuses

Authorizations

Request Bodyrequired

Responses

200

400

Example

403

Example

404

Example

500

Example

503

Example

Request Body^required