Documentation

The CeePrinto v2 API lets your store or app publish CeePrinto designs as products, send in orders that CeePrinto prints, ships and collects cash on delivery for, and track payouts.

What it is and who it is for

CeePrinto is a white-label print-on-demand hub. Merchants design on blank products in the Design Configurator, then sell those designs in their own stores. The API is the single protocol every store connector speaks: the Shopify app, the CeePrinto Connect plugin for WooCommerce and any custom integration you build all call the same routes with the same API key format.

Use it if you are:

• a developer connecting a store that is not Shopify or WooCommerce (a custom site, a marketplace, an ERP);
• a merchant automating publishing, order submission or payout reporting;
• building or debugging a connector and need the exact contract.

Base URLs

Every route in these docs is relative to the base URL. Examples read it from the CP_BASE environment variable.

Authentication in one line

Send Authorization: Bearer cp_live_<key_id>.<secret> on every request, using a key from My Account → Store Connections → API Keys. Details in Authentication and scopes.

Three ways to integrate

The two connectors are clients of this same API, so anything they do you can do with the raw API.

Versioning

Using these docs with an AI assistant

These pages are written so an AI assistant can produce correct integration code from them.

A good prompt: "Using the CeePrinto docs below, write a Node 18 script that publishes design 11 to shop 5 and polls until the publish item completes." Then paste llms-full.txt or the relevant copied sections.

In about five minutes you will have an API key, your environment set up, and a successful call to GET /me that shows which account and scopes the key has.

Prerequisites

• A CeePrinto account (log in at ceeprinto.com).
• curl, or one of PHP 7.4+ with the cURL extension, Node 18+ or Python 3.8+ with requests.

1. Create an API key

   Go to My Account → Store Connections → API Keys. Give the key a name, tick the scopes it needs and create it. The full key (cp_live_<key_id>.<secret>) is shown once. Copy it now; CeePrinto stores only a hash and cannot show it again.

   Not sure which scopes? For a store integration tick all eight. See Authentication and scopes.

2. Set environment variables

   Every example in these docs reads the base URL and key from the environment, so nothing secret ends up in your code.

   Shell Copy

   export CP_BASE="https://ceeprinto.com/wp-json/ceeprinto/v2"
   export CP_KEY="cp_live_xxxxxxxxxxxxxxxxxxxxxxxx.yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"

3. Call GET /me

   /me needs no scope, so it is the right smoke test for any key.

   GET /me curl PHP Node Python

   curl Copy

   curl -s "$CP_BASE/me" \
     -H "Authorization: Bearer $CP_KEY"

   PHP inside WordPress? The CeePrinto Connect plugin's includes/Client.php is a complete WordPress-native client (wp_remote_request, Bearer header, JSON envelope) you can copy. The PHP examples in these docs use plain cURL so they run anywhere.

4. Read the response

   Response 200 Copy

   {
     "data": {
       "id": 214,
       "email": "[email protected]",
       "name": "Ayesha Khan",
       "first_name": "Ayesha",
       "last_name": "Khan",
       "company": "Threadline Karachi",
       "api_key": {
         "key_id": "9f3a1c7eK2pQ8mZx4LbN6tRw",
         "name": "WooCommerce Connect",
         "is_legacy": false,
         "last_used_at": "2026-09-29 10:14:52"
       },
       "scopes": [
         "designs:read",
         "products:read",
         "listings:read",
         "listings:write",
         "orders:write",
         "shops:write",
         "webhooks:write"
       ],
       "fulfillment_profile": {
         "complete": true,
         "missing": [],
         "fields": {
           "billing_phone": true,
           "billing_address_1": true,
           "billing_city": true,
           "billing_country": true,
           "billing_company": true,
           "billing_address_2": false,
           "billing_state": true,
           "billing_postcode": true,
           "first_name": true,
           "last_name": true
         }
       }
     }
   }

   Field	Meaning
   data.id	The merchant id. Store it; it never changes.
   data.api_key.name	The key's name. Shopify App and WooCommerce Connect are connection-code keys.
   data.api_key.is_legacy	true for an old 24-character key.
   data.scopes	What this key may do. Compare with the scopes table.
   data.fulfillment_profile.complete	false means billing phone, address, city or country is missing in My Account; missing lists them.

5. Check what scopes you got

   If scopes lacks orders:read (as in the example above, a connection-code key), GET /orders, GET /payouts and POST /shipping/quote will answer 403. Create a key on the API Keys tab with orders:read ticked if you need them.

If it fails

Every v2 request is authenticated with an API key sent as a Bearer token, and each key only reaches the routes its scopes allow.

Headers

curl -s "$CP_BASE/me" -H "Authorization: Bearer $CP_KEY"
curl -s "$CP_BASE/me" -H "X-CP-Key: $CP_KEY"

Key format

Scopes

Each route requires one scope. A key without it gets 403 forbidden with details.required_scope and details.granted_scopes.

{
  "error": {
    "code": "forbidden",
    "message": "This API key does not have the \"orders:read\" scope.",
    "details": {
      "required_scope": "orders:read",
      "granted_scopes": [
        "designs:read",
        "products:read",
        "listings:read",
        "listings:write",
        "orders:write",
        "shops:write",
        "webhooks:write"
      ]
    }
  }
}

Connection codes (cp1.)

The Shopify app and the CeePrinto Connect plugin do not ask the merchant for a raw key. Instead My Account → Store Connections → Get Started generates a one-time connection code that bundles the hub URL and a freshly minted key.

import base64, json

code = "cp1.eyJ2IjoxLCJiYXNlIjoiaHR0cHM6Ly9jZWVwcmludG8uY29tLyIsImtleSI6ImNwX2xpdmVfLi4uIn0"
raw = code[len("cp1."):]
payload = json.loads(base64.urlsafe_b64decode(raw + "=" * (-len(raw) % 4)))
base_url = payload["base"].rstrip("/") + "/wp-json/ceeprinto/v2"
api_key = payload["key"]

Rotation and revocation

Legacy keys

Accounts created before v2 have a 24-character key without the cp_live_ prefix. It still works in any of the three headers and holds every scope. GET /me reports is_legacy: true and masks key_id to its last 4 characters. Move to a scoped v2 key when you can.

Security tips

• Keep keys server-side. Never ship one in browser JavaScript or a mobile app.
• Give each integration its own key with the fewest scopes it needs, so you can revoke one without breaking the others.
• Store keys in environment variables or a secrets manager, not in source control.
• Revoke immediately if a key leaks, then check the API Keys tab for unexpected "last used" times.
• Always call HTTPS in production.

Every v2 route shares one response envelope, one error format, one pagination scheme and one rate limit, so a single client wrapper handles them all.

Response envelope

Success bodies wrap the payload in data. meta appears only when there is something to say (pagination, replay flags, cache flags). Error bodies have a single error object and no data.

{
  "data": [
    {
      "id": 5,
      "channel": "custom",
      "external_shop_id": "my-store-01",
      "name": "My Store",
      "webhook_url": null,
      "status": "active",
      "connected_at": "2026-09-15T07:30:00+00:00"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 1,
    "total_pages": 1
  }
}

{
  "error": {
    "code": "unprocessable_entity",
    "message": "The order could not be accepted.",
    "details": {
      "issues": [
        "line_items[0].customer_price is required and drives COD collection."
      ]
    }
  }
}

Error codes

WordPress's own validation errors are passed through in the same envelope with their native codes: rest_no_route (404, wrong path or method) and rest_missing_callback_param / rest_invalid_param (400, with details.params). Treat any unknown 4xx code as a client error. Full list with fixes in Errors and troubleshooting.

Pagination

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
X-CP-Request-Id: req_3f9a1c7e5b2d8a40
X-CP-Api-Version: 2.2.0
X-CP-RateLimit-Limit: 120
X-CP-RateLimit-Remaining: 117
X-CP-RateLimit-Reset: 1790676060
X-CP-Total: 230
X-CP-Total-Pages: 3
Link: <https://ceeprinto.com/wp-json/ceeprinto/v2/catalog/products?page=1&per_page=100>; rel="prev", <https://ceeprinto.com/wp-json/ceeprinto/v2/catalog/products?page=1&per_page=100>; rel="first", <https://ceeprinto.com/wp-json/ceeprinto/v2/catalog/products?page=3&per_page=100>; rel="next", <https://ceeprinto.com/wp-json/ceeprinto/v2/catalog/products?page=3&per_page=100>; rel="last"

Loop until meta.page >= meta.total_pages, or until the Link header has no rel="next". A complete example is in Recipes (catalog sync).

Rate limiting

Honour Retry-After on 429, and back off exponentially on 5xx and network errors. A reusable wrapper:

#!/usr/bin/env bash
# cp_call METHOD PATH [JSON_BODY]  - retries 429 (Retry-After) and 5xx (1s, 2s, 4s, 8s)
cp_call() {
  local method="$1" path="$2" body="${3:-}" attempt=0 status headers
  while :; do
    headers=$(mktemp)
    if [ -n "$body" ]; then
      status=$(curl -s -o /tmp/cp_body -D "$headers" -w "%{http_code}" -X "$method" "$CP_BASE$path" \
        -H "Authorization: Bearer $CP_KEY" -H "Content-Type: application/json" -d "$body")
    else
      status=$(curl -s -o /tmp/cp_body -D "$headers" -w "%{http_code}" -X "$method" "$CP_BASE$path" \
        -H "Authorization: Bearer $CP_KEY")
    fi
    if [ "$status" = "429" ] || [ "$status" -ge 500 ] 2>/dev/null; then
      attempt=$((attempt + 1))
      [ "$attempt" -gt 4 ] && { cat /tmp/cp_body; rm -f "$headers"; return 1; }
      wait=$(grep -i '^retry-after:' "$headers" | tr -dc '0-9')
      sleep "${wait:-$((2 ** (attempt - 1)))}"
      rm -f "$headers"
      continue
    fi
    rm -f "$headers"
    cat /tmp/cp_body
    [ "$status" -lt 400 ]
    return
  done
}

cp_call GET /me

<?php
function cp_call(string $method, string $path, ?array $body = null, array $headers = []): array {
  $delay = 1;
  for ($attempt = 1; ; $attempt++) {
    $respHeaders = [];
    $ch = curl_init(getenv('CP_BASE') . $path);
    curl_setopt_array($ch, [
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_CUSTOMREQUEST  => $method,
      CURLOPT_TIMEOUT        => 30,
      CURLOPT_HTTPHEADER     => array_merge([
        'Authorization: Bearer ' . getenv('CP_KEY'),
        'Accept: application/json',
        'Content-Type: application/json',
      ], $headers),
      CURLOPT_HEADERFUNCTION => function ($ch, $line) use (&$respHeaders) {
        $parts = explode(':', $line, 2);
        if (count($parts) === 2) {
          $respHeaders[strtolower(trim($parts[0]))] = trim($parts[1]);
        }
        return strlen($line);
      },
    ]);
    if ($body !== null) {
      curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body));
    }
    $raw    = curl_exec($ch);
    $status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);

    $retryable = $raw === false || $status === 429 || $status >= 500;
    if ($retryable && $attempt < 5) {
      $wait = isset($respHeaders['retry-after']) ? (int) $respHeaders['retry-after'] : $delay;
      sleep(max(1, $wait));
      $delay *= 2;
      continue;
    }
    $json = $raw === false || $raw === '' ? null : json_decode($raw, true);
    if ($status >= 400 || $raw === false) {
      $code = $json['error']['code'] ?? 'network_error';
      throw new RuntimeException("$code (HTTP $status, request " . ($respHeaders['x-cp-request-id'] ?? '?') . ')');
    }
    return ['status' => $status, 'body' => $json, 'headers' => $respHeaders];
  }
}

print_r(cp_call('GET', '/me')['body']['data']);

// cp.mjs
export async function cpCall(method, path, body, headers = {}) {
  let delay = 1000;
  for (let attempt = 1; ; attempt++) {
    let res;
    try {
      res = await fetch(`${process.env.CP_BASE}${path}`, {
        method,
        headers: {
          Authorization: `Bearer ${process.env.CP_KEY}`,
          'Content-Type': 'application/json',
          ...headers,
        },
        body: body === undefined ? undefined : JSON.stringify(body),
        signal: AbortSignal.timeout(30000),
      });
    } catch (err) {
      if (attempt < 5) { await sleep(delay); delay *= 2; continue; }
      throw err;
    }
    if ((res.status === 429 || res.status >= 500) && attempt < 5) {
      const retryAfter = Number(res.headers.get('retry-after'));
      await sleep(retryAfter > 0 ? retryAfter * 1000 : delay);
      delay *= 2;
      continue;
    }
    const json = res.status === 204 ? null : await res.json();
    if (!res.ok) {
      throw new Error(`${json.error.code} (HTTP ${res.status}, request ${res.headers.get('x-cp-request-id')})`);
    }
    return { status: res.status, body: json, headers: res.headers };
  }
}

const sleep = (ms) => new Promise((r) => setTimeout(r, ms));

if (import.meta.url === `file://${process.argv[1]}`) {
  console.log((await cpCall('GET', '/me')).body.data);
}

# cp.py
import os
import time
import requests

def cp_call(method, path, body=None, headers=None):
    delay = 1
    for attempt in range(1, 6):
        try:
            res = requests.request(
                method,
                f"{os.environ['CP_BASE']}{path}",
                headers={"Authorization": f"Bearer {os.environ['CP_KEY']}", **(headers or {})},
                json=body,
                timeout=30,
            )
        except requests.RequestException:
            if attempt == 5:
                raise
            time.sleep(delay)
            delay *= 2
            continue
        if (res.status_code == 429 or res.status_code >= 500) and attempt < 5:
            time.sleep(int(res.headers.get("Retry-After", delay)))
            delay *= 2
            continue
        data = None if res.status_code == 204 else res.json()
        if not res.ok:
            raise RuntimeError(
                f"{data['error']['code']} (HTTP {res.status_code}, request {res.headers.get('X-CP-Request-Id')})"
            )
        return res.status_code, data, res.headers

if __name__ == "__main__":
    print(cp_call("GET", "/me")[1]["data"])

Request id and version headers

Timestamps and money

Idempotency

This glossary defines the objects the API moves around, so the rest of the docs can use each term in exactly one sense.

Glossary

Payout statuses

Resolved in this order; the first match wins.

How the pieces fit

1. The merchant saves a design on a blank in the Design Configurator.
2. Optionally they compose a hub product: default design plus per-variant overrides.
3. A shop is connected (POST /shops).
4. A publish job is created. The connector polls pending items, fetches the mockup matrix, creates the store product, registers one listing per store variant (POST …/listings/bulk) and marks the item complete.
5. A buyer orders in the store. The connector submits an intake (POST /orders) with customer_price per line.
6. The hub resolves each line through the listings, creates a Pending payment WooCommerce order, and the merchant elects COD From Customer.
7. CeePrinto prints and ships; order.shipped carries tracking.
8. After delivery and the 7-day hold, the amount appears as a payout.

With nothing but curl and an API key you will connect a store, publish a design, submit a COD order and subscribe to events, the same protocol the Shopify app and CeePrinto Connect use.

A channel: "custom" integration gets exactly the same behaviour as the official connectors, including cash on delivery. Use a key with all eight scopes (created on My Account → Store Connections → API Keys) so every step below works.

1. Set your base URL and key

   bash Copy

   export CP_BASE="https://ceeprinto.com/wp-json/ceeprinto/v2"
   export CP_KEY="cp_live_xxxxxxxxxxxxxxxxxxxxxxxx.yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
   alias cp='curl -s -H "Authorization: Bearer $CP_KEY" -H "Content-Type: application/json"'

2. Who am I (200)

   bash Copy

   cp "$CP_BASE/me"

   Returns your numeric account id (data.id), granted scopes, and whether your billing details are complete (fulfillment_profile.complete).

3. Connect a store (201)

   bash Copy

   cp -X POST "$CP_BASE/shops" \
     -d '{"channel":"custom","external_shop_id":"my-store-01","name":"My Store"}'
   # → 201 { "data": { "id": 5, "channel": "custom", "status": "active", ... } }
   export CP_SHOP=5

   channel is a free-form label: custom here, woocommerce for a Woo plugin, shopify for the app. Re-posting the same external_shop_id refreshes the shop instead of duplicating it. 409 means another CeePrinto account already owns it.

4. Browse designs and the catalog (200)

   bash Copy

   cp "$CP_BASE/designs?per_page=20"
   cp "$CP_BASE/designs/11"
   cp "$CP_BASE/catalog/products?per_page=100"
   cp "$CP_BASE/catalog/products/37"

   A design's product_id is the blank it was made on. The catalog product lists that blank's variations and print stages.

5. Get the design's product images (200)

   bash Copy

   cp "$CP_BASE/designs/11/variation-mockups"
   # → { "data": { "status": "ready", "total": 24, "store_status": "ready", "store_ready": 24, "queued": 0,
   #              "items": [ { "variation_id": 101, "stage_index": 0, "stage_name": "Front",
   #                           "store_ready": true, "thumb_url": "...", "image_url": "..." }, ... ] } }

   Mockups render on request at the URLs returned, so there is nothing to queue and usually nothing to wait for. Still check store_status is "ready" (or "partial", skipping cells with failed: true) before uploading. POST to the same URL is kept for older clients and answers 202 with queued: 0.

   Rule	Why
   Upload image_url (2048px), never thumb_url (240px)	Thumbs are for the hub UI and look blurry in a store.
   stage_index 0 is the front	Use it as the main product image.
   Key cells by variation_id + stage_index	There is one cell per variation per side. A plain variation_id → url map lets the back overwrite the front.

6. Link the design to your store product (201)

   For one variant:

   bash Copy

   cp -X POST "$CP_BASE/shops/$CP_SHOP/listings" \
     -d '{"design_id":11,"product_id":37,"variation_id":101,"external_product_id":"9001","external_variant_id":"9001-1","external_sku":"TEE-L"}'

   For a full Size × Color matrix use bulk (200 with a per-row summary), one row per store variant, each with its own design_id:

   bash Copy

   cp -X POST "$CP_BASE/shops/$CP_SHOP/listings/bulk" \
     -d '{"listings":[
       {"design_id":11,"product_id":37,"variation_id":101,"external_product_id":"9001","external_variant_id":"9001-1"},
       {"design_id":11,"product_id":37,"variation_id":102,"external_product_id":"9001","external_variant_id":"9001-2"}
     ]}'

   external_variant_id / external_sku are how your store identifies the item; CeePrinto resolves incoming orders back to the design through these listings.

