PATCH /external/api/products

Authorization key

Body

id string Required

Minimum length is 1.
storeId object

Additional properties are NOT allowed.
Hide storeId attribute Show storeId attribute object
- value string | null
name object

Additional properties are NOT allowed.
Hide name attribute Show name attribute object
- value string | null
description object

Additional properties are NOT allowed.
Hide description attribute Show description attribute object
- value string | null
handle object

Additional properties are NOT allowed.
Hide handle attribute Show handle attribute object
- value string | null
vendor object

Additional properties are NOT allowed.
Hide vendor attribute Show vendor attribute object
- value string | null
active object

Additional properties are NOT allowed.
Hide active attribute Show active attribute object
- value boolean | null
isNotDiscountable object

Additional properties are NOT allowed.
Hide isNotDiscountable attribute Show isNotDiscountable attribute object
- value boolean | null
ageGroupId object

Additional properties are NOT allowed.
Hide ageGroupId attribute Show ageGroupId attribute object
- value string | null
relatedProductIds object

Additional properties are NOT allowed.
Hide relatedProductIds attribute Show relatedProductIds attribute object
- value array[string] | null
imageUrls object

Additional properties are NOT allowed.
Hide imageUrls attribute Show imageUrls attribute object
- value array[string] | null
categoryIds object

Additional properties are NOT allowed.
Hide categoryIds attribute Show categoryIds attribute object
- value array[string] | null
dimensions object

Additional properties are NOT allowed.
Hide dimensions attribute Show dimensions attribute object
- value array[object] | null
  Hide value attributes Show value attributes object
  
  id string Required
  
  Minimum length is 1.
  
  name string Required
  
  Minimum length is 1.
  
  articleNumber string | null
  
  barcode string | null
  
  Maximum length is 30.
  
  sortIndex integer(int32) | null
  
  requiredDimensionId string | null
  
  productOption1Value string | null
  
  productOption2Value string | null
  
  productOption3Value string | null
  
  prices array[object] Required
  
  At least 1 element.
  
  Hide prices attributes Show prices attributes object
  
  currencyCode string Required
  
  Minimum length is 0, maximum length is 3.
  
  amount integer(int32) Required
  
  taxPercent integer(int32) Required
  
  adjustmentType string(uuid) | null
  
  validFrom string(date-time) | null
  
  availability object
  
  Additional properties are NOT allowed.
  
  Hide availability attribute Show availability attribute object
  
  count integer(int32) Required
options object

Additional properties are NOT allowed.
Hide options attribute Show options attribute object
- value array[object] | null
  Hide value attributes Show value attributes object
  
  name string Required
  
  Minimum length is 1.
  
  sortIndex integer(int32) Required
  
  values array[string] Required
  
  At least 1 element.

Body

id string Required

Minimum length is 1.
storeId object

Additional properties are NOT allowed.
Hide storeId attribute Show storeId attribute object
- value string | null
name object

Additional properties are NOT allowed.
Hide name attribute Show name attribute object
- value string | null
description object

Additional properties are NOT allowed.
Hide description attribute Show description attribute object
- value string | null
handle object

Additional properties are NOT allowed.
Hide handle attribute Show handle attribute object
- value string | null
vendor object

Additional properties are NOT allowed.
Hide vendor attribute Show vendor attribute object
- value string | null
active object

Additional properties are NOT allowed.
Hide active attribute Show active attribute object
- value boolean | null
isNotDiscountable object

Additional properties are NOT allowed.
Hide isNotDiscountable attribute Show isNotDiscountable attribute object
- value boolean | null
ageGroupId object

Additional properties are NOT allowed.
Hide ageGroupId attribute Show ageGroupId attribute object
- value string | null
relatedProductIds object

Additional properties are NOT allowed.
Hide relatedProductIds attribute Show relatedProductIds attribute object
- value array[string] | null
imageUrls object

Additional properties are NOT allowed.
Hide imageUrls attribute Show imageUrls attribute object
- value array[string] | null
categoryIds object

Additional properties are NOT allowed.
Hide categoryIds attribute Show categoryIds attribute object
- value array[string] | null
dimensions object

