Enqueue a sync

Updated on Mar 27, 2025
Published on Feb 14, 2025

2 minute(s) read

Put

/product-gateway/v1/sync/{entityType}

Enqueue a sync from an external product service to Bento's product gateway. Only 1 sync per entity type can be in progress or queued at one time. This endpoint is only supported for merchants using 'bring your own platform' for their product service.

Security

HTTP

Type bearer

Path parameters

entityType

stringRequired

Valid values[ "PRODUCT", "COLLECTION" ]

Responses

202

Sync Enqueued

Expand All

object

data

object

meta

object

Additional information about the resource.

property*

400

Bad Request

Expand All

object

error

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

401

Unauthorized

Expand All

object

error

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

403

Forbidden

Expand All

object

error

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

429

Too Many Requests

Expand All

object

error

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

500

Internal Server Error

Expand All

object

error

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

503

Service Unavailable

Expand All

object

error

Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status

string

The HTTP status code applicable to the problem

title

string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail

string

A human-readable explanation specific to this occurrence of the problem.

Was this article helpful?