7. Or publish through a publish job (201) and poll it

   bash Copy

   # Create a brand-new product in the store:
   cp -X POST "$CP_BASE/publish-jobs" \
     -d '{"shop_id":'"$CP_SHOP"',"design_ids":[11],"price_mode":"blank","mode":"create"}'
   
   # Or attach the design to a product you already sell:
   cp -X POST "$CP_BASE/publish-jobs" \
     -d '{"shop_id":'"$CP_SHOP"',"design_ids":[11],"mode":"link","external_product_id":"9001"}'
   
   # Or publish a whole hub product (default design + per-variant overrides):
   cp -X POST "$CP_BASE/publish-jobs" \
     -d '{"shop_id":'"$CP_SHOP"',"product_id":42,"price_mode":"blank","mode":"create"}'
   
   # Then poll. Do not rely on the design.publish_requested webhook alone.
   cp "$CP_BASE/shops/$CP_SHOP/publish-jobs/pending"
   # → { "data": [ { "id": 7, "job_id": 3, "design_id": 11, "mode": "create",
   #                 "external_product_id": null, "variant_count": 12, "status": "pending", ... } ] }
   
   # Do the store work, then close the item (200). Always one or the other:
   cp -X POST "$CP_BASE/publish-jobs/items/7/complete" -d '{"external_product_id":"9001"}'
   cp -X POST "$CP_BASE/publish-jobs/items/7/fail"     -d '{"error":"variant matrix rejected"}'

   mode defaults to create. An unknown mode is 422, so a typo never creates a duplicate product. link and update require external_product_id (422 without). Full walkthrough: Publish a design to a store.

8. Submit an order (202)

   bash Copy

   cp -X POST "$CP_BASE/orders" \
     -H "Idempotency-Key: my-store-01:1001" \
     -d '{
       "shop_id": '"$CP_SHOP"',
       "external_order_id": "1001",
       "currency": "PKR",
       "shipping_address": {
         "first_name": "Bilal", "address_1": "Flat 4B, Block 5, Clifton",
         "city": "Karachi", "country": "PK", "phone": "03001234567"
       },
       "line_items": [
         { "external_variant_id": "9001-1", "quantity": 1,
           "customer_price": "2500.00", "customer_variant": "L / Black" }
       ]
     }'
   # → 202 { "data": { "id": 1, "status": "received", "wc_order_id": null, ... } }

   Rule	Result if broken
   Idempotency-Key header is required	400 invalid_request
   customer_price on every line (what the buyer pays, collected on COD)	422 with details.issues[]; never defaulted
   shop_id must be yours	400 (not 404)
   Same Idempotency-Key again	200 with the original intake and meta.idempotent_replay: true; nothing new is created, so retrying a timeout is safe

9. Watch it become an order (200)

   bash Copy

   cp "$CP_BASE/orders/1"
   cp "$CP_BASE/orders/1/events"

   The order is created as Pending payment in the merchant's My Account → Orders, where they elect COD From Customer. If a line item cannot be matched the intake becomes failed with a specific last_error: create the missing listing and retry from My Account → Store Connections → Order Activity.

10. Receive events (201)

    bash Copy

    cp -X POST "$CP_BASE/webhooks" \
      -d '{"topic":"order.status_changed","target_url":"https://my-store-01.pk/webhooks/ceeprinto"}'
    # → 201 { "data": { "id": 9, "secret": "whsec_...", ... } }

    Each delivery is signed X-CP-Signature: t=<ts>,v1=<hex>, an HMAC-SHA256 of <ts>.<raw body> with the secret. See Webhooks for verification code.

Registering your storefront once gives you a shop id that every publish job, listing and order refers to.

Prerequisites

• An API key with shops:write (to connect) and listings:read (to list shops).
• A stable id for your store that you control (external_shop_id): a domain, a Shopify shop handle, a tenant id.

Which path?

1. Register the shop

   POST /shops upserts on (channel, external_shop_id), so it is safe to call on every connector start-up.

   POST /shops curl PHP Node Python

   curl Copy

   curl -s -X POST "$CP_BASE/shops" \
     -H "Authorization: Bearer $CP_KEY" \
     -H "Content-Type: application/json" \
     -d '{"channel":"custom","external_shop_id":"my-store-01","name":"My Store"}'

   Response 201 Copy

   {
     "data": {
       "id": 5,
       "channel": "custom",
       "external_shop_id": "my-store-01",
       "name": "My Store",
       "webhook_url": null,
       "status": "active",
       "connected_at": "2026-09-29T10:15:00+00:00"
     }
   }

2. Store the shop id

   Save data.id (here 5). You need it for /shops/{id}/listings, /shops/{id}/publish-jobs/pending, POST /publish-jobs and POST /orders.

3. Check the connection

   bash Copy

   curl -s "$CP_BASE/shops" -H "Authorization: Bearer $CP_KEY"
   curl -s "$CP_BASE/shops/5" -H "Authorization: Bearer $CP_KEY"

   The shop now appears in My Account → Store Connections → Stores.

4. Subscribe to events (optional)

   Subscribe to design.publish_requested and order.shipped so your store reacts quickly. See Webhooks. Always poll as well; webhooks are best-effort.

5. Disconnect or reconnect

   bash Copy

   # Disconnect (soft): 200 with "status": "disconnected"
   curl -s -X DELETE "$CP_BASE/shops/5" -H "Authorization: Bearer $CP_KEY"
   
   # Reconnect: POST the same channel + external_shop_id again (201, status back to "active")
   curl -s -X POST "$CP_BASE/shops" -H "Authorization: Bearer $CP_KEY" -H "Content-Type: application/json" \
     -d '{"channel":"custom","external_shop_id":"my-store-01","name":"My Store"}'

Outcomes

A publish job turns a design or hub product into a real product in your store, with correct images per variant and a listing per variant so orders route back to the right design.

Prerequisites

• A connected shop id (Connect a store).
• A key with listings:write, listings:read and designs:read.
• A design id (GET /designs) or a hub product id (GET /products).

Who does what

Choosing mode

Choosing price_mode

1. Create the publish job

   Send design_ids for one or more designs, or product_id for a hub product (designs and per-variant composition are derived from it). Answers 201 and fires design.publish_requested.

   POST /publish-jobs curl PHP Node Python

   curl Copy

   curl -s -X POST "$CP_BASE/publish-jobs" \
     -H "Authorization: Bearer $CP_KEY" \
     -H "Content-Type: application/json" \
     -d '{"shop_id":5,"design_ids":[11],"price_mode":"blank","mode":"create"}'

   Other shapes Copy

   # Publish a hub product at a flat price
   curl -s -X POST "$CP_BASE/publish-jobs" -H "Authorization: Bearer $CP_KEY" -H "Content-Type: application/json" \
     -d '{"shop_id":5,"product_id":42,"price_mode":"flat","flat_price":2500,"mode":"create"}'
   
   # Attach design 11 to store product 9001
   curl -s -X POST "$CP_BASE/publish-jobs" -H "Authorization: Bearer $CP_KEY" -H "Content-Type: application/json" \
     -d '{"shop_id":5,"design_ids":[11],"mode":"link","external_product_id":"9001"}'

2. Poll for pending items

   Poll every 30 to 60 seconds. The webhook is only a hint to poll sooner: a missed delivery would otherwise lose the publish silently. The list is not paginated.

   bash Copy

   curl -s "$CP_BASE/shops/5/publish-jobs/pending" -H "Authorization: Bearer $CP_KEY"

   Response 200 Copy

   {
     "data": [
       {
         "id": 7,
         "job_id": 3,
         "design_id": 11,
         "product_id": 37,
         "variant_count": 12,
         "status": "pending",
         "mode": "create",
         "external_product_id": null,
         "product_id_hub": 42,
         "error_text": null,
         "created_at": "2026-09-29T10:15:00+00:00",
         "updated_at": "2026-09-29T10:15:00+00:00",
         "completed_at": null,
         "shop_id": 5,
         "price_mode": "blank",
         "flat_price": null
       }
     ]
   }

   Handle webhook-delivered and polled items with the same code, and de-duplicate by item id.

3. Work out each variant's design

   Item has	Read variants from
   product_id_hub set	GET /products/{product_id_hub}: use each variant's effective_design_id, skip enabled: false, use its price/sku when set
   product_id_hub: null	GET /catalog/products/{product_id}: every variation uses the item's design_id

4. Fetch the images

   bash Copy

   curl -s "$CP_BASE/designs/11/variation-mockups" -H "Authorization: Bearer $CP_KEY"

   For each distinct design, read the matrix. Mockups render on request at the URLs returned; nothing is queued (queued is 0).

   Check	Rule
   store_status	Upload only when "ready". "partial" means some cells failed: upload the rest, skip failed: true. "generating": wait 5 seconds and GET again. "unavailable": the renderer is off; fail the item.
   Which URL	image_url (2048px). Never thumb_url (240px).
   Which side	stage_index 0 is the front: make it the main image. Other stages are extra gallery images.
   Keying	By variation_id + stage_index. One cell per variation per stage.
   Fetching	Download each image_url and upload the bytes to your store. Retry a failed download once after a few seconds.

5. Create the product and register listings

   Create (or link, or update) the store product with one store variant per enabled blank variation. Then register one listing per store variant in a single bulk call:

   bash Copy

   curl -s -X POST "$CP_BASE/shops/5/listings/bulk" \
     -H "Authorization: Bearer $CP_KEY" -H "Content-Type: application/json" \
     -d '{"listings":[
       {"design_id":11,"product_id":37,"variation_id":101,"external_product_id":"9001","external_variant_id":"9001-1"},
       {"design_id":12,"product_id":37,"variation_id":102,"external_product_id":"9001","external_variant_id":"9001-2"}
     ]}'
   # → 200 { "data": [ ... ], "meta": { "created": 2, "failed": 0, "errors": [] } }

   Always send external_variant_id: listings upsert on it, so a retry updates instead of duplicating. Check meta.failed; rows fail independently.

6. Close the item

   bash Copy

   # Success: send the store product id
   curl -s -X POST "$CP_BASE/publish-jobs/items/7/complete" \
     -H "Authorization: Bearer $CP_KEY" -H "Content-Type: application/json" \
     -d '{"external_product_id":"9001"}'
   
   # Failure: the message is shown to the merchant
   curl -s -X POST "$CP_BASE/publish-jobs/items/7/fail" \
     -H "Authorization: Bearer $CP_KEY" -H "Content-Type: application/json" \
     -d '{"error":"Store rejected the variant matrix: too many options"}'

   Every item must end in one of the two, or it stays pending and the merchant sees "publishing" forever. For hub-product items, complete also back-fills product_id_hub on the matching listings.

After publishing

Errors when creating a job

Submitting each store order once, with an Idempotency-Key and the buyer's price per line, gets it printed, shipped and collected on delivery, and lets you follow it to tracking.

Prerequisites

• A key with orders:write. Reading orders back needs orders:read, which connection-code keys ("Shopify App", "WooCommerce Connect") do not have.
• A connected shop id, and listings for the products you sell (Publish a design), or the design id per line.
• The merchant's billing details complete (GET /me → fulfillment_profile.complete).

How a line item finds its design

Each line must carry at least one reference. The hub tries them in this order and uses the first match:

If nothing matches, no WooCommerce order is created for any line and the intake is marked failed.

Required fields

1. Submit the order

   A new key answers 202 with status: "received". A background worker then builds the WooCommerce order, usually within seconds.

   POST /orders curl PHP Node Python

   curl Copy

   curl -s -X POST "$CP_BASE/orders" \
     -H "Authorization: Bearer $CP_KEY" \
     -H "Content-Type: application/json" \
     -H "Idempotency-Key: my-store-01:1001" \
     -d '{
       "shop_id": 5,
       "external_order_id": "1001",
       "currency": "PKR",
       "shipping_address": {
         "first_name": "Bilal", "last_name": "Ahmed", "phone": "03001234567",
         "address_1": "Flat 4B, Block 5, Clifton", "city": "Karachi", "country": "PK"
       },
       "line_items": [
         { "external_variant_id": "9001-1", "quantity": 1,
           "customer_price": "2500.00", "customer_variant": "L / Black" }
       ]
     }'

   Response 202 Copy

   {
     "data": {
       "id": 1,
       "shop_id": 5,
       "external_order_id": "1001",
       "status": "received",
       "wc_order_id": null,
       "attempts": 0,
       "last_error": null,
       "received_at": "2026-09-29T10:15:00+00:00",
       "processed_at": null
     }
   }

2. Retry safely

   You got	Do
   202	Store data.id. Done.
   200 with meta.idempotent_replay: true	This key was already accepted. data is the original intake (it may already be created). Nothing new was made.
   Timeout / network error / 5xx / 429	Resend the same body with the same Idempotency-Key. Never mint a new key for a retry.
   400 / 403 / 422	Fix the request. Do not retry unchanged.

   A replay returns the first intake even if the body changed; use a new key only for a genuinely new order.

3. Follow the intake

   Needs orders:read Copy

   curl -s "$CP_BASE/orders/1" -H "Authorization: Bearer $CP_KEY"
   curl -s "$CP_BASE/orders/1/events" -H "Authorization: Bearer $CP_KEY"

   Intake status	Meaning
   received	Accepted and queued.
   processing	The worker is building the order. attempts counts tries.
   created	WooCommerce order exists: wc_order_id set, order block present on GET /orders/{id}.
   failed	No order was created. last_error says why.
   ignored	Reserved; not set by the current API.

4. Handle a failed intake

   last_error starts with	Cause	Fix
   No listing, design or legacy product matched this line item (…)	No reference on a line resolved. The parentheses list what you sent.	Create the listing (POST /shops/{id}/listings) or send design_id, then the merchant clicks Retry in My Account → Store Connections → Order Activity.
   WooCommerce product N no longer exists.	The blank or variation was removed from the catalog.	Re-publish on a current blank and update the listing.
   Order has no line items.	Stored payload had no lines.	Submit a new order with a new key.
   A line item could not be added to the order.	WooCommerce refused the product (e.g. not purchasable).	Contact support with the X-CP-Request-Id.

   Retrying the same Idempotency-Key through the API does not reprocess a failed intake; it returns it. Reprocessing is the Retry button in Order Activity.

5. Merchant elects COD, CeePrinto ships

   The order lands as Pending payment in the merchant's My Account → Orders, where they elect COD From Customer (and any additional amount). Then subscribe to order.status_changed and order.shipped (Webhooks). order.shipped carries tracking_number, tracking_company and tracking_url; if you miss it, GET /orders/{id} → order.tracking has the same data.

Totals on GET /orders/{id}

Webhooks push signed events to your server within seconds of an order, design, stock or publish change, so your store reacts without constant polling.

Prerequisites

• A key with webhooks:write.
• A public HTTPS endpoint that answers 2xx within 10 seconds.

Topics

Payload schemas and full examples: Webhook events reference.

Delivery

1. Subscribe

   One subscription per topic. The response contains the signing secret; store it with the subscription id.

   bash Copy

   for topic in order.status_changed order.shipped design.publish_requested product.stock_changed product.updated; do
     curl -s -X POST "$CP_BASE/webhooks" \
       -H "Authorization: Bearer $CP_KEY" -H "Content-Type: application/json" \
       -d '{"topic":"'"$topic"'","target_url":"https://my-store-01.pk/webhooks/ceeprinto"}'
   done
   # → 201 { "data": { "id": 9, "topic": "order.status_changed", "secret": "whsec_Xk2p9QvT4mLr7sWn1bYc8dHf3gJa6eZu", "status": "active", ... } }

   GET /webhooks lists your subscriptions, each with its secret (treat the response as sensitive). DELETE /webhooks/{id} removes one (204).

2. Verify the signature

   Compute the HMAC over the raw request bytes, before any JSON parsing. The hub's JSON escapes slashes (https:\/\/), so re-serialising the parsed body gives a different string and a false mismatch. Compare in constant time and reject timestamps more than 5 minutes from now (replay protection).

   Verify X-CP-Signature curl PHP Node Python

   curl Copy

   #!/usr/bin/env bash
   # verify.sh SIGNATURE_HEADER BODY_FILE   (secret in CP_WEBHOOK_SECRET)
   sig_header="$1"; body_file="$2"
   t=$(printf '%s' "$sig_header" | sed -n 's/.*t=\([0-9]*\).*/\1/p')
   v1=$(printf '%s' "$sig_header" | sed -n 's/.*v1=\([0-9a-f]*\).*/\1/p')
   expected=$( { printf '%s.' "$t"; cat "$body_file"; } | openssl dgst -sha256 -hmac "$CP_WEBHOOK_SECRET" | awk '{print $NF}')
   now=$(date +%s)
   if [ "$expected" != "$v1" ]; then echo "bad signature"; exit 1; fi
   if [ $(( now > t ? now - t : t - now )) -gt 300 ]; then echo "stale timestamp"; exit 1; fi
   echo "ok"

   Complete runnable servers are in Recipes.

3. Answer fast, work later

   Return 2xx as soon as the signature checks out, then process asynchronously (a queue, a background job). Slow handlers hit the 10-second timeout and are retried, which causes duplicates.

4. Be idempotent

   Retries and the reduced duplicate below mean the same event can arrive more than once. De-duplicate on the natural key: wc_order_id + status for orders, job_id / item_id for publishes, product_id + variation_id + stock_status for stock.

5. Keep polling

   After 5 failed attempts an event is dropped. Poll GET /shops/{id}/publish-jobs/pending every 30 to 60 seconds, and re-read GET /orders/{id} for open orders, so nothing is lost.

Quirks to handle

Read the same COD payout ledger the merchant sees in My Account → Pay Out, and quote shipping for a city before you take an order.

