FOfourthwall
Design Pipeline

Get design pipeline status

Changed on

Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.

Deprecated alongside the design-pipeline create endpoints; prefer POST /open-api/v1.0/products (type=design). Returns the current status of a design pipeline. Poll until status is DONE or ERROR. When DONE, includes rendered images and either customizationId (for previews) or offerId (for offers).

get/open-api/v1.0/design-pipeline/{pipelineId}

Request

  • Base URL
    https://api.fourthwall.com
  • URL
    https://api.fourthwall.com/open-api/v1.0/design-pipeline/{pipelineId}
  • Auth
    • OAuth 2
      Implicit: https://auth.staging.fourthwall.com/auth/realms/Fourthwall/protocol/openid-connect/auth
      Scopes: offer_read
    • or HTTP basic

Path parameters

pipelineIdstring required

Response

OK

pipelineIdstring required
statusstring required
typestring required
customizationIdstring
offerIdstring
metadataobject

Changes

  • d02dd5a76313Revision changes
    • info

      endpoint deprecated

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status