FOfourthwall
Design Pipeline

Create an offer from a design

Changed on

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

Deprecated. Use POST /open-api/v1.0/products (type=design) instead. Creates a design pipeline that generates product mockup images and creates a purchasable offer synchronously. Submit product, design placement info, and offer metadata. Returns pipelineId, customizationId, rendered images, and the created offerId in the response.

post/open-api/v1.0/design-pipeline/offers

Request

  • Base URL
    https://api.fourthwall.com
  • Auth
    • OAuth 2
      Implicit: https://auth.staging.fourthwall.com/auth/realms/Fourthwall/protocol/openid-connect/auth
      Scopes: offer_write
    • or HTTP basic

Request body

productIdstring required
colorsstring[]
sizesstring[]
namestring required
descriptionstring
publishOnCreateboolean
metadataobject

Arbitrary key-value metadata stored on the pipeline and returned by the status endpoint. At most 25 entries; keys up to 100 characters, values up to 1000 characters.

Example request

{
  "regions": [
    {
      "region": "front",
      "placementStrategy": "AUTO"
    }
  ]
}

Response

Created

pipelineIdstring required
offerIdstring
customizationIdstring

Changes

  • d02dd5a76313Revision changes
    • warning

      removed the request property //

    • info

      endpoint deprecated

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      the request property // became optional

    • info

      request property 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 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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status