Prerequisites

Routes

1. List payouts still owed

   status takes all (default), pending (everything not yet paid out) or one bucket. date_from / date_to (YYYY-MM-DD, inclusive) filter on order creation date.

   GET /payouts curl PHP Node Python

   curl Copy

   curl -s "$CP_BASE/payouts?status=pending&date_from=2026-09-01&per_page=100" \
     -H "Authorization: Bearer $CP_KEY"

2. Show the totals

   bash Copy

   curl -s "$CP_BASE/payouts/summary" -H "Authorization: Bearer $CP_KEY"

   Response 200 Copy

   {
     "data": {
       "total": 184500,
       "processed": 120000,
       "pending": 64500,
       "ready": 22000,
       "in_hold": 30500,
       "awaiting_delivery": 12000,
       "missing_bank": 0,
       "count_total": 41,
       "count_processed": 27,
       "count_pending": 14,
       "count_ready": 5,
       "count_in_hold": 6,
       "count_awaiting_delivery": 3,
       "count_missing_bank": 0,
       "currency": "PKR"
     },
     "meta": {
       "cached": false
     }
   }

   The summary is always the whole ledger (filters are ignored) and is cached per merchant for 15 minutes; the cache is cleared when an order changes status or a payout is processed.

3. Quote shipping

   bash Copy

   curl -s -X POST "$CP_BASE/shipping/quote" \
     -H "Authorization: Bearer $CP_KEY" -H "Content-Type: application/json" \
     -d '{"city":"Karachi"}'
   # → 200 { "data": { "city": "Karachi", "total": 200, "currency": "PKR", "method_id": "flat_rate", "method_title": "Flat Rate" } }

   Send city or a shipping_address object (only its city is read). Missing city is 400. The same rate is added as the shipping line when POST /orders creates the WooCommerce order.

   Defaults; CeePrinto can change the table

   City (case-insensitive)	Default rate
   Karachi, KHI	200 PKR
   Anywhere else	250 PKR

Payout buckets

Four complete, runnable scripts in bash, PHP, Node and Python that you can copy, set environment variables for, and run as the starting point of a real integration.

Runtimes: bash scripts need curl, jq and openssl; PHP 7.4+ with ext-curl (CLI); Node 18+ (save as .mjs); Python 3.8+ with pip install requests.

Publish and poll

Creates a publish job for one design, then works the pending queue for that job: waits for store-ready mockups, creates the store product (a stub you replace), registers one listing per variation, and closes each item with complete, or fail on any error.

#!/usr/bin/env bash
# publish-and-poll.sh   Requires curl, jq.
# Env: CP_BASE, CP_KEY, CP_SHOP_ID, CP_DESIGN_ID
set -euo pipefail
: "${CP_BASE:?}" "${CP_KEY:?}" "${CP_SHOP_ID:?}" "${CP_DESIGN_ID:?}"

# api METHOD PATH [JSON]: prints the body; returns 1 on HTTP >= 400
api() {
  local method="$1" path="$2" body="${3:-}" out status
  out=$(mktemp)
  local args=(-s -o "$out" -w "%{http_code}" -X "$method" "$CP_BASE$path" -H "Authorization: Bearer $CP_KEY")
  [ -n "$body" ] && args+=(-H "Content-Type: application/json" -d "$body")
  status=$(curl "${args[@]}")
  if [ "$status" -ge 400 ]; then
    echo "HTTP $status $method $path: $(cat "$out")" >&2
    rm -f "$out"
    return 1
  fi
  cat "$out"
  rm -f "$out"
}

# Replace with your store's API. Must print the store product id.
create_store_product() {
  local design_id="$1" images_tsv="$2"
  echo "Would create a product for design $design_id with $(wc -l < "$images_tsv") images" >&2
  echo "demo-$design_id-$(date +%s)"
}

process_item() {
  local item="$1" item_id design_id product_id mode ext m status i
  item_id=$(jq -r '.id' <<<"$item")
  design_id=$(jq -r '.design_id' <<<"$item")
  product_id=$(jq -r '.product_id' <<<"$item")
  mode=$(jq -r '.mode' <<<"$item")

  # Mockups render on request; wait for store_status ready or partial.
  for i in $(seq 1 24); do
    m=$(api GET "/designs/$design_id/variation-mockups") || return 1
    status=$(jq -r '.data.store_status' <<<"$m")
    case "$status" in
      ready|partial) break ;;
      unavailable) echo "Mockup renderer unavailable" >&2; return 1 ;;
    esac
    [ "$i" -eq 24 ] && { echo "Mockups not ready after 2 minutes" >&2; return 1; }
    sleep 5
  done

  # One row per variation x stage. Key by variation_id + stage_index; 0 is the front.
  local images
  images=$(mktemp)
  jq -r '.data.items[] | select(.failed | not) | [.variation_id, .stage_index, .image_url] | @tsv' <<<"$m" > "$images"

  if [ "$mode" = "create" ]; then
    ext=$(create_store_product "$design_id" "$images") || return 1
  else
    ext=$(jq -r '.external_product_id' <<<"$item")
  fi
  rm -f "$images"

  local catalog listings
  catalog=$(api GET "/catalog/products/$product_id") || return 1
  listings=$(jq -c --arg ext "$ext" --argjson d "$design_id" --argjson p "$product_id" '
    {listings: (if (.data.variations | length) == 0
      then [{design_id: $d, product_id: $p, variation_id: 0, external_product_id: $ext, external_variant_id: $ext}]
      else [.data.variations[] | {design_id: $d, product_id: $p, variation_id: .id,
            external_product_id: $ext, external_variant_id: ($ext + "-" + (.id | tostring))}]
      end)}' <<<"$catalog")
  api POST "/shops/$CP_SHOP_ID/listings/bulk" "$listings" | jq -e '.meta.failed == 0' >/dev/null || return 1

  api POST "/publish-jobs/items/$item_id/complete" "$(jq -nc --arg e "$ext" '{external_product_id: $e}')" >/dev/null
  echo "Item $item_id complete -> store product $ext"
}

job=$(api POST /publish-jobs "$(jq -nc --argjson s "$CP_SHOP_ID" --argjson d "$CP_DESIGN_ID" \
  '{shop_id: $s, design_ids: [$d], mode: "create", price_mode: "blank"}')")
job_id=$(jq -r '.data.id' <<<"$job")
echo "Created publish job $job_id"

for round in $(seq 1 60); do
  pending=$(api GET "/shops/$CP_SHOP_ID/publish-jobs/pending" | jq -c --argjson j "$job_id" '[.data[] | select(.job_id == $j)]')
  if [ "$(jq length <<<"$pending")" -eq 0 ]; then
    echo "Job $job_id has no pending items. Done."
    exit 0
  fi
  while read -r item; do
    item_id=$(jq -r '.id' <<<"$item")
    if ! process_item "$item"; then
      api POST "/publish-jobs/items/$item_id/fail" '{"error":"Connector could not publish this design. See connector logs."}' >/dev/null || true
      echo "Item $item_id failed" >&2
    fi
  done < <(jq -c '.[]' <<<"$pending")
  sleep 5
done
echo "Gave up waiting on job $job_id" >&2
exit 1

<?php
// publish-and-poll.php   php publish-and-poll.php
// Env: CP_BASE, CP_KEY, CP_SHOP_ID, CP_DESIGN_ID

function env(string $name): string {
  $v = getenv($name);
  if ($v === false || $v === '') {
    fwrite(STDERR, "Missing env $name\n");
    exit(1);
  }
  return $v;
}

function api(string $method, string $path, ?array $body = null): array {
  $ch = curl_init(env('CP_BASE') . $path);
  $headers = ['Authorization: Bearer ' . env('CP_KEY'), 'Accept: application/json'];
  if ($body !== null) {
    $headers[] = 'Content-Type: application/json';
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body));
  }
  curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST  => $method,
    CURLOPT_HTTPHEADER     => $headers,
    CURLOPT_TIMEOUT        => 30,
  ]);
  $raw    = curl_exec($ch);
  $status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
  $err    = curl_error($ch);
  curl_close($ch);
  if ($raw === false) {
    throw new RuntimeException("Network error on $method $path: $err");
  }
  $json = json_decode($raw, true);
  if ($status >= 400) {
    throw new RuntimeException("HTTP $status $method $path: " . ($json['error']['code'] ?? '') . ' ' . ($json['error']['message'] ?? $raw));
  }
  return $json;
}

// Replace with your store's API. Returns the store product id.
function create_store_product(int $designId, array $images): string {
  fwrite(STDERR, 'Would create a product for design ' . $designId . ' with ' . count($images) . " images\n");
  return 'demo-' . $designId . '-' . time();
}

function wait_for_mockups(int $designId): array {
  for ($i = 1; $i <= 24; $i++) {
    $m = api('GET', "/designs/$designId/variation-mockups")['data'];
    if (in_array($m['store_status'], ['ready', 'partial'], true)) {
      return $m;
    }
    if ($m['store_status'] === 'unavailable') {
      throw new RuntimeException('Mockup renderer unavailable');
    }
    sleep(5);
  }
  throw new RuntimeException('Mockups not ready after 2 minutes');
}

function process_item(array $item, int $shopId): void {
  $mockups = wait_for_mockups((int) $item['design_id']);

  // Key by variation_id + stage_index; stage 0 is the front. Upload image_url, never thumb_url.
  $images = [];
  foreach ($mockups['items'] as $cell) {
    if (!$cell['failed']) {
      $images[$cell['variation_id'] . ':' . $cell['stage_index']] = $cell['image_url'];
    }
  }

  $ext = $item['mode'] === 'create'
    ? create_store_product((int) $item['design_id'], $images)
    : (string) $item['external_product_id'];

  $catalog = api('GET', '/catalog/products/' . $item['product_id'])['data'];
  $rows = [];
  $variations = $catalog['variations'] ?: [['id' => 0]];
  foreach ($variations as $v) {
    $rows[] = [
      'design_id'           => (int) $item['design_id'],
      'product_id'          => (int) $item['product_id'],
      'variation_id'        => (int) $v['id'],
      'external_product_id' => $ext,
      'external_variant_id' => $v['id'] ? $ext . '-' . $v['id'] : $ext,
    ];
  }
  $bulk = api('POST', "/shops/$shopId/listings/bulk", ['listings' => $rows]);
  if ($bulk['meta']['failed'] > 0) {
    throw new RuntimeException('Listing rows failed: ' . json_encode($bulk['meta']['errors']));
  }

  api('POST', "/publish-jobs/items/{$item['id']}/complete", ['external_product_id' => $ext]);
  echo "Item {$item['id']} complete -> store product $ext\n";
}

$shopId   = (int) env('CP_SHOP_ID');
$designId = (int) env('CP_DESIGN_ID');

$job   = api('POST', '/publish-jobs', ['shop_id' => $shopId, 'design_ids' => [$designId], 'mode' => 'create', 'price_mode' => 'blank']);
$jobId = $job['data']['id'];
echo "Created publish job $jobId\n";

for ($round = 1; $round <= 60; $round++) {
  $pending = array_filter(
    api('GET', "/shops/$shopId/publish-jobs/pending")['data'],
    fn ($i) => (int) $i['job_id'] === (int) $jobId
  );
  if (!$pending) {
    echo "Job $jobId has no pending items. Done.\n";
    exit(0);
  }
  foreach ($pending as $item) {
    try {
      process_item($item, $shopId);
    } catch (Throwable $e) {
      fwrite(STDERR, "Item {$item['id']} failed: {$e->getMessage()}\n");
      try {
        api('POST', "/publish-jobs/items/{$item['id']}/fail", ['error' => substr($e->getMessage(), 0, 500)]);
      } catch (Throwable $ignored) {
      }
    }
  }
  sleep(5);
}
fwrite(STDERR, "Gave up waiting on job $jobId\n");
exit(1);

// publish-and-poll.mjs   node publish-and-poll.mjs
// Env: CP_BASE, CP_KEY, CP_SHOP_ID, CP_DESIGN_ID
for (const name of ['CP_BASE', 'CP_KEY', 'CP_SHOP_ID', 'CP_DESIGN_ID']) {
  if (!process.env[name]) { console.error(`Missing env ${name}`); process.exit(1); }
}
const shopId = Number(process.env.CP_SHOP_ID);
const designId = Number(process.env.CP_DESIGN_ID);
const sleep = (ms) => new Promise((r) => setTimeout(r, ms));

async function api(method, path, body) {
  const res = await fetch(`${process.env.CP_BASE}${path}`, {
    method,
    headers: {
      Authorization: `Bearer ${process.env.CP_KEY}`,
      ...(body ? { 'Content-Type': 'application/json' } : {}),
    },
    body: body ? JSON.stringify(body) : undefined,
    signal: AbortSignal.timeout(30000),
  });
  const json = res.status === 204 ? null : await res.json();
  if (!res.ok) throw new Error(`HTTP ${res.status} ${method} ${path}: ${json?.error?.code} ${json?.error?.message}`);
  return json;
}

// Replace with your store's API. Returns the store product id.
async function createStoreProduct(designId, images) {
  console.error(`Would create a product for design ${designId} with ${images.size} images`);
  return `demo-${designId}-${Date.now()}`;
}

async function waitForMockups(designId) {
  for (let i = 1; i <= 24; i++) {
    const { data } = await api('GET', `/designs/${designId}/variation-mockups`);
    if (data.store_status === 'ready' || data.store_status === 'partial') return data;
    if (data.store_status === 'unavailable') throw new Error('Mockup renderer unavailable');
    await sleep(5000);
  }
  throw new Error('Mockups not ready after 2 minutes');
}

async function processItem(item) {
  const mockups = await waitForMockups(item.design_id);

  // Key by variation_id + stage_index; stage 0 is the front. Upload image_url, never thumb_url.
  const images = new Map();
  for (const cell of mockups.items) {
    if (!cell.failed) images.set(`${cell.variation_id}:${cell.stage_index}`, cell.image_url);
  }

  const ext = item.mode === 'create'
    ? await createStoreProduct(item.design_id, images)
    : item.external_product_id;

  const { data: blank } = await api('GET', `/catalog/products/${item.product_id}`);
  const variations = blank.variations.length ? blank.variations : [{ id: 0 }];
  const listings = variations.map((v) => ({
    design_id: item.design_id,
    product_id: item.product_id,
    variation_id: v.id,
    external_product_id: ext,
    external_variant_id: v.id ? `${ext}-${v.id}` : ext,
  }));
  const bulk = await api('POST', `/shops/${shopId}/listings/bulk`, { listings });
  if (bulk.meta.failed > 0) throw new Error(`Listing rows failed: ${JSON.stringify(bulk.meta.errors)}`);

  await api('POST', `/publish-jobs/items/${item.id}/complete`, { external_product_id: ext });
  console.log(`Item ${item.id} complete -> store product ${ext}`);
}

const job = await api('POST', '/publish-jobs', {
  shop_id: shopId, design_ids: [designId], mode: 'create', price_mode: 'blank',
});
const jobId = job.data.id;
console.log(`Created publish job ${jobId}`);

for (let round = 1; round <= 60; round++) {
  const { data } = await api('GET', `/shops/${shopId}/publish-jobs/pending`);
  const pending = data.filter((i) => i.job_id === jobId);
  if (pending.length === 0) {
    console.log(`Job ${jobId} has no pending items. Done.`);
    process.exit(0);
  }
  for (const item of pending) {
    try {
      await processItem(item);
    } catch (err) {
      console.error(`Item ${item.id} failed: ${err.message}`);
      await api('POST', `/publish-jobs/items/${item.id}/fail`, { error: err.message.slice(0, 500) }).catch(() => {});
    }
  }
  await sleep(5000);
}
console.error(`Gave up waiting on job ${jobId}`);
process.exit(1);

# publish_and_poll.py   python publish_and_poll.py
# Env: CP_BASE, CP_KEY, CP_SHOP_ID, CP_DESIGN_ID
import os
import sys
import time
import requests

for name in ("CP_BASE", "CP_KEY", "CP_SHOP_ID", "CP_DESIGN_ID"):
    if not os.environ.get(name):
        sys.exit(f"Missing env {name}")

BASE = os.environ["CP_BASE"]
SESSION = requests.Session()
SESSION.headers["Authorization"] = f"Bearer {os.environ['CP_KEY']}"
SHOP_ID = int(os.environ["CP_SHOP_ID"])
DESIGN_ID = int(os.environ["CP_DESIGN_ID"])


def api(method, path, body=None):
    res = SESSION.request(method, BASE + path, json=body, timeout=30)
    data = None if res.status_code == 204 else res.json()
    if not res.ok:
        err = (data or {}).get("error", {})
        raise RuntimeError(f"HTTP {res.status_code} {method} {path}: {err.get('code')} {err.get('message')}")
    return data


def create_store_product(design_id, images):
    """Replace with your store's API. Returns the store product id."""
    print(f"Would create a product for design {design_id} with {len(images)} images", file=sys.stderr)
    return f"demo-{design_id}-{int(time.time())}"


def wait_for_mockups(design_id):
    for _ in range(24):
        data = api("GET", f"/designs/{design_id}/variation-mockups")["data"]
        if data["store_status"] in ("ready", "partial"):
            return data
        if data["store_status"] == "unavailable":
            raise RuntimeError("Mockup renderer unavailable")
        time.sleep(5)
    raise RuntimeError("Mockups not ready after 2 minutes")


def process_item(item):
    mockups = wait_for_mockups(item["design_id"])

    # Key by variation_id + stage_index; stage 0 is the front. Upload image_url, never thumb_url.
    images = {
        (cell["variation_id"], cell["stage_index"]): cell["image_url"]
        for cell in mockups["items"]
        if not cell["failed"]
    }

    if item["mode"] == "create":
        ext = create_store_product(item["design_id"], images)
    else:
        ext = item["external_product_id"]

    blank = api("GET", f"/catalog/products/{item['product_id']}")["data"]
    variations = blank["variations"] or [{"id": 0}]
    listings = [
        {
            "design_id": item["design_id"],
            "product_id": item["product_id"],
            "variation_id": v["id"],
            "external_product_id": ext,
            "external_variant_id": f"{ext}-{v['id']}" if v["id"] else ext,
        }
        for v in variations
    ]
    bulk = api("POST", f"/shops/{SHOP_ID}/listings/bulk", {"listings": listings})
    if bulk["meta"]["failed"] > 0:
        raise RuntimeError(f"Listing rows failed: {bulk['meta']['errors']}")

    api("POST", f"/publish-jobs/items/{item['id']}/complete", {"external_product_id": ext})
    print(f"Item {item['id']} complete -> store product {ext}")