Additional properties are NOT allowed.
Hide dimensions attribute Show dimensions attribute object
- value array[object] | null
  Hide value attributes Show value attributes object
  
  id string Required
  
  Minimum length is 1.
  
  name string Required
  
  Minimum length is 1.
  
  articleNumber string | null
  
  barcode string | null
  
  Maximum length is 30.
  
  sortIndex integer(int32) | null
  
  requiredDimensionId string | null
  
  productOption1Value string | null
  
  productOption2Value string | null
  
  productOption3Value string | null
  
  prices array[object] Required
  
  At least 1 element.
  
  Hide prices attributes Show prices attributes object
  
  currencyCode string Required
  
  Minimum length is 0, maximum length is 3.
  
  amount integer(int32) Required
  
  taxPercent integer(int32) Required
  
  adjustmentType string(uuid) | null
  
  validFrom string(date-time) | null
  
  availability object
  
  Additional properties are NOT allowed.
  
  Hide availability attribute Show availability attribute object
  
  count integer(int32) Required
options object

Additional properties are NOT allowed.
Hide options attribute Show options attribute object
- value array[object] | null
  Hide value attributes Show value attributes object
  
  name string Required
  
  Minimum length is 1.
  
  sortIndex integer(int32) Required
  
  values array[string] Required
  
  At least 1 element.

Body

id string Required

Minimum length is 1.
storeId object

Additional properties are NOT allowed.
Hide storeId attribute Show storeId attribute object
- value string | null
name object

Additional properties are NOT allowed.
Hide name attribute Show name attribute object
- value string | null
description object

Additional properties are NOT allowed.
Hide description attribute Show description attribute object
- value string | null
handle object

Additional properties are NOT allowed.
Hide handle attribute Show handle attribute object
- value string | null
vendor object

Additional properties are NOT allowed.
Hide vendor attribute Show vendor attribute object
- value string | null
active object

Additional properties are NOT allowed.
Hide active attribute Show active attribute object
- value boolean | null
isNotDiscountable object

Additional properties are NOT allowed.
Hide isNotDiscountable attribute Show isNotDiscountable attribute object
- value boolean | null
ageGroupId object

Additional properties are NOT allowed.
Hide ageGroupId attribute Show ageGroupId attribute object
- value string | null
relatedProductIds object

Additional properties are NOT allowed.
Hide relatedProductIds attribute Show relatedProductIds attribute object
- value array[string] | null
imageUrls object

Additional properties are NOT allowed.
Hide imageUrls attribute Show imageUrls attribute object
- value array[string] | null
categoryIds object

Additional properties are NOT allowed.
Hide categoryIds attribute Show categoryIds attribute object
- value array[string] | null
dimensions object

Additional properties are NOT allowed.
Hide dimensions attribute Show dimensions attribute object
- value array[object] | null
  Hide value attributes Show value attributes object
  
  id string Required
  
  Minimum length is 1.
  
  name string Required
  
  Minimum length is 1.
  
  articleNumber string | null
  
  barcode string | null
  
  Maximum length is 30.
  
  sortIndex integer(int32) | null
  
  requiredDimensionId string | null
  
  productOption1Value string | null
  
  productOption2Value string | null
  
  productOption3Value string | null
  
  prices array[object] Required
  
  At least 1 element.
  
  Hide prices attributes Show prices attributes object
  
  currencyCode string Required
  
  Minimum length is 0, maximum length is 3.
  
  amount integer(int32) Required
  
  taxPercent integer(int32) Required
  
  adjustmentType string(uuid) | null
  
  validFrom string(date-time) | null
  
  availability object
  
  Additional properties are NOT allowed.
  
  Hide availability attribute Show availability attribute object
  
  count integer(int32) Required
options object

Additional properties are NOT allowed.
Hide options attribute Show options attribute object
- value array[object] | null
  Hide value attributes Show value attributes object
  
  name string Required
  
  Minimum length is 1.
  
  sortIndex integer(int32) Required
  
  values array[string] Required
  
  At least 1 element.

Responses

200

Success

PATCH /external/api/products

curl \
 --request PATCH 'http://test.api.fygi.store/external/api/products' \
 --header "authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '[{"id":"string","storeId":{"value":"string"},"name":{"value":"string"},"description":{"value":"string"},"handle":{"value":"string"},"vendor":{"value":"string"},"active":{"value":true},"isNotDiscountable":{"value":true},"ageGroupId":{"value":"string"},"relatedProductIds":{"value":["string"]},"imageUrls":{"value":["string"]},"categoryIds":{"value":["string"]},"dimensions":{"value":[{"id":"string","name":"string","articleNumber":"string","barcode":"string","sortIndex":42,"requiredDimensionId":"string","productOption1Value":"string","productOption2Value":"string","productOption3Value":"string","prices":[{"currencyCode":"string","amount":42,"taxPercent":42,"adjustmentType":"string","validFrom":"2025-05-04T09:42:00Z"}],"availability":{"count":42}}]},"options":{"value":[{"name":"string","sortIndex":42,"values":["string"]}]}}]'

