PUT /external/api/products

Authorization key

Body

id string Required

Minimum length is 1.
storeId string | null
active boolean | null
name string | null
description string | null
handle string Required

Minimum length is 1. Format should match the following pattern: ^[/\S]+$.
vendor string | null
isShoppingBag boolean
isVending boolean
isWeight boolean
isNotDiscountable boolean
ageGroupId string | null
relatedProductIds array[string] | null
images array[object] | null
Hide images attributes Show images attributes object
- externalId string Required
  
  Minimum length is 1.
- url string Required
  
  Minimum length is 1.
- Additional properties are NOT allowed
categoryIds array[string] | null
dimensions array[object] Required

At least 1 element.
Hide dimensions attributes Show dimensions attributes object
- name string Required
  
  Minimum length is 1.
- articleNumber string | null
- barcode string | null
  
  Maximum length is 30.
- externalId string | null
- 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
  
  Additional properties are NOT allowed
- availability object
  Hide availability attributes Show availability attributes object
  
  count integer(int32) Required
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
options array[object] | null
Hide options attributes Show options attributes object
- name string Required
  
  Minimum length is 1.
- sortIndex integer(int32) Required
- values array[string] Required
  
  At least 1 element.
- Additional properties are NOT allowed
Additional properties are NOT allowed

Body

id string Required

Minimum length is 1.
storeId string | null
active boolean | null
name string | null
description string | null
handle string Required

Minimum length is 1. Format should match the following pattern: ^[/\S]+$.
vendor string | null
isShoppingBag boolean
isVending boolean
isWeight boolean
isNotDiscountable boolean
ageGroupId string | null
relatedProductIds array[string] | null
images array[object] | null
Hide images attributes Show images attributes object
- externalId string Required
  
  Minimum length is 1.
- url string Required
  
  Minimum length is 1.
- Additional properties are NOT allowed
categoryIds array[string] | null
dimensions array[object] Required

At least 1 element.
Hide dimensions attributes Show dimensions attributes object
- name string Required
  
  Minimum length is 1.
- articleNumber string | null
- barcode string | null
  
  Maximum length is 30.
- externalId string | null
- 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
  
  Additional properties are NOT allowed
- availability object
  Hide availability attributes Show availability attributes object
  
  count integer(int32) Required
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
options array[object] | null
Hide options attributes Show options attributes object
- name string Required
  
  Minimum length is 1.
- sortIndex integer(int32) Required
- values array[string] Required
  
  At least 1 element.
- Additional properties are NOT allowed
Additional properties are NOT allowed

Body

id string Required

Minimum length is 1.
storeId string | null
active boolean | null
name string | null
description string | null
handle string Required

Minimum length is 1. Format should match the following pattern: ^[/\S]+$.
vendor string | null
isShoppingBag boolean
isVending boolean
isWeight boolean
isNotDiscountable boolean
ageGroupId string | null
relatedProductIds array[string] | null
images array[object] | null
Hide images attributes Show images attributes object
- externalId string Required
  
  Minimum length is 1.
- url string Required
  
  Minimum length is 1.
- Additional properties are NOT allowed
categoryIds array[string] | null
dimensions array[object] Required

At least 1 element.
Hide dimensions attributes Show dimensions attributes object
- name string Required
  
  Minimum length is 1.
- articleNumber string | null
- barcode string | null
  
  Maximum length is 30.
- externalId string | null
- 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
  
  Additional properties are NOT allowed
- availability object
  Hide availability attributes Show availability attributes object
  
  count integer(int32) Required
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
options array[object] | null
Hide options attributes Show options attributes object
- name string Required
  
  Minimum length is 1.
- sortIndex integer(int32) Required
- values array[string] Required
  
  At least 1 element.
- Additional properties are NOT allowed
Additional properties are NOT allowed

Responses

200

Success

PUT /external/api/products

