# Docs

- Checkout
  - Checkout API 2021-02-23 (Legacy)
    - [Introduction](/docs/checkout/2021-02-23): Smake Checkout API — Introduction
    - Setup
      - [Authentication](/docs/checkout/2021-02-23/setup/authentication): Smake Checkout API — Authentication
      - [Headers](/docs/checkout/2021-02-23/setup/headers): Smake Checkout API — Headers
      - [Test Mode](/docs/checkout/2021-02-23/setup/test-mode): Smake Checkout API — Test Mode
    - Basic Usage
      - [Request](/docs/checkout/2021-02-23/basic/request): Smake Checkout API — Request
      - [HTTP Status](/docs/checkout/2021-02-23/basic/http-status): Smake Checkout API — HTTP Status
      - [Response](/docs/checkout/2021-02-23/basic/response): Smake Checkout API — Response
      - [Expanding Objects](/docs/checkout/2021-02-23/basic/expanding-objects): Smake Checkout API — Expanding Objects
      - [Pagination](/docs/checkout/2021-02-23/basic/pagination): Smake Checkout API — Pagination
      - [Filtering](/docs/checkout/2021-02-23/basic/filtering): Smake Checkout API — Filtering
      - [Rate Limit](/docs/checkout/2021-02-23/basic/rate-limit): Smake Checkout API — Rate Limit
      - [Conditional Request](/docs/checkout/2021-02-23/basic/conditional-request): Smake Checkout API — Conditional Request
      - [Pooling](/docs/checkout/2021-02-23/basic/polling): Smake Checkout API — Pooling
      - [Webhooks](/docs/checkout/2021-02-23/basic/webhooks): Smake Checkout API — Webhooks
      - [Request Id](/docs/checkout/2021-02-23/basic/request-id): Smake Checkout API — Request Id
      - [Localization](/docs/checkout/2021-02-23/basic/localization): Smake Checkout API — Localization
    - Endpoints
      - [Media](/docs/checkout/2021-02-23/endpoints/media): Smake Checkout API — Media
      - [Products](/docs/checkout/2021-02-23/endpoints/products): Smake Checkout API — Products
      - [Additional Instructions](/docs/checkout/2021-02-23/endpoints/additional-instructions): Smake Checkout API — Additional Instructions
      - [Variants](/docs/checkout/2021-02-23/endpoints/variants): Smake Checkout API — Variants
      - [Payment methods](/docs/checkout/2021-02-23/endpoints/payment-methods): Smake Checkout API — Payment methods
      - [Checkouts](/docs/checkout/2021-02-23/endpoints/checkouts): Smake Checkout API — Checkouts
      - [Orders](/docs/checkout/2021-02-23/endpoints/orders): Smake Checkout API — Orders
      - [Webhooks](/docs/checkout/2021-02-23/endpoints/webhooks): Smake Checkout API — Webhooks
    - References
      - [Versioning](/docs/checkout/2021-02-23/references/versioning): Smake Checkout API — Versioning
      - [Changelog](/docs/checkout/2021-02-23/references/changelog): Smake Checkout API — Changelog
  - Checkout API 2022-02-01
    - [Introduction](/docs/checkout/2022-02-01): Smake Checkout API — Introduction
    - Setup
      - [Authentication](/docs/checkout/2022-02-01/setup/authentication): Smake Checkout API — Authentication
      - [Headers](/docs/checkout/2022-02-01/setup/headers): Smake Checkout API — Headers
      - [Test Mode](/docs/checkout/2022-02-01/setup/test-mode): Smake Checkout API — Test Mode
    - Basic Usage
      - [Request](/docs/checkout/2022-02-01/basic/request): Smake Checkout API — Request
      - [HTTP Status](/docs/checkout/2022-02-01/basic/http-status): Smake Checkout API — HTTP Status
      - [Response](/docs/checkout/2022-02-01/basic/response): Smake Checkout API — Response
      - [Expanding Objects](/docs/checkout/2022-02-01/basic/expanding-objects): Smake Checkout API — Expanding Objects
      - [Pagination](/docs/checkout/2022-02-01/basic/pagination): Smake Checkout API — Pagination
      - [Batch-Endpoints](/docs/checkout/2022-02-01/basic/batch-filtering): Smake Checkout API — Batch-Endpoints
      - [Filtering](/docs/checkout/2022-02-01/basic/filtering): Smake Checkout API — Filtering
      - [Rate Limit](/docs/checkout/2022-02-01/basic/rate-limit): Smake Checkout API — Rate Limit
      - [Conditional Request](/docs/checkout/2022-02-01/basic/conditional-request): Smake Checkout API — Conditional Request
      - [Polling](/docs/checkout/2022-02-01/basic/polling): Smake Checkout API — Polling
      - [Webhooks](/docs/checkout/2022-02-01/basic/webhooks): Smake Checkout API — Webhooks
      - [Request Id](/docs/checkout/2022-02-01/basic/request-id): Smake Checkout API — Request Id
      - [Localization](/docs/checkout/2022-02-01/basic/localization): Smake Checkout API — Localization
      - [Requested data](/docs/checkout/2022-02-01/basic/requested-data): Smake Checkout API — Requested data
    - Endpoints
      - Variants: Product variants — the sellable unit that gets designed and ordered.
        - [List variants](/docs/checkout/2022-02-01/endpoints/variants/listVariants): Returns a paginated collection of variants.