job = api("POST", "/publish-jobs", {"shop_id": SHOP_ID, "design_ids": [DESIGN_ID], "mode": "create", "price_mode": "blank"})
job_id = job["data"]["id"]
print(f"Created publish job {job_id}")

for _ in range(60):
    pending = [i for i in api("GET", f"/shops/{SHOP_ID}/publish-jobs/pending")["data"] if i["job_id"] == job_id]
    if not pending:
        print(f"Job {job_id} has no pending items. Done.")
        sys.exit(0)
    for item in pending:
        try:
            process_item(item)
        except Exception as exc:  # noqa: BLE001
            print(f"Item {item['id']} failed: {exc}", file=sys.stderr)
            try:
                api("POST", f"/publish-jobs/items/{item['id']}/fail", {"error": str(exc)[:500]})
            except Exception:  # noqa: BLE001
                pass
    time.sleep(5)

sys.exit(f"Gave up waiting on job {job_id}")

Verify a webhook

A minimal HTTP receiver: reads the raw body, checks X-CP-Signature with a constant-time compare and a 5-minute tolerance, answers 200 immediately and then handles the event. The bash tab is a test sender that signs a sample event and posts it to your receiver.

#!/usr/bin/env bash
# send-test-webhook.sh   Signs a sample event and POSTs it to your receiver.
# Env: CP_WEBHOOK_SECRET. Optional: TARGET (default https://your-store.example/webhooks/ceeprinto)
set -euo pipefail
: "${CP_WEBHOOK_SECRET:?}"
TARGET="${TARGET:-https://your-store.example/webhooks/ceeprinto}"

now=$(date +%s)
sent_at=$(date -u +%Y-%m-%dT%H:%M:%S+00:00)
body='{"topic":"order.status_changed","data":{"wc_order_id":50231,"status":"processing","previous_status":"pending","external_order_id":"1001"},"sent_at":"'"$sent_at"'"}'
sig=$(printf '%s.%s' "$now" "$body" | openssl dgst -sha256 -hmac "$CP_WEBHOOK_SECRET" | awk '{print $NF}')

echo "Valid signature:"
curl -s -w " (HTTP %{http_code})\n" -X POST "$TARGET" \
  -H "Content-Type: application/json" \
  -H "X-CP-Topic: order.status_changed" \
  -H "X-CP-Signature: t=$now,v1=$sig" \
  --data-binary "$body"

echo "Tampered body (must be rejected):"
curl -s -w " (HTTP %{http_code})\n" -X POST "$TARGET" \
  -H "Content-Type: application/json" \
  -H "X-CP-Topic: order.status_changed" \
  -H "X-CP-Signature: t=$now,v1=$sig" \
  --data-binary "${body/processing/cancelled}"

<?php
// webhook.php   Run: CP_WEBHOOK_SECRET=whsec_... php -S 0.0.0.0:8080 webhook.php

const TOLERANCE_SECONDS = 300;

function cp_verify(string $raw, string $header, string $secret): bool {
  $parts = [];
  foreach (explode(',', $header) as $pair) {
    $kv = explode('=', trim($pair), 2);
    if (count($kv) === 2) {
      $parts[$kv[0]] = $kv[1];
    }
  }
  if (!isset($parts['t'], $parts['v1']) || !ctype_digit($parts['t'])) {
    return false;
  }
  if (abs(time() - (int) $parts['t']) > TOLERANCE_SECONDS) {
    return false;
  }
  $expected = hash_hmac('sha256', $parts['t'] . '.' . $raw, $secret);
  return hash_equals($expected, $parts['v1']);
}

if ($_SERVER['REQUEST_METHOD'] !== 'POST') {
  http_response_code(405);
  exit;
}

$secret = getenv('CP_WEBHOOK_SECRET');
$raw    = file_get_contents('php://input'); // raw bytes: never re-encode before verifying
$header = $_SERVER['HTTP_X_CP_SIGNATURE'] ?? '';

if (!$secret || !cp_verify($raw, $header, $secret)) {
  http_response_code(400);
  echo 'invalid signature';
  exit;
}

$event = json_decode($raw, true);
http_response_code(200);
echo 'ok';

// Answer first, then work (php-fpm: fastcgi_finish_request()).
if (function_exists('fastcgi_finish_request')) {
  fastcgi_finish_request();
}

switch ($event['topic']) {
  case 'order.shipped':
    error_log("Order {$event['data']['wc_order_id']} shipped: {$event['data']['tracking_url']}");
    break;
  case 'order.status_changed':
    error_log("Order {$event['data']['wc_order_id']} is now {$event['data']['status']}");
    break;
  case 'design.publish_requested':
    error_log("Publish job {$event['data']['job_id']}: poll /shops/{$event['data']['shop_id']}/publish-jobs/pending now");
    break;
  default:
    error_log('Received ' . $event['topic']);
}

// webhook.mjs   Run: CP_WEBHOOK_SECRET=whsec_... node webhook.mjs
import http from 'node:http';
import crypto from 'node:crypto';

const SECRET = process.env.CP_WEBHOOK_SECRET;
const TOLERANCE_SECONDS = 300;
if (!SECRET) { console.error('Missing env CP_WEBHOOK_SECRET'); process.exit(1); }

function verify(raw, header) {
  const parts = {};
  for (const pair of String(header || '').split(',')) {
    const i = pair.indexOf('=');
    if (i > 0) parts[pair.slice(0, i).trim()] = pair.slice(i + 1).trim();
  }
  if (!/^\d+$/.test(parts.t || '') || !/^[0-9a-f]{64}$/.test(parts.v1 || '')) return false;
  if (Math.abs(Math.floor(Date.now() / 1000) - Number(parts.t)) > TOLERANCE_SECONDS) return false;
  const expected = crypto.createHmac('sha256', SECRET).update(`${parts.t}.`).update(raw).digest();
  return crypto.timingSafeEqual(expected, Buffer.from(parts.v1, 'hex'));
}

function handle(event) {
  switch (event.topic) {
    case 'order.shipped':
      console.log(`Order ${event.data.wc_order_id} shipped: ${event.data.tracking_url}`);
      break;
    case 'order.status_changed':
      console.log(`Order ${event.data.wc_order_id} is now ${event.data.status}`);
      break;
    case 'design.publish_requested':
      console.log(`Publish job ${event.data.job_id}: poll /shops/${event.data.shop_id}/publish-jobs/pending now`);
      break;
    default:
      console.log(`Received ${event.topic}`);
  }
}

http.createServer((req, res) => {
  if (req.method !== 'POST') { res.writeHead(405).end(); return; }
  const chunks = [];
  req.on('data', (c) => chunks.push(c));
  req.on('end', () => {
    const raw = Buffer.concat(chunks); // raw bytes: never re-encode before verifying
    if (!verify(raw, req.headers['x-cp-signature'])) {
      res.writeHead(400).end('invalid signature');
      return;
    }
    res.writeHead(200).end('ok'); // answer within 10 s, then work
    setImmediate(() => {
      try { handle(JSON.parse(raw.toString('utf8'))); } catch (err) { console.error(err); }
    });
  });
}).listen(8080, () => console.log('Listening on :8080'));

# webhook.py   Run: CP_WEBHOOK_SECRET=whsec_... python webhook.py
import hashlib
import hmac
import json
import os
import sys
import threading
import time
from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer

SECRET = os.environ.get("CP_WEBHOOK_SECRET") or sys.exit("Missing env CP_WEBHOOK_SECRET")
TOLERANCE_SECONDS = 300


def verify(raw: bytes, header: str) -> bool:
    parts = dict(p.strip().split("=", 1) for p in (header or "").split(",") if "=" in p)
    t, v1 = parts.get("t", ""), parts.get("v1", "")
    if not t.isdigit() or not v1:
        return False
    if abs(time.time() - int(t)) > TOLERANCE_SECONDS:
        return False
    expected = hmac.new(SECRET.encode(), t.encode() + b"." + raw, hashlib.sha256).hexdigest()
    return hmac.compare_digest(expected, v1)


def handle(event: dict) -> None:
    topic, data = event["topic"], event["data"]
    if topic == "order.shipped":
        print(f"Order {data['wc_order_id']} shipped: {data['tracking_url']}")
    elif topic == "order.status_changed":
        print(f"Order {data['wc_order_id']} is now {data['status']}")
    elif topic == "design.publish_requested":
        print(f"Publish job {data['job_id']}: poll /shops/{data['shop_id']}/publish-jobs/pending now")
    else:
        print(f"Received {topic}")


class Handler(BaseHTTPRequestHandler):
    def do_POST(self):
        raw = self.rfile.read(int(self.headers.get("Content-Length", 0)))  # raw bytes
        if not verify(raw, self.headers.get("X-CP-Signature", "")):
            self.send_response(400)
            self.end_headers()
            self.wfile.write(b"invalid signature")
            return
        self.send_response(200)  # answer within 10 s, then work
        self.end_headers()
        self.wfile.write(b"ok")
        threading.Thread(target=handle, args=(json.loads(raw),), daemon=True).start()


if __name__ == "__main__":
    print("Listening on :8080")
    ThreadingHTTPServer(("0.0.0.0", 8080), Handler).serve_forever()

Submit an order with idempotent retry

Sends one order with an Idempotency-Key derived from your shop and order number, retries timeouts, network errors, 429 and 5xx with the same key, stops on 4xx, recognises a replay, then follows the intake until it is created or failed. Pass your order number as the first argument.

#!/usr/bin/env bash
# submit-order.sh ORDER_NUMBER   Requires curl, jq.
# Env: CP_BASE, CP_KEY, CP_SHOP_ID, CP_EXTERNAL_SHOP_ID
set -euo pipefail
: "${CP_BASE:?}" "${CP_KEY:?}" "${CP_SHOP_ID:?}" "${CP_EXTERNAL_SHOP_ID:?}"
order_no="${1:?usage: $0 ORDER_NUMBER}"
idem="$CP_EXTERNAL_SHOP_ID:$order_no"   # same key on every retry

body=$(jq -nc --argjson shop "$CP_SHOP_ID" --arg no "$order_no" '{
  shop_id: $shop, external_order_id: $no, currency: "PKR",
  shipping_address: {first_name: "Bilal", last_name: "Ahmed", phone: "03001234567",
    address_1: "Flat 4B, Block 5, Clifton", city: "Karachi", country: "PK"},
  line_items: [{external_variant_id: "9001-1", quantity: 1, customer_price: "2500.00", customer_variant: "L / Black"}]
}')

out=$(mktemp); hdr=$(mktemp); trap 'rm -f "$out" "$hdr"' EXIT
delay=1
for attempt in 1 2 3 4 5; do
  status=$(curl -s --max-time 20 -o "$out" -D "$hdr" -w "%{http_code}" -X POST "$CP_BASE/orders" \
    -H "Authorization: Bearer $CP_KEY" -H "Content-Type: application/json" \
    -H "Idempotency-Key: $idem" -d "$body") || status=000
  case "$status" in
    202) echo "Accepted: $(jq -c '.data' "$out")"; break ;;
    200) echo "Already accepted earlier (replay): $(jq -c '.data' "$out")"; break ;;
    000|429|5??)
      wait=$(grep -i '^retry-after:' "$hdr" 2>/dev/null | tr -dc '0-9' || true)
      echo "Attempt $attempt got $status; retrying with the same key" >&2
      sleep "${wait:-$delay}"; delay=$((delay * 2)) ;;
    *) echo "Rejected ($status): $(cat "$out")" >&2; exit 1 ;;
  esac
  [ "$attempt" -eq 5 ] && { echo "Gave up; safe to rerun later with the same order number" >&2; exit 1; }
done

intake_id=$(jq -r '.data.id' "$out")
for i in $(seq 1 30); do
  status=$(curl -s -o "$out" -w "%{http_code}" "$CP_BASE/orders/$intake_id" -H "Authorization: Bearer $CP_KEY")
  [ "$status" = "403" ] && { echo "Key lacks orders:read; check My Account -> Store Connections -> Order Activity"; exit 0; }
  s=$(jq -r '.data.status' "$out")
  case "$s" in
    created) echo "WooCommerce order $(jq -r '.data.wc_order_id' "$out") created (Pending payment)"; exit 0 ;;
    failed)  echo "Intake failed: $(jq -r '.data.last_error' "$out")" >&2; exit 1 ;;
  esac
  sleep 2
done
echo "Still $s after 60 s; check again later" >&2

<?php
// submit-order.php ORDER_NUMBER
// Env: CP_BASE, CP_KEY, CP_SHOP_ID, CP_EXTERNAL_SHOP_ID

foreach (['CP_BASE', 'CP_KEY', 'CP_SHOP_ID', 'CP_EXTERNAL_SHOP_ID'] as $n) {
  if (!getenv($n)) { fwrite(STDERR, "Missing env $n\n"); exit(1); }
}
$orderNo = $argv[1] ?? null;
if (!$orderNo) { fwrite(STDERR, "usage: php submit-order.php ORDER_NUMBER\n"); exit(1); }

$idempotencyKey = getenv('CP_EXTERNAL_SHOP_ID') . ':' . $orderNo; // same key on every retry
$order = [
  'shop_id'           => (int) getenv('CP_SHOP_ID'),
  'external_order_id' => $orderNo,
  'currency'          => 'PKR',
  'shipping_address'  => [
    'first_name' => 'Bilal', 'last_name' => 'Ahmed', 'phone' => '03001234567',
    'address_1'  => 'Flat 4B, Block 5, Clifton', 'city' => 'Karachi', 'country' => 'PK',
  ],
  'line_items' => [
    ['external_variant_id' => '9001-1', 'quantity' => 1, 'customer_price' => '2500.00', 'customer_variant' => 'L / Black'],
  ],
];

function request(string $method, string $path, ?array $body = null, array $extra = []): array {
  $headers = [];
  $ch = curl_init(getenv('CP_BASE') . $path);
  curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST  => $method,
    CURLOPT_TIMEOUT        => 20,
    CURLOPT_HTTPHEADER     => array_merge(['Authorization: Bearer ' . getenv('CP_KEY'), 'Content-Type: application/json'], $extra),
    CURLOPT_HEADERFUNCTION => function ($ch, $line) use (&$headers) {
      $kv = explode(':', $line, 2);
      if (count($kv) === 2) { $headers[strtolower(trim($kv[0]))] = trim($kv[1]); }
      return strlen($line);
    },
  ]);
  if ($body !== null) { curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body)); }
  $raw    = curl_exec($ch);
  $status = $raw === false ? 0 : curl_getinfo($ch, CURLINFO_HTTP_CODE);
  curl_close($ch);
  return [$status, $raw ? json_decode($raw, true) : null, $headers];
}

$delay = 1;
for ($attempt = 1; ; $attempt++) {
  [$status, $json, $headers] = request('POST', '/orders', $order, ['Idempotency-Key: ' . $idempotencyKey]);
  if ($status === 202 || $status === 200) {
    $replay = !empty($json['meta']['idempotent_replay']);
    echo ($replay ? 'Already accepted earlier (replay): ' : 'Accepted: ') . json_encode($json['data']) . "\n";
    break;
  }
  $retryable = $status === 0 || $status === 429 || $status >= 500;
  if (!$retryable) {
    fwrite(STDERR, "Rejected ($status): " . json_encode($json['error'] ?? null) . "\n");
    exit(1);
  }
  if ($attempt === 5) {
    fwrite(STDERR, "Gave up; safe to rerun later with the same order number\n");
    exit(1);
  }
  fwrite(STDERR, "Attempt $attempt got $status; retrying with the same key\n");
  sleep(isset($headers['retry-after']) ? (int) $headers['retry-after'] : $delay);
  $delay *= 2;
}

$intakeId = $json['data']['id'];
for ($i = 0; $i < 30; $i++) {
  [$status, $json] = request('GET', "/orders/$intakeId");
  if ($status === 403) { echo "Key lacks orders:read; check My Account -> Store Connections -> Order Activity\n"; exit(0); }
  $s = $json['data']['status'] ?? 'unknown';
  if ($s === 'created') { echo "WooCommerce order {$json['data']['wc_order_id']} created (Pending payment)\n"; exit(0); }
  if ($s === 'failed') { fwrite(STDERR, "Intake failed: {$json['data']['last_error']}\n"); exit(1); }
  sleep(2);
}
fwrite(STDERR, "Still $s after 60 s; check again later\n");

// submit-order.mjs ORDER_NUMBER
// Env: CP_BASE, CP_KEY, CP_SHOP_ID, CP_EXTERNAL_SHOP_ID
for (const n of ['CP_BASE', 'CP_KEY', 'CP_SHOP_ID', 'CP_EXTERNAL_SHOP_ID']) {
  if (!process.env[n]) { console.error(`Missing env ${n}`); process.exit(1); }
}
const orderNo = process.argv[2];
if (!orderNo) { console.error('usage: node submit-order.mjs ORDER_NUMBER'); process.exit(1); }

const idempotencyKey = `${process.env.CP_EXTERNAL_SHOP_ID}:${orderNo}`; // same key on every retry
const order = {
  shop_id: Number(process.env.CP_SHOP_ID),
  external_order_id: orderNo,
  currency: 'PKR',
  shipping_address: {
    first_name: 'Bilal', last_name: 'Ahmed', phone: '03001234567',
    address_1: 'Flat 4B, Block 5, Clifton', city: 'Karachi', country: 'PK',
  },
  line_items: [
    { external_variant_id: '9001-1', quantity: 1, customer_price: '2500.00', customer_variant: 'L / Black' },
  ],
};
const sleep = (ms) => new Promise((r) => setTimeout(r, ms));

