PATCH /external/api/products

Authorization key

Body

id string Required

Minimum length is 1.
storeId Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
Hide storeId attributes Show storeId attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
- value string | null
- Additional properties are NOT allowed
name Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
Hide name attributes Show name attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
- value string | null
- Additional properties are NOT allowed
description Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
Hide description attributes Show description attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
- value string | null
- Additional properties are NOT allowed
handle Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
Hide handle attributes Show handle attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
- value string | null
- Additional properties are NOT allowed
vendor Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
Hide vendor attributes Show vendor attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
- value string | null
- Additional properties are NOT allowed
active Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Nullable`1[object]]
Hide active attributes Show active attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Nullable`1[object]]
- value boolean | null
- Additional properties are NOT allowed
isNotDiscountable Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Nullable`1[object]]
Hide isNotDiscountable attributes Show isNotDiscountable attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Nullable`1[object]]
- value boolean | null
- Additional properties are NOT allowed
ageGroupId Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
Hide ageGroupId attributes Show ageGroupId attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
- value string | null
- Additional properties are NOT allowed
relatedProductIds Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
Hide relatedProductIds attributes Show relatedProductIds attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
- value array[string] | null
- Additional properties are NOT allowed
imageUrls Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
Hide imageUrls attributes Show imageUrls attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
- value array[string] | null
- Additional properties are NOT allowed
categoryIds Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
Hide categoryIds attributes Show categoryIds attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
- value array[string] | null
- Additional properties are NOT allowed
dimensions Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
Hide dimensions attributes Show dimensions attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
- value array[object] | null
  Hide value attributes Show value 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
- Additional properties are NOT allowed
options Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
Hide options attributes Show options attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[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.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Additional properties are NOT allowed

Body

id string Required

Minimum length is 1.
storeId Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
Hide storeId attributes Show storeId attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
- value string | null
- Additional properties are NOT allowed
name Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
Hide name attributes Show name attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
- value string | null
- Additional properties are NOT allowed
description Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
Hide description attributes Show description attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
- value string | null
- Additional properties are NOT allowed
handle Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
Hide handle attributes Show handle attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
- value string | null
- Additional properties are NOT allowed
vendor Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
Hide vendor attributes Show vendor attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
- value string | null
- Additional properties are NOT allowed
active Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Nullable`1[object]]
Hide active attributes Show active attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Nullable`1[object]]
- value boolean | null
- Additional properties are NOT allowed
isNotDiscountable Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Nullable`1[object]]
Hide isNotDiscountable attributes Show isNotDiscountable attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Nullable`1[object]]
- value boolean | null
- Additional properties are NOT allowed
ageGroupId Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
Hide ageGroupId attributes Show ageGroupId attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
- value string | null
- Additional properties are NOT allowed
relatedProductIds Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
Hide relatedProductIds attributes Show relatedProductIds attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
- value array[string] | null
- Additional properties are NOT allowed
imageUrls Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
Hide imageUrls attributes Show imageUrls attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
- value array[string] | null
- Additional properties are NOT allowed
categoryIds Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
Hide categoryIds attributes Show categoryIds attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
- value array[string] | null
- Additional properties are NOT allowed
dimensions Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
Hide dimensions attributes Show dimensions attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
- value array[object] | null
  Hide value attributes Show value 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
- Additional properties are NOT allowed
options Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
Hide options attributes Show options attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[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.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Additional properties are NOT allowed

Body

id string Required

Minimum length is 1.
storeId Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
Hide storeId attributes Show storeId attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
- value string | null
- Additional properties are NOT allowed
name Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
Hide name attributes Show name attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
- value string | null
- Additional properties are NOT allowed
description Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
Hide description attributes Show description attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
- value string | null
- Additional properties are NOT allowed
handle Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
Hide handle attributes Show handle attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
- value string | null
- Additional properties are NOT allowed
vendor Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
Hide vendor attributes Show vendor attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
- value string | null
- Additional properties are NOT allowed
active Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Nullable`1[object]]
Hide active attributes Show active attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Nullable`1[object]]
- value boolean | null
- Additional properties are NOT allowed
isNotDiscountable Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Nullable`1[object]]
Hide isNotDiscountable attributes Show isNotDiscountable attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Nullable`1[object]]
- value boolean | null
- Additional properties are NOT allowed
ageGroupId Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
Hide ageGroupId attributes Show ageGroupId attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[object]
- value string | null
- Additional properties are NOT allowed
relatedProductIds Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
Hide relatedProductIds attributes Show relatedProductIds attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
- value array[string] | null
- Additional properties are NOT allowed
imageUrls Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
Hide imageUrls attributes Show imageUrls attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
- value array[string] | null
- Additional properties are NOT allowed
categoryIds Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
Hide categoryIds attributes Show categoryIds attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
- value array[string] | null
- Additional properties are NOT allowed
dimensions Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
Hide dimensions attributes Show dimensions attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
- value array[object] | null
  Hide value attributes Show value 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
- Additional properties are NOT allowed
options Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[object]]
Hide options attributes Show options attributes Fygi.Domain.Utils.Optionals.cs.Optional`1[System.Collections.Generic.List`1[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.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Additional properties are NOT allowed

Responses

200

Success

PATCH /external/api/products

curl \
 -X PATCH http://test.api.fygi.store/external/api/products \
 -H "authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '[{"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":[{"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":{"value":[{"name":"string","sortIndex":42,"values":["string"]}]}}]'

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

curl \
 -X PATCH http://test.api.fygi.store/external/api/products \
 -H "authorization: $API_KEY" \
 -H "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": [
        {
          "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": {
      "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": [
        {
          "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": {
      "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": [
        {
          "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": {
      "value": [
        {
          "name": "string",
          "sortIndex": 42,
          "values": [
            "string"
          ]
        }
      ]
    }
  }
]