Reschedule fulfillment

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

POST/preorders/orders/{id}/reschedule_fulfillment

Costs 2 rate-limit points · Rate limits

Change the fulfillment date for the order's scheduled fulfillment orders.

Accepts the same ISO 8601 timestamp as the merchant dashboard. send_shipping_update emails the customer a shipping update, like the modal's Send customers a shipping update, only when a scheduled fulfillment moved. subject and header default to the template text. description is sent as given; left out, it is what the modal prefills: "Your preorder is now scheduled to ship on {date}." (the fulfill_at UTC date in the shop's app language) followed by the template text. outcome.notified says whether the email went out (as the dashboard reports it).

Also searched asreschedule fulfillmentchange fulfillment date

Path parameters

idstringRequired

Headers

Idempotency-Keystring
A fresh unique key for every write (a new UUID, say); reuse it only to retry that write. Keys are remembered for 1 hour: the same key and the same request within that hour returns the first result, with Idempotent-Replayed: true, without running again; the same key with a different method, path or body is refused (422 idempotency_key_reused); a retry while the first is still running gets 409 idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.

Request body

fulfill_atstringRequired
Example: 2026-07-01T00:00:00Z
send_shipping_updatestring
Example: 2026-07-01T00:00:00Z
subjectstring
Example: string
headerstring
Example: string
descriptionstring
Example: string

Errors

401

Missing or invalid X-Auth-Token.

404

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

409

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

422

The request failed validation.

429

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

Every error has the same shape: see Errors.

POST/preorders/orders/{id}/reschedule_fulfillment

curl -X POST "https://app.stoqapp.com/api/v2/external/preorders/orders/{id}/reschedule_fulfillment" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fulfill_at": "2026-07-01T00:00:00Z",
    "send_shipping_update": "2026-07-01T00:00:00Z",
    "subject": "string",
    "header": "string",
    "description": "string"
  }'

const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/orders/{id}/reschedule_fulfillment", {
  method: "POST",
  headers: {
    "X-Auth-Token": process.env.STOQ_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "fulfill_at": "2026-07-01T00:00:00Z",
    "send_shipping_update": "2026-07-01T00:00:00Z",
    "subject": "string",
    "header": "string",
    "description": "string"
  }),
});
const data = await res.json();

import os
import requests

res = requests.post(
    "https://app.stoqapp.com/api/v2/external/preorders/orders/{id}/reschedule_fulfillment",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
    json={
        "fulfill_at": "2026-07-01T00:00:00Z",
        "send_shipping_update": "2026-07-01T00:00:00Z",
        "subject": "string",
        "header": "string",
        "description": "string"
    },
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v2/external/preorders/orders/{id}/reschedule_fulfillment")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
  fulfill_at: "2026-07-01T00:00:00Z",
  send_shipping_update: "2026-07-01T00:00:00Z",
  subject: "string",
  header: "string",
  description: "string"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

No body

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

{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "Offer not found"
  ],
  "code": "not_found",
  "details": [
    {
      "code": "not_found",
      "message": "Offer not found",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "A request with this Idempotency-Key is still running"
  ],
  "code": "idempotency_key_in_progress",
  "details": [
    {
      "code": "idempotency_key_in_progress",
      "message": "A request with this Idempotency-Key is still running",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}