async function request(method, path, body, headers = {}) {
  try {
    const res = await fetch(`${process.env.CP_BASE}${path}`, {
      method,
      headers: { Authorization: `Bearer ${process.env.CP_KEY}`, 'Content-Type': 'application/json', ...headers },
      body: body ? JSON.stringify(body) : undefined,
      signal: AbortSignal.timeout(20000),
    });
    return { status: res.status, json: await res.json().catch(() => null), headers: res.headers };
  } catch (err) {
    return { status: 0, json: null, headers: new Headers(), err }; // timeout or network error
  }
}

let result;
for (let attempt = 1, delay = 1000; ; attempt++, delay *= 2) {
  result = await request('POST', '/orders', order, { 'Idempotency-Key': idempotencyKey });
  const { status, json } = result;
  if (status === 202 || status === 200) {
    const replay = json.meta?.idempotent_replay === true;
    console.log(`${replay ? 'Already accepted earlier (replay)' : 'Accepted'}: ${JSON.stringify(json.data)}`);
    break;
  }
  if (!(status === 0 || status === 429 || status >= 500)) {
    console.error(`Rejected (${status}): ${JSON.stringify(json?.error)}`);
    process.exit(1);
  }
  if (attempt === 5) { console.error('Gave up; safe to rerun later with the same order number'); process.exit(1); }
  console.error(`Attempt ${attempt} got ${status}; retrying with the same key`);
  const retryAfter = Number(result.headers.get('retry-after'));
  await sleep(retryAfter > 0 ? retryAfter * 1000 : delay);
}

const intakeId = result.json.data.id;
let state = 'unknown';
for (let i = 0; i < 30; i++) {
  const { status, json } = await request('GET', `/orders/${intakeId}`);
  if (status === 403) { console.log('Key lacks orders:read; check My Account -> Store Connections -> Order Activity'); process.exit(0); }
  state = json?.data?.status;
  if (state === 'created') { console.log(`WooCommerce order ${json.data.wc_order_id} created (Pending payment)`); process.exit(0); }
  if (state === 'failed') { console.error(`Intake failed: ${json.data.last_error}`); process.exit(1); }
  await sleep(2000);
}
console.error(`Still ${state} after 60 s; check again later`);

# submit_order.py ORDER_NUMBER
# Env: CP_BASE, CP_KEY, CP_SHOP_ID, CP_EXTERNAL_SHOP_ID
import os
import sys
import time
import requests

for n in ("CP_BASE", "CP_KEY", "CP_SHOP_ID", "CP_EXTERNAL_SHOP_ID"):
    if not os.environ.get(n):
        sys.exit(f"Missing env {n}")
if len(sys.argv) < 2:
    sys.exit("usage: python submit_order.py ORDER_NUMBER")

order_no = sys.argv[1]
idempotency_key = f"{os.environ['CP_EXTERNAL_SHOP_ID']}:{order_no}"  # same key on every retry
BASE = os.environ["CP_BASE"]
HEADERS = {"Authorization": f"Bearer {os.environ['CP_KEY']}"}
order = {
    "shop_id": int(os.environ["CP_SHOP_ID"]),
    "external_order_id": order_no,
    "currency": "PKR",
    "shipping_address": {
        "first_name": "Bilal", "last_name": "Ahmed", "phone": "03001234567",
        "address_1": "Flat 4B, Block 5, Clifton", "city": "Karachi", "country": "PK",
    },
    "line_items": [
        {"external_variant_id": "9001-1", "quantity": 1, "customer_price": "2500.00", "customer_variant": "L / Black"},
    ],
}

delay = 1
for attempt in range(1, 6):
    try:
        res = requests.post(
            f"{BASE}/orders",
            headers={**HEADERS, "Idempotency-Key": idempotency_key},
            json=order,
            timeout=20,
        )
        status = res.status_code
    except requests.RequestException:
        res, status = None, 0  # timeout or network error

    if status in (200, 202):
        body = res.json()
        replay = body.get("meta", {}).get("idempotent_replay", False)
        print(("Already accepted earlier (replay): " if replay else "Accepted: ") + str(body["data"]))
        break
    if not (status == 0 or status == 429 or status >= 500):
        sys.exit(f"Rejected ({status}): {res.json().get('error')}")
    if attempt == 5:
        sys.exit("Gave up; safe to rerun later with the same order number")
    print(f"Attempt {attempt} got {status}; retrying with the same key", file=sys.stderr)
    wait = int(res.headers.get("Retry-After", delay)) if res is not None else delay
    time.sleep(wait)
    delay *= 2

intake_id = body["data"]["id"]
state = "unknown"
for _ in range(30):
    r = requests.get(f"{BASE}/orders/{intake_id}", headers=HEADERS, timeout=20)
    if r.status_code == 403:
        print("Key lacks orders:read; check My Account -> Store Connections -> Order Activity")
        sys.exit(0)
    data = r.json()["data"]
    state = data["status"]
    if state == "created":
        print(f"WooCommerce order {data['wc_order_id']} created (Pending payment)")
        sys.exit(0)
    if state == "failed":
        sys.exit(f"Intake failed: {data['last_error']}")
    time.sleep(2)
print(f"Still {state} after 60 s; check again later", file=sys.stderr)

Sync catalog and stock

Walks GET /catalog/products 100 at a time by following the Link header's rel="next", fetches each variable blank for per-variation stock, honours 429 Retry-After, and writes catalog.json with one row per sellable variant. Subscribe to product.stock_changed afterwards to stay in sync without re-running it.

#!/usr/bin/env bash
# sync-catalog.sh   Requires curl, jq. Env: CP_BASE, CP_KEY. Writes catalog.json
set -euo pipefail
: "${CP_BASE:?}" "${CP_KEY:?}"

hdr=$(mktemp); out=$(mktemp); rows=$(mktemp); trap 'rm -f "$hdr" "$out" "$rows"' EXIT

# get URL: fetch into $out/$hdr, retrying 429 after Retry-After
get() {
  local url="$1" status wait
  for attempt in 1 2 3 4 5; do
    status=$(curl -s -o "$out" -D "$hdr" -w "%{http_code}" "$url" -H "Authorization: Bearer $CP_KEY")
    [ "$status" = "200" ] && return 0
    if [ "$status" = "429" ] || [ "$status" -ge 500 ]; then
      wait=$(grep -i '^retry-after:' "$hdr" | tr -dc '0-9' || true)
      sleep "${wait:-$attempt}"; continue
    fi
    echo "HTTP $status for $url: $(cat "$out")" >&2; return 1
  done
  return 1
}

url="$CP_BASE/catalog/products?per_page=100"
while [ -n "$url" ]; do
  get "$url"
  # Save the next-page URL now; the detail requests below overwrite $hdr.
  next=$(grep -i '^link:' "$hdr" | tr ',' '\n' | grep 'rel="next"' | sed -E 's/.*<([^>]+)>.*/\1/' || true)
  jq -c '.data[]' "$out" > "$rows.page"
  while read -r p; do
    id=$(jq -r '.id' <<<"$p")
    if [ "$(jq -r '.has_variations' <<<"$p")" = "true" ]; then
      get "$CP_BASE/catalog/products/$id"
      jq -c '.data as $p | $p.variations[] | {product_id: $p.id, variation_id: .id, title: .title, sku, stock_status, stock_quantity, in_stock}' "$out" >> "$rows"
    else
      jq -c '{product_id: .id, variation_id: 0, title, sku, stock_status, stock_quantity, in_stock}' <<<"$p" >> "$rows"
    fi
  done < "$rows.page"
  rm -f "$rows.page"
  url="$next"
done

jq -s '.' "$rows" > catalog.json
echo "Wrote $(jq length catalog.json) variants to catalog.json"

<?php
// sync-catalog.php   Env: CP_BASE, CP_KEY. Writes catalog.json

foreach (['CP_BASE', 'CP_KEY'] as $n) {
  if (!getenv($n)) { fwrite(STDERR, "Missing env $n\n"); exit(1); }
}

function get_json(string $url): array {
  for ($attempt = 1; $attempt <= 5; $attempt++) {
    $headers = [];
    $ch = curl_init($url);
    curl_setopt_array($ch, [
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_TIMEOUT        => 30,
      CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('CP_KEY')],
      CURLOPT_HEADERFUNCTION => function ($ch, $line) use (&$headers) {
        $kv = explode(':', $line, 2);
        if (count($kv) === 2) { $headers[strtolower(trim($kv[0]))] = trim($kv[1]); }
        return strlen($line);
      },
    ]);
    $raw    = curl_exec($ch);
    $status = $raw === false ? 0 : curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);
    if ($status === 200) {
      return [json_decode($raw, true), $headers];
    }
    if ($status === 0 || $status === 429 || $status >= 500) {
      sleep(isset($headers['retry-after']) ? (int) $headers['retry-after'] : $attempt);
      continue;
    }
    throw new RuntimeException("HTTP $status for $url: $raw");
  }
  throw new RuntimeException("Gave up on $url");
}

function next_link(?string $link): ?string {
  foreach (explode(',', (string) $link) as $part) {
    if (preg_match('/<([^>]+)>\s*;\s*rel="next"/', $part, $m)) {
      return $m[1];
    }
  }
  return null;
}

$rows = [];
$url  = getenv('CP_BASE') . '/catalog/products?per_page=100';
while ($url) {
  [$page, $headers] = get_json($url);
  foreach ($page['data'] as $p) {
    if ($p['has_variations']) {
      [$detail] = get_json(getenv('CP_BASE') . '/catalog/products/' . $p['id']);
      foreach ($detail['data']['variations'] as $v) {
        $rows[] = ['product_id' => $p['id'], 'variation_id' => $v['id'], 'title' => $v['title'], 'sku' => $v['sku'],
          'stock_status' => $v['stock_status'], 'stock_quantity' => $v['stock_quantity'], 'in_stock' => $v['in_stock']];
      }
    } else {
      $rows[] = ['product_id' => $p['id'], 'variation_id' => 0, 'title' => $p['title'], 'sku' => $p['sku'],
        'stock_status' => $p['stock_status'], 'stock_quantity' => $p['stock_quantity'], 'in_stock' => $p['in_stock']];
    }
  }
  $url = next_link($headers['link'] ?? null);
}

file_put_contents('catalog.json', json_encode($rows, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
echo 'Wrote ' . count($rows) . " variants to catalog.json\n";

// sync-catalog.mjs   Env: CP_BASE, CP_KEY. Writes catalog.json
import { writeFile } from 'node:fs/promises';

for (const n of ['CP_BASE', 'CP_KEY']) {
  if (!process.env[n]) { console.error(`Missing env ${n}`); process.exit(1); }
}
const sleep = (ms) => new Promise((r) => setTimeout(r, ms));

async function getJson(url) {
  for (let attempt = 1; attempt <= 5; attempt++) {
    let res;
    try {
      res = await fetch(url, {
        headers: { Authorization: `Bearer ${process.env.CP_KEY}` },
        signal: AbortSignal.timeout(30000),
      });
    } catch {
      await sleep(attempt * 1000);
      continue;
    }
    if (res.ok) return { json: await res.json(), headers: res.headers };
    if (res.status === 429 || res.status >= 500) {
      await sleep((Number(res.headers.get('retry-after')) || attempt) * 1000);
      continue;
    }
    throw new Error(`HTTP ${res.status} for ${url}: ${await res.text()}`);
  }
  throw new Error(`Gave up on ${url}`);
}

function nextLink(link) {
  const m = /<([^>]+)>\s*;\s*rel="next"/.exec(link || '');
  return m ? m[1] : null;
}

const rows = [];
let url = `${process.env.CP_BASE}/catalog/products?per_page=100`;
while (url) {
  const { json: page, headers } = await getJson(url);
  for (const p of page.data) {
    if (p.has_variations) {
      const { json: detail } = await getJson(`${process.env.CP_BASE}/catalog/products/${p.id}`);
      for (const v of detail.data.variations) {
        rows.push({ product_id: p.id, variation_id: v.id, title: v.title, sku: v.sku,
          stock_status: v.stock_status, stock_quantity: v.stock_quantity, in_stock: v.in_stock });
      }
    } else {
      rows.push({ product_id: p.id, variation_id: 0, title: p.title, sku: p.sku,
        stock_status: p.stock_status, stock_quantity: p.stock_quantity, in_stock: p.in_stock });
    }
  }
  url = nextLink(headers.get('link'));
}

await writeFile('catalog.json', JSON.stringify(rows, null, 2));
console.log(`Wrote ${rows.length} variants to catalog.json`);

# sync_catalog.py   Env: CP_BASE, CP_KEY. Writes catalog.json
import json
import os
import sys
import time
import requests

for n in ("CP_BASE", "CP_KEY"):
    if not os.environ.get(n):
        sys.exit(f"Missing env {n}")

BASE = os.environ["CP_BASE"]
SESSION = requests.Session()
SESSION.headers["Authorization"] = f"Bearer {os.environ['CP_KEY']}"


def get(url):
    for attempt in range(1, 6):
        try:
            res = SESSION.get(url, timeout=30)
        except requests.RequestException:
            time.sleep(attempt)
            continue
        if res.ok:
            return res
        if res.status_code == 429 or res.status_code >= 500:
            time.sleep(int(res.headers.get("Retry-After", attempt)))
            continue
        raise RuntimeError(f"HTTP {res.status_code} for {url}: {res.text}")
    raise RuntimeError(f"Gave up on {url}")


rows = []
url = f"{BASE}/catalog/products?per_page=100"
while url:
    res = get(url)
    for p in res.json()["data"]:
        if p["has_variations"]:
            detail = get(f"{BASE}/catalog/products/{p['id']}").json()["data"]
            for v in detail["variations"]:
                rows.append({"product_id": p["id"], "variation_id": v["id"], "title": v["title"], "sku": v["sku"],
                             "stock_status": v["stock_status"], "stock_quantity": v["stock_quantity"],
                             "in_stock": v["in_stock"]})
        else:
            rows.append({"product_id": p["id"], "variation_id": 0, "title": p["title"], "sku": p["sku"],
                         "stock_status": p["stock_status"], "stock_quantity": p["stock_quantity"],
                         "in_stock": p["in_stock"]})
    url = res.links.get("next", {}).get("url")  # requests parses the Link header

with open("catalog.json", "w") as fh:
    json.dump(rows, fh, indent=2)
print(f"Wrote {len(rows)} variants to catalog.json")

Every ceeprinto/v2 route with its scope, parameters, request body, full response and runnable examples.

Base URL https://ceeprinto.com/wp-json/ceeprinto/v2. Every request sends Authorization: Bearer $CP_KEY. Examples read CP_BASE and CP_KEY from the environment; Node examples use top-level await, so save them as .mjs (Node 18+). The machine-readable spec is openapi.yaml.

Me

The account and API key behind the credential.

{
  "data": {
    "id": 214,
    "email": "[email protected]",
    "name": "Ayesha Khan",
    "first_name": "Ayesha",
    "last_name": "Khan",
    "company": "Threadline Karachi",
    "api_key": {
      "key_id": "9f3a1c7eK2pQ8mZx4LbN6tRw",
      "name": "WooCommerce Connect",
      "is_legacy": false,
      "last_used_at": "2026-09-29 10:14:52"
    },
    "scopes": [
      "designs:read",
      "products:read",
      "listings:read",
      "listings:write",
      "orders:write",
      "shops:write",
      "webhooks:write"
    ],
    "fulfillment_profile": {
      "complete": true,
      "missing": [],
      "fields": {
        "billing_phone": true,
        "billing_address_1": true,
        "billing_city": true,
        "billing_country": true,
        "billing_company": true,
        "billing_address_2": false,
        "billing_state": true,
        "billing_postcode": true,
        "first_name": true,
        "last_name": true
      }
    }
  }
}

curl -s "$CP_BASE/me" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/me');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/me`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/me",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

Catalog

Blank WooCommerce products that designs are printed on, with stock.

{
  "data": [
    {
      "id": 37,
      "title": "Classic Crew Tee",
      "type": "variable",
      "has_variations": true,
      "sku": "CP-TEE",
      "price": "1200",
      "image_url": "https://ceeprinto.com/wp-content/uploads/2026/05/classic-tee.jpg",
      "stock_status": "instock",
      "stock_quantity": null,
      "in_stock": true
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 1,
    "total_pages": 1
  }
}

curl -s "$CP_BASE/catalog/products?search=tee&per_page=50" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/catalog/products?search=tee&per_page=50');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/catalog/products?search=tee&per_page=50`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/catalog/products",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    params={
        "search": "tee",
        "per_page": 50,
    },
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "data": {
    "id": 37,
    "title": "Classic Crew Tee",
    "type": "variable",
    "has_variations": true,
    "sku": "CP-TEE",
    "price": "1200",
    "image_url": "https://ceeprinto.com/wp-content/uploads/2026/05/classic-tee.jpg",
    "stock_status": "instock",
    "stock_quantity": null,
    "in_stock": true,
    "description": "180 GSM combed cotton crew neck.",
    "attributes": [
      {
        "name": "Size",
        "slug": "pa_size",
        "options": [
          "S",
          "M",
          "L"
        ]
      },
      {
        "name": "Color",
        "slug": "pa_color",
        "options": [
          "Black",
          "White",
          "Navy",
          "Maroon"
        ]
      }
    ],
    "variations": [
      {
        "id": 101,
        "title": "Classic Crew Tee - L, Black",
        "attributes": {
          "attribute_pa_size": "l",
          "attribute_pa_color": "black"
        },
        "sku": "CP-TEE-L-BLK",
        "price": "1200",
        "stock_status": "instock",
        "stock_quantity": 40,
        "in_stock": true
      }
    ],
    "print_config": {
      "stages": [
        {
          "id": 1,
          "index": 0,
          "name": "Front"
        },
        {
          "id": 2,
          "index": 1,
          "name": "Back"
        }
      ]
    }
  }
}

curl -s "$CP_BASE/catalog/products/37" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/catalog/products/37');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/catalog/products/37`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/catalog/products/37",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

Products

Hub products: a blank plus a default design and per-variant overrides, publishable to any connected store.

{
  "data": [
    {
      "id": 42,
      "user_id": 214,
      "blank_product_id": 37,
      "title": "Karachi Skyline Tee",
      "description": "",
      "price_mode": "blank",
      "flat_price": null,
      "default_design_id": 11,
      "status": "active",
      "created_at": "2026-09-20T09:12:00+00:00",
      "updated_at": "2026-09-28T16:40:05+00:00",
      "variants": [
        {
          "id": 501,
          "product_id": 42,
          "variation_id": 101,
          "design_id": null,
          "price": null,
          "sku": null,
          "enabled": true,
          "effective_design_id": 11,
          "inherits_default": true
        },
        {
          "id": 502,
          "product_id": 42,
          "variation_id": 102,
          "design_id": 12,
          "price": 2800,
          "sku": "TEE-BLK-L",
          "enabled": true,
          "effective_design_id": 12,
          "inherits_default": false
        }
      ]
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 1,
    "total_pages": 1
  }
}

curl -s "$CP_BASE/products" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/products');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/products`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/products",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "blank_product_id": 37,
  "title": "Karachi Skyline Tee",
  "default_design_id": 11,
  "price_mode": "flat",
  "flat_price": 2500
}

{
  "data": {
    "id": 42,
    "user_id": 214,
    "blank_product_id": 37,
    "title": "Karachi Skyline Tee",
    "description": "",
    "price_mode": "flat",
    "flat_price": 2500,
    "default_design_id": 11,
    "status": "draft",
    "created_at": "2026-09-29T10:15:00+00:00",
    "updated_at": "2026-09-29T10:15:00+00:00",
    "variants": [
      {
        "id": 501,
        "product_id": 42,
        "variation_id": 101,
        "design_id": null,
        "price": null,
        "sku": null,
        "enabled": true,
        "effective_design_id": 11,
        "inherits_default": true
      },
      {
        "id": 502,
        "product_id": 42,
        "variation_id": 102,
        "design_id": null,
        "price": null,
        "sku": null,
        "enabled": true,
        "effective_design_id": 11,
        "inherits_default": true
      }
    ]
  }
}

curl -s -X POST "$CP_BASE/products" \
  -H "Authorization: Bearer $CP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"blank_product_id":37,"title":"Karachi Skyline Tee","default_design_id":11,"price_mode":"flat","flat_price":2500}'

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/products');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'blank_product_id' => 37,
    'title' => 'Karachi Skyline Tee',
    'default_design_id' => 11,
    'price_mode' => 'flat',
    'flat_price' => 2500,
  ]),
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/products`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    blank_product_id: 37,
    title: 'Karachi Skyline Tee',
    default_design_id: 11,
    price_mode: 'flat',
    flat_price: 2500,
  }),
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.post(
    f"{os.environ['CP_BASE']}/products",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    json={
        "blank_product_id": 37,
        "title": "Karachi Skyline Tee",
        "default_design_id": 11,
        "price_mode": "flat",
        "flat_price": 2500,
    },
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "data": {
    "id": 42,
    "user_id": 214,
    "blank_product_id": 37,
    "title": "Karachi Skyline Tee",
    "description": "",
    "price_mode": "blank",
    "flat_price": null,
    "default_design_id": 11,
    "status": "active",
    "created_at": "2026-09-20T09:12:00+00:00",
    "updated_at": "2026-09-28T16:40:05+00:00",
    "variants": [
      {
        "id": 501,
        "product_id": 42,
        "variation_id": 101,
        "design_id": null,
        "price": null,
        "sku": null,
        "enabled": true,
        "effective_design_id": 11,
        "inherits_default": true
      },
      {
        "id": 502,
        "product_id": 42,
        "variation_id": 102,
        "design_id": 12,
        "price": 2800,
        "sku": "TEE-BLK-L",
        "enabled": true,
        "effective_design_id": 12,
        "inherits_default": false
      }
    ]
  }
}

curl -s "$CP_BASE/products/42" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/products/42');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/products/42`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/products/42",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "default_design_id": 12,
  "status": "active"
}