curl \
 --request PUT 'https://demo.api.fygi.store/external/api/products' \
 --header "authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '[{"id":"string","storeId":"string","active":true,"name":"string","description":"string","handle":"string","vendor":"string","isShoppingBag":true,"isVending":true,"isWeight":true,"isNotDiscountable":true,"ageGroupId":"string","relatedProductIds":["string"],"images":[{"externalId":"string","url":"string"}],"categoryIds":["string"],"dimensions":[{"name":"string","articleNumber":"string","barcode":"string","externalId":"string","sortIndex":42,"requiredDimensionId":"string","productOption1Value":"string","productOption2Value":"string","productOption3Value":"string","prices":[{"currencyCode":"string","amount":42,"taxPercent":42,"adjustmentType":"string"}],"availability":{"count":42}}],"options":[{"name":"string","sortIndex":42,"values":["string"]}]}]'

curl \
 --request PUT 'https://demo.api.fygi.store/external/api/products' \
 --header "authorization: $API_KEY" \
 --header "Content-Type: text/json"

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

Request examples

[
  {
    "id": "string",
    "storeId": "string",
    "active": true,
    "name": "string",
    "description": "string",
    "handle": "string",
    "vendor": "string",
    "isShoppingBag": true,
    "isVending": true,
    "isWeight": true,
    "isNotDiscountable": true,
    "ageGroupId": "string",
    "relatedProductIds": [
      "string"
    ],
    "images": [
      {
        "externalId": "string",
        "url": "string"
      }
    ],
    "categoryIds": [
      "string"
    ],
    "dimensions": [
      {
        "name": "string",
        "articleNumber": "string",
        "barcode": "string",
        "externalId": "string",
        "sortIndex": 42,
        "requiredDimensionId": "string",
        "productOption1Value": "string",
        "productOption2Value": "string",
        "productOption3Value": "string",
        "prices": [
          {
            "currencyCode": "string",
            "amount": 42,
            "taxPercent": 42,
            "adjustmentType": "string"
          }
        ],
        "availability": {
          "count": 42
        }
      }
    ],
    "options": [
      {
        "name": "string",
        "sortIndex": 42,
        "values": [
          "string"
        ]
      }
    ]
  }
]

Request examples

[
  {
    "id": "string",
    "storeId": "string",
    "active": true,
    "name": "string",
    "description": "string",
    "handle": "string",
    "vendor": "string",
    "isShoppingBag": true,
    "isVending": true,
    "isWeight": true,
    "isNotDiscountable": true,
    "ageGroupId": "string",
    "relatedProductIds": [
      "string"
    ],
    "images": [
      {
        "externalId": "string",
        "url": "string"
      }
    ],
    "categoryIds": [
      "string"
    ],
    "dimensions": [
      {
        "name": "string",
        "articleNumber": "string",
        "barcode": "string",
        "externalId": "string",
        "sortIndex": 42,
        "requiredDimensionId": "string",
        "productOption1Value": "string",
        "productOption2Value": "string",
        "productOption3Value": "string",
        "prices": [
          {
            "currencyCode": "string",
            "amount": 42,
            "taxPercent": 42,
            "adjustmentType": "string"
          }
        ],
        "availability": {
          "count": 42
        }
      }
    ],
    "options": [
      {
        "name": "string",
        "sortIndex": 42,
        "values": [
          "string"
        ]
      }
    ]
  }
]

Request examples

[
  {
    "id": "string",
    "storeId": "string",
    "active": true,
    "name": "string",
    "description": "string",
    "handle": "string",
    "vendor": "string",
    "isShoppingBag": true,
    "isVending": true,
    "isWeight": true,
    "isNotDiscountable": true,
    "ageGroupId": "string",
    "relatedProductIds": [
      "string"
    ],
    "images": [
      {
        "externalId": "string",
        "url": "string"
      }
    ],
    "categoryIds": [
      "string"
    ],
    "dimensions": [
      {
        "name": "string",
        "articleNumber": "string",
        "barcode": "string",
        "externalId": "string",
        "sortIndex": 42,
        "requiredDimensionId": "string",
        "productOption1Value": "string",
        "productOption2Value": "string",
        "productOption3Value": "string",
        "prices": [
          {
            "currencyCode": "string",
            "amount": 42,
            "taxPercent": 42,
            "adjustmentType": "string"
          }
        ],
        "availability": {
          "count": 42
        }
      }
    ],
    "options": [
      {
        "name": "string",
        "sortIndex": 42,
        "values": [
          "string"
        ]
      }
    ]
  }
]