{"openapi":"3.0.0","info":{"title":"SKU Generator","description":"This API can be used to generate SKU identifiers.\n\n# General Usage\n\nThe Stock Keeping Unit (SKU), i.e. a merchant-specific identifier used to keep track of the inventory of a \ncustomer. Typically, a SKU is used to track an item in the customer's inventory by the customer. Each individual \nitem has a unique identifier to track each item in an inventory.\n\nWe will use the SKU to identify products in a database rather than an inventory. It's the same thing, but a \nproduct in a database is not the same as every single item in an inventory.\n\n## Support\n\nIf you have trouble making any standard requests that our system permits, please\n[send us](mailto:contact-project+ibthedatacompany-ibapi-nl-sku-generator-39656908-issue-@incoming.gitlab.com)\na full copy of the request(s) that you're attempting, including all headers (without the authentication token),\nso that we may investigate further.\n\n## Getting Started\n\nBefore _you_ can use this API, _you_ first need an `authentication token`. This token can be obtained from\nthe IB.nl [Login API](https:\/\/login.ib.nl\/).\n\n## Authorize\n\nAdd the `token` to the [Authorization](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Authorization)\nheader prefixed with [bearer](https:\/\/www.rfc-editor.org\/rfc\/rfc6750.html).\n\n``` shell\n$ curl -X 'GET' 'https:\/\/sku.ibapi.nl\/configs' \\\n       -H 'Accept: application\/json' \\\n       -H 'Authorization: Bearer <token>'\n```","version":"v1.6.3"},"servers":[{"url":"https:\/\/sku.ibapi.nl","description":"production"}],"paths":{"\/configs":{"get":{"operationId":"api_configs_get_collection","tags":["Config"],"responses":{"200":{"description":"Config collection","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Config-output"}}},"text\/html":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Config-output"}}}}},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","readOnly":true,"default":"https:\/\/tools.ietf.org\/html\/rfc2616#section-10"},"title":{"type":"string","readOnly":true,"default":"An error occurred"},"detail":{"type":"string","readOnly":true,"default":"Access Denied."}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","readOnly":true,"default":401},"message":{"type":"string","readOnly":true,"default":"JWT Token not found"}}}}}}},"summary":"Retrieves the collection of Config resources.","description":"Retrieves the collection of Config resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"integer","default":1},"style":"form","explode":false,"allowReserved":false}],"deprecated":false},"post":{"operationId":"api_configs_post","tags":["Config"],"responses":{"201":{"description":"Config resource created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Config-output"}},"text\/html":{"schema":{"$ref":"#\/components\/schemas\/Config-output"}}},"links":{}},"400":{"description":"Invalid input"},"422":{"description":"Unprocessable entity"},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","readOnly":true,"default":"https:\/\/tools.ietf.org\/html\/rfc2616#section-10"},"title":{"type":"string","readOnly":true,"default":"An error occurred"},"detail":{"type":"string","readOnly":true,"default":"Access Denied."}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","readOnly":true,"default":401},"message":{"type":"string","readOnly":true,"default":"JWT Token not found"}}}}}}},"summary":"Creates a Config resource.","description":"Creates a Config resource.","parameters":[],"requestBody":{"description":"The new Config resource","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Config-input"}},"text\/html":{"schema":{"$ref":"#\/components\/schemas\/Config-input"}}},"required":true},"deprecated":false},"parameters":[]},"\/configs\/{config}\/sku":{"post":{"operationId":"api_configs_configsku_post","tags":["Sku"],"responses":{"201":{"description":"Sku resource created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Sku.SkuOutput"}},"text\/html":{"schema":{"$ref":"#\/components\/schemas\/Sku.SkuOutput"}}},"links":{}},"400":{"description":"Invalid input"},"422":{"description":"Unprocessable entity"},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","readOnly":true,"default":"https:\/\/tools.ietf.org\/html\/rfc2616#section-10"},"title":{"type":"string","readOnly":true,"default":"An error occurred"},"detail":{"type":"string","readOnly":true,"default":"Access Denied."}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","readOnly":true,"default":401},"message":{"type":"string","readOnly":true,"default":"JWT Token not found"}}}}}}},"summary":"Creates a Sku resource.","description":"Creates a Sku resource.","parameters":[{"name":"config","in":"path","description":"Config identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"requestBody":{"description":"The new Sku resource","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Sku.SkuInput"}},"text\/html":{"schema":{"$ref":"#\/components\/schemas\/Sku.SkuInput"}}},"required":true},"deprecated":true},"parameters":[]},"\/configs\/{config}\/sku-bulk":{"post":{"operationId":"api_configs_configsku-bulk_post","tags":["Sku"],"responses":{"201":{"description":"Sku resource created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Sku.SkuBulkOutput"}},"text\/html":{"schema":{"$ref":"#\/components\/schemas\/Sku.SkuBulkOutput"}}},"links":{}},"400":{"description":"Invalid input"},"422":{"description":"Unprocessable entity"},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","readOnly":true,"default":"https:\/\/tools.ietf.org\/html\/rfc2616#section-10"},"title":{"type":"string","readOnly":true,"default":"An error occurred"},"detail":{"type":"string","readOnly":true,"default":"Access Denied."}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","readOnly":true,"default":401},"message":{"type":"string","readOnly":true,"default":"JWT Token not found"}}}}}}},"summary":"Creates a Sku resource.","description":"Creates a Sku resource.","parameters":[{"name":"config","in":"path","description":"Config identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"requestBody":{"description":"The new Sku resource","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Sku.SkuBulkInput"}},"text\/html":{"schema":{"$ref":"#\/components\/schemas\/Sku.SkuBulkInput"}}},"required":true},"deprecated":false},"parameters":[]},"\/configs\/{id}":{"get":{"operationId":"api_configs_id_get","tags":["Config"],"responses":{"200":{"description":"Config resource","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Config-output"}},"text\/html":{"schema":{"$ref":"#\/components\/schemas\/Config-output"}}}},"404":{"description":"Resource not found"},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","readOnly":true,"default":"https:\/\/tools.ietf.org\/html\/rfc2616#section-10"},"title":{"type":"string","readOnly":true,"default":"An error occurred"},"detail":{"type":"string","readOnly":true,"default":"Access Denied."}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","readOnly":true,"default":401},"message":{"type":"string","readOnly":true,"default":"JWT Token not found"}}}}}}},"summary":"Retrieves a Config resource.","description":"Retrieves a Config resource.","parameters":[{"name":"id","in":"path","description":"Config identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"deprecated":false},"delete":{"operationId":"api_configs_id_delete","tags":["Config"],"responses":{"204":{"description":"Config resource deleted"},"404":{"description":"Resource not found"},"403":{"description":"Forbidden","content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","readOnly":true,"default":"https:\/\/tools.ietf.org\/html\/rfc2616#section-10"},"title":{"type":"string","readOnly":true,"default":"An error occurred"},"detail":{"type":"string","readOnly":true,"default":"Access Denied."}}}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","readOnly":true,"default":401},"message":{"type":"string","readOnly":true,"default":"JWT Token not found"}}}}}}},"summary":"Removes the Config resource.","description":"Removes the Config resource.","parameters":[{"name":"id","in":"path","description":"Config identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"deprecated":false},"parameters":[]}},"components":{"schemas":{"Config-input":{"type":"object","description":"Configuration for the SKU generator.","deprecated":false,"required":["attributeMaxLength","counterFixedLength"],"properties":{"attributeMaxLength":{"minimum":0,"description":"The maximum length an attribute can have.\n        eg. attributes: \"[group, prod]\"; attributeMaxLength: 3; result: \"gropro1\".","type":"integer","nullable":true},"separate":{"minLength":0,"maxLength":1,"description":"A character that separates the attributes from each other, and the counter.\n        eg. attributes: \"[group, prod]\"; seperator: \"\/\"; result: \"group\/prod\/1\".","example":"-","type":"string","nullable":true},"counterFixedLength":{"minimum":0,"description":"The counter length. eg. attributes: \"[group, prod]\"; counterFixedLength: 3; result: \"groupprod001\"","type":"integer","nullable":true},"counterAlphanumeric":{"description":"Use alphanumeric counter system (base 36). eg. 9+1=a; a+1=b; y+1=z; z+1=10; z+10=19; z+11=1a; z9+1=za;","example":"false","type":"boolean"}}},"Config-output":{"type":"object","description":"Configuration for the SKU generator.","deprecated":false,"properties":{"id":{"readOnly":true,"type":"string","nullable":true},"attributeMaxLength":{"minimum":0,"description":"The maximum length an attribute can have.\n        eg. attributes: \"[group, prod]\"; attributeMaxLength: 3; result: \"gropro1\".","type":"integer","nullable":true},"separate":{"minLength":0,"maxLength":1,"description":"A character that separates the attributes from each other, and the counter.\n        eg. attributes: \"[group, prod]\"; seperator: \"\/\"; result: \"group\/prod\/1\".","example":"-","type":"string","nullable":true},"counterFixedLength":{"minimum":0,"description":"The counter length. eg. attributes: \"[group, prod]\"; counterFixedLength: 3; result: \"groupprod001\"","type":"integer","nullable":true},"counterAlphanumeric":{"description":"Use alphanumeric counter system (base 36). eg. 9+1=a; a+1=b; y+1=z; z+1=10; z+10=19; z+11=1a; z9+1=za;","example":"false","type":"boolean"}},"required":["attributeMaxLength","counterFixedLength"]},"Sku.SkuBulkInput":{"type":"object","description":"","deprecated":false,"properties":{"items":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"string"}}}},"description":"Generate SKU identifiers"}}},"Sku.SkuBulkOutput":{"type":"object","description":"","deprecated":false,"properties":{"items":{"type":"array","items":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"string"}},"sku":{"type":"string"}}}}}},"Sku.SkuInput":{"type":"object","description":"","deprecated":true,"required":["attributes"],"properties":{"attributes":{"type":"array","items":{"type":"string"}}}},"Sku.SkuOutput":{"type":"object","description":"","deprecated":true,"properties":{"sku":{"type":"string"}}}},"responses":{},"parameters":{},"examples":{},"requestBodies":{},"headers":{},"securitySchemes":{"JWT":{"type":"apiKey","description":"Value for the Authorization header parameter.","name":"Authorization","in":"header"}}},"security":[{"JWT":[]}],"tags":[]}