Skip to content

Duplicate

BetaAPI v2 is in public beta: endpoints, fields and behaviour can change before general availability. See the changelog

POST
/preorders/offers/{id}/duplicate
curl --request POST \
--url https://app.stoqapp.com/api/v2/external/preorders/offers/example/duplicate \
--header 'X-Auth-Token: <X-Auth-Token>'

Duplicate a preorder offer, as the dashboard’s Duplicate does. Returns the new offer.

Note: The copy has every setting, payment option and batch of the original, named “<internal_name> (Copy)” (“(Copy 2)” and so on when taken). It starts off, with no products (selection is a custom list, empty), no schedule and no automatic hold release. A ship or balance date already in the past is reset: delivery to asap, the balance charge to none remaining. A deleted offer returns 404; restore it first.

id
required
string

Success — the updated resource.

Media typeapplication/json
object

Example generated

{}

Accepted — async/bulk work was queued. Poll the returned job.

Media typeapplication/json

Returned for async/bulk work — poll the job until it reaches a terminal state.

object
job_id
string
status_url
string

Example

{
"job_id": "job_a1b2c3",
"status_url": "/api/v2/external/jobs/job_a1b2c3"
}

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example

{
"errors": [
"Unauthorized"
]
}

The resource does not exist for this shop, or the action path is not registered.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example

{
"errors": [
"Offer not found"
]
}

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example

{
"errors": [
"name is required"
]
}

Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example

{
"errors": [
"Rate limit exceeded"
]
}
Was this page helpful?

Still stuck? Ask Quinn or chat with support