{
  "data": {
    "id": 42,
    "user_id": 214,
    "blank_product_id": 37,
    "title": "Karachi Skyline Tee",
    "description": "",
    "price_mode": "blank",
    "flat_price": null,
    "default_design_id": 12,
    "status": "active",
    "created_at": "2026-09-20T09:12:00+00:00",
    "updated_at": "2026-09-29T10:15:00+00:00",
    "variants": [
      {
        "id": 501,
        "product_id": 42,
        "variation_id": 101,
        "design_id": null,
        "price": null,
        "sku": null,
        "enabled": true,
        "effective_design_id": 12,
        "inherits_default": true
      }
    ]
  }
}

curl -s -X PATCH "$CP_BASE/products/42" \
  -H "Authorization: Bearer $CP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"default_design_id":12,"status":"active"}'

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/products/42');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'default_design_id' => 12,
    'status' => 'active',
  ]),
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/products/42`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    default_design_id: 12,
    status: 'active',
  }),
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.patch(
    f"{os.environ['CP_BASE']}/products/42",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    json={
        "default_design_id": 12,
        "status": "active",
    },
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "design_id": 12,
  "price": 2800,
  "sku": "TEE-BLK-L"
}

{
  "data": {
    "id": 502,
    "product_id": 42,
    "variation_id": 102,
    "design_id": 12,
    "price": 2800,
    "sku": "TEE-BLK-L",
    "enabled": true,
    "effective_design_id": 12,
    "inherits_default": false
  }
}

curl -s -X PATCH "$CP_BASE/products/42/variants/102" \
  -H "Authorization: Bearer $CP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"design_id":12,"price":2800,"sku":"TEE-BLK-L"}'

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/products/42/variants/102');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'design_id' => 12,
    'price' => 2800,
    'sku' => 'TEE-BLK-L',
  ]),
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/products/42/variants/102`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    design_id: 12,
    price: 2800,
    sku: 'TEE-BLK-L',
  }),
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.patch(
    f"{os.environ['CP_BASE']}/products/42/variants/102",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    json={
        "design_id": 12,
        "price": 2800,
        "sku": "TEE-BLK-L",
    },
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

Designs

The merchant's saved designs and their per-variation, per-side mockups.

{
  "data": [
    {
      "id": 11,
      "name": "Karachi Skyline",
      "status": "saved",
      "product_id": 37,
      "variation_id": 101,
      "preview_url": "https://ceeprinto.com/wp-content/uploads/ceeprinto-designs/previews/design-11.png",
      "total_price": 1200,
      "order_id": null,
      "created_at": "2026-09-18T11:02:44+00:00",
      "updated_at": "2026-09-18T11:05:10+00:00"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 1,
    "total_pages": 1
  }
}

curl -s "$CP_BASE/designs?product_id=37&per_page=20" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/designs?product_id=37&per_page=20');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/designs?product_id=37&per_page=20`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/designs",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    params={
        "product_id": 37,
        "per_page": 20,
    },
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "data": {
    "id": 11,
    "name": "Karachi Skyline",
    "status": "saved",
    "product_id": 37,
    "variation_id": 101,
    "preview_url": "https://ceeprinto.com/wp-content/uploads/ceeprinto-designs/previews/design-11.png",
    "total_price": 1200,
    "order_id": null,
    "created_at": "2026-09-18T11:02:44+00:00",
    "updated_at": "2026-09-18T11:05:10+00:00",
    "hires_png_url": "https://ceeprinto.com/wp-content/uploads/ceeprinto-designs/hires/design-11.png",
    "pdf_url": null,
    "config_id": 6,
    "base_product": {
      "id": 37,
      "title": "Classic Crew Tee",
      "sku": "CP-TEE",
      "price": "1200"
    },
    "design_data": {
      "stages": [
        {
          "index": 0,
          "name": "Front",
          "objects": []
        }
      ]
    }
  }
}

curl -s "$CP_BASE/designs/11" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/designs/11');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/designs/11`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/designs/11",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "data": {
    "status": "ready",
    "total": 24,
    "ready": 24,
    "pending": 0,
    "failed": 0,
    "store_status": "ready",
    "store_ready": 24,
    "store_failed": 0,
    "store_pending": 0,
    "batch": 5,
    "queued": 0,
    "items": [
      {
        "variation_id": 101,
        "stage_index": 0,
        "stage_id": 1,
        "stage_name": "Front",
        "ready": true,
        "store_ready": true,
        "failed": false,
        "error": null,
        "thumb_url": "https://ceeprinto.com/wp-json/ceeprinto/v1/mockup/11/3fa9c2e1b7d4.jpg",
        "image_url": "https://ceeprinto.com/wp-json/ceeprinto/v1/mockup/11/8be0d41c92aa.jpg"
      },
      {
        "variation_id": 101,
        "stage_index": 1,
        "stage_id": 2,
        "stage_name": "Back",
        "ready": true,
        "store_ready": true,
        "failed": false,
        "error": null,
        "thumb_url": "https://ceeprinto.com/wp-json/ceeprinto/v1/mockup/11/c71f03d5e2b9.jpg",
        "image_url": "https://ceeprinto.com/wp-json/ceeprinto/v1/mockup/11/0d4e6a91f3c7.jpg"
      }
    ]
  }
}

curl -s "$CP_BASE/designs/11/variation-mockups" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/designs/11/variation-mockups');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/designs/11/variation-mockups`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/designs/11/variation-mockups",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "data": {
    "status": "ready",
    "total": 24,
    "ready": 24,
    "pending": 0,
    "failed": 0,
    "store_status": "ready",
    "store_ready": 24,
    "store_failed": 0,
    "store_pending": 0,
    "batch": 5,
    "queued": 0,
    "items": [
      {
        "variation_id": 101,
        "stage_index": 0,
        "stage_id": 1,
        "stage_name": "Front",
        "ready": true,
        "store_ready": true,
        "failed": false,
        "error": null,
        "thumb_url": "https://ceeprinto.com/wp-json/ceeprinto/v1/mockup/11/3fa9c2e1b7d4.jpg",
        "image_url": "https://ceeprinto.com/wp-json/ceeprinto/v1/mockup/11/8be0d41c92aa.jpg"
      },
      {
        "variation_id": 101,
        "stage_index": 1,
        "stage_id": 2,
        "stage_name": "Back",
        "ready": true,
        "store_ready": true,
        "failed": false,
        "error": null,
        "thumb_url": "https://ceeprinto.com/wp-json/ceeprinto/v1/mockup/11/c71f03d5e2b9.jpg",
        "image_url": "https://ceeprinto.com/wp-json/ceeprinto/v1/mockup/11/0d4e6a91f3c7.jpg"
      }
    ]
  }
}

curl -s -X POST "$CP_BASE/designs/11/variation-mockups" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/designs/11/variation-mockups');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/designs/11/variation-mockups`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.post(
    f"{os.environ['CP_BASE']}/designs/11/variation-mockups",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

Shops

Connected storefronts (Shopify, WooCommerce, custom).

{
  "data": [
    {
      "id": 5,
      "channel": "custom",
      "external_shop_id": "my-store-01",
      "name": "My Store",
      "webhook_url": null,
      "status": "active",
      "connected_at": "2026-09-15T07:30:00+00:00"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 1,
    "total_pages": 1
  }
}

curl -s "$CP_BASE/shops" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/shops');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/shops`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/shops",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "channel": "custom",
  "external_shop_id": "my-store-01",
  "name": "My Store"
}

{
  "data": {
    "id": 5,
    "channel": "custom",
    "external_shop_id": "my-store-01",
    "name": "My Store",
    "webhook_url": null,
    "status": "active",
    "connected_at": "2026-09-29T10:15:00+00:00"
  }
}

curl -s -X POST "$CP_BASE/shops" \
  -H "Authorization: Bearer $CP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"channel":"custom","external_shop_id":"my-store-01","name":"My Store"}'

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/shops');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'channel' => 'custom',
    'external_shop_id' => 'my-store-01',
    'name' => 'My Store',
  ]),
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/shops`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    channel: 'custom',
    external_shop_id: 'my-store-01',
    name: 'My Store',
  }),
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.post(
    f"{os.environ['CP_BASE']}/shops",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    json={
        "channel": "custom",
        "external_shop_id": "my-store-01",
        "name": "My Store",
    },
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "data": {
    "id": 5,
    "channel": "custom",
    "external_shop_id": "my-store-01",
    "name": "My Store",
    "webhook_url": null,
    "status": "active",
    "connected_at": "2026-09-15T07:30:00+00:00"
  }
}

curl -s "$CP_BASE/shops/5" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/shops/5');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/shops/5`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/shops/5",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "data": {
    "id": 5,
    "channel": "custom",
    "external_shop_id": "my-store-01",
    "name": "My Store",
    "webhook_url": null,
    "status": "disconnected",
    "connected_at": "2026-09-15T07:30:00+00:00"
  }
}

curl -s -X DELETE "$CP_BASE/shops/5" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/shops/5');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'DELETE',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/shops/5`, {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.delete(
    f"{os.environ['CP_BASE']}/shops/5",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

Listings

Links between a design and a store product/variant, used to resolve incoming orders.

{
  "data": [
    {
      "id": 88,
      "shop_id": 5,
      "design_id": 11,
      "product_id": 37,
      "variation_id": 101,
      "external_product_id": "9001",
      "external_variant_id": "9001-1",
      "external_sku": "TEE-L",
      "product_id_hub": 42,
      "status": "active",
      "created_at": "2026-09-20T09:30:00+00:00",
      "updated_at": "2026-09-20T09:30:00+00:00"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 1,
    "total_pages": 1
  }
}

curl -s "$CP_BASE/shops/5/listings" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/shops/5/listings');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/shops/5/listings`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/shops/5/listings",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "design_id": 11,
  "product_id": 37,
  "variation_id": 101,
  "external_product_id": "9001",
  "external_variant_id": "9001-1",
  "external_sku": "TEE-L"
}

{
  "data": {
    "id": 88,
    "shop_id": 5,
    "design_id": 11,
    "product_id": 37,
    "variation_id": 101,
    "external_product_id": "9001",
    "external_variant_id": "9001-1",
    "external_sku": "TEE-L",
    "product_id_hub": null,
    "status": "active",
    "created_at": "2026-09-29T10:15:00+00:00",
    "updated_at": "2026-09-29T10:15:00+00:00"
  }
}

curl -s -X POST "$CP_BASE/shops/5/listings" \
  -H "Authorization: Bearer $CP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"design_id":11,"product_id":37,"variation_id":101,"external_product_id":"9001","external_variant_id":"9001-1","external_sku":"TEE-L"}'

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/shops/5/listings');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'design_id' => 11,
    'product_id' => 37,
    'variation_id' => 101,
    'external_product_id' => '9001',
    'external_variant_id' => '9001-1',
    'external_sku' => 'TEE-L',
  ]),
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/shops/5/listings`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    design_id: 11,
    product_id: 37,
    variation_id: 101,
    external_product_id: '9001',
    external_variant_id: '9001-1',
    external_sku: 'TEE-L',
  }),
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.post(
    f"{os.environ['CP_BASE']}/shops/5/listings",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    json={
        "design_id": 11,
        "product_id": 37,
        "variation_id": 101,
        "external_product_id": "9001",
        "external_variant_id": "9001-1",
        "external_sku": "TEE-L",
    },
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

curl -s -o /dev/null -w "%{http_code}\n" -X DELETE "$CP_BASE/shops/5/listings?external_product_id=9001" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/shops/5/listings?external_product_id=9001');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'DELETE',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status !== 204) {
  $json = json_decode($raw, true);
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
echo "Deleted\n";

const res = await fetch(`${process.env.CP_BASE}/shops/5/listings?external_product_id=9001`, {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
if (res.status !== 204) {
  const json = await res.json();
  throw new Error(`${json.error.code}: ${json.error.message}`);
}
console.log('Deleted');

import os
import requests

res = requests.delete(
    f"{os.environ['CP_BASE']}/shops/5/listings",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    params={
        "external_product_id": "9001",
    },
    timeout=30,
)
if res.status_code != 204:
    err = res.json()["error"]
    raise RuntimeError(f"{err['code']}: {err['message']}")
print("Deleted")

{
  "listings": [
    {
      "design_id": 11,
      "product_id": 37,
      "variation_id": 101,
      "external_product_id": "9001",
      "external_variant_id": "9001-1"
    },
    {
      "design_id": 12,
      "product_id": 37,
      "variation_id": 102,
      "external_product_id": "9001",
      "external_variant_id": "9001-2"
    }
  ]
}

{
  "data": [
    {
      "id": 88,
      "shop_id": 5,
      "design_id": 11,
      "product_id": 37,
      "variation_id": 101,
      "external_product_id": "9001",
      "external_variant_id": "9001-1",
      "external_sku": null,
      "product_id_hub": null,
      "status": "active",
      "created_at": "2026-09-29T10:15:00+00:00",
      "updated_at": "2026-09-29T10:15:00+00:00"
    },
    {
      "id": 89,
      "shop_id": 5,
      "design_id": 12,
      "product_id": 37,
      "variation_id": 102,
      "external_product_id": "9001",
      "external_variant_id": "9001-2",
      "external_sku": null,
      "product_id_hub": null,
      "status": "active",
      "created_at": "2026-09-29T10:15:00+00:00",
      "updated_at": "2026-09-29T10:15:00+00:00"
    }
  ],
  "meta": {
    "created": 2,
    "failed": 0,
    "errors": []
  }
}

curl -s -X POST "$CP_BASE/shops/5/listings/bulk" \
  -H "Authorization: Bearer $CP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"listings":[{"design_id":11,"product_id":37,"variation_id":101,"external_product_id":"9001","external_variant_id":"9001-1"},{"design_id":12,"product_id":37,"variation_id":102,"external_product_id":"9001","external_variant_id":"9001-2"}]}'

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/shops/5/listings/bulk');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'listings' => [
      [
        'design_id' => 11,
        'product_id' => 37,
        'variation_id' => 101,
        'external_product_id' => '9001',
        'external_variant_id' => '9001-1',
      ],
      [
        'design_id' => 12,
        'product_id' => 37,
        'variation_id' => 102,
        'external_product_id' => '9001',
        'external_variant_id' => '9001-2',
      ],
    ],
  ]),
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/shops/5/listings/bulk`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    listings: [
      {
        design_id: 11,
        product_id: 37,
        variation_id: 101,
        external_product_id: '9001',
        external_variant_id: '9001-1',
      },
      {
        design_id: 12,
        product_id: 37,
        variation_id: 102,
        external_product_id: '9001',
        external_variant_id: '9001-2',
      },
    ],
  }),
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.post(
    f"{os.environ['CP_BASE']}/shops/5/listings/bulk",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    json={
        "listings": [
            {
                "design_id": 11,
                "product_id": 37,
                "variation_id": 101,
                "external_product_id": "9001",
                "external_variant_id": "9001-1",
            },
            {
                "design_id": 12,
                "product_id": 37,
                "variation_id": 102,
                "external_product_id": "9001",
                "external_variant_id": "9001-2",
            },
        ],
    },
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "design_id": 12
}