curl \
 --request PATCH 'http://test.api.fygi.store/external/api/products' \
 --header "authorization: $API_KEY" \
 --header "Content-Type: text/json"

curl \
 --request PATCH 'http://test.api.fygi.store/external/api/products' \
 --header "authorization: $API_KEY" \
 --header "Content-Type: application/*+json"

Request examples

[
  {
    "id": "string",
    "storeId": {
      "value": "string"
    },
    "name": {
      "value": "string"
    },
    "description": {
      "value": "string"
    },
    "handle": {
      "value": "string"
    },
    "vendor": {
      "value": "string"
    },
    "active": {
      "value": true
    },
    "isNotDiscountable": {
      "value": true
    },
    "ageGroupId": {
      "value": "string"
    },
    "relatedProductIds": {
      "value": [
        "string"
      ]
    },
    "imageUrls": {
      "value": [
        "string"
      ]
    },
    "categoryIds": {
      "value": [
        "string"
      ]
    },
    "dimensions": {
      "value": [
        {
          "id": "string",
          "name": "string",
          "articleNumber": "string",
          "barcode": "string",
          "sortIndex": 42,
          "requiredDimensionId": "string",
          "productOption1Value": "string",
          "productOption2Value": "string",
          "productOption3Value": "string",
          "prices": [
            {
              "currencyCode": "string",
              "amount": 42,
              "taxPercent": 42,
              "adjustmentType": "string",
              "validFrom": "2025-05-04T09:42:00Z"
            }
          ],
          "availability": {
            "count": 42
          }
        }
      ]
    },
    "options": {
      "value": [
        {
          "name": "string",
          "sortIndex": 42,
          "values": [
            "string"
          ]
        }
      ]
    }
  }
]

Request examples

[
  {
    "id": "string",
    "storeId": {
      "value": "string"
    },
    "name": {
      "value": "string"
    },
    "description": {
      "value": "string"
    },
    "handle": {
      "value": "string"
    },
    "vendor": {
      "value": "string"
    },
    "active": {
      "value": true
    },
    "isNotDiscountable": {
      "value": true
    },
    "ageGroupId": {
      "value": "string"
    },
    "relatedProductIds": {
      "value": [
        "string"
      ]
    },
    "imageUrls": {
      "value": [
        "string"
      ]
    },
    "categoryIds": {
      "value": [
        "string"
      ]
    },
    "dimensions": {
      "value": [
        {
          "id": "string",
          "name": "string",
          "articleNumber": "string",
          "barcode": "string",
          "sortIndex": 42,
          "requiredDimensionId": "string",
          "productOption1Value": "string",
          "productOption2Value": "string",
          "productOption3Value": "string",
          "prices": [
            {
              "currencyCode": "string",
              "amount": 42,
              "taxPercent": 42,
              "adjustmentType": "string",
              "validFrom": "2025-05-04T09:42:00Z"
            }
          ],
          "availability": {
            "count": 42
          }
        }
      ]
    },
    "options": {
      "value": [
        {
          "name": "string",
          "sortIndex": 42,
          "values": [
            "string"
          ]
        }
      ]
    }
  }
]

Request examples

[
  {
    "id": "string",
    "storeId": {
      "value": "string"
    },
    "name": {
      "value": "string"
    },
    "description": {
      "value": "string"
    },
    "handle": {
      "value": "string"
    },
    "vendor": {
      "value": "string"
    },
    "active": {
      "value": true
    },
    "isNotDiscountable": {
      "value": true
    },
    "ageGroupId": {
      "value": "string"
    },
    "relatedProductIds": {
      "value": [
        "string"
      ]
    },
    "imageUrls": {
      "value": [
        "string"
      ]
    },
    "categoryIds": {
      "value": [
        "string"
      ]
    },
    "dimensions": {
      "value": [
        {
          "id": "string",
          "name": "string",
          "articleNumber": "string",
          "barcode": "string",
          "sortIndex": 42,
          "requiredDimensionId": "string",
          "productOption1Value": "string",
          "productOption2Value": "string",
          "productOption3Value": "string",
          "prices": [
            {
              "currencyCode": "string",
              "amount": 42,
              "taxPercent": 42,
              "adjustmentType": "string",
              "validFrom": "2025-05-04T09:42:00Z"
            }
          ],
          "availability": {
            "count": 42
          }
        }
      ]
    },
    "options": {
      "value": [
        {
          "name": "string",
          "sortIndex": 42,
          "values": [
            "string"
          ]
        }
      ]
    }
  }
]