**Filtering**
- `?filter[id]=1` or `?filter[id]=1,2,3` — one or more variant IDs
- `?filter[sku]=TS-100-BLK-M` — by SKU
- `?filter[since_id]=1` — IDs greater than the given ID

**Expanding objects** — `?expand=product`, `?expand=customizations`
— see [Basic Usage → Expanding Objects](/docs/checkout/2022-02-01/basic/expanding-objects).
        - [Show a variant](/docs/checkout/2022-02-01/endpoints/variants/showVariant): Returns a single variant including its current customizations.
        - [Design a variant](/docs/checkout/2022-02-01/endpoints/variants/designVariant): Applies customizations (logos, texts) to a variant. Designs are processed
**asynchronously** — poll the variant or subscribe to the
`variant.completed` / `variant.failed` webhook events to get the result
— see [Basic Usage → Polling](/docs/checkout/2022-02-01/basic/polling) and [Webhooks](/docs/checkout/2022-02-01/basic/webhooks).

Each customization targets a view area of the product and references
either an existing logo/text or an inline media object.
      - Orders: Orders are created when the checkout process is complete.
        - [List orders](/docs/checkout/2022-02-01/endpoints/orders/listOrders): Returns a collection of created orders.

**Filtering** — see [Basic Usage → Filtering](/docs/checkout/2022-02-01/basic/filtering)
- `?filter[id]=1,2,3` — one or more order IDs
- `?filter[state]=completed` / `cancelled` — by state
- `?filter[external_identifier]=organic` — by your own identifier
- `?filter[external_reference]=143000` — by your own reference
- `?filter[since_id]=1` — IDs greater than the given ID
- `?filter[created_at_min]=2025-09-27` / `created_at_max` — created in range
- `?filter[updated_at_min]` / `updated_at_max` — updated in range

**Expanding objects** ([Basic Usage → Expanding Objects](/docs/checkout/2022-02-01/basic/expanding-objects)) —
`?expand=order_type`, `?expand=items.id_tags`, `?expand=items.variant`.
        - [Create an order](/docs/checkout/2022-02-01/endpoints/orders/createOrder): Creates an order from designed variants (see [Variants → Design](/docs/checkout/2022-02-01/endpoints/variants/designVariant)).
Variants must be in state `completed` before they can be ordered; orders with pending designs are
rejected with a validation error. Use `external_identifier` /
`external_reference` to link the order to your shop system —
both are returned in every webhook payload.
        - [Show an order](/docs/checkout/2022-02-01/endpoints/orders/showOrder)
        - [Cancel an order](/docs/checkout/2022-02-01/endpoints/orders/cancelOrder): Cancels an order that has not entered production yet. Once production
has started the order can no longer be cancelled and this endpoint
returns a validation error. Subscribe to `order.cancelled` ([Basic Usage → Webhooks](/docs/checkout/2022-02-01/basic/webhooks))
to be notified when the cancellation is completed.
      - Customers: End customers of your shop.
        - [List customers](/docs/checkout/2022-02-01/endpoints/customers/listCustomers): Returns a collection of customers.

**Filtering** — `?filter[id]=1,2,3`, `?filter[email]=jane@example.com`,
`?filter[external_identifier]=crm-4711`.
        - [Show a customer](/docs/checkout/2022-02-01/endpoints/customers/showCustomer)
      - Products: Products group variants (sizes, colors).
        - [List products](/docs/checkout/2022-02-01/endpoints/products/listProducts): Returns a collection of products. Expand `variants` to embed the
sellable variants of each product.
        - [Show a product](/docs/checkout/2022-02-01/endpoints/products/showProduct)
      - Logos: Uploaded logos and their production-ready design state.
        - [List logos](/docs/checkout/2022-02-01/endpoints/logos/listLogos): Returns a collection of logos.