{
  "data": {
    "id": 89,
    "shop_id": 5,
    "design_id": 12,
    "product_id": 37,
    "variation_id": 102,
    "external_product_id": "9001",
    "external_variant_id": "9001-2",
    "external_sku": null,
    "product_id_hub": 42,
    "status": "active",
    "created_at": "2026-09-20T09:30:00+00:00",
    "updated_at": "2026-09-29T10:15:00+00:00"
  }
}

curl -s -X PATCH "$CP_BASE/shops/5/listings/89" \
  -H "Authorization: Bearer $CP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"design_id":12}'

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/shops/5/listings/89');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'design_id' => 12,
  ]),
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/shops/5/listings/89`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    design_id: 12,
  }),
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.patch(
    f"{os.environ['CP_BASE']}/shops/5/listings/89",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    json={
        "design_id": 12,
    },
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

curl -s -o /dev/null -w "%{http_code}\n" -X DELETE "$CP_BASE/shops/5/listings/89" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/shops/5/listings/89');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'DELETE',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status !== 204) {
  $json = json_decode($raw, true);
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
echo "Deleted\n";

const res = await fetch(`${process.env.CP_BASE}/shops/5/listings/89`, {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
if (res.status !== 204) {
  const json = await res.json();
  throw new Error(`${json.error.code}: ${json.error.message}`);
}
console.log('Deleted');

import os
import requests

res = requests.delete(
    f"{os.environ['CP_BASE']}/shops/5/listings/89",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
if res.status_code != 204:
    err = res.json()["error"]
    raise RuntimeError(f"{err['code']}: {err['message']}")
print("Deleted")

Publish jobs

Hub-driven publishing. Connectors poll pending items and close them out.

{
  "shop_id": 5,
  "design_ids": [
    11
  ],
  "price_mode": "blank",
  "mode": "create"
}

{
  "data": {
    "id": 3,
    "user_id": 214,
    "shop_id": 5,
    "status": "pending",
    "mode": "create",
    "price_mode": "blank",
    "flat_price": null,
    "created_at": "2026-09-29T10:15:00+00:00",
    "updated_at": "2026-09-29T10:15:00+00:00",
    "items": [
      {
        "id": 7,
        "job_id": 3,
        "design_id": 11,
        "product_id": 37,
        "variant_count": 12,
        "status": "pending",
        "mode": "create",
        "external_product_id": null,
        "product_id_hub": null,
        "error_text": null,
        "created_at": "2026-09-29T10:15:00+00:00",
        "updated_at": "2026-09-29T10:15:00+00:00",
        "completed_at": null
      }
    ]
  }
}

curl -s -X POST "$CP_BASE/publish-jobs" \
  -H "Authorization: Bearer $CP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"shop_id":5,"design_ids":[11],"price_mode":"blank","mode":"create"}'

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/publish-jobs');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'shop_id' => 5,
    'design_ids' => [11],
    'price_mode' => 'blank',
    'mode' => 'create',
  ]),
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/publish-jobs`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    shop_id: 5,
    design_ids: [11],
    price_mode: 'blank',
    mode: 'create',
  }),
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.post(
    f"{os.environ['CP_BASE']}/publish-jobs",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    json={
        "shop_id": 5,
        "design_ids": [11],
        "price_mode": "blank",
        "mode": "create",
    },
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "data": {
    "id": 3,
    "user_id": 214,
    "shop_id": 5,
    "status": "completed",
    "mode": "create",
    "price_mode": "blank",
    "flat_price": null,
    "created_at": "2026-09-29T10:15:00+00:00",
    "updated_at": "2026-09-29T10:18:40+00:00",
    "items": [
      {
        "id": 7,
        "job_id": 3,
        "design_id": 11,
        "product_id": 37,
        "variant_count": 12,
        "status": "completed",
        "mode": "create",
        "external_product_id": "9001",
        "product_id_hub": null,
        "error_text": null,
        "created_at": "2026-09-29T10:15:00+00:00",
        "updated_at": "2026-09-29T10:18:40+00:00",
        "completed_at": "2026-09-29T10:18:40+00:00"
      }
    ]
  }
}

curl -s "$CP_BASE/publish-jobs/3" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/publish-jobs/3');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/publish-jobs/3`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/publish-jobs/3",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "data": [
    {
      "id": 7,
      "job_id": 3,
      "design_id": 11,
      "product_id": 37,
      "variant_count": 12,
      "status": "pending",
      "mode": "create",
      "external_product_id": null,
      "product_id_hub": 42,
      "error_text": null,
      "created_at": "2026-09-29T10:15:00+00:00",
      "updated_at": "2026-09-29T10:15:00+00:00",
      "completed_at": null,
      "shop_id": 5,
      "price_mode": "blank",
      "flat_price": null
    }
  ]
}

curl -s "$CP_BASE/shops/5/publish-jobs/pending" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/shops/5/publish-jobs/pending');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/shops/5/publish-jobs/pending`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/shops/5/publish-jobs/pending",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "external_product_id": "9001"
}

{
  "data": {
    "id": 7,
    "job_id": 3,
    "design_id": 11,
    "product_id": 37,
    "variant_count": 12,
    "status": "completed",
    "mode": "create",
    "external_product_id": "9001",
    "product_id_hub": 42,
    "error_text": null,
    "created_at": "2026-09-29T10:15:00+00:00",
    "updated_at": "2026-09-29T10:18:40+00:00",
    "completed_at": "2026-09-29T10:18:40+00:00"
  }
}

curl -s -X POST "$CP_BASE/publish-jobs/items/7/complete" \
  -H "Authorization: Bearer $CP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"external_product_id":"9001"}'

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/publish-jobs/items/7/complete');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'external_product_id' => '9001',
  ]),
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/publish-jobs/items/7/complete`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    external_product_id: '9001',
  }),
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.post(
    f"{os.environ['CP_BASE']}/publish-jobs/items/7/complete",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    json={
        "external_product_id": "9001",
    },
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "error": "variant matrix rejected"
}

{
  "data": {
    "id": 7,
    "job_id": 3,
    "design_id": 11,
    "product_id": 37,
    "variant_count": 12,
    "status": "failed",
    "mode": "create",
    "external_product_id": null,
    "product_id_hub": null,
    "error_text": "variant matrix rejected",
    "created_at": "2026-09-29T10:15:00+00:00",
    "updated_at": "2026-09-29T10:17:02+00:00",
    "completed_at": null
  }
}

curl -s -X POST "$CP_BASE/publish-jobs/items/7/fail" \
  -H "Authorization: Bearer $CP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"error":"variant matrix rejected"}'

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/publish-jobs/items/7/fail');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'error' => 'variant matrix rejected',
  ]),
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/publish-jobs/items/7/fail`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    error: 'variant matrix rejected',
  }),
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.post(
    f"{os.environ['CP_BASE']}/publish-jobs/items/7/fail",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    json={
        "error": "variant matrix rejected",
    },
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

Orders

Order intake (idempotent, queued) and the resulting WooCommerce order with COD fields.

{
  "data": [
    {
      "id": 1,
      "shop_id": 5,
      "external_order_id": "1001",
      "status": "created",
      "wc_order_id": 50231,
      "attempts": 1,
      "last_error": null,
      "received_at": "2026-09-29T10:15:00+00:00",
      "processed_at": "2026-09-29T10:15:04+00:00"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 1,
    "total_pages": 1
  }
}

curl -s "$CP_BASE/orders?per_page=20" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/orders?per_page=20');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/orders?per_page=20`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/orders",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    params={
        "per_page": 20,
    },
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "shop_id": 5,
  "external_order_id": "1001",
  "currency": "PKR",
  "shipping_address": {
    "first_name": "Bilal",
    "last_name": "Ahmed",
    "phone": "03001234567",
    "email": "[email protected]",
    "address_1": "Flat 4B, Block 5, Clifton",
    "city": "Karachi",
    "state": "Sindh",
    "postcode": "75600",
    "country": "PK"
  },
  "line_items": [
    {
      "external_variant_id": "9001-1",
      "quantity": 1,
      "customer_price": "2500.00",
      "customer_price_currency": "PKR",
      "customer_variant": "L / Black"
    }
  ]
}

{
  "data": {
    "id": 1,
    "shop_id": 5,
    "external_order_id": "1001",
    "status": "received",
    "wc_order_id": null,
    "attempts": 0,
    "last_error": null,
    "received_at": "2026-09-29T10:15:00+00:00",
    "processed_at": null
  }
}

curl -s -X POST "$CP_BASE/orders" \
  -H "Authorization: Bearer $CP_KEY" \
  -H "Idempotency-Key: my-store-01:1001" \
  -H "Content-Type: application/json" \
  -d '{"shop_id":5,"external_order_id":"1001","currency":"PKR","shipping_address":{"first_name":"Bilal","last_name":"Ahmed","phone":"03001234567","email":"[email protected]","address_1":"Flat 4B, Block 5, Clifton","city":"Karachi","state":"Sindh","postcode":"75600","country":"PK"},"line_items":[{"external_variant_id":"9001-1","quantity":1,"customer_price":"2500.00","customer_price_currency":"PKR","customer_variant":"L / Black"}]}'

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/orders');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
    'Idempotency-Key: my-store-01:1001',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'shop_id' => 5,
    'external_order_id' => '1001',
    'currency' => 'PKR',
    'shipping_address' => [
      'first_name' => 'Bilal',
      'last_name' => 'Ahmed',
      'phone' => '03001234567',
      'email' => '[email protected]',
      'address_1' => 'Flat 4B, Block 5, Clifton',
      'city' => 'Karachi',
      'state' => 'Sindh',
      'postcode' => '75600',
      'country' => 'PK',
    ],
    'line_items' => [
      [
        'external_variant_id' => '9001-1',
        'quantity' => 1,
        'customer_price' => '2500.00',
        'customer_price_currency' => 'PKR',
        'customer_variant' => 'L / Black',
      ],
    ],
  ]),
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/orders`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
    'Idempotency-Key': 'my-store-01:1001',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    shop_id: 5,
    external_order_id: '1001',
    currency: 'PKR',
    shipping_address: {
      first_name: 'Bilal',
      last_name: 'Ahmed',
      phone: '03001234567',
      email: '[email protected]',
      address_1: 'Flat 4B, Block 5, Clifton',
      city: 'Karachi',
      state: 'Sindh',
      postcode: '75600',
      country: 'PK',
    },
    line_items: [
      {
        external_variant_id: '9001-1',
        quantity: 1,
        customer_price: '2500.00',
        customer_price_currency: 'PKR',
        customer_variant: 'L / Black',
      },
    ],
  }),
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.post(
    f"{os.environ['CP_BASE']}/orders",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}", "Idempotency-Key": "my-store-01:1001"},
    json={
        "shop_id": 5,
        "external_order_id": "1001",
        "currency": "PKR",
        "shipping_address": {
            "first_name": "Bilal",
            "last_name": "Ahmed",
            "phone": "03001234567",
            "email": "[email protected]",
            "address_1": "Flat 4B, Block 5, Clifton",
            "city": "Karachi",
            "state": "Sindh",
            "postcode": "75600",
            "country": "PK",
        },
        "line_items": [
            {
                "external_variant_id": "9001-1",
                "quantity": 1,
                "customer_price": "2500.00",
                "customer_price_currency": "PKR",
                "customer_variant": "L / Black",
            },
        ],
    },
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "data": {
    "id": 1,
    "shop_id": 5,
    "external_order_id": "1001",
    "status": "created",
    "wc_order_id": 50231,
    "attempts": 1,
    "last_error": null,
    "received_at": "2026-09-29T10:15:00+00:00",
    "processed_at": "2026-09-29T10:15:04+00:00",
    "order": {
      "wc_order_id": 50231,
      "status": "completed",
      "total": "1400.00",
      "currency": "PKR",
      "cod_from_customer": true,
      "additional_cod_from_customer": 200,
      "customer_price_total": 2500,
      "cod_collection_total": 2700,
      "tracking": {
        "number": "KHI1234567",
        "company": "M&P Courier",
        "url": "https://mulphilog.com/tracking/KHI1234567"
      },
      "items": [
        {
          "name": "Karachi Skyline Tee - L",
          "quantity": 1,
          "line_total": 1200,
          "customer_price": "2500.00",
          "customer_variant": "L / Black",
          "design_id": 11
        }
      ]
    }
  }
}

curl -s "$CP_BASE/orders/1" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/orders/1');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/orders/1`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/orders/1",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "data": [
    {
      "event": "received",
      "at": "2026-09-29T10:15:00+00:00"
    },
    {
      "event": "processing",
      "attempts": 1
    },
    {
      "event": "created",
      "wc_order_id": 50231,
      "at": "2026-09-29T10:15:04+00:00"
    }
  ]
}

curl -s "$CP_BASE/orders/1/events" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/orders/1/events');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/orders/1/events`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/orders/1/events",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

Payouts

Read-only COD payout ledger (money CeePrinto owes the brand).

{
  "data": [
    {
      "wc_order_id": 50231,
      "number": "50231",
      "date_created": "2026-09-29T10:15:04+00:00",
      "order_status": "completed",
      "currency": "PKR",
      "amount": 2700,
      "payout_status": "in_hold",
      "payout_status_label": "7-day hold",
      "release_at": "2026-10-08T08:02:11+00:00",
      "days_until_ready": 7,
      "processed_at": null,
      "tracking": {
        "number": "KHI1234567",
        "company": "M&P Courier",
        "url": "https://mulphilog.com/tracking/KHI1234567"
      },
      "needs_payment": false,
      "payment_url": null,
      "items": [
        {
          "name": "Karachi Skyline Tee - L",
          "quantity": 1,
          "customer_price": "2500.00"
        }
      ]
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 1,
    "total_pages": 1
  }
}

curl -s "$CP_BASE/payouts?status=pending&per_page=50" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/payouts?status=pending&per_page=50');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/payouts?status=pending&per_page=50`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/payouts",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    params={
        "status": "pending",
        "per_page": 50,
    },
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "data": {
    "total": 184500,
    "processed": 120000,
    "pending": 64500,
    "ready": 22000,
    "in_hold": 30500,
    "awaiting_delivery": 12000,
    "missing_bank": 0,
    "count_total": 41,
    "count_processed": 27,
    "count_pending": 14,
    "count_ready": 5,
    "count_in_hold": 6,
    "count_awaiting_delivery": 3,
    "count_missing_bank": 0,
    "currency": "PKR"
  },
  "meta": {
    "cached": false
  }
}

curl -s "$CP_BASE/payouts/summary" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/payouts/summary');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/payouts/summary`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/payouts/summary",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

Shipping

Shipping rate quotes (PKR).

{
  "city": "Karachi"
}

{
  "data": {
    "city": "Karachi",
    "total": 200,
    "currency": "PKR",
    "method_id": "flat_rate",
    "method_title": "Flat Rate"
  }
}

curl -s -X POST "$CP_BASE/shipping/quote" \
  -H "Authorization: Bearer $CP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"city":"Karachi"}'

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/shipping/quote');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'city' => 'Karachi',
  ]),
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/shipping/quote`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    city: 'Karachi',
  }),
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.post(
    f"{os.environ['CP_BASE']}/shipping/quote",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    json={
        "city": "Karachi",
    },
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

Webhooks

Signed outbound event subscriptions.

{
  "data": [
    {
      "id": 9,
      "topic": "order.status_changed",
      "target_url": "https://my-store-01.pk/webhooks/ceeprinto",
      "secret": "whsec_Xk2p9QvT4mLr7sWn1bYc8dHf3gJa6eZu",
      "status": "active",
      "created_at": "2026-09-15T07:31:00+00:00"
    }
  ]
}

curl -s "$CP_BASE/webhooks" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/webhooks');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/webhooks`, {
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.get(
    f"{os.environ['CP_BASE']}/webhooks",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

{
  "topic": "order.status_changed",
  "target_url": "https://my-store-01.pk/webhooks/ceeprinto"
}

{
  "data": {
    "id": 9,
    "topic": "order.status_changed",
    "target_url": "https://my-store-01.pk/webhooks/ceeprinto",
    "secret": "whsec_Xk2p9QvT4mLr7sWn1bYc8dHf3gJa6eZu",
    "status": "active",
    "created_at": "2026-09-29T10:15:00+00:00"
  }
}

curl -s -X POST "$CP_BASE/webhooks" \
  -H "Authorization: Bearer $CP_KEY" \
  -H "Content-Type: application/json" \
  -d '{"topic":"order.status_changed","target_url":"https://my-store-01.pk/webhooks/ceeprinto"}'

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/webhooks');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'topic' => 'order.status_changed',
    'target_url' => 'https://my-store-01.pk/webhooks/ceeprinto',
  ]),
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$json = json_decode($raw, true);
if ($status >= 400) {
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
print_r($json['data']);

const res = await fetch(`${process.env.CP_BASE}/webhooks`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    topic: 'order.status_changed',
    target_url: 'https://my-store-01.pk/webhooks/ceeprinto',
  }),
});
const json = await res.json();
if (!res.ok) throw new Error(`${json.error.code}: ${json.error.message}`);
console.log(json.data);

import os
import requests

