FOfourthwall
Products (offers)

Update product (offer) availability by id

Changed on

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

Updates a product (offer) availability

put/open-api/v1.0/products/{productId}/availability

Request

  • Base URL
    https://api.fourthwall.com
  • URL
    https://api.fourthwall.com/open-api/v1.0/products/{productId}/availability
  • Auth
    • OAuth 2
      Implicit: https://auth.staging.fourthwall.com/auth/realms/Fourthwall/protocol/openid-connect/auth
      Scopes: offer_write
    • or HTTP basic

Path parameters

productIdstring required

Request body

availableboolean required

Response

OK

idstring required
namestring required
slugstring required
descriptionstring required
type'STANDARD' | 'GIFT_CARD' | 'UNKNOWN' required
createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
  "name": "My t-shirt",
  "slug": "my-t-shirt",
  "description": "My t-shirt description",
  "thumbnailImage": {
    "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
    "url": "https://fourthwall.com/image.png",
    "width": 800,
    "height": 600,
    "transformedUrl": "https://fourthwall.com/image.png"
  },
  "images": [
    {
      "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
      "url": "https://fourthwall.com/image.png",
      "width": 800,
      "height": 600,
      "transformedUrl": "https://fourthwall.com/image.png"
    }
  ],
  "variants": [
    {
      "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
      "name": "My t-shirt - Black, L",
      "sku": "WDEK-DRE200L",
      "unitPrice": {
        "value": 10,
        "currency": "USD"
      },
      "compareAtPrice": {
        "value": 10,
        "currency": "USD"
      },
      "unitCost": {
        "value": 10,
        "currency": "USD"
      },
      "attributes": {
        "description": "Black, L",
        "color": {
          "name": "Black",
          "swatch": "#000000"
        },
        "size": {
          "name": "L"
        }
      },
      "creatorDeclaredCost": {
        "value": 10,
        "currency": "USD"
      },
      "stock": {
        "inStock": 5
      },
      "weight": {
        "value": 1,
        "unit": "kg"
      },
      "dimensions": {
        "length": 1,
        "width": 2,
        "height": 3,
        "unit": "cm"
      },
      "images": [
        {
          "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
          "url": "https://fourthwall.com/image.png",
          "width": 800,
          "height": 600,
          "transformedUrl": "https://fourthwall.com/image.png"
        }
      ],
      "thumbnailImage": {
        "id": "00aa4abd-5778-4199-8161-0b49b2f212e5",
        "url": "https://fourthwall.com/image.png",
        "width": 800,
        "height": 600,
        "transformedUrl": "https://fourthwall.com/image.png"
      }
    }
  ],
  "digitalFiles": [
    {
      "uri": "https://storage.googleapis.com/bucket/shop/offer/file",
      "name": "my-ebook.pdf",
      "fileSize": "15.4 MB",
      "mediaType": "application/pdf"
    }
  ],
  "createdAt": "2020-08-13T09:05:36.939Z",
  "updatedAt": "2020-08-13T09:05:36.939Z"
}

Changes

  • d02dd5a76313Revision changes
    • breaking

      added to the response property oneOf list for the response status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added PRIVATE discriminator mapping keys to the // response property for the response status

    • info

      added PRIVATE discriminator mapping keys to the // response property for the response status

    • info

      added PRIVATE discriminator mapping keys to the // response property for the response status