**Filtering** — `?filter[id]=1,2,3`, `?filter[state]=completed`.
**Expanding** — `?expand=production_method`.
        - [Create a logo](/docs/checkout/2022-02-01/endpoints/logos/createLogo): Creates a logo from an [uploaded media object](/docs/checkout/2022-02-01/endpoints/media/uploadMedia) or a public URL.
You have to choose **exactly one** of `media.id` or `media.url`.
Processing is asynchronous — listen to `logo.completed` / `logo.failed`
(see [Basic Usage → Webhooks](/docs/checkout/2022-02-01/basic/webhooks)).
        - [Show a logo](/docs/checkout/2022-02-01/endpoints/logos/showLogo)
      - Texts: Text personalizations (names, initials) with font and color.
        - [List texts](/docs/checkout/2022-02-01/endpoints/texts/listTexts): Returns a collection of text personalizations.
        - [Show a text](/docs/checkout/2022-02-01/endpoints/texts/showText)
      - Media: Raw media uploads used for logos and designs.
        - [Upload media](/docs/checkout/2022-02-01/endpoints/media/uploadMedia): Uploads a raw image file (`multipart/form-data`). The returned media `id` can then be used to
[create a logo](/docs/checkout/2022-02-01/endpoints/logos/createLogo) or
[design a variant](/docs/checkout/2022-02-01/endpoints/variants/designVariant).
        - [Show a media object](/docs/checkout/2022-02-01/endpoints/media/showMedia)
      - Webhooks: Subscriptions that notify your system about order, variant, logo and shipment events.
        - [List webhook subscriptions](/docs/checkout/2022-02-01/endpoints/webhooks/listWebhooks)
        - [Create a webhook subscription](/docs/checkout/2022-02-01/endpoints/webhooks/createWebhook): Subscribes a URL to one or more events. Deliveries are signed —
see [Basic Usage → Webhooks](/docs/checkout/2022-02-01/basic/webhooks) for signature verification.
        - [Show a webhook subscription](/docs/checkout/2022-02-01/endpoints/webhooks/showWebhook)
        - [Delete a webhook subscription](/docs/checkout/2022-02-01/endpoints/webhooks/deleteWebhook)
        - [Update a webhook subscription](/docs/checkout/2022-02-01/endpoints/webhooks/updateWebhook)
      - Payment Methods: Payment methods available in the checkout.
        - [List payment methods](/docs/checkout/2022-02-01/endpoints/payment-methods/listPaymentMethods)
      - Shipping Methods: Shipping methods available in the checkout.
        - [List shipping methods](/docs/checkout/2022-02-01/endpoints/shipping-methods/listShippingMethods)
      - Production Methods: Embellishment techniques (DTG, embroidery, DTF, …) offered by the production.
        - [List production methods](/docs/checkout/2022-02-01/endpoints/production-methods/listProductionMethods): Returns the embellishment techniques offered by the production
(e.g. DTG, embroidery, DTF). Logos and texts reference one of these.
      - Additional Instructions: Manual production steps that can be booked with a variant design.
        - [List additional instructions](/docs/checkout/2022-02-01/endpoints/additional-instructions/listAdditionalInstructions): Returns manual production steps that can be booked together with a
variant design (see [Variants → Design](/docs/checkout/2022-02-01/endpoints/variants/designVariant)).
        - [Show an additional instruction](/docs/checkout/2022-02-01/endpoints/additional-instructions/showAdditionalInstruction)
    - References
      - [Versioning](/docs/checkout/2022-02-01/references/versioning): Smake Checkout API — Versioning
      - [Changelog](/docs/checkout/2022-02-01/references/changelog): Smake Checkout API — Changelog
