Draft a post about up to 10 listings
- Credentials
- OAuth access token
- Scopes
marketing:write- Subscription
- Needs an active plan. Otherwise
403 subscription_locked. - Idempotency
- Send an
Idempotency-Keyheader. A retry with the same key does the work once.
Saved as a draft: nothing is posted. Photos come from the listings. The Facebook caption gets the product link ({link} marks where, or it is added at the end). Instagram needs a photo. Needs a connected Facebook Page. Owner or admin.
Access: OAuth scope marketing:write; write-gated by the subscription.
merchantOAuth marketing:writeAuthorizationBearer <token>OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.
Scope: marketing:write
storeId*stringA store the person can reach. Any other id answers 404, never 403.
Idempotency-Key*stringRequired on every write. Minted on the device when the person taps, reused on every retry. A write without one, or with one that does not match the pattern, is refused with 422 validation_error. Scoped to the token's subject, remembered 24 hours. A replay returns the first 2xx response with Idempotent-Replay: true; a request still running answers 409 in_flight; the same key with a different method, path or body answers 409 idempotency_key_reused; non-2xx results are not remembered. If the key store cannot be read nothing is processed and the answer is 503 idempotency_unavailable: retry with the same key.
^[A-Za-z0-9_-]{8,128}$application/json- body
listingIds*array<string>1 <= items <= 10channels*array<>1 <= items <= 2facebook?stringFacebook caption. Links work here.
length <= 2000instagram?stringInstagram caption. Links do not work there.
length <= 2200Created
application/json- response
data*curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/social/posts' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{ "listingIds": [ "string" ], "channels": [ "facebook" ]}'{ "data": { "id": "string", "status": "draft", "channels": [ "facebook" ], "message": { "facebook": "string", "instagram": "string" }, "imageUrls": [ "string" ], "videoUrl": "string", "linkUrl": "string", "scheduledAt": 0, "publishedAt": 0, "results": { "property1": { "status": "pending", "error": "string", "permalink": "string" }, "property2": { "status": "pending", "error": "string", "permalink": "string" } }, "createdAt": 0 }}