res = requests.post(
    f"{os.environ['CP_BASE']}/webhooks",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    json={
        "topic": "order.status_changed",
        "target_url": "https://my-store-01.pk/webhooks/ceeprinto",
    },
    timeout=30,
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"])

curl -s -o /dev/null -w "%{http_code}\n" -X DELETE "$CP_BASE/webhooks/9" \
  -H "Authorization: Bearer $CP_KEY"

<?php
$base = getenv('CP_BASE');
$key  = getenv('CP_KEY');

$ch = curl_init($base . '/webhooks/9');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'DELETE',
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . $key,
    'Accept: application/json',
  ],
]);

$raw    = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status !== 204) {
  $json = json_decode($raw, true);
  throw new RuntimeException($json['error']['code'] . ': ' . $json['error']['message']);
}
echo "Deleted\n";

const res = await fetch(`${process.env.CP_BASE}/webhooks/9`, {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.CP_KEY}`,
  },
});
if (res.status !== 204) {
  const json = await res.json();
  throw new Error(`${json.error.code}: ${json.error.message}`);
}
console.log('Deleted');

import os
import requests

res = requests.delete(
    f"{os.environ['CP_BASE']}/webhooks/9",
    headers={"Authorization": f"Bearer {os.environ['CP_KEY']}"},
    timeout=30,
)
if res.status_code != 204:
    err = res.json()["error"]
    raise RuntimeError(f"{err['code']}: {err['message']}")
print("Deleted")

Each webhook topic below lists when it fires, every payload field, a full example body and a real signed delivery you can test your verifier against.

Envelope and headers (all topics)

All signatures on this page were computed with the example secret whsec_Xk2p9QvT4mLr7sWn1bYc8dHf3gJa6eZu over the exact raw body shown. Feed a raw body and its header to your verifier (with the timestamp tolerance disabled) and it must accept it; change one byte and it must reject it.

order.status_changed

A WooCommerce order placed through the API changes status (for example pending → processing). Sent to the merchant who owns the order. When the same change also fires order.shipped, a second, reduced order.status_changed is sent carrying only wc_order_id and status.

{
    "topic": "order.status_changed",
    "data": {
        "wc_order_id": 50231,
        "status": "processing",
        "previous_status": "pending",
        "external_order_id": "1001"
    },
    "sent_at": "2026-09-29T10:15:00+00:00"
}

POST /webhooks/ceeprinto HTTP/1.1
Content-Type: application/json
X-CP-Topic: order.status_changed
X-CP-Signature: t=1790676900,v1=d5dd3d9012f146631ada820fcc0c3b433f7d726bdf037cba4c64ae2cda33fca8

{"topic":"order.status_changed","data":{"wc_order_id":50231,"status":"processing","previous_status":"pending","external_order_id":"1001"},"sent_at":"2026-09-29T10:15:00+00:00"}

The reduced event sent alongside order.shipped:

POST /webhooks/ceeprinto HTTP/1.1
Content-Type: application/json
X-CP-Topic: order.status_changed
X-CP-Signature: t=1790841731,v1=8c31ab481cce00bfbbf0b35f56335296cbee66697e0b8cf4d438200fc7a97d4d

{"topic":"order.status_changed","data":{"wc_order_id":50231,"status":"completed"},"sent_at":"2026-10-01T08:02:11+00:00"}

order.shipped

An API order transitions to completed and has a live (non-cancelled) courier booking. Carries the tracking details, which are also on GET /orders/{id} → order.tracking.

{
    "topic": "order.shipped",
    "data": {
        "wc_order_id": 50231,
        "status": "completed",
        "previous_status": "processing",
        "external_order_id": "1001",
        "tracking_number": "KHI1234567",
        "tracking_company": "M&P Courier",
        "tracking_url": "https://mulphilog.com/tracking/KHI1234567"
    },
    "sent_at": "2026-10-01T08:02:11+00:00"
}

POST /webhooks/ceeprinto HTTP/1.1
Content-Type: application/json
X-CP-Topic: order.shipped
X-CP-Signature: t=1790841731,v1=cee1b4edfd917ad0906dee86730f60489237461410d49cfd4db21356843ef201

{"topic":"order.shipped","data":{"wc_order_id":50231,"status":"completed","previous_status":"processing","external_order_id":"1001","tracking_number":"KHI1234567","tracking_company":"M&P Courier","tracking_url":"https:\/\/mulphilog.com\/tracking\/KHI1234567"},"sent_at":"2026-10-01T08:02:11+00:00"}

design.updated

A saved design owned by the subscriber changes.

{
    "topic": "design.updated",
    "data": {
        "design_id": 11,
        "status": "saved"
    },
    "sent_at": "2026-09-29T10:15:00+00:00"
}

POST /webhooks/ceeprinto HTTP/1.1
Content-Type: application/json
X-CP-Topic: design.updated
X-CP-Signature: t=1790676900,v1=7b4759b08da6b57e7de5dfe5726b8a7e58a122618511d85a0ff47798b6251541

{"topic":"design.updated","data":{"design_id":11,"status":"saved"},"sent_at":"2026-09-29T10:15:00+00:00"}

design.publish_requested

A publish job is created (API, Products tab or Get Started tab). IDs only: fetch design, blank and hub product detail yourself, then POST /shops/{id}/listings/bulk. Jobs from the Get Started tab omit mode, product_id_hub, variants and per-item mode / external_product_id: treat them as create. Best-effort: poll pending items as well.

{
    "topic": "design.publish_requested",
    "data": {
        "job_id": 3,
        "shop_id": 5,
        "mode": "create",
        "product_id_hub": 42,
        "items": [
            {
                "item_id": 7,
                "design_id": 11,
                "product_id": 37,
                "variant_count": 12,
                "mode": "create",
                "external_product_id": null
            }
        ],
        "variants": [
            {
                "variation_id": 101,
                "design_id": 11,
                "price": null,
                "sku": null,
                "enabled": true
            },
            {
                "variation_id": 102,
                "design_id": 12,
                "price": 2800,
                "sku": "TEE-BLK-L",
                "enabled": true
            }
        ],
        "price_mode": "blank",
        "flat_price": null
    },
    "sent_at": "2026-09-29T10:15:00+00:00"
}

POST /webhooks/ceeprinto HTTP/1.1
Content-Type: application/json
X-CP-Topic: design.publish_requested
X-CP-Signature: t=1790676900,v1=ecac396f02a7139327ea77d1c162cabd11a69ae6416ae0492a40f299f71b1d9e

{"topic":"design.publish_requested","data":{"job_id":3,"shop_id":5,"mode":"create","product_id_hub":42,"items":[{"item_id":7,"design_id":11,"product_id":37,"variant_count":12,"mode":"create","external_product_id":null}],"variants":[{"variation_id":101,"design_id":11,"price":null,"sku":null,"enabled":true},{"variation_id":102,"design_id":12,"price":2800,"sku":"TEE-BLK-L","enabled":true}],"price_mode":"blank","flat_price":null},"sent_at":"2026-09-29T10:15:00+00:00"}

product.stock_changed

A blank product or variation changes stock status or quantity (quantity-only changes included). Sent only to merchants who have a listing referencing that product_id / variation_id.

{
    "topic": "product.stock_changed",
    "data": {
        "product_id": 37,
        "variation_id": 101,
        "stock_status": "outofstock",
        "stock_quantity": 0,
        "in_stock": false
    },
    "sent_at": "2026-09-29T10:15:00+00:00"
}

POST /webhooks/ceeprinto HTTP/1.1
Content-Type: application/json
X-CP-Topic: product.stock_changed
X-CP-Signature: t=1790676900,v1=3def3e51f29dd957977a630b4434fa06f557c406bebd180e580edec58eeae3e8

{"topic":"product.stock_changed","data":{"product_id":37,"variation_id":101,"stock_status":"outofstock","stock_quantity":0,"in_stock":false},"sent_at":"2026-09-29T10:15:00+00:00"}

product.updated

A hub product's default design or a variant override changes after it was published (PATCH /products/{id}, PATCH /products/{id}/variants/{variation_id} or the Products tab). The hub has already updated its listings; update your store images for each variant.

{
    "topic": "product.updated",
    "data": {
        "product_id_hub": 42,
        "shop_ids": [
            5
        ],
        "variants": [
            {
                "variation_id": 101,
                "design_id": 11
            },
            {
                "variation_id": 102,
                "design_id": 12
            }
        ]
    },
    "sent_at": "2026-09-29T10:15:00+00:00"
}

POST /webhooks/ceeprinto HTTP/1.1
Content-Type: application/json
X-CP-Topic: product.updated
X-CP-Signature: t=1790676900,v1=3109a19bca2da19790b920802b474111c7a423be628337ae57a6b1c67a9cc5cd

{"topic":"product.updated","data":{"product_id_hub":42,"shop_ids":[5],"variants":[{"variation_id":101,"design_id":11},{"variation_id":102,"design_id":12}]},"sent_at":"2026-09-29T10:15:00+00:00"}

Retry schedule

Match the status and error.code you got to the table below to find the likely cause and the fix, and include the X-CP-Request-Id when you need help.

Every error code

Connection-code keys and 403

Keys named "Shopify App" or "WooCommerce Connect" come from cp1. connection codes and deliberately omit orders:read.

Fix: create a key on My Account → Store Connections → API Keys with orders:read ticked, and use it for those reads.

Order intake failed

POST /orders answered 202 but GET /orders/{id} shows status: "failed". No WooCommerce order was created. last_error (and the failed event's reason) says why:

Common problems

Handling 429

async function withRateLimit(doRequest) {
  for (let attempt = 1; attempt <= 5; attempt++) {
    const res = await doRequest();
    if (res.status !== 429) return res;
    const wait = Number(res.headers.get('retry-after')) || 2 ** attempt;
    await new Promise((r) => setTimeout(r, wait * 1000));
  }
  throw new Error('Still rate limited after 5 attempts');
}

Spread bulk work: at 120 requests per minute, sync with per_page=100 and use POST /shops/{id}/listings/bulk instead of one call per listing.

What to include in a support ticket

Every change to the ceeprinto/v2 API that affects integrators, newest first, so you can tell at a glance whether your client needs an update.

2.2.0 (2026-09-29)

Deprecations

A Sunset header will be added to legacy responses once a date is chosen, and the date will be listed here first.

The CeePrinto design editor lets you put your own images and text on a product, preview every print side, and add the finished design to your cart or save it for later.

Who uses the editor

• Buyers customise a single product (a T-shirt, a hoodie, a mug) and order it.
• Merchants create designs, save them to their account, and publish them to their own online store so CeePrinto can print and ship each order.

Where the editor opens

On any product that can be customised, the product page shows a "Customize" button next to the normal cart button. Clicking it opens the editor on its own page at /product/{product-name}/design/. If the product comes in options (for example sizes or colours), pick an option first; the button stays greyed out until you do.

Some pages open the editor in a pop-up window instead. That window is titled "Customize Your Design" and has a "Close" button and a "Save & Add to Cart" button at the bottom.

The screen at a glance

On a phone, the sidebar and the Print Sides panel slide in from the edges. Use the menu button at the top left ("Open design tools") and the grid button at the top right ("Open print sides"). The "Add to Cart" button sits in a bar at the bottom of the screen.

Design guidelines and pricing

Under the cart button on every product page you will find a short note asking you to make sure your design follows the CeePrinto guideline. Read the design guidelines before you order; CeePrinto is not responsible for designs that do not follow them. The same note links to the product's "Pricing Chart" tab.

You pay for each side you actually print on. A side you leave empty costs nothing extra. See Print sides and design areas.

What happens after "Add to Cart"

1. The editor checks that nothing sticks out of the dashed print area and warns you if it does.
2. It creates a preview and a high-resolution print file (300 DPI) for every side you used, and uploads them.
3. It saves your design to the store and adds the product to your cart.
4. The cart shows the item with a "Custom design" line and, when sides carry a price, a "Customization fee" line.

Follow these ten steps to go from a product page to a custom product in your cart in a few minutes.

1. Open the product and choose an option

   Go to the product you want to customise. If it has options such as size or colour, choose one first. The "Customize" button stays greyed out until an option is selected.

2. Click "Customize"

   The editor opens on its own page (/product/{product-name}/design/). Wait for "Setting up your designer…" to finish. The top bar shows the product name, then "Design Tools", then the side you are on, for example "Front".

3. Pick the side you want to print on

   In the "Print Sides" panel on the right, click a side card. Each card shows the print size in inches and any extra price for that side. On a phone, tap the grid button at the top right ("Open print sides").

4. Upload an image

   In the left sidebar open the "Images" tab and drag a file onto "Drop images here or browse", or click the box to choose a file. The image appears on the canvas once the upload finishes. Pictures you uploaded before are listed underneath; click one to add it again.

5. Check the print quality badge

   Click the image. The toolbar in the top bar shows a quality badge: "Good" is ready to print, "OK" may print slightly soft, "Low" will print blurry. Make the image smaller or upload a bigger file if you see "Low".

6. Add text

   Open the "Text" tab and click "Add Text Layer". In the "Add New Text" window type your words under "Text content", choose a size, colour and font, then click "Add Text".

7. Move, resize and arrange

   Drag a layer to move it and drag its corner handles to resize or rotate it. Keep everything inside the dashed box: the hint under the canvas reads "Place images and text inside the dashed design area." Use the "Product" tab to see your layers and change their order.

8. Repeat for other sides (optional)

   Click another card in "Print Sides" and add content there too. Every side you use adds its own price, shown at the bottom of the "Print Sides" panel.

9. Click "Add to Cart"

   Click "Add to Cart" in the top bar (on a phone, in the bar at the bottom). If part of a layer is outside the print area you will see "Some layers will be cropped" or "Some layers won't print". Choose "Fix automatically" to pull the layers back inside, or "Continue anyway".

10. Wait for the progress window

    A window titled "Adding your design to cart" lists each step, starting with "Preparing your design" and ending with "Adding to cart". When it shows "Redirecting to cart…" you are taken to your cart, where the item shows a "Custom design" line.

Choose which sides of the product to print on, keep your design inside each side's dashed print area, and see exactly what each side adds to the price.

Switch between sides

1. Open "Print Sides"

   The "Print Sides" panel is on the right. On a phone, tap the grid button at the top right ("Open print sides"). Products with only one side do not show side cards.

2. Click a side card

   The canvas switches to that side and its name appears at the end of the top bar breadcrumb. The first side is usually "Front".

3. Design that side

   Images and text you add go onto the side you are viewing. Each side keeps its own layers.

What a side card shows

Design areas and the dashed box

Every side has at least one printable area, drawn on the canvas as a dashed box. Only what sits inside the dashed box is printed; anything outside is cut off. The hint under the canvas reads "Place images and text inside the dashed design area." and, next to it, "Print" with the side's print size and, when set, "Placement" notes from CeePrinto (for example how far below the collar the print sits).

Some sides have more than one printable area. In that case a "Design Area" drop-down appears at the bottom of the left sidebar. Choose an area before you add an image or text; new layers are placed in the chosen area.

When something sticks out

If a layer crosses the dashed edge, the hint under the canvas turns amber and says how many layers are outside the print area, with a "Fit to area" button. The layer list marks those layers "Partly cropped" or "Won't print".

When you click "Add to Cart", "Save Design", "Update design", "Download PNG (current side)" or "Export PDF (current side)", the editor checks every side and shows a window if anything is outside:

How sides affect the price

You pay the product price plus the price of each side you actually use. A side with no layers adds nothing. The bottom of the "Print Sides" panel lists the sides you have used with their prices, and the note "Price applies when you add design to a side." In the cart the extra appears as a "Customization fee" line.

Print specifications

Tips

• Leave a small margin inside the dashed box; edges of a print can shift slightly.
• Use "Fit to area" before adding to cart so you do not get the warning window.
• Check every side before ordering. A stray layer on the back adds that side's price.

Add text to the current side, style it with any of 13 fonts, and change it later from the toolbar without starting over.

Add text

1. Open the "Text" tab

   In the left "Design Tools" sidebar, click "Text", then "Add Text Layer".

2. Type and style your text

   The "Add New Text" window shows a live preview at the top. Type under "Text content" (the box says "Enter your text"), then set the size, colour, spacing, alignment, style and font.

3. Click "Add Text"

   The text is placed inside the dashed area of the current side. Click "Cancel" to close the window without adding anything.

"Add New Text" fields

Available fonts

Edit existing text

Click a text layer on the canvas (or in the "Product" tab's layer list). The text toolbar appears in the top bar (on a phone, just below it). Changes apply immediately.

Tips

• Keep text a little away from the dashed edge so nothing gets trimmed.
• Very thin fonts at small sizes may not print cleanly. Use "Bold" or a larger size for small lettering.
• Keyboard shortcuts (such as Delete) are paused while you type in a text box, so you will not delete a layer by accident.

Upload your artwork, check that it is sharp enough to print, then crop, clean up the background, shape and fit it without leaving the editor.

Upload an image

1. Open the "Images" tab

   In the left sidebar, click "Images".

2. Drop or choose files

   Drag one or more files onto "Drop images here or browse", or click the box (or press Enter when it is focused) to pick files. While you drag, the box says "Drop to upload".

3. Watch the progress list

   Each file gets its own row with a progress bar showing how much has been sent. When a row shows "Uploaded", the image is placed in the middle of the dashed area on the current side.

Large files and poor connections

Big files are sent in small pieces. If your connection drops, the row shows "Waiting for connection…" and carries on by itself when you are back online. Short hiccups show "Retrying" with the attempt number. If a file still fails, its row turns red with the reason and a "Retry" button. Retrying continues from the last piece that arrived, so nothing is sent twice. Click the X on a row to cancel an upload or to clear a finished one.

Reuse earlier uploads

Below the upload box the editor lists the images you uploaded before. Type in "Search your uploads…" to find one by name and click a thumbnail to add it to the current side. If you have not uploaded anything yet it says "Nothing uploaded yet."

Print quality badge

When you select an image, the image toolbar starts with a coloured badge that tells you how sharp it will print at its current size on this side. Hover over the badge to see the exact DPI (dots per inch). Making an image bigger lowers its DPI; making it smaller raises it.