{"openapi":"3.1.0","info":{"title":"CommerceForAI API","version":"v1","description":"Products, inventory, Stripe checkout, orders, shipping, returns and print-on-demand on the merchant's own Stripe account. All money is an integer in minor units (cents). Send `Idempotency-Key` on POSTs. Lists use `limit` and `starting_after`. Agent guide: https://commerceforai.com/llms.txt. No sign-up needed to start: POST https://api.commerceforai.com/sandbox/stores returns a test store and API key."},"servers":[{"url":"https://api.commerceforai.com"}],"security":[{"apiKey":[]}],"externalDocs":{"description":"Docs (each page is also available as markdown by adding .md)","url":"https://commerceforai.com/docs"},"paths":{"/sandbox/stores":{"post":{"tags":["Start"],"summary":"Create a free test store and API key. No sign-up or auth.","operationId":"create_sandbox_store","security":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}}}}},"responses":{"201":{"description":"store_id, api_key and a claim_url for the owner","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/store":{"get":{"tags":["Store"],"summary":"Store settings, connected providers and feed URLs","operationId":"get_store","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"tags":["Store"],"summary":"Update store settings (name, tax, emails, branding, alerts, defaults)","operationId":"patch_store","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/storeUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/setup_status":{"get":{"tags":["Store"],"summary":"Everything between this store and real orders, each with the exact fix. Call this first.","operationId":"get_setup_status","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/storefront/check":{"post":{"tags":["Store"],"summary":"After deploying: check the live site from the outside, each problem with its fix","operationId":"post_storefront_check","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/storefrontCheck"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/store/usage":{"get":{"tags":["Store"],"summary":"This month's paid orders, free orders left and fees","operationId":"get_store_usage","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/go_live_links":{"post":{"tags":["Store"],"summary":"Create a link the owner opens to take a test store live","operationId":"post_go_live_links","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/store/sync":{"get":{"tags":["Store"],"summary":"Preview syncing the store's other version (test or live) into this one","operationId":"get_store_sync","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Store"],"summary":"Apply a sync into this store; live stores need plan_id from the preview","operationId":"post_store_sync","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/store/checkout-shipping":{"put":{"tags":["Store"],"summary":"Shipping rates and countries every checkout uses","operationId":"put_store_checkout_shipping","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/checkoutShippingConfig"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["Store"],"summary":"Remove store-wide checkout shipping","operationId":"delete_store_checkout_shipping","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/store/shipping":{"put":{"tags":["Store"],"summary":"Connect EasyPost or Shippo for labels","operationId":"put_store_shipping","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/shippingConfig"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/store/fulfillment":{"put":{"tags":["Store"],"summary":"Connect Printful or Printify","operationId":"put_store_fulfillment","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fulfillmentConfig"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["Store"],"summary":"Disconnect a print-on-demand provider","operationId":"delete_store_fulfillment","parameters":[{"name":"provider","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/store/emails":{"put":{"tags":["Store"],"summary":"Send customer emails from your own domain (Resend)","operationId":"put_store_emails","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/emailConfig"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["Store"],"summary":"Disconnect your email provider","operationId":"delete_store_emails","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/store/storefront":{"put":{"tags":["Store"],"summary":"Product URL template and policies; publishes AI shopping feeds","operationId":"put_store_storefront","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/storefrontConfig"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Store"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/products":{"post":{"tags":["Products"],"summary":"Create a product (price for one variant, or variants)","operationId":"post_products","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/productCreate"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"tags":["Products"],"summary":"List products","operationId":"get_products","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"string"}},{"name":"starting_after","in":"query","required":false,"schema":{"type":"string"}},{"name":"active","in":"query","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","required":false,"schema":{"type":"string"}},{"name":"collection","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductList"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/products/bulk":{"post":{"tags":["Products"],"summary":"Create up to 100 products; each succeeds or fails on its own","operationId":"post_products_bulk","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/products/{id}":{"get":{"tags":["Products"],"summary":"Get a product","operationId":"get_products_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"tags":["Products"],"summary":"Update a product","operationId":"patch_products_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/productUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["Products"],"summary":"Archive a product","operationId":"delete_products_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/products/{id}/variants":{"post":{"tags":["Products"],"summary":"Add a variant","operationId":"post_products_id_variants","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/variantInput"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variant"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/variants/{id}":{"patch":{"tags":["Products"],"summary":"Update a variant","operationId":"patch_variants_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/variantUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variant"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/inventory":{"get":{"tags":["Products"],"summary":"Stock for every variant","operationId":"get_inventory","parameters":[{"name":"low_stock_threshold","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/variants/{id}/inventory":{"post":{"tags":["Products"],"summary":"Adjust or set stock","operationId":"post_variants_id_inventory","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/inventoryAdjust"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variant"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/collections":{"get":{"tags":["Products"],"summary":"List collections","operationId":"get_collections","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionList"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Products"],"summary":"Create a collection","operationId":"post_collections","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/collections/{id}":{"get":{"tags":["Products"],"summary":"Get a collection by id or handle","operationId":"get_collections_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"tags":["Products"],"summary":"Update a collection; product_ids replaces membership","operationId":"patch_collections_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collection"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["Products"],"summary":"Delete a collection (products are kept)","operationId":"delete_collections_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/collections/{id}/products":{"post":{"tags":["Products"],"summary":"Add products to a collection","operationId":"post_collections_id_products","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/collections/{id}/products/{productId}":{"delete":{"tags":["Products"],"summary":"Remove a product from a collection","operationId":"delete_collections_id_products_productId","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/checkouts":{"post":{"tags":["Checkout and orders"],"summary":"Create a Stripe-hosted checkout; stock is held until it expires","operationId":"post_checkouts","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/checkoutCreate"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Checkout"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/checkouts/{id}":{"get":{"tags":["Checkout and orders"],"summary":"Checkout status and resulting order","operationId":"get_checkouts_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Checkout"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/simulate/order":{"post":{"tags":["Checkout and orders"],"summary":"Test stores: run a purchase end to end without a browser","operationId":"post_simulate_order","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/subscriptions":{"get":{"tags":["Checkout and orders"],"summary":"Subscriptions (variants sold with recurring); each renewal is a new order","operationId":"get_subscriptions","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionList"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/subscriptions/{id}":{"get":{"tags":["Checkout and orders"],"summary":"A subscription and its orders","operationId":"get_subscriptions_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/subscriptions/{id}/cancel":{"post":{"tags":["Checkout and orders"],"summary":"Cancel at the end of the paid period (default) or now","operationId":"post_subscriptions_id_cancel","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionCancel"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/subscriptions/{id}/resume":{"post":{"tags":["Checkout and orders"],"summary":"Undo a cancellation that hasn't taken effect yet","operationId":"post_subscriptions_id_resume","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/subscriptions/{id}/simulate_renewal":{"post":{"tags":["Checkout and orders"],"summary":"Test stores: run the next renewal now","operationId":"post_subscriptions_id_simulate_renewal","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/gift_cards":{"post":{"tags":["Checkout and orders"],"summary":"Issue a gift card (optionally emailing the code)","operationId":"post_gift_cards","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/giftCardCreate"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCard"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"tags":["Checkout and orders"],"summary":"List gift cards","operationId":"get_gift_cards","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCardList"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/gift_cards/{id}":{"get":{"tags":["Checkout and orders"],"summary":"A gift card by id, code or last 4, with the orders that used it","operationId":"get_gift_cards_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCard"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"tags":["Checkout and orders"],"summary":"Disable a card, set its balance, note or expiry","operationId":"patch_gift_cards_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/giftCardUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCard"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/gift_cards/{id}/send":{"post":{"tags":["Checkout and orders"],"summary":"Email the code to the recipient","operationId":"post_gift_cards_id_send","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/giftCardSend"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftCard"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/draft_orders":{"post":{"tags":["Checkout and orders"],"summary":"Build an order for a customer (custom prices allowed); it becomes an order when they pay the invoice","operationId":"post_draft_orders","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/draftCreate"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftOrder"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"tags":["Checkout and orders"],"summary":"List draft orders","operationId":"get_draft_orders","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftOrderList"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/draft_orders/{id}":{"get":{"tags":["Checkout and orders"],"summary":"Get a draft order by id or number","operationId":"get_draft_orders_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftOrder"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"tags":["Checkout and orders"],"summary":"Change a draft order before it's paid","operationId":"patch_draft_orders_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/draftUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftOrder"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/draft_orders/{id}/send_invoice":{"post":{"tags":["Checkout and orders"],"summary":"Email the customer the invoice with a link to pay","operationId":"post_draft_orders_id_send_invoice","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoiceSend"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftOrder"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/draft_orders/{id}/cancel":{"post":{"tags":["Checkout and orders"],"summary":"Cancel a draft order; its invoice link stops working","operationId":"post_draft_orders_id_cancel","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftOrder"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/orders":{"get":{"tags":["Checkout and orders"],"summary":"List orders","operationId":"get_orders","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"string"}},{"name":"starting_after","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderList"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/orders/{id}":{"get":{"tags":["Checkout and orders"],"summary":"Get an order by id or number","operationId":"get_orders_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"tags":["Checkout and orders"],"summary":"Update an order's note or metadata","operationId":"patch_orders_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/orders/{id}/fulfill":{"post":{"tags":["Checkout and orders"],"summary":"Mark shipped with tracking","operationId":"post_orders_id_fulfill","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fulfillInput"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/orders/{id}/edit":{"post":{"tags":["Checkout and orders"],"summary":"Change a paid order before it ships: swap, remove or add items, fix the address; refunds the difference","operationId":"post_orders_id_edit","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/orderEdit"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderEdit"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/orders/{id}/refund":{"post":{"tags":["Checkout and orders"],"summary":"Refund through Stripe, optionally restocking","operationId":"post_orders_id_refund","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/refundInput"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/orders/{id}/submit-fulfillment":{"post":{"tags":["Checkout and orders"],"summary":"Send to print-on-demand now","operationId":"post_orders_id_submit_fulfillment","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/discounts":{"get":{"tags":["Checkout and orders"],"summary":"List discount codes","operationId":"get_discounts","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscountList"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Checkout and orders"],"summary":"Create a discount code","operationId":"post_discounts","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Discount"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/discounts/{id}":{"get":{"tags":["Checkout and orders"],"summary":"Get a discount by id or code","operationId":"get_discounts_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Discount"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"tags":["Checkout and orders"],"summary":"Update a discount; active: false pauses it","operationId":"patch_discounts_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Discount"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["Checkout and orders"],"summary":"Delete a discount code","operationId":"delete_discounts_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/orders/{id}/shipping-rates":{"post":{"tags":["Shipping and returns"],"summary":"Live label rates, cheapest first","operationId":"post_orders_id_shipping_rates","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ratesInput"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/orders/{id}/labels":{"post":{"tags":["Shipping and returns"],"summary":"Buy a label; marks the order shipped","operationId":"post_orders_id_labels","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/labelInput"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Label"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"tags":["Shipping and returns"],"summary":"Labels bought for an order","operationId":"get_orders_id_labels","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelList"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/orders/{id}/returns":{"post":{"tags":["Shipping and returns"],"summary":"Open a return","operationId":"post_orders_id_returns","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/returnCreate"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Return"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/returns":{"get":{"tags":["Shipping and returns"],"summary":"List returns","operationId":"get_returns","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"order_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnList"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/returns/{id}":{"get":{"tags":["Shipping and returns"],"summary":"Get a return","operationId":"get_returns_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Return"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/returns/{id}/approve":{"post":{"tags":["Shipping and returns"],"summary":"Approve, optionally buying a return label","operationId":"post_returns_id_approve","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/returnApprove"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Return"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/returns/{id}/reject":{"post":{"tags":["Shipping and returns"],"summary":"Reject a return","operationId":"post_returns_id_reject","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/returnReject"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Return"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/returns/{id}/receive":{"post":{"tags":["Shipping and returns"],"summary":"Items arrived: restock and refund","operationId":"post_returns_id_receive","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/returnReceive"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Return"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/customers":{"get":{"tags":["Customers and reports"],"summary":"Customers from paid orders","operationId":"get_customers","parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerList"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/customers/{email}":{"get":{"tags":["Customers and reports"],"summary":"One customer's totals and order history","operationId":"get_customers_email","parameters":[{"name":"email","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDetail"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"tags":["Customers and reports"],"summary":"Mark a customer tax-exempt (their checkouts with customer_email skip sales tax)","operationId":"patch_customers_email","parameters":[{"name":"email","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customerUpdate"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDetail"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/reports/sales":{"get":{"tags":["Customers and reports"],"summary":"Sales over a period","operationId":"get_reports_sales","parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesReport"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/store/tax":{"get":{"tags":["Customers and reports"],"summary":"Sales tax readiness, registrations and categories","operationId":"get_store_tax","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/reports/tax":{"get":{"tags":["Customers and reports"],"summary":"Sales and tax collected by state","operationId":"get_reports_tax","parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/reports/tax/orders":{"get":{"tags":["Customers and reports"],"summary":"Every order with its tax","operationId":"get_reports_tax_orders","parameters":[{"name":"from","in":"query","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","required":false,"schema":{"type":"string"}},{"name":"format","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/files":{"post":{"tags":["Files"],"summary":"Host an image: multipart file, { url } to copy a link, or { data, filename } as base64","operationId":"post_files","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"tags":["Files"],"summary":"List hosted files and storage used","operationId":"get_files","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"string"}},{"name":"starting_after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/files/{id}":{"delete":{"tags":["Files"],"summary":"Delete a hosted file","operationId":"delete_files_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/products/{id}/copy-images":{"post":{"tags":["Files"],"summary":"Copy a product's outside images to the CDN","operationId":"post_products_id_copy_images","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/products/copy-images":{"post":{"tags":["Files"],"summary":"Copy outside images for the next batch of products","operationId":"post_products_copy_images","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/catalog/import":{"post":{"tags":["Print-on-demand"],"summary":"Import the products already set up at the connected provider","operationId":"post_catalog_import","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/fulfillment/printify/shop":{"get":{"tags":["Print-on-demand"],"summary":"The connected Printify store and its sales channel","operationId":"get_fulfillment_printify_shop","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/fulfillment/printify/blueprints":{"get":{"tags":["Print-on-demand"],"summary":"Search Printify's catalog","operationId":"get_fulfillment_printify_blueprints","parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/fulfillment/printify/blueprints/{id}/providers":{"get":{"tags":["Print-on-demand"],"summary":"Print providers for a blueprint","operationId":"get_fulfillment_printify_blueprints_id_providers","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/fulfillment/printify/blueprints/{id}/providers/{pid}/variants":{"get":{"tags":["Print-on-demand"],"summary":"Variant ids, options and placements","operationId":"get_fulfillment_printify_blueprints_id_providers_pid_variants","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"pid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/products/{id}/printify":{"post":{"tags":["Print-on-demand"],"summary":"Create the product in Printify and map its variants","operationId":"post_products_id_printify","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/products/{id}/printify/publish":{"post":{"tags":["Print-on-demand"],"summary":"Publish to the Printify store's sales channel (e.g. Etsy)","operationId":"post_products_id_printify_publish","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/import/shopify":{"post":{"tags":["Print-on-demand"],"summary":"Import products from a Shopify export or the Admin API","operationId":"post_import_shopify","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/channels/chatgpt":{"get":{"tags":["Channels"],"summary":"Sell in ChatGPT: readiness and application answers","operationId":"get_channels_chatgpt","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"tags":["Channels"],"summary":"Record the ChatGPT application status","operationId":"patch_channels_chatgpt","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/feeds/openai/check":{"get":{"tags":["Channels"],"summary":"What OpenAI would reject in the product feed","operationId":"get_feeds_openai_check","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/events":{"get":{"tags":["Events and email"],"summary":"Ordered event log","operationId":"get_events","parameters":[{"name":"after","in":"query","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventList"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/webhook-endpoints":{"post":{"tags":["Events and email"],"summary":"Register a webhook endpoint","operationId":"post_webhook_endpoints","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/endpointCreate"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpoint"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"tags":["Events and email"],"summary":"List webhook endpoints","operationId":"get_webhook_endpoints","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpointList"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/webhook-endpoints/{id}":{"delete":{"tags":["Events and email"],"summary":"Remove a webhook endpoint","operationId":"delete_webhook_endpoints_id","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/emails":{"get":{"tags":["Events and email"],"summary":"Customer email log","operationId":"get_emails","parameters":[{"name":"order_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/emails/preview/{template}":{"get":{"tags":["Events and email"],"summary":"Render a customer email with your branding","operationId":"get_emails_preview_template","parameters":[{"name":"template","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/emails/test":{"post":{"tags":["Events and email"],"summary":"Send previews to the store owner","operationId":"post_emails_test","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"2XX":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"4XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"5XX":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"Store API key: `Authorization: Bearer cfa_test_...` or `cfa_live_...`"}},"schemas":{"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","message"],"properties":{"type":{"type":"string","enum":["invalid_request","authentication_error","permission_error","not_found","conflict","out_of_stock","stripe_error","idempotency_error","rate_limited","internal_error"]},"message":{"type":"string"},"param":{"type":"string"},"hint":{"type":"string"}}}}},"Product":{"type":"object","properties":{"object":{"type":"string","const":"product"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"images":{"type":"array","items":{"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"active":{"type":"boolean"},"print_files":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PrintFile"}},{"type":"null"}],"description":"Default artwork for all variants (a variant's or checkout line's own print_files win)."},"variants":{"type":"array","items":{"$ref":"#/components/schemas/Variant"}},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["object","id","name","description","images","metadata","active","print_files","variants","created_at","updated_at"]},"PrintFile":{"type":"object","properties":{"placement":{"type":"string","description":"Provider placement, e.g. \"front\", \"back\", or Printful \"embroidery_chest_left\"."},"url":{"type":"string","description":"Public https URL of the artwork (PNG recommended)."},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{}},"required":["id","value"]},"description":"Provider file options, e.g. Printful [{ id: \"thread_colors\", value: [\"#FFFFFF\"] }]."}},"required":["placement","url"]},"Variant":{"type":"object","properties":{"object":{"type":"string","const":"variant"},"id":{"type":"string"},"product_id":{"type":"string"},"name":{"type":"string"},"sku":{"type":["string","null"]},"options":{"type":"object","additionalProperties":{"type":"string"}},"price":{"$ref":"#/components/schemas/Money"},"currency":{"type":"string"},"weight_oz":{"type":["number","null"]},"fulfillment":{"anyOf":[{"$ref":"#/components/schemas/VariantFulfillment"},{"type":"null"}],"description":"Print-on-demand mapping (null = you ship it yourself)."},"recurring":{"anyOf":[{"type":"object","properties":{"interval":{"type":"string","enum":["day","week","month","year"]},"interval_count":{"type":"number"}}},{"type":"null"}],"description":"Sold as a subscription; null for one-time purchases."},"inventory":{"$ref":"#/components/schemas/Inventory"},"active":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["object","id","product_id","name","sku","options","price","currency","weight_oz","fulfillment","recurring","inventory","active","created_at","updated_at"]},"Money":{"type":"number","description":"All amounts are integers in the currency's minor unit (cents for USD)."},"VariantFulfillment":{"type":"object","properties":{"printful_variant_id":{"type":"number","description":"Printful catalog variant id (product + color + size), e.g. 4012."},"printful_sync_variant_id":{"type":"number","description":"A product already set up in your Printful store (sync variant id): no print files needed."},"printful_options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{}},"required":["id","value"]},"description":"Printful item options, e.g. [{ id: \"thread_colors_chest_left\", value: [\"#000000\"] }] for embroidery."},"printify":{"type":"object","properties":{"variant_id":{"type":"number"},"blueprint_id":{"type":"number"},"print_provider_id":{"type":"number"},"product_id":{"type":"string"}},"required":["variant_id"],"description":"Printify: for per-order artwork give catalog `blueprint_id` + `print_provider_id` + `variant_id`; to print an existing Printify product give `product_id` + `variant_id`."},"print_files":{"type":"array","items":{"$ref":"#/components/schemas/PrintFile"},"description":"Default artwork; a checkout line's own print_files override it."}},"description":"Print-on-demand mapping: set exactly one of `printful_variant_id`, `printful_sync_variant_id` or `printify`."},"Inventory":{"type":"object","properties":{"tracked":{"type":"boolean"},"on_hand":{"type":["number","null"],"description":"Units physically in stock (null when not tracked)."},"reserved":{"type":"number","description":"Units held by open checkouts."},"available":{"type":["number","null"],"description":"on_hand − reserved: what can be sold right now (null = unlimited)."}},"required":["tracked","on_hand","reserved","available"]},"Checkout":{"type":"object","properties":{"object":{"type":"string","const":"checkout"},"id":{"type":"string"},"status":{"type":"string","enum":["pending","open","completed","expired","failed"]},"url":{"type":["string","null"],"description":"Stripe-hosted payment page. Redirect the customer here."},"items":{"type":"array","items":{"$ref":"#/components/schemas/CheckoutItem"}},"currency":{"type":"string"},"customer_email":{"type":["string","null"]},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"order_id":{"type":["string","null"]},"expires_at":{"type":"string"},"created_at":{"type":"string"}},"required":["object","id","status","url","items","currency","customer_email","metadata","order_id","expires_at","created_at"]},"CheckoutItem":{"type":"object","properties":{"variant_id":{"type":"string"},"product_id":{"type":"string"},"product_name":{"type":"string"},"variant_name":{"type":"string"},"sku":{"type":["string","null"]},"quantity":{"type":"number"},"unit_price":{"$ref":"#/components/schemas/Money"},"properties":{"type":"object","additionalProperties":{"type":"string"}},"print_files":{"type":"array","items":{"$ref":"#/components/schemas/PrintFile"}}},"required":["variant_id","product_id","product_name","variant_name","sku","quantity","unit_price"]},"Order":{"type":"object","properties":{"object":{"type":"string","const":"order"},"id":{"type":"string"},"number":{"type":"number","description":"Human-friendly, per-store sequential number (e.g. 1001)."},"status":{"$ref":"#/components/schemas/OrderStatus"},"email":{"type":["string","null"]},"customer_name":{"type":["string","null"]},"shipping_address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"items":{"type":"array","items":{"$ref":"#/components/schemas/CheckoutItem"}},"currency":{"type":"string"},"subtotal":{"$ref":"#/components/schemas/Money"},"shipping":{"$ref":"#/components/schemas/Money"},"tax":{"$ref":"#/components/schemas/Money"},"total":{"$ref":"#/components/schemas/Money"},"discount":{"$ref":"#/components/schemas/Money","description":"Taken off by a discount code."},"discount_code":{"type":["string","null"]},"tax_exempt":{"type":"boolean","description":"The customer was tax-exempt at this store, so no sales tax was charged."},"gift_card":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"amount":{"$ref":"#/components/schemas/Money"}},"required":["id","amount"]},{"type":"null"}],"description":"Gift card used on this order and how much it covered (included in discount)."},"refunded":{"$ref":"#/components/schemas/Money"},"fulfillment":{"anyOf":[{"type":"object","properties":{"carrier":{"type":["string","null"]},"tracking_number":{"type":["string","null"]},"tracking_url":{"type":["string","null"]},"fulfilled_at":{"type":"string"},"shipments":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"carrier":{"type":"string"},"tracking_number":{"type":"string"},"tracking_url":{"type":["string","null"]}},"required":["carrier","tracking_number","tracking_url"]},"description":"The packages recorded when the order was marked shipped. For every package with its status, use `order.shipments`."}},"required":["carrier","tracking_number","tracking_url","fulfilled_at"]},{"type":"null"}]},"shipments":{"type":"array","items":{"$ref":"#/components/schemas/Shipment"},"description":"Every package of the order (the store's own and print-on-demand), each with its delivery status."},"fulfillment_status":{"type":"string","enum":["unshipped","partial","shipped"],"description":"unshipped, partial (some items are in packages) or shipped."},"unshipped_items":{"type":"array","items":{"type":"object","properties":{"variant_id":{"type":"string"},"quantity":{"type":"number"}},"required":["variant_id","quantity"]},"description":"Items not in a package yet (empty once the order has shipped)."},"delivered_at":{"type":["string","null"],"description":"When the last package was delivered; null until every package has been."},"tracking_page_url":{"type":["string","null"],"description":"The customer's tracking page for this order (linked from the shipping emails); null before anything ships."},"fulfillment_provider_orders":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string","enum":["printful","printify"]},"id":{"type":"string"},"status":{"type":"string"},"dashboard_url":{"type":["string","null"]},"error":{"type":"string"},"shipments":{"type":"array","items":{"type":"object","properties":{"carrier":{"type":"string"},"tracking_number":{"type":"string"},"tracking_url":{"type":["string","null"]}},"required":["carrier","tracking_number","tracking_url"]}}},"required":["provider","status"]},"description":"One entry per print-on-demand provider this order was routed to."},"imported":{"type":"boolean","description":"Brought over from another platform (e.g. Shopify): a record of a past sale, never charged or fulfilled here."},"edits":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"at":{"type":"string"},"changes":{"type":"array","items":{"type":"string"}},"refund":{"$ref":"#/components/schemas/Money"},"extra_cost_waived":{"$ref":"#/components/schemas/Money"},"reason":{"type":["string","null"]}},"required":["id","at","changes","refund","extra_cost_waived","reason"]},"description":"Changes made after the order was paid. Totals stay what was charged; items are what ships."},"note":{"type":["string","null"]},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"checkout_id":{"type":"string"},"stripe_payment_intent_id":{"type":["string","null"]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["object","id","number","status","email","customer_name","shipping_address","items","currency","subtotal","shipping","tax","total","discount","discount_code","tax_exempt","gift_card","refunded","fulfillment","shipments","fulfillment_status","unshipped_items","delivered_at","tracking_page_url","fulfillment_provider_orders","imported","edits","note","metadata","checkout_id","stripe_payment_intent_id","created_at","updated_at"]},"OrderStatus":{"type":"string","enum":["pending_payment","paid","fulfilled","cancelled","refunded"]},"Address":{"type":"object","properties":{"name":{"type":["string","null"]},"line1":{"type":["string","null"]},"line2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"postal_code":{"type":["string","null"]},"country":{"type":["string","null"]}}},"Shipment":{"type":"object","properties":{"provider":{"type":"string","description":"printful / printify for print-on-demand packages; absent for packages the store ships."},"carrier":{"type":"string"},"tracking_number":{"type":"string"},"tracking_url":{"type":["string","null"]},"status":{"type":"string","enum":["shipped","label_created","in_transit","out_for_delivery","available_for_pickup","delivered","returned","exception"]},"delivered_at":{"type":["string","null"]},"eta":{"type":["string","null"],"description":"Estimated delivery, when known."},"detail":{"type":["string","null"],"description":"The carrier's wording for the latest update."},"items":{"type":"array","items":{"type":"object","properties":{"variant_id":{"type":"string"},"quantity":{"type":"number"}},"required":["variant_id","quantity"]},"description":"What's in this package, when it was recorded."}},"required":["carrier","tracking_number","tracking_url","status","delivered_at","eta","detail"],"description":"One package. `status` stays \"shipped\" until the carrier or print provider reports more."},"OrderEdit":{"type":"object","properties":{"object":{"type":"string","const":"order_edit"},"order_id":{"type":"string"},"order_number":{"type":"number"},"changes":{"type":"array","items":{"type":"string"},"description":"In words, e.g. \"Swapped 1 × Tee (M) for Tee (L)\"."},"refund":{"$ref":"#/components/schemas/Money","description":"Refunded to the customer, in cents."},"extra_cost_waived":{"$ref":"#/components/schemas/Money"},"currency":{"type":"string"},"items_after":{"type":"array","items":{"type":"object","properties":{"variant_id":{"type":"string"},"product_name":{"type":"string"},"variant_name":{"type":"string"},"quantity":{"type":"number"},"unit_price":{"$ref":"#/components/schemas/Money"}},"required":["variant_id","product_name","variant_name","quantity","unit_price"]}},"fulfillment":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"provider_order_id":{"type":"string"},"action":{"type":"string","enum":["cancel_and_resend","cancel"]}},"required":["provider","provider_order_id","action"]},"description":"Print-on-demand orders cancelled at the provider and sent again with the change."},"dry_run":{"type":"boolean"},"order":{"$ref":"#/components/schemas/Order"}},"required":["object","order_id","order_number","changes","refund","extra_cost_waived","currency","items_after","fulfillment","dry_run","order"]},"Store":{"type":"object","properties":{"object":{"type":"string","const":"store"},"id":{"type":"string"},"name":{"type":"string"},"currency":{"type":"string"},"mode":{"type":"string","enum":["test","live"]},"tax_enabled":{"type":"boolean"},"default_success_url":{"type":["string","null"]},"default_cancel_url":{"type":["string","null"]},"stripe_webhook_url":{"type":["string","null"]},"stripe_webhook_configured":{"type":"boolean"},"shipping":{"anyOf":[{"type":"object","properties":{"provider":{"type":"string","enum":["easypost","shippo"]},"ship_from":{"$ref":"#/components/schemas/Address"},"default_parcel":{"anyOf":[{"$ref":"#/components/schemas/Dimensions"},{"type":"null"}]}},"required":["provider","ship_from","default_parcel"]},{"type":"null"}]},"emails":{"anyOf":[{"type":"object","properties":{"provider":{"type":"string","const":"resend"},"from":{"type":"string"},"reply_to":{"type":["string","null"]},"events":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]}},"required":["provider","from","reply_to","events"]},{"type":"null"}]},"storefront":{"anyOf":[{"$ref":"#/components/schemas/StorefrontConfig"},{"type":"null"}]},"agent_access":{"type":"boolean"},"checkout_shipping":{"anyOf":[{"type":"object","properties":{"countries":{"type":"array","items":{"type":"string"}},"rates":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"amount":{"$ref":"#/components/schemas/Money"},"min_days":{"type":"number"},"max_days":{"type":"number"}},"required":["name","amount"]}},"free_over":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]}},"required":["countries","rates","free_over"]},{"type":"null"}],"description":"Shipping every checkout offers unless it passes its own rates."},"fulfillment":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string","enum":["printful","printify"]},"auto_confirm":{"type":"boolean"},"printful_store_id":{"type":["string","null"]},"printify_shop_id":{"type":["string","null"]}},"required":["provider","auto_confirm"]},"description":"Connected print-on-demand providers; each variant routes to the one it's mapped to."},"feeds":{"anyOf":[{"type":"object","properties":{"acp":{"type":"string"},"google":{"type":"string"},"agent":{"type":["string","null"]}},"required":["acp","google","agent"]},{"type":"null"}]}},"required":["object","id","name","currency","mode","tax_enabled","default_success_url","default_cancel_url","stripe_webhook_url","stripe_webhook_configured","shipping","emails","storefront","agent_access","checkout_shipping","fulfillment","feeds"]},"Dimensions":{"type":"object","properties":{"length":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"}},"required":["length","width","height"]},"StorefrontConfig":{"type":"object","properties":{"product_url_template":{"type":"string","description":"Your product page URL with `{handle}` or `{id}`, e.g. \"https://acme.com/products/{handle}\"."},"brand":{"type":"string"},"seller_url":{"type":"string"},"privacy_policy_url":{"type":"string"},"terms_url":{"type":"string"},"return_policy_url":{"type":"string"},"return_window_days":{"type":"number"}},"required":["product_url_template"]},"Label":{"type":"object","properties":{"object":{"type":"string","const":"label"},"id":{"type":"string"},"order_id":{"type":"string"},"return_id":{"type":["string","null"]},"provider":{"type":"string","enum":["easypost","shippo"]},"carrier":{"type":"string"},"service":{"type":"string"},"cost":{"$ref":"#/components/schemas/Money"},"currency":{"type":"string"},"tracking_number":{"type":["string","null"]},"tracking_url":{"type":["string","null"]},"label_url":{"type":"string","description":"PDF/PNG to print."},"created_at":{"type":"string"}},"required":["object","id","order_id","return_id","provider","carrier","service","cost","currency","tracking_number","tracking_url","label_url","created_at"]},"Return":{"type":"object","properties":{"object":{"type":"string","const":"return"},"id":{"type":"string"},"number":{"type":"number","description":"Per-store sequential number, shown to customers as R1, R2, ..."},"status":{"type":"string","enum":["requested","approved","rejected","completed"]},"order_id":{"type":"string"},"order_number":{"type":["number","null"]},"email":{"type":["string","null"]},"currency":{"type":["string","null"]},"items":{"type":"array","items":{"type":"object","properties":{"variant_id":{"type":"string"},"product_name":{"type":"string"},"variant_name":{"type":"string"},"quantity":{"type":"number"},"unit_price":{"$ref":"#/components/schemas/Money"}},"required":["variant_id","product_name","variant_name","quantity","unit_price"]}},"reason":{"type":["string","null"]},"note":{"type":["string","null"]},"refund_amount":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"restocked":{"type":"boolean"},"label":{"anyOf":[{"$ref":"#/components/schemas/Label"},{"type":"null"}]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["object","id","number","status","order_id","order_number","email","currency","items","reason","note","refund_amount","restocked","label","created_at","updated_at"]},"Customer":{"type":"object","properties":{"object":{"type":"string","const":"customer"},"email":{"type":"string"},"name":{"type":["string","null"]},"orders":{"type":"number","description":"Paid orders (simulated ones never count)."},"total_spent":{"$ref":"#/components/schemas/Money","description":"After refunds."},"currency":{"type":"string"},"tax_exempt":{"type":"boolean","description":"No sales tax on this customer's checkouts (those you create with their customer_email)."},"first_order_at":{"type":["string","null"],"description":"Null for a customer set up before their first order."},"last_order_at":{"type":["string","null"]}},"required":["object","email","name","orders","total_spent","currency","tax_exempt","first_order_at","last_order_at"]},"CustomerDetail":{"type":"object","properties":{"object":{"type":"string","const":"customer"},"email":{"type":"string"},"name":{"type":["string","null"]},"orders":{"type":"number","description":"Paid orders (simulated ones never count)."},"total_spent":{"$ref":"#/components/schemas/Money","description":"After refunds."},"currency":{"type":"string"},"tax_exempt":{"type":"boolean","description":"No sales tax on this customer's checkouts (those you create with their customer_email)."},"first_order_at":{"type":["string","null"],"description":"Null for a customer set up before their first order."},"last_order_at":{"type":["string","null"]},"account_url":{"type":"string","description":"This customer's private page: orders, tracking, subscriptions, return requests. Send it only to them."},"tax_exempt_note":{"type":["string","null"],"description":"Your note about the exemption, e.g. the certificate number."},"last_shipping_address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"order_history":{"type":"array","items":{"$ref":"#/components/schemas/Order"}}},"required":["account_url","currency","email","first_order_at","last_order_at","last_shipping_address","name","object","order_history","orders","tax_exempt","tax_exempt_note","total_spent"]},"Discount":{"type":"object","properties":{"object":{"type":"string","const":"discount"},"id":{"type":"string"},"code":{"type":"string","description":"Uppercase; what shoppers type (for an automatic discount, the name on the receipt)."},"automatic":{"type":"boolean","description":"Applied to every qualifying checkout without a code."},"kind":{"type":"string","enum":["percent","amount"]},"value":{"type":"number","description":"1–100 for percent; cents for amount."},"currency":{"type":"string"},"description":{"type":"string"},"min_subtotal":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"max_redemptions":{"type":["number","null"]},"times_used":{"type":"number"},"starts_at":{"type":["string","null"]},"ends_at":{"type":["string","null"]},"active":{"type":"boolean"},"status":{"type":"string","enum":["live","scheduled","expired","used_up","off"]},"created_at":{"type":"string"}},"required":["object","id","code","automatic","kind","value","currency","description","min_subtotal","max_redemptions","times_used","starts_at","ends_at","active","status","created_at"]},"Collection":{"type":"object","properties":{"object":{"type":"string","const":"collection"},"id":{"type":"string"},"name":{"type":"string"},"handle":{"type":"string","description":"URL-safe, unique per store. Use it anywhere an id is accepted."},"description":{"type":["string","null"]},"image":{"type":["string","null"]},"position":{"type":"number"},"product_count":{"type":"number"},"product_ids":{"type":"array","items":{"type":"string"},"description":"In display order."},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["object","id","name","handle","description","image","position","product_count","product_ids","created_at","updated_at"]},"DraftOrder":{"type":"object","properties":{"object":{"type":"string","const":"draft_order"},"id":{"type":"string"},"number":{"type":"number","description":"Shown as D1001."},"status":{"type":"string","enum":["open","invoice_sent","completed","cancelled","expired"]},"customer_email":{"type":["string","null"]},"customer_name":{"type":["string","null"]},"note":{"type":["string","null"]},"currency":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"variant_id":{"type":"string"},"product_name":{"type":"string"},"variant_name":{"type":"string"},"quantity":{"type":"number"},"unit_price":{"$ref":"#/components/schemas/Money"},"catalog_price":{"$ref":"#/components/schemas/Money"},"properties":{"type":"object","additionalProperties":{"type":"string"}}},"required":["variant_id","product_name","variant_name","quantity","unit_price"]}},"discount_code":{"type":["string","null"]},"shipping":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"amount":{"$ref":"#/components/schemas/Money"}},"required":["name","amount"]},{"type":"null"}]},"subtotal":{"$ref":"#/components/schemas/Money","description":"Before discount, shipping and tax, which are worked out when the customer pays."},"invoice_url":{"type":"string","description":"The customer's page to review and pay. Works until expires_at."},"order_id":{"type":["string","null"],"description":"Set once the customer pays."},"invoice_sent_at":{"type":["string","null"]},"expires_at":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["object","id","number","status","customer_email","customer_name","note","currency","items","discount_code","shipping","subtotal","invoice_url","order_id","invoice_sent_at","expires_at","created_at","updated_at"]},"GiftCard":{"type":"object","properties":{"object":{"type":"string","const":"gift_card"},"id":{"type":"string"},"code":{"type":"string","description":"What the customer types, e.g. K7QX-M2PD-9WRT-H4NB."},"last4":{"type":"string"},"currency":{"type":"string"},"initial_value":{"$ref":"#/components/schemas/Money"},"balance":{"$ref":"#/components/schemas/Money"},"status":{"type":"string","enum":["active","used_up","disabled","expired"]},"recipient_email":{"type":["string","null"]},"note":{"type":["string","null"]},"order_id":{"type":["string","null"],"description":"The order that bought it, for cards sold as products."},"expires_at":{"type":["string","null"]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["object","id","code","last4","currency","initial_value","balance","status","recipient_email","note","order_id","expires_at","created_at","updated_at"]},"Subscription":{"type":"object","properties":{"object":{"type":"string","const":"subscription"},"id":{"type":"string"},"status":{"type":"string","enum":["active","past_due","unpaid","canceled","incomplete","incomplete_expired","trialing","paused"]},"cancel_at_period_end":{"type":"boolean","description":"Set when it will stop at the end of the period already paid for."},"schedule":{"type":"object","properties":{"interval":{"type":"string","enum":["day","week","month","year"]},"interval_count":{"type":"number"}}},"description":{"type":"string","description":"e.g. \"every month\", \"every 2 weeks\"."},"email":{"type":["string","null"]},"customer_name":{"type":["string","null"]},"items":{"type":"array","items":{"$ref":"#/components/schemas/CheckoutItem"},"description":"What each renewal order contains."},"shipping":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"amount":{"$ref":"#/components/schemas/Money"}},"required":["name","amount"]},{"type":"null"}],"description":"Charged with every renewal."},"shipping_address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"first_order_id":{"type":["string","null"]},"current_period_end":{"type":["string","null"]},"canceled_at":{"type":["string","null"]},"stripe_subscription_id":{"type":"string"},"manage_url":{"type":"string","description":"The customer's page to cancel (or undo cancelling); also linked from their order emails."},"created_at":{"type":"string"}},"required":["object","id","status","cancel_at_period_end","schedule","description","email","customer_name","items","shipping","shipping_address","first_order_id","current_period_end","canceled_at","stripe_subscription_id","manage_url","created_at"]},"SalesReport":{"type":"object","properties":{"object":{"type":"string","const":"sales_report"},"days":{"type":"number"},"interval":{"type":"string","enum":["day","week","month"]},"currency":{"type":"string"},"totals":{"type":"object","properties":{"orders":{"type":"number"},"gross":{"$ref":"#/components/schemas/Money"},"net":{"$ref":"#/components/schemas/Money"},"refunds":{"$ref":"#/components/schemas/Money"},"discounts":{"$ref":"#/components/schemas/Money"},"average_order":{"$ref":"#/components/schemas/Money"},"customers":{"type":"number"},"returning_customers":{"type":"number"}},"required":["orders","gross","net","refunds","discounts","average_order","customers","returning_customers"]},"previous":{"type":"object","properties":{"orders":{"type":"number"},"gross":{"$ref":"#/components/schemas/Money"},"net":{"$ref":"#/components/schemas/Money"},"refunds":{"$ref":"#/components/schemas/Money"},"discounts":{"$ref":"#/components/schemas/Money"},"change_pct":{"type":"object","properties":{"orders":{"type":["number","null"]},"gross":{"type":["number","null"]},"net":{"type":["number","null"]}},"required":["orders","gross","net"]}},"required":["orders","gross","net","refunds","discounts","change_pct"]},"series":{"type":"array","items":{"type":"object","properties":{"period":{"type":"string"},"orders":{"type":"number"},"gross":{"$ref":"#/components/schemas/Money"},"discounts":{"$ref":"#/components/schemas/Money"},"shipping":{"$ref":"#/components/schemas/Money"},"tax":{"$ref":"#/components/schemas/Money"},"refunds":{"$ref":"#/components/schemas/Money"},"net":{"$ref":"#/components/schemas/Money"}},"required":["period","orders","gross","discounts","shipping","tax","refunds","net"]}},"top_products":{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"name":{"type":"string"},"units":{"type":"number"},"revenue":{"$ref":"#/components/schemas/Money"}},"required":["product_id","name","units","revenue"]}}},"required":["object","days","interval","currency","totals","previous","series","top_products"]},"WebhookEndpoint":{"type":"object","properties":{"object":{"type":"string","const":"webhook_endpoint"},"id":{"type":"string"},"url":{"type":"string"},"events":{"type":"array","items":{"type":"string"}},"secret":{"type":"string","description":"Only returned when the endpoint is created."},"created_at":{"type":"string"}},"required":["object","id","url","events"]},"ProductList":{"$ref":"#/components/schemas/List_Product"},"List_Product":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"OrderList":{"$ref":"#/components/schemas/List_Order"},"List_Order":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"ReturnList":{"$ref":"#/components/schemas/List_Return"},"List_Return":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Return"}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"CustomerList":{"$ref":"#/components/schemas/List_Customer"},"List_Customer":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"DiscountList":{"$ref":"#/components/schemas/List_Discount"},"List_Discount":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"CollectionList":{"$ref":"#/components/schemas/List_Collection"},"List_Collection":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Collection"}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"DraftOrderList":{"$ref":"#/components/schemas/List_DraftOrder"},"List_DraftOrder":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DraftOrder"}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"GiftCardList":{"$ref":"#/components/schemas/List_GiftCard"},"List_GiftCard":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GiftCard"}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"SubscriptionList":{"$ref":"#/components/schemas/List_Subscription"},"List_Subscription":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Subscription"}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"LabelList":{"$ref":"#/components/schemas/List_Label"},"List_Label":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Label"}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"EventList":{"$ref":"#/components/schemas/List_Event"},"List_Event":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Event"}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"Event":{"type":"object","properties":{"id":{"type":"string"},"object":{"type":"string","const":"event"},"type":{"$ref":"#/components/schemas/EventType"},"created_at":{"type":"string"},"data":{}},"required":["id","object","type","created_at","data"]},"EventType":{"type":"string","enum":["order.created","order.paid","order.fulfilled","order.updated","order.cancelled","order.refunded","checkout.expired","checkout.abandoned","label.created","order.shipment_created","order.edited","order.shipment_updated","order.shipment_delivered","order.delivered","draft_order.created","gift_card.created","subscription.created","subscription.renewed","subscription.updated","subscription.canceled","gift_card.sent","gift_card.used","gift_card.updated","draft_order.updated","draft_order.invoice_sent","draft_order.completed","draft_order.cancelled","fulfillment.submitted","fulfillment.failed","fulfillment.canceled","fulfillment.on_hold","return.requested","return.approved","return.rejected","return.completed","inventory.updated","product.created","product.updated"]},"WebhookEndpointList":{"$ref":"#/components/schemas/List_WebhookEndpoint"},"List_WebhookEndpoint":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookEndpoint"}},"has_more":{"type":"boolean"}},"required":["object","data","has_more"]},"productCreate":{"type":"object","properties":{"name":{"type":"string","minLength":1},"print_files":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"placement":{"type":"string","minLength":1,"maxLength":60},"url":{"type":"string","format":"uri"},"options":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"value":{}},"required":["id","value"]}}},"required":["placement","url"]}},"tax_code":{"anyOf":[{"type":"string","pattern":"^txcd_\\d{8}$"},{"type":"null"}]},"description":{"type":"string"},"images":{"maxItems":8,"type":"array","items":{"type":"string","format":"uri"}},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"variants":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"name":{"default":"Default","type":"string","minLength":1},"sku":{"type":"string","minLength":1},"price":{"type":"integer","minimum":0,"maximum":9007199254740991},"options":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"inventory":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"weight_oz":{"type":"number","exclusiveMinimum":0},"fulfillment":{"type":"object","properties":{"printful_variant_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"printful_sync_variant_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"printful_options":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"value":{}},"required":["id","value"]}},"printify":{"type":"object","properties":{"variant_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"blueprint_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"print_provider_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"product_id":{"type":"string","minLength":1}},"required":["variant_id"]},"print_files":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"placement":{"type":"string","minLength":1,"maxLength":60},"url":{"type":"string","format":"uri"},"options":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"value":{}},"required":["id","value"]}}},"required":["placement","url"]}}}},"recurring":{"type":"object","properties":{"interval":{"type":"string","enum":["day","week","month","year"]},"interval_count":{"type":"integer","minimum":1,"maximum":12}},"required":["interval"]}},"required":["price"]}},"price":{"type":"integer","minimum":0,"maximum":9007199254740991},"recurring":{"type":"object","properties":{"interval":{"type":"string","enum":["day","week","month","year"]},"interval_count":{"type":"integer","minimum":1,"maximum":12}},"required":["interval"]},"inventory":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"sku":{"type":"string","minLength":1},"weight_oz":{"type":"number","exclusiveMinimum":0}},"required":["name"]},"productUpdate":{"type":"object","properties":{"name":{"type":"string","minLength":1},"print_files":{"anyOf":[{"maxItems":10,"type":"array","items":{"type":"object","properties":{"placement":{"type":"string","minLength":1,"maxLength":60},"url":{"type":"string","format":"uri"},"options":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"value":{}},"required":["id","value"]}}},"required":["placement","url"]}},{"type":"null"}]},"tax_code":{"anyOf":[{"type":"string","pattern":"^txcd_\\d{8}$"},{"type":"null"}]},"description":{"type":["string","null"]},"images":{"maxItems":8,"type":"array","items":{"type":"string","format":"uri"}},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"active":{"type":"boolean"}}},"variantInput":{"type":"object","properties":{"name":{"default":"Default","type":"string","minLength":1},"sku":{"type":"string","minLength":1},"price":{"type":"integer","minimum":0,"maximum":9007199254740991},"options":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"inventory":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"weight_oz":{"type":"number","exclusiveMinimum":0},"fulfillment":{"type":"object","properties":{"printful_variant_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"printful_sync_variant_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"printful_options":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"value":{}},"required":["id","value"]}},"printify":{"type":"object","properties":{"variant_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"blueprint_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"print_provider_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"product_id":{"type":"string","minLength":1}},"required":["variant_id"]},"print_files":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"placement":{"type":"string","minLength":1,"maxLength":60},"url":{"type":"string","format":"uri"},"options":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"value":{}},"required":["id","value"]}}},"required":["placement","url"]}}}},"recurring":{"type":"object","properties":{"interval":{"type":"string","enum":["day","week","month","year"]},"interval_count":{"type":"integer","minimum":1,"maximum":12}},"required":["interval"]}},"required":["price"]},"variantUpdate":{"type":"object","properties":{"name":{"type":"string","minLength":1},"sku":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"price":{"type":"integer","minimum":0,"maximum":9007199254740991},"options":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"active":{"type":"boolean"},"weight_oz":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"null"}]},"fulfillment":{"anyOf":[{"type":"object","properties":{"printful_variant_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"printful_sync_variant_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"printful_options":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"value":{}},"required":["id","value"]}},"printify":{"type":"object","properties":{"variant_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"blueprint_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"print_provider_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"product_id":{"type":"string","minLength":1}},"required":["variant_id"]},"print_files":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"placement":{"type":"string","minLength":1,"maxLength":60},"url":{"type":"string","format":"uri"},"options":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"value":{}},"required":["id","value"]}}},"required":["placement","url"]}}}},{"type":"null"}]},"recurring":{"anyOf":[{"type":"object","properties":{"interval":{"type":"string","enum":["day","week","month","year"]},"interval_count":{"type":"integer","minimum":1,"maximum":12}},"required":["interval"]},{"type":"null"}]}}},"inventoryAdjust":{"type":"object","properties":{"adjust":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"set":{"type":"integer","minimum":0,"maximum":9007199254740991},"reason":{"type":"string","maxLength":200}}},"checkoutCreate":{"type":"object","properties":{"items":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"variant_id":{"type":"string"},"quantity":{"type":"integer","minimum":1,"maximum":999},"properties":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500}},"print_files":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"placement":{"type":"string","minLength":1,"maxLength":60},"url":{"type":"string","format":"starts_with","pattern":"^https:\\/\\/.*"},"options":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"value":{}},"required":["id","value"]}}},"required":["placement","url"]}}},"required":["variant_id","quantity"]}},"success_url":{"type":"string","format":"uri"},"cancel_url":{"type":"string","format":"uri"},"customer_email":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"collect_shipping_address":{"type":"boolean"},"shipping_countries":{"minItems":1,"type":"array","items":{"type":"string","minLength":2,"maxLength":2}},"shipping_rates":{"maxItems":5,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"amount":{"type":"integer","minimum":0,"maximum":9007199254740991},"min_days":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"max_days":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["name","amount"]}},"expires_in_minutes":{"type":"integer","minimum":30,"maximum":1440},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"discount_code":{"type":"string","maxLength":40}},"required":["items"]},"checkoutShippingConfig":{"type":"object","properties":{"countries":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":2,"maxLength":2}},"rates":{"minItems":1,"maxItems":5,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"amount":{"type":"integer","minimum":0,"maximum":9007199254740991},"min_days":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"max_days":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["name","amount"]}},"free_over":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["countries","rates"]},"storeUpdate":{"type":"object","properties":{"name":{"type":"string","minLength":1},"tax_enabled":{"type":"boolean"},"default_success_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"default_cancel_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"builtin_emails":{"type":"boolean"},"recovery_emails":{"type":"boolean"},"hosted_pages":{"type":"boolean"},"email_brand":{"type":"object","properties":{"logo_url":{"anyOf":[{"type":"string","maxLength":2000,"format":"starts_with","pattern":"^https:\\/\\/.*"},{"type":"null"}]},"accent_color":{"anyOf":[{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]}}},"default_tax_code":{"anyOf":[{"type":"string","pattern":"^txcd_\\d{8}$"},{"type":"null"}]},"send_test_orders_to_providers":{"type":"boolean"},"prices_include_tax":{"type":"boolean"},"owner_alerts":{"type":"object","properties":{"new_order":{"type":"boolean"},"low_stock_threshold":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]},"delivery_problem":{"type":"boolean"}}},"delivered_emails":{"type":"boolean"},"local_currencies":{"type":"boolean"},"returns_window_days":{"anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]}}},"shippingConfig":{"type":"object","properties":{"provider":{"type":"string","enum":["easypost","shippo"]},"api_key":{"type":"string","minLength":8},"ship_from":{"type":"object","properties":{"name":{"type":"string"},"company":{"type":"string"},"line1":{"type":"string","minLength":1},"line2":{"type":"string"},"city":{"type":"string","minLength":1},"state":{"type":"string"},"postal_code":{"type":"string","minLength":1},"country":{"type":"string","minLength":2,"maxLength":2},"phone":{"type":"string"},"email":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["line1","city","postal_code","country"]},"default_parcel":{"type":"object","properties":{"length":{"type":"number","exclusiveMinimum":0},"width":{"type":"number","exclusiveMinimum":0},"height":{"type":"number","exclusiveMinimum":0}},"required":["length","width","height"]}},"required":["provider","api_key","ship_from"]},"fulfillmentConfig":{"oneOf":[{"type":"object","properties":{"provider":{"type":"string","const":"printful"},"api_key":{"type":"string","minLength":10},"printful_store_id":{"type":"string"},"auto_confirm":{"type":"boolean"},"import_catalog":{"type":"boolean"}},"required":["provider","api_key"]},{"type":"object","properties":{"provider":{"type":"string","const":"printify"},"api_key":{"type":"string","minLength":10},"printify_shop_id":{"type":"string","minLength":1},"auto_confirm":{"type":"boolean"},"import_catalog":{"type":"boolean"}},"required":["provider","api_key","printify_shop_id"]}]},"emailConfig":{"type":"object","properties":{"resend_api_key":{"type":"string","format":"starts_with","pattern":"^re_.*"},"from":{"type":"string","minLength":3},"reply_to":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"events":{"type":"array","items":{"type":"string","enum":["order.paid","order.fulfilled","order.shipment_delivered","order.refunded","return.approved","checkout.abandoned"]}}},"required":["resend_api_key","from"]},"storefrontConfig":{"type":"object","properties":{"product_url_template":{"type":"string","format":"uri"},"brand":{"type":"string"},"seller_url":{"type":"string","format":"uri"},"privacy_policy_url":{"type":"string","format":"uri"},"terms_url":{"type":"string","format":"uri"},"return_policy_url":{"type":"string","format":"uri"},"return_window_days":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"agent_access":{"type":"boolean"}},"required":["product_url_template"]},"orderUpdate":{"type":"object","properties":{"note":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}]},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}}},"fulfillInput":{"type":"object","properties":{"carrier":{"type":"string","maxLength":100},"tracking_number":{"type":"string","maxLength":200},"tracking_url":{"type":"string","format":"uri"},"replace":{"type":"boolean"},"items":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"variant_id":{"type":"string"},"quantity":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["variant_id","quantity"]}}}},"refundInput":{"type":"object","properties":{"amount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"restock":{"type":"boolean"},"reason":{"type":"string","enum":["duplicate","fraudulent","requested_by_customer"]}}},"ratesInput":{"type":"object","properties":{"parcel":{"type":"object","properties":{"length":{"type":"number","exclusiveMinimum":0},"width":{"type":"number","exclusiveMinimum":0},"height":{"type":"number","exclusiveMinimum":0},"weight_oz":{"type":"number","exclusiveMinimum":0}}},"return_id":{"type":"string"}}},"labelInput":{"type":"object","properties":{"rate_id":{"type":"string"},"max_cost":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["rate_id"]},"returnCreate":{"type":"object","properties":{"items":{"minItems":1,"type":"array","items":{"type":"object","properties":{"variant_id":{"type":"string"},"quantity":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["variant_id","quantity"]}},"reason":{"type":"string","maxLength":1000}},"required":["items"]},"returnApprove":{"type":"object","properties":{"return_label":{"anyOf":[{"type":"string","const":"cheapest"},{"type":"object","properties":{"rate_id":{"type":"string"}},"required":["rate_id"]}]},"note":{"type":"string","maxLength":2000}}},"returnReject":{"type":"object","properties":{"note":{"type":"string","maxLength":2000}}},"returnReceive":{"type":"object","properties":{"restock":{"type":"boolean"},"refund":{"type":"boolean"},"refund_amount":{"type":"integer","minimum":0,"maximum":9007199254740991}}},"endpointCreate":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"events":{"minItems":1,"type":"array","items":{"type":"string"}}},"required":["url"]},"customerUpdate":{"type":"object","properties":{"tax_exempt":{"type":"boolean"},"tax_exempt_note":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]}}},"draftCreate":{"type":"object","properties":{"items":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"variant_id":{"type":"string"},"quantity":{"type":"integer","minimum":1,"maximum":999},"unit_price":{"type":"integer","minimum":0,"maximum":9007199254740991},"properties":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500}}},"required":["variant_id","quantity"]}},"customer_email":{"anyOf":[{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"customer_name":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"note":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"discount_code":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"shipping":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"amount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["name","amount"]},{"type":"null"}]},"expires_in_days":{"type":"integer","minimum":1,"maximum":365}},"required":["items"]},"draftUpdate":{"type":"object","properties":{"items":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"variant_id":{"type":"string"},"quantity":{"type":"integer","minimum":1,"maximum":999},"unit_price":{"type":"integer","minimum":0,"maximum":9007199254740991},"properties":{"type":"object","propertyNames":{"type":"string","maxLength":40},"additionalProperties":{"type":"string","maxLength":500}}},"required":["variant_id","quantity"]}},"customer_email":{"anyOf":[{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"customer_name":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"note":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"discount_code":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"shipping":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"amount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["name","amount"]},{"type":"null"}]},"expires_in_days":{"type":"integer","minimum":1,"maximum":365}}},"invoiceSend":{"type":"object","properties":{"to":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"message":{"type":"string","maxLength":2000}}},"giftCardCreate":{"type":"object","properties":{"value":{"type":"integer","minimum":0,"maximum":9007199254740991},"recipient_email":{"anyOf":[{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"note":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"expires_at":{"type":["string","null"]},"send":{"type":"boolean"},"message":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]}},"required":["value"]},"giftCardUpdate":{"type":"object","properties":{"active":{"type":"boolean"},"balance":{"type":"integer","minimum":0,"maximum":9007199254740991},"note":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"expires_at":{"type":["string","null"]}}},"giftCardSend":{"type":"object","properties":{"to":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"message":{"type":"string","maxLength":1000}}},"subscriptionCancel":{"type":"object","properties":{"at_period_end":{"type":"boolean"}}},"orderEdit":{"type":"object","properties":{"remove":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"variant_id":{"type":"string"},"quantity":{"type":"integer","minimum":1,"maximum":999}},"required":["variant_id","quantity"]}},"replace":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"variant_id":{"type":"string"},"with_variant_id":{"type":"string"},"quantity":{"type":"integer","minimum":1,"maximum":999}},"required":["variant_id","with_variant_id"]}},"add":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"variant_id":{"type":"string"},"quantity":{"type":"integer","minimum":1,"maximum":999}},"required":["variant_id","quantity"]}},"shipping_address":{"type":"object","properties":{"name":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"line1":{"type":"string","minLength":1,"maxLength":200},"line2":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":100},"state":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"postal_code":{"type":"string","minLength":1,"maxLength":20},"country":{"type":"string","minLength":2,"maxLength":2}},"required":["line1","city","postal_code","country"]},"email":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"waive_difference":{"type":"boolean"},"notify_customer":{"type":"boolean"},"reason":{"type":"string","maxLength":500},"dry_run":{"type":"boolean"}}},"storefrontCheck":{"type":"object","properties":{"url":{"type":"string","format":"uri"}},"required":["url"]}}}}