- Master
  - Master API 2022-07-01
    - [Introduction](/docs/master/2022-07-01): Smake Master API — Introduction
    - Setup
      - [Authentication](/docs/master/2022-07-01/setup/authentication): Smake Master API — Authentication
      - [Headers](/docs/master/2022-07-01/setup/headers): Smake Master API — Headers
    - Basic Usage
      - [Request](/docs/master/2022-07-01/basic/request): Smake Master API — Request
      - [HTTP Status](/docs/master/2022-07-01/basic/http-status): Smake Master API — HTTP Status
      - [Response](/docs/master/2022-07-01/basic/response): Smake Master API — Response
      - [Expanding Objects](/docs/master/2022-07-01/basic/expanding-objects): Smake Master API — Expanding Objects
      - [Pagination](/docs/master/2022-07-01/basic/pagination): Smake Master API — Pagination
      - [Batch-Endpoints](/docs/master/2022-07-01/basic/batch-filtering): Smake Master API — Batch-Endpoints
      - [Filtering](/docs/master/2022-07-01/basic/filtering): Smake Master API — Filtering
      - [Rate Limit](/docs/master/2022-07-01/basic/rate-limit): Smake Master API — Rate Limit
      - [Conditional Request](/docs/master/2022-07-01/basic/conditional-request): Smake Master API — Conditional Request
      - [Webhooks](/docs/master/2022-07-01/basic/webhooks): Smake Master API — Webhooks
      - [Request Id](/docs/master/2022-07-01/basic/request-id): Smake Master API — Request Id
      - [Date and time](/docs/master/2022-07-01/basic/date-time): Smake Master API — Date and time
      - [Temporary Upload](/docs/master/2022-07-01/basic/temporary-upload-url): Smake Master API — Temporary Upload
    - Endpoints
      - [Import Process](/docs/master/2022-07-01/endpoints/temporary-upload-url): Smake Master API — Import Process
      - [Product](/docs/master/2022-07-01/endpoints/product): Smake Master API — Product
      - [Product Fetch EU](/docs/master/2022-07-01/endpoints/product-strauss-usa): Smake Master API — Product Fetch EU
      - [Variant](/docs/master/2022-07-01/endpoints/variant): Smake Master API — Variant
      - [Product Option Type](/docs/master/2022-07-01/endpoints/product-option-type): Smake Master API — Product Option Type
      - [Product Option Value](/docs/master/2022-07-01/endpoints/product-option-value): Smake Master API — Product Option Value
      - [Product Option Import](/docs/master/2022-07-01/endpoints/product-option-imports): Smake Master API — Product Option Import
      - [Product Size Label](/docs/master/2022-07-01/endpoints/product-size-label): Smake Master API — Product Size Label
      - [Product Size Label Import](/docs/master/2022-07-01/endpoints/product-size-label-import): Smake Master API — Product Size Label Import
      - [Product Size Scale](/docs/master/2022-07-01/endpoints/product-size-scale): Smake Master API — Product Size Scale
      - [Product Import](/docs/master/2022-07-01/endpoints/product-import): Smake Master API — Product Import
      - [Production Method](/docs/master/2022-07-01/endpoints/production-method): Smake Master API — Production Method
      - [Positioning Area Identifier](/docs/master/2022-07-01/endpoints/positioning-area-identifier): Smake Master API — Positioning Area Identifier
      - [Annotation](/docs/master/2022-07-01/endpoints/annotation): Smake Master API — Annotation
      - [Annotation Channel](/docs/master/2022-07-01/endpoints/annotation-channel): Smake Master API — Annotation Channel
      - [Logo Color](/docs/master/2022-07-01/endpoints/logo-color): Smake Master API — Logo Color
      - [Merchant](/docs/master/2022-07-01/endpoints/merchant): Smake Master API — Merchant
      - [Merchant Product Import](/docs/master/2022-07-01/endpoints/merchant-product-importer): Smake Master API — Merchant Product Import
      - [Merchant Product](/docs/master/2022-07-01/endpoints/merchant-product): Smake Master API — Merchant Product
      - [Merchant Variant](/docs/master/2022-07-01/endpoints/merchant-variant): Smake Master API — Merchant Variant
      - [Disposition Order](/docs/master/2022-07-01/endpoints/disposition-order): Smake Master API — Disposition Order
      - [Order](/docs/master/2022-07-01/endpoints/order): Smake Master API — Order
      - [Order Patch Parcel Number](/docs/master/2022-07-01/endpoints/order-patch-parcel): Smake Master API — Order Patch Parcel Number
      - [Order Item Units](/docs/master/2022-07-01/endpoints/order-item-unit): Smake Master API — Order Item Units
      - [Production](/docs/master/2022-07-01/endpoints/production): Smake Master API — Production
      - [Timezones](/docs/master/2022-07-01/endpoints/timezone): Smake Master API — Timezones
      - [Supplier](/docs/master/2022-07-01/endpoints/supplier): Smake Master API — Supplier
      - [Id Tags](/docs/master/2022-07-01/endpoints/id-tag): Smake Master API — Id Tags
      - [Good Transfer](/docs/master/2022-07-01/endpoints/good-transfer): Smake Master API — Good Transfer
      - [Good Transfer by Parcel Number](/docs/master/2022-07-01/endpoints/good-transfer-by-parcel-number): Smake Master API — Good Transfer by Parcel Number
      - [Webhook](/docs/master/2022-07-01/endpoints/webhook): Smake Master API — Webhook
      - [Job Statuses](/docs/master/2022-07-01/endpoints/job): Smake Master API — Job Statuses
      - [Media](/docs/master/2022-07-01/endpoints/media): Smake Master API — Media
      - [Draft Order Complete](/docs/master/2022-07-01/endpoints/draft-order-complete): Smake Master API — Draft Order Complete