--- title: "Retail Express API" url: "https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/210b509a-613e-44ac-a87b-ef6c22c23a2c" --- # Retail Express API OpenAPI specification document. ```json {"openapi":"3.0.1","info":{"title":"Retail Express API","version":"v2.1"},"servers":[{"url":"https://api.retailexpress.com.au/v2.1"}],"paths":{"/auth/token":{"get":{"tags":["token"],"summary":"Acquires token","description":"Acquires token","operationId":"get-auth-token","parameters":[{"name":"x-api-key","in":"header","description":"Subscription key.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns authentication result"}}}},"/customers":{"get":{"tags":["customers"],"summary":"Searches Customers by parameters","description":"Searches Customers by parameters","operationId":"get-customers","parameters":[{"name":"created_since","in":"query","description":"Created since","schema":{"type":"string","description":"Created since","format":"date-time","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, customer_number, first_name, last_name, full_name, company, date_of_birth, date_of_birth_withheld, customer_type_name, \r\nmobile, phone, email, acn, fax, website, account_customer_enabled, account_customer_payment_terms, account_customer_credit_blocked, account_customer_credit_limit, \r\nbilling_address_line1, billing_address_line2, billing_address_suburb, billing_address_state, billing_address_postcode, billing_address_country,\r\ndelivery_first_name, delivery_last_name, delivery_company, delivery_address_line1, delivery_address_line2, delivery_suburb, delivery_state, delivery_postcode, delivery_country, delivery_phone, delivery_mobile,\r\nloyalty_program_enabled, loyalty_points_available, loyalty_points_available_value, loyalty_points_redeemed, loyalty_points_to_date, \r\nreceive_email, receive_post, receive_sms, price_group_standard, price_group_fixed, home_outlet_name, custom_reference, created_on, modified_on,\r\nexport_to_web, sales_channel:id, survey:id\r\n\r\nAvailable direction values: id asc, customer_number desc. \r\n\r\nExample: id asc, supplier desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, customer_number, first_name, last_name, full_name, company, date_of_birth, date_of_birth_withheld, customer_type_name, \r\nmobile, phone, email, acn, fax, website, account_customer_enabled, account_customer_payment_terms, account_customer_credit_blocked, account_customer_credit_limit, \r\nbilling_address_line1, billing_address_line2, billing_address_suburb, billing_address_state, billing_address_postcode, billing_address_country,\r\ndelivery_first_name, delivery_last_name, delivery_company, delivery_address_line1, delivery_address_line2, delivery_suburb, delivery_state, delivery_postcode, delivery_country, delivery_phone, delivery_mobile,\r\nloyalty_program_enabled, loyalty_points_available, loyalty_points_available_value, loyalty_points_redeemed, loyalty_points_to_date, \r\nreceive_email, receive_post, receive_sms, price_group_standard, price_group_fixed, home_outlet_name, custom_reference, created_on, modified_on,\r\nexport_to_web, sales_channel:id, survey:id\r\n\r\nAvailable direction values: id asc, customer_number desc. \r\n\r\nExample: id asc, supplier desc","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, customer_number, first_name, last_name, full_name, company, date_of_birth, date_of_birth_withheld, customer_type_name, \r\nmobile, phone, email, acn, fax, website, account_customer_enabled, account_customer_payment_terms, account_customer_credit_blocked, account_customer_credit_limit, \r\nbilling_address_line1, billing_address_line2, billing_address_suburb, billing_address_state, billing_address_postcode, billing_address_country,\r\ndelivery_first_name, delivery_last_name, delivery_company, delivery_address_line1, delivery_address_line2, delivery_suburb, delivery_state, delivery_postcode, delivery_country, delivery_phone, delivery_mobile,\r\nloyalty_program_enabled, loyalty_points_available, loyalty_points_available_value, loyalty_points_redeemed, loyalty_points_to_date, \r\nreceive_email, receive_post, receive_sms, price_group_standard, price_group_fixed, home_outlet_name, custom_reference, created_on, modified_on,\r\nexport_to_web, sales_channel:id, survey:id\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:eq:303062, sales_channel:3039:eq:true","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, customer_number, first_name, last_name, full_name, company, date_of_birth, date_of_birth_withheld, customer_type_name, \r\nmobile, phone, email, acn, fax, website, account_customer_enabled, account_customer_payment_terms, account_customer_credit_blocked, account_customer_credit_limit, \r\nbilling_address_line1, billing_address_line2, billing_address_suburb, billing_address_state, billing_address_postcode, billing_address_country,\r\ndelivery_first_name, delivery_last_name, delivery_company, delivery_address_line1, delivery_address_line2, delivery_suburb, delivery_state, delivery_postcode, delivery_country, delivery_phone, delivery_mobile,\r\nloyalty_program_enabled, loyalty_points_available, loyalty_points_available_value, loyalty_points_redeemed, loyalty_points_to_date, \r\nreceive_email, receive_post, receive_sms, price_group_standard, price_group_fixed, home_outlet_name, custom_reference, created_on, modified_on,\r\nexport_to_web, sales_channel:id, survey:id\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:eq:303062, sales_channel:3039:eq:true","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Customers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer.PagingResponse"},"example":{"data":[{"account_customer":{"credit_blocked":true,"credit_limit":0,"credit_remaining":0,"enabled":true,"payment_terms":0},"acn":"string","billing_address":{"country":"string","country_code":"string","state":"string","suburb":"string","address_line1":"string","address_line2":"string","postcode":"string","first_name":"string","last_name":"string"},"company":"string","customer_number":"string","customer_type":{"id":0,"name":"string"},"date_of_birth":"string","date_of_birth_withheld":true,"delivery_addresses":[{"country":"string","country_code":"string","state":"string","suburb":"string","address_line1":"string","address_line2":"string","postcode":"string","company":"string","mobile":"string","phone":"string","first_name":"string","last_name":"string","id":0,"default":true,"modified_on":"string"}],"email":"string","fax":"string","first_name":"string","id":0,"last_name":"string","loyalty_program":{"enabled":true,"points_available":0,"points_redeemed":0,"points_to_date":0,"auto_price_group":true,"points_available_value":0},"marketing":{"receive_email":true,"receive_post":true,"receive_sms":true},"mobile":"string","phone":"string","price_groups":[{"id":0,"name":"string","type":"string"}],"survey_responses":[{"id":0,"question":"string","answer":"string"}],"website":"string","home_outlet":{"id":0,"name":"string","modified_on":"string"},"custom_reference":"string","export_to_web":true,"total_payments":0,"total_transactions":0,"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"enabled":true}],"created_on":"string","modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["customers"],"summary":"Creates Customer","description":"Sample request:\r\n\r\n POST /customers\r\n {\r\n \"first_name\": \"FirstNameUser\",\r\n \"last_name\": \"LastNameUser\",\r\n \"company\": \"company\",\r\n \"abn\": \"abn\",\r\n \"phone\": \"+321\",\r\n \"fax\": \"fax\",\r\n \"mobile\": \"+123\",\r\n \"email\": \"email@lel.org\",\r\n \"website\": \"website.org\",\r\n \"custom_reference\": \"customReference\",\r\n \"export_to_web\": true,\r\n \"customer_type\": {\r\n\t \"name\": \"type1\",\r\n\t \"id\": 5\r\n },\r\n \"home_outlet\": {\r\n\t \"id\": 1,\r\n\t \"name\": \"name\"\r\n },\r\n \"date_of_birth\": \"1999-04-30\",\r\n \"date_of_birth_withheld\": false,\r\n \"marketing\":{\r\n\t \"receive_email\": true,\r\n\t \"receive_post\": true,\r\n\t \"receive_sms\": true\r\n }, \r\n \"price_groups\": [\r\n {\r\n\t \"id\": 1,\r\n\t \"name\": \"name1\",\r\n\t \"type\": \"Standard\"\r\n },\r\n {\r\n\t \"id\": 5,\r\n\t \"name\": \"name2\",\r\n\t \"type\": \"Fixed\"\r\n }],\r\n \"billing_address\": {\r\n \"address_line1\": \"address_line1\",\r\n \"address_line2\": \"address_line2\",\r\n \"suburb\": \"suburb\",\r\n \"state\": \"state\",\r\n \"postcode\": \"postcode\",\r\n \"country\": \"country\"\r\n },\r\n \"loyalty_program\": {\r\n \"enabled\": false,\r\n \"auto_price_group\": false\r\n },\r\n \"account_customer\": {\r\n \"enabled\": false,\r\n \"payment_terms\": 0,\r\n \"credit_limit\": 0,\r\n \"credit_blocked\": false,\r\n \"credit_remaining\": 10\r\n },\r\n \"survey_responses\": [{\r\n \"id\": 1,\r\n \"question\": \"question1\",\r\n \"answer\": \"answer\"\r\n }],\r\n \"sales_channels\": [{\r\n \"id\": 1\r\n },\r\n {\r\n \"id\": 2\r\n }]\r\n }","operationId":"post-customers","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Customer created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"},"example":{"account_customer":{"credit_blocked":true,"credit_limit":0,"credit_remaining":0,"enabled":true,"payment_terms":0},"acn":"string","billing_address":{"country":"string","country_code":"string","state":"string","suburb":"string","address_line1":"string","address_line2":"string","postcode":"string","first_name":"string","last_name":"string"},"company":"string","customer_number":"string","customer_type":{"id":0,"name":"string"},"date_of_birth":"string","date_of_birth_withheld":true,"delivery_addresses":[{"country":"string","country_code":"string","state":"string","suburb":"string","address_line1":"string","address_line2":"string","postcode":"string","company":"string","mobile":"string","phone":"string","first_name":"string","last_name":"string","id":0,"default":true,"modified_on":"string"}],"email":"string","fax":"string","first_name":"string","id":0,"last_name":"string","loyalty_program":{"enabled":true,"points_available":0,"points_redeemed":0,"points_to_date":0,"auto_price_group":true,"points_available_value":0},"marketing":{"receive_email":true,"receive_post":true,"receive_sms":true},"mobile":"string","phone":"string","price_groups":[{"id":0,"name":"string","type":"string"}],"survey_responses":[{"id":0,"question":"string","answer":"string"}],"website":"string","home_outlet":{"id":0,"name":"string","modified_on":"string"},"custom_reference":"string","export_to_web":true,"total_payments":0,"total_transactions":0,"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"enabled":true}],"created_on":"string","modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/customers/{id}":{"get":{"tags":["customers"],"summary":"Gets specific Customer by unique id","description":"Gets specific Customer by unique id","operationId":"get-customers-id","parameters":[{"name":"id","in":"path","description":"Customer id","required":true,"schema":{"type":"integer","description":"Customer id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Customer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"},"example":{"account_customer":{"credit_blocked":true,"credit_limit":0,"credit_remaining":0,"enabled":true,"payment_terms":0},"acn":"string","billing_address":{"country":"string","country_code":"string","state":"string","suburb":"string","address_line1":"string","address_line2":"string","postcode":"string","first_name":"string","last_name":"string"},"company":"string","customer_number":"string","customer_type":{"id":0,"name":"string"},"date_of_birth":"string","date_of_birth_withheld":true,"delivery_addresses":[{"country":"string","country_code":"string","state":"string","suburb":"string","address_line1":"string","address_line2":"string","postcode":"string","company":"string","mobile":"string","phone":"string","first_name":"string","last_name":"string","id":0,"default":true,"modified_on":"string"}],"email":"string","fax":"string","first_name":"string","id":0,"last_name":"string","loyalty_program":{"enabled":true,"points_available":0,"points_redeemed":0,"points_to_date":0,"auto_price_group":true,"points_available_value":0},"marketing":{"receive_email":true,"receive_post":true,"receive_sms":true},"mobile":"string","phone":"string","price_groups":[{"id":0,"name":"string","type":"string"}],"survey_responses":[{"id":0,"question":"string","answer":"string"}],"website":"string","home_outlet":{"id":0,"name":"string","modified_on":"string"},"custom_reference":"string","export_to_web":true,"total_payments":0,"total_transactions":0,"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"enabled":true}],"created_on":"string","modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Customer not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["customers"],"summary":"Updates Customer","description":"Sample request:\r\n\r\n PUT /customers\r\n {\r\n \"first_name\": \"FirstNameUser\",\r\n \"last_name\": \"LastNameUser\",\r\n \"company\": \"company\",\r\n \"abn\": \"abn\",\r\n \"phone\": \"+321\",\r\n \"fax\": \"fax\",\r\n \"mobile\": \"+123\",\r\n \"email\": \"email@lel.org\",\r\n \"website\": \"website.org\",\r\n \"custom_reference\": \"customReference\",\r\n \"customer_type\": {\r\n\t \"name\": \"type1\",\r\n\t \"id\": 5\r\n },\r\n \"home_outlet\": {\r\n\t \"id\": 1,\r\n\t \"name\": \"name\"\r\n },\r\n \"date_of_birth\": \"1999-04-30\",\r\n \"date_of_birth_withheld\": false,\r\n \"marketing\":{\r\n\t \"receive_email\": true,\r\n\t \"receive_post\": true,\r\n\t \"receive_sms\": true\r\n }, \r\n \"price_groups\": [\r\n {\r\n\t \"id\": 1,\r\n\t \"name\": \"name1\",\r\n\t \"type\": \"Standard\"\r\n },\r\n {\r\n\t \"id\": 5,\r\n\t \"name\": \"name2\",\r\n\t \"type\": \"Fixed\"\r\n }],\r\n \"billing_address\": {\r\n \"address_line1\": \"address_line1\",\r\n \"address_line2\": \"address_line2\",\r\n \"suburb\": \"suburb\",\r\n \"state\": \"state\",\r\n \"postcode\": \"postcode\",\r\n \"country\": \"country\"\r\n },\r\n \"loyalty_program\": {\r\n \"enabled\": false,\r\n \"auto_price_group\": false\r\n },\r\n \"account_customer\": {\r\n \"enabled\": false,\r\n \"payment_terms\": 0,\r\n \"credit_limit\": 0,\r\n \"credit_blocked\": false,\r\n \"credit_remaining\": 10\r\n },\r\n \"survey_responses\": [{\r\n \"id\": 1,\r\n \"question\": \"question1\",\r\n \"answer\": \"answer\"\r\n }],\r\n \"sales_channels\": [{\r\n \"id\": 1\r\n },\r\n {\r\n \"id\": 2\r\n }]\r\n }","operationId":"put-customers-id","parameters":[{"name":"id","in":"path","description":"Customer id","required":true,"schema":{"type":"integer","description":"Customer id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Customer model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Returns updated Customer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"},"example":{"account_customer":{"credit_blocked":true,"credit_limit":0,"credit_remaining":0,"enabled":true,"payment_terms":0},"acn":"string","billing_address":{"country":"string","country_code":"string","state":"string","suburb":"string","address_line1":"string","address_line2":"string","postcode":"string","first_name":"string","last_name":"string"},"company":"string","customer_number":"string","customer_type":{"id":0,"name":"string"},"date_of_birth":"string","date_of_birth_withheld":true,"delivery_addresses":[{"country":"string","country_code":"string","state":"string","suburb":"string","address_line1":"string","address_line2":"string","postcode":"string","company":"string","mobile":"string","phone":"string","first_name":"string","last_name":"string","id":0,"default":true,"modified_on":"string"}],"email":"string","fax":"string","first_name":"string","id":0,"last_name":"string","loyalty_program":{"enabled":true,"points_available":0,"points_redeemed":0,"points_to_date":0,"auto_price_group":true,"points_available_value":0},"marketing":{"receive_email":true,"receive_post":true,"receive_sms":true},"mobile":"string","phone":"string","price_groups":[{"id":0,"name":"string","type":"string"}],"survey_responses":[{"id":0,"question":"string","answer":"string"}],"website":"string","home_outlet":{"id":0,"name":"string","modified_on":"string"},"custom_reference":"string","export_to_web":true,"total_payments":0,"total_transactions":0,"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"enabled":true}],"created_on":"string","modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/freighttypes":{"post":{"tags":["freighttypes"],"summary":"Creates Freight Type","description":"Sample request:\r\n\r\n POST /freighttypes\r\n {\r\n \"name\": \"Freight Type Name\",\r\n }","operationId":"post-freighttypes","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Freight Type model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Freight Type created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreightType"},"example":{"name":"string","id":0,"deleted":true,"modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"get":{"tags":["freighttypes"],"summary":"Searches Freight Types by parameters","description":"Searches Freight Types by parameters","operationId":"get-freighttypes","parameters":[{"name":"name","in":"query","description":"Freight type name.","schema":{"maxLength":100,"minLength":0,"type":"string","description":"Freight type name.","nullable":true}},{"name":"deleted","in":"query","description":"Is freight type deleted.","schema":{"type":"boolean","description":"Is freight type deleted.","nullable":true}},{"name":"modified_since","in":"query","description":"Freight type modified since date and time.","schema":{"type":"string","description":"Freight type modified since date and time.","format":"date-time","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Freight Types data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreightType.PagingResponse"},"example":{"data":[{"name":"string","id":0,"deleted":true,"modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/freighttypes/{id}":{"delete":{"tags":["freighttypes"],"summary":"Deletes specific Freight Type by id","description":"Deletes specific Freight Type by id","operationId":"delete-freighttypes-id","parameters":[{"name":"id","in":"path","description":"Freight Type id","required":true,"schema":{"type":"integer","description":"Freight Type id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Freight Type deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"get":{"tags":["freighttypes"],"summary":"Gets specific Freight Type by unique id","description":"Gets specific Freight Type by unique id","operationId":"get-freighttypes-id","parameters":[{"name":"id","in":"path","description":"Freight Type id","required":true,"schema":{"type":"integer","description":"Freight Type id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Freight Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreightType"},"example":{"name":"string","id":0,"deleted":true,"modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Freight Type not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["freighttypes"],"summary":"Updates Freight Type","description":"Sample request:\r\n\r\n PUT /freighttypes\r\n {\r\n \"name\": \"Freight Type Name\"\r\n }","operationId":"put-freighttypes-id","parameters":[{"name":"id","in":"path","description":"Freight Type id","required":true,"schema":{"type":"integer","description":"Freight Type id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Freight Type model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Returns updated Freight Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreightType"},"example":{"name":"string","id":0,"deleted":true,"modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Freight Type not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/inventory":{"get":{"tags":["inventory"],"summary":"Searches Inventories by parameters","description":"Searches Inventories by parameters","operationId":"get-inventory","parameters":[{"name":"sales_channel_id","in":"query","description":"Sales Channel Id or Collection of Sales Channel Ids (comma separated)\r\nExample: 14,3,312","schema":{"type":"string","description":"Sales Channel Id or Collection of Sales Channel Ids (comma separated)\r\nExample: 14,3,312","nullable":true}},{"name":"sku","in":"query","description":"Product SKU or Collection of Product SKUs (comma separated)\r\nExample: sku1,sku2,sku3","schema":{"type":"string","description":"Product SKU or Collection of Product SKUs (comma separated)\r\nExample: sku1,sku2,sku3","nullable":true}},{"name":"outlet_id","in":"query","description":"Outlet Id or Collection of Outlet Ids (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Outlet Id or Collection of Outlet Ids (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"product_id","in":"query","description":"Product Id or Collection of Product Ids (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Product Id or Collection of Product Ids (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since search parameter","schema":{"type":"string","description":"Modified since search parameter","format":"date-time","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: modified_on, allocated, available, stock_on_hand, faulty, on_order, picked, received, requested, \r\ntransit_in, transit_out, last_sold_on, last_fulfiled_on, msl\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: modified_on asc, allocated desc, msl asc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: modified_on, allocated, available, stock_on_hand, faulty, on_order, picked, received, requested, \r\ntransit_in, transit_out, last_sold_on, last_fulfiled_on, msl\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: modified_on asc, allocated desc, msl asc","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\nAvailable field name values: modified_on, allocated, available, stock_on_hand, faulty, on_order, picked, received, requested, \r\ntransit_in, transit_out, last_sold_on, last_fulfiled_on, sales_channel_id, outlet_id, product_id, sku, msl\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: product_id:eq:2, last_sold_on:isnotnull, stock_on_hand:gte:0, msl:gte:100","schema":{"type":"string","description":"Filter by. \r\nAvailable field name values: modified_on, allocated, available, stock_on_hand, faulty, on_order, picked, received, requested, \r\ntransit_in, transit_out, last_sold_on, last_fulfiled_on, sales_channel_id, outlet_id, product_id, sku, msl\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: product_id:eq:2, last_sold_on:isnotnull, stock_on_hand:gte:0, msl:gte:100","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Inventories data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.PagingResponse"},"example":{"data":[{"allocated":0,"available":0,"stock_on_hand":0,"bin_location":"string","faulty":0,"msl":0,"on_order":0,"outlet_id":0,"picked":0,"product_id":0,"received":0,"requested":0,"transit_in":0,"transit_out":0,"modified_on":"string","last_sold_on":"string","last_fulfiled_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/orders/{id}/fulfilments":{"get":{"tags":["orders"],"summary":"Searches Order Fulfilments by parameters","description":"Searches Order Fulfilments by parameters","operationId":"get-orders-id-fulfilments","parameters":[{"name":"id","in":"path","description":"Order id","required":true,"schema":{"type":"integer","description":"Order id","format":"int32"}},{"name":"created_since","in":"query","description":"Created since","schema":{"type":"string","description":"Created since","format":"date-time","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, order_item_id, fulfil_outlet, created_on, serial_number.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,id:in:2|3","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, order_item_id, fulfil_outlet, created_on, serial_number.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,id:in:2|3","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, order_item_id, fulfil_outlet, created_on.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, fulfil_outlet desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, order_item_id, fulfil_outlet, created_on.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, fulfil_outlet desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Order Fulfilments","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fulfilment.PagingResponse"},"example":{"data":[{"id":0,"order_item_id":0,"quantity_fulfiled":0,"fulfil_outlet":{"id":0,"name":"string","modified_on":"string"},"created_on":"string","serial_number":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/orders/{id}/fulfilments/{fulfilment_id}":{"get":{"tags":["orders"],"summary":"Gets specific Order Fulfilment","description":"Gets specific Order Fulfilment","operationId":"get-orders-id-fulfilments-fulfilment_id","parameters":[{"name":"id","in":"path","description":"Order id","required":true,"schema":{"type":"integer","description":"Order id","format":"int32"}},{"name":"fulfilment_id","in":"path","description":"Fulfilment id","required":true,"schema":{"type":"integer","description":"Fulfilment id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Order Fulfilment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fulfilment"},"example":{"id":0,"order_item_id":0,"quantity_fulfiled":0,"fulfil_outlet":{"id":0,"name":"string","modified_on":"string"},"created_on":"string","serial_number":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Order Fulfilment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/orders/{id}/orderitems":{"get":{"tags":["orders"],"summary":"Searches Order Items by parameters","description":"Searches Order Items by parameters","operationId":"get-orders-id-orderitems","parameters":[{"name":"id","in":"path","description":"Order id","required":true,"schema":{"type":"integer","description":"Order id","format":"int32"}},{"name":"created_since","in":"query","description":"Created since","schema":{"type":"string","description":"Created since","format":"date-time","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, order_item_type, return_reason_id, return_reason_name, original_order_item_id, notes, fulfil_outlet, source_outlet, created_on, modified_on, serial_number.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,id:in:2|3","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, order_item_type, return_reason_id, return_reason_name, original_order_item_id, notes, fulfil_outlet, source_outlet, created_on, modified_on, serial_number.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,id:in:2|3","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, order_item_type, return_reason_name, notes, fulfil_outlet, source_outlet, created_on, modified_on.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, order_item_type desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, order_item_type, return_reason_name, notes, fulfil_outlet, source_outlet, created_on, modified_on.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, order_item_type desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Order Items","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderItem.PagingResponse"},"example":{"data":[{"id":0,"external_id":"string","order_item_type":"string","product":{"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier_sku":"string","supplier_sku2":"string","sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","id":0},"original_price":0,"sell_price":0,"order_item_total":0,"order_item_discount_total":0,"taxable":true,"tax_rate":0,"supplier_buy_ex":0,"direct_costs_ex":0,"cogs_ex":0,"fulfilment_method":"string","due_date":"string","delivery_driver":{"id":0,"name":"string"},"delivery_zone":{"id":0,"name":"string"},"delivery_time":{"id":0,"name":"string"},"quantity_ordered":0,"quantity_fulfiled":0,"notes":"string","original_order_item_id":0,"return_reason":{"id":0,"name":"string"},"fulfil_outlet":{"id":0,"name":"string","modified_on":"string"},"source_outlet":{"id":0,"name":"string","modified_on":"string"},"applied_promotional_campaigns":[{"id":0,"name":"string"}],"created_on":"string","modified_on":"string","linked_purchase_order":{"id":0,"status":{"id":0,"name":"string"},"eta":"string","supplier_invoice_number":"string","created_on":"string","modified_on":"string","received_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}},"serial_number":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/orders/{id}/orderitems/{item_id}":{"get":{"tags":["orders"],"summary":"Gets specific Order Item","description":"Gets specific Order Item","operationId":"get-orders-id-orderitems-item_id","parameters":[{"name":"id","in":"path","description":"Order id","required":true,"schema":{"type":"integer","description":"Order id","format":"int32"}},{"name":"item_id","in":"path","description":"Order Item id","required":true,"schema":{"type":"integer","description":"Order Item id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Order Item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderItem"},"example":{"id":0,"external_id":"string","order_item_type":"string","product":{"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier_sku":"string","supplier_sku2":"string","sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","id":0},"original_price":0,"sell_price":0,"order_item_total":0,"order_item_discount_total":0,"taxable":true,"tax_rate":0,"supplier_buy_ex":0,"direct_costs_ex":0,"cogs_ex":0,"fulfilment_method":"string","due_date":"string","delivery_driver":{"id":0,"name":"string"},"delivery_zone":{"id":0,"name":"string"},"delivery_time":{"id":0,"name":"string"},"quantity_ordered":0,"quantity_fulfiled":0,"notes":"string","original_order_item_id":0,"return_reason":{"id":0,"name":"string"},"fulfil_outlet":{"id":0,"name":"string","modified_on":"string"},"source_outlet":{"id":0,"name":"string","modified_on":"string"},"applied_promotional_campaigns":[{"id":0,"name":"string"}],"created_on":"string","modified_on":"string","linked_purchase_order":{"id":0,"status":{"id":0,"name":"string"},"eta":"string","supplier_invoice_number":"string","created_on":"string","modified_on":"string","received_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}},"serial_number":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Order Item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/orders/{id}/payments":{"get":{"tags":["orders"],"summary":"Searches Order Payments by parameters","description":"Searches Order Payments by parameters","operationId":"get-orders-id-payments","parameters":[{"name":"id","in":"path","description":"Order id","required":true,"schema":{"type":"integer","description":"Order id","format":"int32"}},{"name":"created_since","in":"query","description":"Created since","schema":{"type":"string","description":"Created since","format":"date-time","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, payment_method, created_on.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,id:in:2|3","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, payment_method, created_on.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,id:in:2|3","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, payment_method, created_on.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, payment_method desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, payment_method, created_on.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, payment_method desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Order Payments data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderPayment.PagingResponse"},"example":{"data":[{"id":0,"external_id":"string","payment_method":{"id":0,"name":"string"},"amount":0,"created_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/orders/{id}/payments/{payment_id}":{"get":{"tags":["orders"],"summary":"Gets specific Order Payment","description":"Gets specific Order Payment","operationId":"get-orders-id-payments-payment_id","parameters":[{"name":"id","in":"path","description":"Order id","required":true,"schema":{"type":"integer","description":"Order id","format":"int32"}},{"name":"payment_id","in":"path","description":"Payment id","required":true,"schema":{"type":"integer","description":"Payment id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Order Payment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderPayment"},"example":{"id":0,"external_id":"string","payment_method":{"id":0,"name":"string"},"amount":0,"created_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Order Payment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/orders":{"get":{"tags":["orders"],"summary":"Searches Orders by parameters","description":"Searches Orders by parameters","operationId":"get-orders","parameters":[{"name":"created_since","in":"query","description":"Created since","schema":{"type":"string","description":"Created since","format":"date-time","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"include_items","in":"query","description":"Include items","schema":{"type":"boolean","description":"Include items"}},{"name":"include_fulfilments","in":"query","description":"Include fulfilments","schema":{"type":"boolean","description":"Include fulfilments"}},{"name":"include_payments","in":"query","description":"Include payments","schema":{"type":"boolean","description":"Include payments"}},{"name":"include_order_vouchers","in":"query","description":"Include order vouchers","schema":{"type":"boolean","description":"Include order vouchers"}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, outlet, sales_channel, customer, sales_person, created_on, modified_on. \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, outlet desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, outlet, sales_channel, customer, sales_person, created_on, modified_on. \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, outlet desc","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: created_on, modified_on, order_number, order_status_id, sales_channel_id, shopify_channel, outlet_id, customer_id, customer_number, customer_email, sales_person_id, original_order_id, ext_unique_id, order_id.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,order_number:in:order_number1|order_number2\r\nExample: shopify_channel:eq:true","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: created_on, modified_on, order_number, order_status_id, sales_channel_id, shopify_channel, outlet_id, customer_id, customer_number, customer_email, sales_person_id, original_order_id, ext_unique_id, order_id.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,order_number:in:order_number1|order_number2\r\nExample: shopify_channel:eq:true","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Orders","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order.PagingResponse"},"example":{"data":[{"billing_address":{"country":"string","country_code":"string","state":"string","suburb":"string","address_line1":"string","address_line2":"string","postcode":"string","company":"string","mobile":"string","phone":"string","first_name":"string","last_name":"string","email":"string"},"private_comments":"string","delivery_address":{"country":"string","country_code":"string","state":"string","suburb":"string","address_line1":"string","address_line2":"string","postcode":"string","company":"string","mobile":"string","phone":"string","first_name":"string","last_name":"string","id":0,"default":true,"modified_on":"string"},"ext_unique_id":"string","freight_total":0,"freight_type":{"id":0,"name":"string"},"id":0,"customer":{"customer_number":"string","email":"string","first_name":"string","id":0,"last_name":"string","custom_reference":"string"},"order_number":"string","original_order_id":0,"sales_channel":{"id":0,"name":"string","shopify_channel":true},"sales_person":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"order_status":{"id":0,"status":"string"},"order_total":0,"outlet":{"id":0,"name":"string","modified_on":"string"},"public_comments":"string","taxable":0,"created_on":"string","modified_on":"string","fulfilled_in_full_on":"string","paid_in_full_on":"string","order_items":[{"id":0,"external_id":"string","order_item_type":"string","product":{"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier_sku":"string","supplier_sku2":"string","sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","id":0},"original_price":0,"sell_price":0,"order_item_total":0,"order_item_discount_total":0,"taxable":true,"tax_rate":0,"supplier_buy_ex":0,"direct_costs_ex":0,"cogs_ex":0,"fulfilment_method":"string","due_date":"string","delivery_driver":{"id":0,"name":"string"},"delivery_zone":{"id":0,"name":"string"},"delivery_time":{"id":0,"name":"string"},"quantity_ordered":0,"quantity_fulfiled":0,"notes":"string","original_order_item_id":0,"return_reason":{"id":0,"name":"string"},"fulfil_outlet":{"id":0,"name":"string","modified_on":"string"},"source_outlet":{"id":0,"name":"string","modified_on":"string"},"applied_promotional_campaigns":[{"id":0,"name":"string"}],"created_on":"string","modified_on":"string","linked_purchase_order":{"id":0,"status":{"id":0,"name":"string"},"eta":"string","supplier_invoice_number":"string","created_on":"string","modified_on":"string","received_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}},"serial_number":"string"}],"fulfilments":[{"id":0,"order_item_id":0,"quantity_fulfiled":0,"fulfil_outlet":{"id":0,"name":"string","modified_on":"string"},"created_on":"string","serial_number":"string"}],"payments":[{"id":0,"external_id":"string","payment_method":{"id":0,"name":"string"},"amount":0,"created_on":"string"}],"vouchers":[{"id":0,"code":"string","type":{"id":0,"name":"string"},"initial_value":0,"balance":0,"created_on":"string","expires_on":"string"}]}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/orders/{id}":{"get":{"tags":["orders"],"summary":"Gets specific Order by unique id","description":"Gets specific Order by unique id","operationId":"get-orders-id","parameters":[{"name":"id","in":"path","description":"Order id","required":true,"schema":{"type":"integer","description":"Order id","format":"int32","example":10000}},{"name":"include_items","in":"query","description":"Include items","schema":{"type":"boolean","description":"Include items"}},{"name":"include_fulfilments","in":"query","description":"Include fulfilments","schema":{"type":"boolean","description":"Include fulfilments"}},{"name":"include_payments","in":"query","description":"Include payments","schema":{"type":"boolean","description":"Include payments"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Order","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"},"example":{"billing_address":{"country":"string","country_code":"string","state":"string","suburb":"string","address_line1":"string","address_line2":"string","postcode":"string","company":"string","mobile":"string","phone":"string","first_name":"string","last_name":"string","email":"string"},"private_comments":"string","delivery_address":{"country":"string","country_code":"string","state":"string","suburb":"string","address_line1":"string","address_line2":"string","postcode":"string","company":"string","mobile":"string","phone":"string","first_name":"string","last_name":"string","id":0,"default":true,"modified_on":"string"},"ext_unique_id":"string","freight_total":0,"freight_type":{"id":0,"name":"string"},"id":0,"customer":{"customer_number":"string","email":"string","first_name":"string","id":0,"last_name":"string","custom_reference":"string"},"order_number":"string","original_order_id":0,"sales_channel":{"id":0,"name":"string","shopify_channel":true},"sales_person":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"order_status":{"id":0,"status":"string"},"order_total":0,"outlet":{"id":0,"name":"string","modified_on":"string"},"public_comments":"string","taxable":0,"created_on":"string","modified_on":"string","fulfilled_in_full_on":"string","paid_in_full_on":"string","order_items":[{"id":0,"external_id":"string","order_item_type":"string","product":{"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier_sku":"string","supplier_sku2":"string","sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","id":0},"original_price":0,"sell_price":0,"order_item_total":0,"order_item_discount_total":0,"taxable":true,"tax_rate":0,"supplier_buy_ex":0,"direct_costs_ex":0,"cogs_ex":0,"fulfilment_method":"string","due_date":"string","delivery_driver":{"id":0,"name":"string"},"delivery_zone":{"id":0,"name":"string"},"delivery_time":{"id":0,"name":"string"},"quantity_ordered":0,"quantity_fulfiled":0,"notes":"string","original_order_item_id":0,"return_reason":{"id":0,"name":"string"},"fulfil_outlet":{"id":0,"name":"string","modified_on":"string"},"source_outlet":{"id":0,"name":"string","modified_on":"string"},"applied_promotional_campaigns":[{"id":0,"name":"string"}],"created_on":"string","modified_on":"string","linked_purchase_order":{"id":0,"status":{"id":0,"name":"string"},"eta":"string","supplier_invoice_number":"string","created_on":"string","modified_on":"string","received_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}},"serial_number":"string"}],"fulfilments":[{"id":0,"order_item_id":0,"quantity_fulfiled":0,"fulfil_outlet":{"id":0,"name":"string","modified_on":"string"},"created_on":"string","serial_number":"string"}],"payments":[{"id":0,"external_id":"string","payment_method":{"id":0,"name":"string"},"amount":0,"created_on":"string"}],"vouchers":[{"id":0,"code":"string","type":{"id":0,"name":"string"},"initial_value":0,"balance":0,"created_on":"string","expires_on":"string"}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Order not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/productattributes/{id}/values":{"get":{"tags":["productattributes"],"summary":"Gets all Product Attribute Values, existing in the system for provided Product Attribute","description":"Gets all Product Attribute Values, existing in the system for provided Product Attribute","operationId":"get-productattributes-id-values","parameters":[{"name":"id","in":"path","description":"Product Attribute id","required":true,"schema":{"type":"integer","description":"Product Attribute id","format":"int32","example":2}},{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Product Attributes data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeValue.PagingResponse"},"example":{"data":[{"id":0,"attribute_id":0,"name":"string","list_order":0,"modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["productattributes"],"summary":"Creates new Product Attribute Value entity in the system","description":"Sample request:\r\n \r\n POST /productattributes/2/values\r\n {\r\n \"name\": \"sample_name\"\r\n }","operationId":"post-productattributes-id-values","parameters":[{"name":"id","in":"path","description":"Product Attribute id","required":true,"schema":{"type":"integer","description":"Product Attribute id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Product Attribute Value model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"New Product Attribute Value was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeValue"},"example":{"id":0,"attribute_id":0,"name":"string","list_order":0,"modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/productattributes/{id}/values/{value_id}":{"get":{"tags":["productattributes"],"summary":"Gets specific Product Attribute Value by unique id","description":"Gets specific Product Attribute Value by unique id","operationId":"get-productattributes-id-values-value_id","parameters":[{"name":"id","in":"path","description":"Product Attribute id","required":true,"schema":{"type":"integer","description":"Product Attribute id","format":"int32","example":2}},{"name":"value_id","in":"path","description":"Product Attribute Value id","required":true,"schema":{"type":"integer","description":"Product Attribute Value id","format":"int32","example":321}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Product Attribute","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeValue"},"example":{"id":0,"attribute_id":0,"name":"string","list_order":0,"modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["productattributes"],"summary":"Updates Product Attribute Value entity in the system.","description":"Sample request:\r\n \r\n PUT /productattributes/2/values/66\r\n {\r\n \"name\": \"sample_name\"\r\n }","operationId":"put-productattributes-id-values-value_id","parameters":[{"name":"id","in":"path","description":"Product Attribute id","required":true,"schema":{"type":"integer","description":"Product Attribute id","format":"int32"}},{"name":"value_id","in":"path","description":"Product Attribute value id","required":true,"schema":{"type":"integer","description":"Product Attribute value id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Product Attribute Value model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Product Attribute Value was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttributeValue"},"example":{"id":0,"attribute_id":0,"name":"string","list_order":0,"modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/productattributes":{"get":{"tags":["productattributes"],"summary":"Gets all Product Attributes, existing in the system","description":"Gets all Product Attributes, existing in the system","operationId":"get-productattributes","parameters":[{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Product Attributes data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attribute.PagingResponse"},"example":{"data":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/productattributes/{id}":{"get":{"tags":["productattributes"],"summary":"Gets specific Product Attribute by unique id","description":"Gets specific Product Attribute by unique id","operationId":"get-productattributes-id","parameters":[{"name":"id","in":"path","description":"Product Attribute id","required":true,"schema":{"type":"integer","description":"Product Attribute id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Product Attribute","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attribute"},"example":{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Product Attribute not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/productprices":{"get":{"tags":["productprices"],"summary":"Searches Product Pricings by parameters","description":"Searches Product Pricings by parameters","operationId":"get-productprices","parameters":[{"name":"product_id","in":"query","description":"Product id or collection (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Product id or collection (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"sku","in":"query","description":"Supplier product SKU or collection (comma separated)\r\nExample: D124088,D124089","schema":{"type":"string","description":"Supplier product SKU or collection (comma separated)\r\nExample: D124088,D124089","nullable":true}},{"name":"outlet_id","in":"query","description":"Unique outlet id or collection (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Unique outlet id or collection (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"sales_channel_id","in":"query","description":"Unique sales channel id or collection (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Unique sales channel id or collection (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Pricings data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductPricing.PagingResponse"},"example":{"data":[{"product_id":0,"outlet_id":0,"supplier_buy_ex":0,"direct_costs_ex":0,"cogs_ex":0,"sell_price_inc":0,"promotional_price_inc":0,"promotional_price_start":"string","promotional_price_end":"string","taxable":true}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/products":{"get":{"tags":["products"],"summary":"Searches Products by parameters","description":"Searches Products by parameters","operationId":"get-products","parameters":[{"name":"id","in":"query","description":"Product Id. Other properties are skipped, if used","schema":{"type":"integer","description":"Product Id. Other properties are skipped, if used","format":"int32","nullable":true}},{"name":"search","in":"query","description":"Search. If used, other properties are skipped, except outlet_id and disabled","schema":{"type":"string","description":"Search. If used, other properties are skipped, except outlet_id and disabled","nullable":true}},{"name":"sales_channel_id","in":"query","description":"Sales Channel Id","schema":{"type":"integer","description":"Sales Channel Id","format":"int32","nullable":true}},{"name":"include_inventory","in":"query","description":"Include inventory","schema":{"type":"boolean","description":"Include inventory"}},{"name":"po_supplier_code","in":"query","description":"PO Supplier Code","schema":{"type":"string","description":"PO Supplier Code","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, supplier_sku, supplier_sku2, manufacturer_sku, short_description, product_type, supplier, core_product, disabled,\r\nlong_description, custom1, custom2, custom3, supplier_buy_ex, buy_price_ex, direct_costs_ex, markup_target, sell_price_inc, promotional_price_inc,\r\npromotional_price_expiry, rrp_inc, web_price_inc, freight_inc, max_discount_rule_id, lead_time, carton_quantity, replenishment_method_code, length, depth, breadth,\r\nshipping_cubic, weight, prevent_disabling, voucher_product, requires_assembly, loyalty_ratio, brand, season, size, colour, attribute:id, sales_channel:id, export_to_web,\r\nlast_sold_on, last_fulfiled_on, external_link:name, fixed_price_group:id, price_group_sell_price_inc:id, price_group_web_price_inc:id, created_since, modified_since \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, supplier_sku desc , external_link:ExternalURL2 desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, supplier_sku, supplier_sku2, manufacturer_sku, short_description, product_type, supplier, core_product, disabled,\r\nlong_description, custom1, custom2, custom3, supplier_buy_ex, buy_price_ex, direct_costs_ex, markup_target, sell_price_inc, promotional_price_inc,\r\npromotional_price_expiry, rrp_inc, web_price_inc, freight_inc, max_discount_rule_id, lead_time, carton_quantity, replenishment_method_code, length, depth, breadth,\r\nshipping_cubic, weight, prevent_disabling, voucher_product, requires_assembly, loyalty_ratio, brand, season, size, colour, attribute:id, sales_channel:id, export_to_web,\r\nlast_sold_on, last_fulfiled_on, external_link:name, fixed_price_group:id, price_group_sell_price_inc:id, price_group_web_price_inc:id, created_since, modified_since \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, supplier_sku desc , external_link:ExternalURL2 desc","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\nAvailable field name values: id, supplier_sku, supplier_sku2, manufacturer_sku, short_description, product_type, supplier, supplier_code, supplier_buy_ex,\r\nsize, colour, brand, season, core_product, disabled, enabled_supplier, attribute:Id, outlet_id, quantity_available, quantity_on_order, package, max_discount_rule_id, replenishment_method_code,\r\nexport_to_web, loyalty_ratio, voucher_product, requires_assembly, created_on, modified_on, sales_channel:id, long_description, custom1, custom2, custom3, buy_price_ex, direct_costs_ex, \r\nmarkup_target, sell_price_inc, promotional_price_inc, promotional_price_expiry, rrp_inc, web_price_inc, freight_inc, max_discount_rule_id, lead_time, carton_quantity, \r\nlength, depth, breadth, shipping_cubic, weight, prevent_disabling, last_sold_on, last_fulfiled_on, url, fixed_price_group:id, price_group_sell_price_inc:id, price_group_web_price_inc:id,require_serial_number\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:eq:2, attribute:101:isnotnull, attribute:101:eq:Custom Attribute Value 123,external_link:ExternalURL2:eq:http..","schema":{"type":"string","description":"Filter by. \r\nAvailable field name values: id, supplier_sku, supplier_sku2, manufacturer_sku, short_description, product_type, supplier, supplier_code, supplier_buy_ex,\r\nsize, colour, brand, season, core_product, disabled, enabled_supplier, attribute:Id, outlet_id, quantity_available, quantity_on_order, package, max_discount_rule_id, replenishment_method_code,\r\nexport_to_web, loyalty_ratio, voucher_product, requires_assembly, created_on, modified_on, sales_channel:id, long_description, custom1, custom2, custom3, buy_price_ex, direct_costs_ex, \r\nmarkup_target, sell_price_inc, promotional_price_inc, promotional_price_expiry, rrp_inc, web_price_inc, freight_inc, max_discount_rule_id, lead_time, carton_quantity, \r\nlength, depth, breadth, shipping_cubic, weight, prevent_disabling, last_sold_on, last_fulfiled_on, url, fixed_price_group:id, price_group_sell_price_inc:id, price_group_web_price_inc:id,require_serial_number\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:eq:2, attribute:101:isnotnull, attribute:101:eq:Custom Attribute Value 123,external_link:ExternalURL2:eq:http..","nullable":true}},{"name":"sku","in":"query","description":"Supplier SKU.","schema":{"maxLength":50,"minLength":0,"type":"string","description":"Supplier SKU.","nullable":true}},{"name":"manufacturer_sku","in":"query","description":"Manufacturer SKU.","schema":{"maxLength":50,"minLength":0,"type":"string","description":"Manufacturer SKU.","nullable":true}},{"name":"supplier","in":"query","description":"Supplier or Collection of Suppliers (comma separated)\r\nExample: Supplier1,Supplier2,Supplier3","schema":{"type":"string","description":"Supplier or Collection of Suppliers (comma separated)\r\nExample: Supplier1,Supplier2,Supplier3","nullable":true}},{"name":"plu","in":"query","description":"Product Look-Up code (PLU) It can be Product Id, Supplier SKU, Manufacturer SKU, Supplier SKU 2 or any Barcodes for a product. The other search parameters are ignored if used. (except of 'autocomplete')","schema":{"minLength":3,"type":"string","description":"Product Look-Up code (PLU) It can be Product Id, Supplier SKU, Manufacturer SKU, Supplier SKU 2 or any Barcodes for a product. The other search parameters are ignored if used. (except of 'autocomplete')","nullable":true}},{"name":"autocomplete","in":"query","description":"Autocomplete. Controls partial vs exact match search. Should return only exactly matching results when its value is false and partially matching results when true.","schema":{"type":"boolean","description":"Autocomplete. Controls partial vs exact match search. Should return only exactly matching results when its value is false and partially matching results when true."}},{"name":"created_since","in":"query","description":"Created since","schema":{"type":"string","description":"Created since","format":"date-time","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"disabled","in":"query","description":"Disabled","schema":{"type":"boolean","description":"Disabled","nullable":true}},{"name":"product_type_id","in":"query","description":"Product Type Id or Collection of Product Type Ids (comma separated)\r\nExample: 1,5,7","schema":{"type":"string","description":"Product Type Id or Collection of Product Type Ids (comma separated)\r\nExample: 1,5,7","nullable":true}},{"name":"short_description","in":"query","description":"Allows to search by description parts","schema":{"type":"string","description":"Allows to search by description parts","nullable":true}},{"name":"outlet_id","in":"query","description":"Outlet Id","schema":{"type":"integer","description":"Outlet Id","format":"int32","nullable":true}},{"name":"include_zero_stock","in":"query","description":"Filters products based on them being in stock","schema":{"type":"boolean","description":"Filters products based on them being in stock","nullable":true}},{"name":"style_code","in":"query","description":"Product Look-Up code (Style Code) It can be Manufacturer SKU for a product. The other search parameters are ignored if used. (except of 'autocomplete')","schema":{"minLength":3,"type":"string","description":"Product Look-Up code (Style Code) It can be Manufacturer SKU for a product. The other search parameters are ignored if used. (except of 'autocomplete')","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Products data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product.PagingResponse"},"example":{"data":[{"carton_quantity":"string","cogs_ex":0,"cubic":0,"direct_costs_ex":0,"prevent_disabling":true,"promotional_price_inc":0,"promotional_price_expiry":"string","freight_inc":0,"price_ex":0,"rrp_inc":0,"sell_price_inc":0,"web_price_inc":0,"markup_target":0,"breadth":0,"core_product":true,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"disabled":true,"id":0,"lead_time":0,"length":0,"loyalty_ratio":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"requires_assembly":true,"shipping_cubic":0,"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_buy_ex":0,"supplier_sku":"string","supplier_sku2":"string","weight":0,"buy_price_ex":0,"long_description":"string","voucher_product":true,"max_discount_rule":{"id":0,"name":"string","value":0,"type":"string","modified_on":"string"},"replenishment_method":{"id":0,"code":"string","name":"string"},"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"created_on":"string","modified_on":"string","inventory":[{"outlet":{"id":0,"name":"string","modified_on":"string"},"quantity_available":0,"quantity_on_order":0}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["products"],"summary":"Creates products","description":"Sample request:\r\n\r\n POST /products\r\n [\r\n {\r\n \"carton_quantity\":\"1\",\r\n \"cogs_ex\":11.1,\r\n \"cubic\":20.2,\r\n \"direct_costs_ex\":1.1,\r\n \"prevent_disabling\":false,\r\n \"promotional_price_inc\":1.1,\r\n \"promotional_price_expiry\":\"2021-12-12T00:00:00\",\r\n \"freight_inc\":1.1,\r\n \"rrp_inc\":1.1,\r\n \"sell_price_inc\":1.1,\r\n \"web_price_inc\":1.1,\r\n \"breadth\":1.1,\r\n \"core_product\":false,\r\n \"custom_properties\": [\r\n {\r\n \"Name\": \"Custom1\",\r\n \"Value\": \"Value1\"\r\n },\r\n {\r\n \"Name\": \"Custom2\",\r\n \"Value\": \"Value2\"\r\n }\r\n ],\r\n \"depth\":1.1,\r\n \"disabled\":false,\r\n \"lead_time\":12,\r\n \"length\":1.1,\r\n \"loyalty_ratio\":1.1,\r\n \"manufacturer_sku\":\"UniqueManufacturerSku\",\r\n \"product_type\":{\r\n \"id\":3\r\n },\r\n \"requires_assembly\":false,\r\n \"require_serial_number\":1,\r\n \"shipping_cubic\":1.1,\r\n \"short_description\":\"ShortDescription\",\r\n \"supplier\":{\r\n \"supplier_code\":\"00\"\r\n },\r\n \"supplier_buy_ex\":1.1,\r\n \"supplier_sku\":\"SupplierSKU1\",\r\n \"supplier_sku2\":\"SupplierSKU2\",\r\n \"weight\":1.1,\r\n \"buy_price_ex\" : 0.0000,\r\n \"attributes\":[\r\n {\r\n \"value\":{\r\n \"id\":1\r\n },\r\n \"id\":3\r\n }\r\n ],\r\n \"long_description\": \"sample text\",\r\n \"voucher_product\" : false,\r\n \"max_discount_rule\":{\r\n \"id\": 1\r\n },\r\n \"replenishment_method\": {\r\n \"id\": 1\r\n },\r\n \"sales_channels\":[\r\n {\r\n \"id\": 1,\r\n \"source_group\": \r\n {\r\n \"id\": 1\r\n },\r\n \"enabled\": true\r\n }],\r\n \"export_to_web\": false,\r\n \"external_links\": [\r\n {\r\n \"id\": 0,\r\n \"name\": \"ExternalURL1\",\r\n \"url\": \"https://test1.com\"\r\n },\r\n {\r\n \"id\": 0,\r\n \"name\": \"ExternalURL2\",\r\n \"url\": \"https://test2.com\"\r\n },\r\n {\r\n \"id\": 0,\r\n \"name\": \"ExternalImageURL\",\r\n \"url\": \"https://test3.com\"\r\n }\r\n ],\r\n \"fixed_price_groups\": [\r\n {\r\n \"id\": 1,\r\n \"price_inc\": 15.5\r\n },\r\n {\r\n \"id\": 2,\r\n \"price_inc\": 35\r\n },\r\n {\r\n \"id\": 3,\r\n \"price_inc\": 25\r\n }\r\n ]\r\n }\r\n ]","operationId":"post-products","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Products to be created","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Products created","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"example":[{"carton_quantity":"string","cogs_ex":0,"cubic":0,"direct_costs_ex":0,"prevent_disabling":true,"promotional_price_inc":0,"promotional_price_expiry":"string","freight_inc":0,"price_ex":0,"rrp_inc":0,"sell_price_inc":0,"web_price_inc":0,"markup_target":0,"breadth":0,"core_product":true,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"disabled":true,"id":0,"lead_time":0,"length":0,"loyalty_ratio":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"requires_assembly":true,"shipping_cubic":0,"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_buy_ex":0,"supplier_sku":"string","supplier_sku2":"string","weight":0,"buy_price_ex":0,"long_description":"string","voucher_product":true,"max_discount_rule":{"id":0,"name":"string","value":0,"type":"string","modified_on":"string"},"replenishment_method":{"id":0,"code":"string","name":"string"},"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"created_on":"string","modified_on":"string","inventory":[{"outlet":{"id":0,"name":"string","modified_on":"string"},"quantity_available":0,"quantity_on_order":0}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]}]}}},"400":{"description":"Bad request, max batch size limit of 100 is exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/products/{id}":{"get":{"tags":["products"],"summary":"Gets specific Product by unique id","description":"Gets specific Product by unique id","operationId":"get-products-id","parameters":[{"name":"id","in":"path","description":"Product id","required":true,"schema":{"type":"integer","description":"Product id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Product","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"},"example":{"carton_quantity":"string","cogs_ex":0,"cubic":0,"direct_costs_ex":0,"prevent_disabling":true,"promotional_price_inc":0,"promotional_price_expiry":"string","freight_inc":0,"price_ex":0,"rrp_inc":0,"sell_price_inc":0,"web_price_inc":0,"markup_target":0,"breadth":0,"core_product":true,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"disabled":true,"id":0,"lead_time":0,"length":0,"loyalty_ratio":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"requires_assembly":true,"shipping_cubic":0,"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_buy_ex":0,"supplier_sku":"string","supplier_sku2":"string","weight":0,"buy_price_ex":0,"long_description":"string","voucher_product":true,"max_discount_rule":{"id":0,"name":"string","value":0,"type":"string","modified_on":"string"},"replenishment_method":{"id":0,"code":"string","name":"string"},"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"created_on":"string","modified_on":"string","inventory":[{"outlet":{"id":0,"name":"string","modified_on":"string"},"quantity_available":0,"quantity_on_order":0}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["products"],"summary":"Disables specific Product by id\r\n1) Hides the product from reports and Stocktake by default\r\n2) Turns off communication between Retail Express and eCommerce/Web Store integrations\r\n3) Excluded from Product Search in POS","description":"Disables specific Product by id\r\n1) Hides the product from reports and Stocktake by default\r\n2) Turns off communication between Retail Express and eCommerce/Web Store integrations\r\n3) Excluded from Product Search in POS","operationId":"delete-products-id","parameters":[{"name":"id","in":"path","description":"Product id","required":true,"schema":{"type":"integer","description":"Product id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Product disabled"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["products"],"summary":"Updates Product","description":"Sample request:\r\n\r\n PUT /products\r\n {\r\n \"carton_quantity\":1,\r\n \"cogs_ex\":11.1,\r\n \"cubic\":20.2,\r\n \"direct_costs_ex\":1.1,\r\n \"prevent_disabling\":false,\r\n \"promotional_price_inc\":1.1,\r\n \"promotional_price_expiry\":\"2021-12-12T00:00:00\",\r\n \"freight_inc\":1.1,\r\n \"rrp_inc\":1.1,\r\n \"sell_price_inc\":1.1,\r\n \"web_price_inc\":1.1,\r\n \"breadth\":1.1,\r\n \"core_product\":false,\r\n \"custom_properties\": [\r\n {\r\n \"Name\": \"Custom1\",\r\n \"Value\": \"Value1\"\r\n },\r\n {\r\n \"Name\": \"Custom2\",\r\n \"Value\": \"Value2\"\r\n }\r\n ],\r\n \"depth\":1.1,\r\n \"disabled\":false,\r\n \"lead_time\":12,\r\n \"length\":1.1,\r\n \"loyalty_ratio\":1.1,\r\n \"manufacturer_sku\":\"UniqueManufacturerSku\",\r\n \"product_type\":{\r\n \"id\":3\r\n },\r\n \"requires_assembly\":false,\r\n \"require_serial_number\":1,\r\n \"shipping_cubic\":1.1,\r\n \"short_description\":\"ShortDescription\",\r\n \"supplier\":{\r\n \"supplier_code\":\"00\"\r\n },\r\n \"supplier_buy_ex\":1.1,\r\n \"supplier_sku\":\"SupplierSKU1\",\r\n \"supplier_sku2\":\"SupplierSKU2\",\r\n \"weight\":1.1,\r\n \"buy_price_ex\" : 0.0000,\r\n \"attributes\":[\r\n {\r\n \"value\":{\r\n \"id\":1\r\n },\r\n \"id\":3\r\n }\r\n ],\r\n \"long_description\": \"sample text\",\r\n \"voucher_product\" : false,\r\n \"max_discount_rule\":{\r\n \"id\": 1\r\n },\r\n \"replenishment_method\": {\r\n \"id\": 1\r\n },\r\n \"sales_channels\":[\r\n {\r\n \"id\": 1,\r\n \"source_group\": \r\n {\r\n \"id\": 1\r\n },\r\n \"enabled\": true\r\n }],\r\n \"export_to_web\": false ,\r\n \"external_links\":[\r\n {\r\n \"id\": 1,\r\n \"url\": \"https://test1.com\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"url\": \"https://test2.com\"\r\n },\r\n {\r\n \"id\": 3,\r\n \"url\": \"https://test3.com\"\r\n }\r\n ],\r\n \"fixed_price_groups\": [\r\n {\r\n \"id\": 1,\r\n \"price_inc\": 15.5\r\n },\r\n {\r\n \"id\": 2,\r\n \"price_inc\": null\r\n }\r\n ]\r\n }","operationId":"put-products-id","parameters":[{"name":"id","in":"path","description":"Product id","required":true,"schema":{"type":"integer","description":"Product id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Product model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Returns updated Product","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"},"example":{"carton_quantity":"string","cogs_ex":0,"cubic":0,"direct_costs_ex":0,"prevent_disabling":true,"promotional_price_inc":0,"promotional_price_expiry":"string","freight_inc":0,"price_ex":0,"rrp_inc":0,"sell_price_inc":0,"web_price_inc":0,"markup_target":0,"breadth":0,"core_product":true,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"disabled":true,"id":0,"lead_time":0,"length":0,"loyalty_ratio":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"requires_assembly":true,"shipping_cubic":0,"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_buy_ex":0,"supplier_sku":"string","supplier_sku2":"string","weight":0,"buy_price_ex":0,"long_description":"string","voucher_product":true,"max_discount_rule":{"id":0,"name":"string","value":0,"type":"string","modified_on":"string"},"replenishment_method":{"id":0,"code":"string","name":"string"},"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"created_on":"string","modified_on":"string","inventory":[{"outlet":{"id":0,"name":"string","modified_on":"string"},"quantity_available":0,"quantity_on_order":0}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/producttypes":{"get":{"tags":["producttypes"],"summary":"Searches Product Types by parameters","description":"Searches Product Types by parameters","operationId":"get-producttypes","parameters":[{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Product Types data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductType.PagingResponse"},"example":{"data":[{"id":0,"name":"string","modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["producttypes"],"summary":"Creates new Product Type entity in the system","description":"Sample request:\r\n \r\n POST /producttypes\r\n {\r\n \"name\": \"ProductTypeName\"\r\n }","operationId":"post-producttypes","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Type model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"New Product Type was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductType"},"example":{"id":0,"name":"string","modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/producttypes/{id}":{"get":{"tags":["producttypes"],"summary":"Gets specific Product Type by unique id","description":"Gets specific Product Type by unique id","operationId":"get-producttypes-id","parameters":[{"name":"id","in":"path","description":"Product Type id","required":true,"schema":{"type":"integer","description":"Product Type id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Product Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductType"},"example":{"id":0,"name":"string","modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Product Type not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/fulfilment/fulfilmentorders":{"get":{"tags":["fulfilmentorders"],"summary":"Searches fulfilment orders by parameters","description":"Searches fulfilment orders by parameters","operationId":"get-fulfilment-fulfilmentorders","parameters":[{"name":"order_item_id","in":"query","description":"Order item id.","schema":{"type":"integer","description":"Order item id.","format":"int32","nullable":true}},{"name":"order_id","in":"query","description":"Order id.","schema":{"type":"integer","description":"Order id.","format":"int32","nullable":true}},{"name":"fulfilment_id","in":"query","description":"Fulfilment id","schema":{"type":"integer","description":"Fulfilment id","format":"int32","nullable":true}},{"name":"fulfilment_service_id","in":"query","description":"Fulfilment service id.","schema":{"type":"string","description":"Fulfilment service id.","format":"uuid","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns fulfilment orders","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fulfilment.Order.PagingResponse"},"example":{"data":[{"tracking_number":"string","tracking_link":"string","delivery_service":"string","fulfilment_service_id":"string","order_item_id":0,"order_id":0,"status":"string","error":"string","fulfilment_service_name":"string","fulfilment_id":0,"fulfilment_qty":0,"fulfilment_date":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/fulfilment/fulfilmentorders/{id}":{"get":{"tags":["fulfilmentorders"],"summary":"Get specific fulfilment order by fulfilment id","description":"Get specific fulfilment order by fulfilment id","operationId":"get-fulfilment-fulfilmentorders-id","parameters":[{"name":"id","in":"path","description":"Fulfilment id","required":true,"schema":{"type":"integer","description":"Fulfilment id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/fulfilment.ShippitOrder"}],"description":"Order model.","discriminator":{"propertyName":"fulfilment_service_id","mapping":{"afc01107-0905-4172-b0be-5787a8e6e0a5":"#/components/schemas/fulfilment.ShippitOrder"}}},"example":{"tracking_number":"string","tracking_link":"string","delivery_service":"string","fulfilment_service_id":"string","order_item_id":0,"order_id":0,"status":"string","error":"string","fulfilment_service_name":"string","fulfilment_id":0,"fulfilment_qty":0,"fulfilment_date":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/products/{id}/barcodes":{"get":{"tags":["products"],"summary":"Searches Product Barcodes by Product id and other parameters","description":"Searches Product Barcodes by Product id and other parameters","operationId":"get-products-id-barcodes","parameters":[{"name":"id","in":"path","description":"Product id","required":true,"schema":{"type":"integer","description":"Product id","format":"int32"}},{"name":"barcode","in":"query","description":"Product barcode name","schema":{"type":"string","description":"Product barcode name","nullable":true}},{"name":"enabled","in":"query","description":"Product barcode enabled","schema":{"type":"boolean","description":"Product barcode enabled","nullable":true}},{"name":"created_since","in":"query","description":"Created since","schema":{"type":"string","description":"Created since","format":"date-time","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Barcodes data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBarcode.PagingResponse"},"example":{"data":[{"id":0,"barcode":"string","enabled":true,"product_id":0,"created_on":"string","modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["products"],"summary":"Creates Product Barcode","description":"Sample request:\r\n\r\n POST /products/2/barcodes\r\n {\r\n \"barcode\": \"BARCODENAME\", \r\n \"enabled\": true\r\n }","operationId":"post-products-id-barcodes","parameters":[{"name":"id","in":"path","description":"Product id","required":true,"schema":{"type":"integer","description":"Product id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Product Barcode to be created","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Product Barcode was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBarcode"},"example":{"id":0,"barcode":"string","enabled":true,"product_id":0,"created_on":"string","modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/products/{id}/barcodes/{barcode_id}":{"get":{"tags":["products"],"summary":"Gets specific Product Barcode by unique Product Barcode id and Product id","description":"Gets specific Product Barcode by unique Product Barcode id and Product id","operationId":"get-products-id-barcodes-barcode_id","parameters":[{"name":"id","in":"path","description":"Product id","required":true,"schema":{"type":"integer","description":"Product id","format":"int32"}},{"name":"barcode_id","in":"path","description":"Product Barcode id","required":true,"schema":{"type":"integer","description":"Product Barcode id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Product Barcode","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBarcode"},"example":{"id":0,"barcode":"string","enabled":true,"product_id":0,"created_on":"string","modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["products"],"summary":"Updates Product Barcode by Product id and Product Barcode id.","description":"Sample request:\r\n \r\n PUT /products/2/barcodes/1\r\n {\r\n \"barcode\": \"BARCODENAME1\", \r\n \"enabled\": true\r\n }","operationId":"put-products-id-barcodes-barcode_id","parameters":[{"name":"id","in":"path","description":"Product id","required":true,"schema":{"type":"integer","description":"Product id","format":"int32"}},{"name":"barcode_id","in":"path","description":"Product Barcode id","required":true,"schema":{"type":"integer","description":"Product Barcode id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Product Barcode model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Product Barcode was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBarcode"},"example":{"id":0,"barcode":"string","enabled":true,"product_id":0,"created_on":"string","modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["products"],"summary":"Deletes specific Product Barcode by id","description":"Deletes specific Product Barcode by id","operationId":"delete-products-id-barcodes-barcode_id","parameters":[{"name":"id","in":"path","description":"Product id","required":true,"schema":{"type":"integer","description":"Product id","format":"int32"}},{"name":"barcode_id","in":"path","description":"Product Barcode id","required":true,"schema":{"type":"integer","description":"Product Barcode id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Product Barcode was deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/creditnotes":{"get":{"tags":["creditnotes"],"summary":"Search Credit Notes by parameters","description":"Search Credit Notes by parameters","operationId":"get-creditnotes","parameters":[{"name":"ids","in":"query","description":"Сredit note Ids. (comma separated)\r\nOther properties are skipped, if used.\r\nExample: 2,3,4","schema":{"type":"string","description":"Сredit note Ids. (comma separated)\r\nOther properties are skipped, if used.\r\nExample: 2,3,4","nullable":true}},{"name":"supplier_return_ids","in":"query","description":"Supplier Return Ids. (comma separated)\r\nExample: 2,3,4","schema":{"type":"string","description":"Supplier Return Ids. (comma separated)\r\nExample: 2,3,4","nullable":true}},{"name":"outlet_ids","in":"query","description":"Outlet Ids. (comma separated)\r\nExample: 2,3,4","schema":{"type":"string","description":"Outlet Ids. (comma separated)\r\nExample: 2,3,4","nullable":true}},{"name":"supplier_ids","in":"query","description":"Supplier Ids. (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Supplier Ids. (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"supplier_reference","in":"query","description":"Supplier reference.","schema":{"type":"string","description":"Supplier reference.","nullable":true}},{"name":"created_since","in":"query","description":"Created since","schema":{"type":"string","description":"Created since","format":"date-time","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\nAvailable field name values: id, supplier_return_id, supplier, outlet, supplier_reference, total_credit_quantity, total_credit_amount_ex, total_credit_amount_tax, total_credit_amount_inc, created_on, modified_on, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname, supplier_credited_on.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432","schema":{"type":"string","description":"Filter by. \r\nAvailable field name values: id, supplier_return_id, supplier, outlet, supplier_reference, total_credit_quantity, total_credit_amount_ex, total_credit_amount_tax, total_credit_amount_inc, created_on, modified_on, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname, supplier_credited_on.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, supplier_return_id, supplier, outlet, supplier_reference, total_credit_quantity, total_credit_amount_ex, total_credit_amount_tax, total_credit_amount_inc, created_on, modified_on, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname, supplier_credited_on. \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, supplier_return_id desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, supplier_return_id, supplier, outlet, supplier_reference, total_credit_quantity, total_credit_amount_ex, total_credit_amount_tax, total_credit_amount_inc, created_on, modified_on, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname, supplier_credited_on. \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, supplier_return_id desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Credit Notes returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNote.PagingResponse"},"example":{"data":[{"id":0,"supplier_return_id":0,"supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"outlet":{"id":0,"name":"string","modified_on":"string"},"supplier_reference":"string","include_tax":false,"rounding_adjustment":0,"total_credit_quantity":0,"total_credit_amount_ex":0,"total_credit_amount_tax":0,"total_credit_amount_inc":0,"total_applied_credit_quantity":0,"total_applied_credit_amount_ex":0,"total_applied_credit_amount_inc":0,"total_applied_credit_tax":0,"created_on":"string","modified_on":"string","supplier_credited_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/creditnotes/{id}":{"get":{"tags":["creditnotes"],"summary":"Get Credit Note by id","description":"Get Credit Note by id","operationId":"get-creditnotes-id","parameters":[{"name":"id","in":"path","description":"Credit Note id","required":true,"schema":{"type":"integer","description":"Credit Note id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Credit Note","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNote"},"example":{"id":0,"supplier_return_id":0,"supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"outlet":{"id":0,"name":"string","modified_on":"string"},"supplier_reference":"string","include_tax":false,"rounding_adjustment":0,"total_credit_quantity":0,"total_credit_amount_ex":0,"total_credit_amount_tax":0,"total_credit_amount_inc":0,"total_applied_credit_quantity":0,"total_applied_credit_amount_ex":0,"total_applied_credit_amount_inc":0,"total_applied_credit_tax":0,"created_on":"string","modified_on":"string","supplier_credited_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Credit Note not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/creditnotes/{id}/creditnoteitems":{"get":{"tags":["creditnotes"],"summary":"Searches Credit Note Items by parameters","description":"Searches Credit Note Items by parameters","operationId":"get-creditnotes-id-creditnoteitems","parameters":[{"name":"id","in":"path","description":"Credit Note id","required":true,"schema":{"type":"integer","description":"Credit Note id","format":"int32","example":1}},{"name":"supplier_return_item_ids","in":"query","description":"Supplier Return Item id or collection of Supplier Return Item id (comma separated)\r\nExample: 1,3,72,12","schema":{"type":"string","description":"Supplier Return Item id or collection of Supplier Return Item id (comma separated)\r\nExample: 1,3,72,12","nullable":true}},{"name":"created_since","in":"query","description":"Created since","schema":{"type":"string","description":"Created since","format":"date-time","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, credit_note_id, supplier_return_item_id, product_id, supplier_sku, manufacturer_sku, supplier_sku2, short_description, size, colour, credit_quantity, credit_amount_ex, total_credit_amount_ex, total_credit_amount_tax, total_credit_amount_inc, created_on, modified_on, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname. \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, credit_note_id desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, credit_note_id, supplier_return_item_id, product_id, supplier_sku, manufacturer_sku, supplier_sku2, short_description, size, colour, credit_quantity, credit_amount_ex, total_credit_amount_ex, total_credit_amount_tax, total_credit_amount_inc, created_on, modified_on, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname. \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, credit_note_id desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Credit Note Items returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteItem.PagingResponse"},"example":{"data":[{"id":0,"credit_note_id":0,"supplier_return_item_id":0,"product":{"id":0,"supplier_sku":"string","manufacturer_sku":"string","supplier_sku2":"string","short_description":"string","size":{"id":0,"name":"string","list_order":0},"colour":{"id":0,"name":"string","list_order":0},"modified_on":"string"},"credit_quantity":0,"credit_amount_ex":0,"total_credit_amount_ex":0,"applied_credit_quantity":0,"applied_credit_tax":0,"applied_credit_amount_inc":0,"applied_credit_amount_ex":0,"total_applied_credit_amount_ex":0,"total_credit_amount_inc":0,"total_credit_amount_tax":0,"total_applied_credit_amount_inc":0,"total_applied_credit_tax":0,"created_on":"string","modified_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/creditnotes/{id}/creditnoteitems/{item_id}":{"get":{"tags":["creditnotes"],"summary":"Gets Credit Note Item by id","description":"Gets Credit Note Item by id","operationId":"get-creditnotes-id-creditnoteitems-item_id","parameters":[{"name":"id","in":"path","description":"Credit Note id","required":true,"schema":{"type":"integer","description":"Credit Note id","format":"int32","example":1}},{"name":"item_id","in":"path","description":"Credit Note Item id","required":true,"schema":{"type":"integer","description":"Credit Note Item id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Credit Note","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteItem"},"example":{"id":0,"credit_note_id":0,"supplier_return_item_id":0,"product":{"id":0,"supplier_sku":"string","manufacturer_sku":"string","supplier_sku2":"string","short_description":"string","size":{"id":0,"name":"string","list_order":0},"colour":{"id":0,"name":"string","list_order":0},"modified_on":"string"},"credit_quantity":0,"credit_amount_ex":0,"total_credit_amount_ex":0,"applied_credit_quantity":0,"applied_credit_tax":0,"applied_credit_amount_inc":0,"applied_credit_amount_ex":0,"total_applied_credit_amount_ex":0,"total_credit_amount_inc":0,"total_credit_amount_tax":0,"total_applied_credit_amount_inc":0,"total_applied_credit_tax":0,"created_on":"string","modified_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Credit Note Item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/outlets":{"get":{"tags":["outlets"],"summary":"Searches Outlets by parameters","description":"Searches Outlets by parameters","operationId":"get-outlets","parameters":[{"name":"enabled","in":"query","description":"Enabled flag.","schema":{"type":"boolean","description":"Enabled flag.","nullable":true}},{"name":"id","in":"query","description":"Outlet Id. Other properties are skipped, if used","schema":{"type":"integer","description":"Outlet Id. Other properties are skipped, if used","format":"int32","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Outlets","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Outlet.PagingResponse"},"example":{"data":[{"id":0,"name":"string","external_reference":"string","enabled":true,"company_name":"string","company_registration_number":"string","company_registration_label":"string","billing_type":0,"fob_currency":{"id":0,"currency_code":"string","currency_name":"string"},"store_type":{"id":0,"name":"string"},"address":{"address_line1":"string","address_line2":"string","address_line3":"string","suburb":"string","state":"string","postcode":"string","country":{"id":0,"name":"string"}},"phone":"string","fax":"string","email":"string","bank_details":{"bank_name":"string","bsb":"string","account_number":"string","account_name":"string"},"default_source_outlet":{"id":0,"name":"string"},"default_fulfil_outlet":{"id":0,"name":"string"},"minimum_replenishment_quantity":0,"logo":{"id":0,"description":"string"},"invoice_email_template":{"id":0,"name":"string"},"invoice_receipt_comments":"string","display_address_on_invoice":true,"purchase_order_comments":"string","modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/outlets/{id}":{"get":{"tags":["outlets"],"summary":"Gets specific Outlet by unique id","description":"Gets specific Outlet by unique id","operationId":"get-outlets-id","parameters":[{"name":"id","in":"path","description":"Outlet id","required":true,"schema":{"type":"integer","description":"Outlet id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Outlet","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Outlet"},"example":{"id":0,"name":"string","external_reference":"string","enabled":true,"company_name":"string","company_registration_number":"string","company_registration_label":"string","billing_type":0,"fob_currency":{"id":0,"currency_code":"string","currency_name":"string"},"store_type":{"id":0,"name":"string"},"address":{"address_line1":"string","address_line2":"string","address_line3":"string","suburb":"string","state":"string","postcode":"string","country":{"id":0,"name":"string"}},"phone":"string","fax":"string","email":"string","bank_details":{"bank_name":"string","bsb":"string","account_number":"string","account_name":"string"},"default_source_outlet":{"id":0,"name":"string"},"default_fulfil_outlet":{"id":0,"name":"string"},"minimum_replenishment_quantity":0,"logo":{"id":0,"description":"string"},"invoice_email_template":{"id":0,"name":"string"},"invoice_receipt_comments":"string","display_address_on_invoice":true,"purchase_order_comments":"string","modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Outlet not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/supplierreturnitemsource":{"get":{"tags":["supplierreturnitemsource"],"summary":"Searches Supplier Return Item Sources by parameters","description":"Searches Supplier Return Item Sources by parameters","operationId":"get-supplierreturnitemsource","parameters":[{"name":"name","in":"query","description":"Supplier Return Item source name.","schema":{"type":"string","description":"Supplier Return Item source name.","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, name\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, name\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Supplier Return Item Sources data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturnItemSource.PagingResponse"},"example":{"data":[{"id":0,"name":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/supplierreturnitemsource/{id}":{"get":{"tags":["supplierreturnitemsource"],"summary":"Gets specific Supplier Return Item Source by unique id","description":"Gets specific Supplier Return Item Source by unique id","operationId":"get-supplierreturnitemsource-id","parameters":[{"name":"id","in":"path","description":"Supplier Return Source id","required":true,"schema":{"type":"integer","description":"Supplier Return Source id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Supplier Return Item Source","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturnItemSource"},"example":{"id":0,"name":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Supplier Return Item Source not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/supplierreturnitemstatus":{"get":{"tags":["supplierreturnitemstatus"],"summary":"Searches Supplier Return Item Statuses by parameters","description":"Searches Supplier Return Item Statuses by parameters","operationId":"get-supplierreturnitemstatus","parameters":[{"name":"name","in":"query","description":"SupplierReturnItemStatus name.","schema":{"type":"string","description":"SupplierReturnItemStatus name.","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, name. \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, name. \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Supplier Return Item Statuses data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturnItemStatus.PagingResponse"},"example":{"data":[{"id":0,"name":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/supplierreturnitemstatus/{id}":{"get":{"tags":["supplierreturnitemstatus"],"summary":"Gets specific Supplier Return Item Status by unique id","description":"Gets specific Supplier Return Item Status by unique id","operationId":"get-supplierreturnitemstatus-id","parameters":[{"name":"id","in":"path","description":"Supplier Return Status id","required":true,"schema":{"type":"integer","description":"Supplier Return Status id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Supplier Return Item Status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturnItemStatus"},"example":{"id":0,"name":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Supplier Return Item Status not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/supplierreturnreasons":{"post":{"tags":["supplierreturnreasons"],"summary":"Creates Supplier Return Reason","description":"Sample request:\r\n\r\n POST /supplierreturnreasons\r\n {\r\n \"name\": \"Supplier Return Reason\"\r\n }","operationId":"post-supplierreturnreasons","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Supplier Return Reason model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Supplier Return Reason created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturnReasons"},"example":{"id":0,"name":"string","created_on":"string","modified_on":"string","deleted":false,"deleted_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"get":{"tags":["supplierreturnreasons"],"summary":"Searches Supplier Return Reasons by parameters","description":"Searches Supplier Return Reasons by parameters","operationId":"get-supplierreturnreasons","parameters":[{"name":"is_deleted","in":"query","description":"Is deleted? \r\n\r\nLeave it empty to get both deleted and not deleted Supplier Return Reasons","schema":{"type":"boolean","description":"Is deleted? \r\n\r\nLeave it empty to get both deleted and not deleted Supplier Return Reasons","nullable":true}},{"name":"created_since","in":"query","description":"Created since","schema":{"type":"string","description":"Created since","format":"date-time","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"select","in":"query","description":"Select fields.\r\n\r\nAvailable field name values: id\r\n\r\nExample: id","schema":{"type":"string","description":"Select fields.\r\n\r\nAvailable field name values: id\r\n\r\nExample: id","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, name, created_on, modified_on. \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, name, created_on, modified_on. \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Supplier Return Reasons data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturnReasons.PagingResponse"},"example":{"data":[{"id":0,"name":"string","created_on":"string","modified_on":"string","deleted":false,"deleted_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/supplierreturnreasons/{id}":{"put":{"tags":["supplierreturnreasons"],"summary":"Updates Supplier Return Reason","description":"Sample request:\r\n\r\n PUT /supplierreturnreasons\r\n {\r\n \"name\": \"New Supplier Return Reason\"\r\n }","operationId":"put-supplierreturnreasons-id","parameters":[{"name":"id","in":"path","description":"Supplier Return Reason id","required":true,"schema":{"type":"integer","description":"Supplier Return Reason id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Supplier Return Reason model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Returns updated Supplier Return Reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturnReasons"},"example":{"id":0,"name":"string","created_on":"string","modified_on":"string","deleted":false,"deleted_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Supplier Return Reason not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["supplierreturnreasons"],"summary":"Deletes Supplier Return Reason by id","description":"Deletes Supplier Return Reason by id","operationId":"delete-supplierreturnreasons-id","parameters":[{"name":"id","in":"path","description":"Supplier Return Reason id","required":true,"schema":{"type":"integer","description":"Supplier Return Reason id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Supplier Return Reason deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Supplier Return Reason not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"get":{"tags":["supplierreturnreasons"],"summary":"Gets specific Supplier Return Reason by unique id","description":"Gets specific Supplier Return Reason by unique id","operationId":"get-supplierreturnreasons-id","parameters":[{"name":"id","in":"path","description":"Supplier Return Reason id","required":true,"schema":{"type":"integer","description":"Supplier Return Reason id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Supplier Return Reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturnReasons"},"example":{"id":0,"name":"string","created_on":"string","modified_on":"string","deleted":false,"deleted_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Supplier Return Reason not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/supplierreturns":{"get":{"tags":["supplierreturns"],"summary":"Searches Supplier Returns by parameters","description":"Searches Supplier Returns by parameters","operationId":"get-supplierreturns","parameters":[{"name":"ids","in":"query","description":"List of supplier returns identifiers\r\n Example: 2,3,4","schema":{"type":"string","description":"List of supplier returns identifiers\r\n Example: 2,3,4","nullable":true}},{"name":"supplier_ids","in":"query","description":"List of supplier identifiers\r\n Example: 2,3,4","schema":{"type":"string","description":"List of supplier identifiers\r\n Example: 2,3,4","nullable":true}},{"name":"outlet_ids","in":"query","description":"List of outlet identifiers\r\n Example: 2,3,4","schema":{"type":"string","description":"List of outlet identifiers\r\n Example: 2,3,4","nullable":true}},{"name":"supplier_return_status_ids","in":"query","description":"List of Supplier Return Status identifiers\r\n Example: 2,3,4","schema":{"type":"string","description":"List of Supplier Return Status identifiers\r\n Example: 2,3,4","nullable":true}},{"name":"created_since","in":"query","description":"Created since","schema":{"type":"string","description":"Created since","format":"date-time","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"include_credit_notes","in":"query","description":"Include Credit Notes flag","schema":{"type":"boolean","description":"Include Credit Notes flag"}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, supplier, outlet, supplier_return_status, return_authorisation, total_return_quantity, total_claim_amount_ex, total_claim_amount_tax, total_claim_amount_inc, total_credit_received_ex, total_credit_received_inc, created_on, started_on, modified_on, finalised_on, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, supplier desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, supplier, outlet, supplier_return_status, return_authorisation, total_return_quantity, total_claim_amount_ex, total_claim_amount_tax, total_claim_amount_inc, total_credit_received_ex, total_credit_received_inc, created_on, started_on, modified_on, finalised_on, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, supplier desc","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, supplier, outlet, supplier_return_status, return_authorisation, created_on, started_on, finalised_on, modified_on, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname, total_return_quantity, total_claim_amount_ex, total_claim_amount_tax, total_claim_amount_inc, total_credit_received_ex, total_credit_received_inc, credit_note_number (for value, ​matches id or supplier_reference of any of credit_notes linked to Supplier Return. Supported operators are eq, neq, contains, doesnotcontain, in, notin)\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,supplier:in:supplier1|supplier2","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, supplier, outlet, supplier_return_status, return_authorisation, created_on, started_on, finalised_on, modified_on, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname, total_return_quantity, total_claim_amount_ex, total_claim_amount_tax, total_claim_amount_inc, total_credit_received_ex, total_credit_received_inc, credit_note_number (for value, ​matches id or supplier_reference of any of credit_notes linked to Supplier Return. Supported operators are eq, neq, contains, doesnotcontain, in, notin)\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,supplier:in:supplier1|supplier2","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Supplier Returns","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturns.PagingResponse"},"example":{"data":[{"id":0,"include_tax":true,"supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"outlet":{"id":0,"name":"string","modified_on":"string"},"supplier_return_status":{"id":0,"name":"string"},"supplier_address":{"address_line1":"string","suburb":"string","state":"string","postcode":"string","country":{"id":0,"name":"string"}},"total_return_quantity":0,"total_claim_amount_ex":0,"total_claim_amount_tax":0,"total_claim_amount_inc":0,"total_credit_received_ex":0,"total_credit_received_inc":0,"notes":"string","return_authorisation":"string","started_on":"string","created_on":"string","modified_on":"string","finalised_on":"string","credit_notes":[{"id":0,"supplier_return_id":0,"supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"outlet":{"id":0,"name":"string","modified_on":"string"},"supplier_reference":"string","include_tax":false,"rounding_adjustment":0,"total_credit_quantity":0,"total_credit_amount_ex":0,"total_credit_amount_tax":0,"total_credit_amount_inc":0,"total_applied_credit_quantity":0,"total_applied_credit_amount_ex":0,"total_applied_credit_amount_inc":0,"total_applied_credit_tax":0,"created_on":"string","modified_on":"string","supplier_credited_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}],"created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["supplierreturns"],"summary":"Creates Supplier Return","description":"Sample request:\r\n\r\n POST /supplierreturns\r\n {\r\n \"supplier\":{\r\n \"id\": 1\r\n },\r\n \"outlet\":{\r\n \"id\": 1\r\n },\r\n \"notes\": \"notes\",\r\n \"return_authorisation\": \"return authorisation\",\r\n \"include_tax\": false\r\n }","operationId":"post-supplierreturns","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Supplier Return model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Supplier Return created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturns"},"example":{"id":0,"include_tax":true,"supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"outlet":{"id":0,"name":"string","modified_on":"string"},"supplier_return_status":{"id":0,"name":"string"},"supplier_address":{"address_line1":"string","suburb":"string","state":"string","postcode":"string","country":{"id":0,"name":"string"}},"total_return_quantity":0,"total_claim_amount_ex":0,"total_claim_amount_tax":0,"total_claim_amount_inc":0,"total_credit_received_ex":0,"total_credit_received_inc":0,"notes":"string","return_authorisation":"string","started_on":"string","created_on":"string","modified_on":"string","finalised_on":"string","credit_notes":[{"id":0,"supplier_return_id":0,"supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"outlet":{"id":0,"name":"string","modified_on":"string"},"supplier_reference":"string","include_tax":false,"rounding_adjustment":0,"total_credit_quantity":0,"total_credit_amount_ex":0,"total_credit_amount_tax":0,"total_credit_amount_inc":0,"total_applied_credit_quantity":0,"total_applied_credit_amount_ex":0,"total_applied_credit_amount_inc":0,"total_applied_credit_tax":0,"created_on":"string","modified_on":"string","supplier_credited_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}],"created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/supplierreturns/{id}":{"get":{"tags":["supplierreturns"],"summary":"Gets specific Supplier Return by unique id","description":"Gets specific Supplier Return by unique id","operationId":"get-supplierreturns-id","parameters":[{"name":"id","in":"path","description":"Supplier Return id","required":true,"schema":{"type":"integer","description":"Supplier Return id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Supplier Return","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturns"},"example":{"id":0,"include_tax":true,"supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"outlet":{"id":0,"name":"string","modified_on":"string"},"supplier_return_status":{"id":0,"name":"string"},"supplier_address":{"address_line1":"string","suburb":"string","state":"string","postcode":"string","country":{"id":0,"name":"string"}},"total_return_quantity":0,"total_claim_amount_ex":0,"total_claim_amount_tax":0,"total_claim_amount_inc":0,"total_credit_received_ex":0,"total_credit_received_inc":0,"notes":"string","return_authorisation":"string","started_on":"string","created_on":"string","modified_on":"string","finalised_on":"string","credit_notes":[{"id":0,"supplier_return_id":0,"supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"outlet":{"id":0,"name":"string","modified_on":"string"},"supplier_reference":"string","include_tax":false,"rounding_adjustment":0,"total_credit_quantity":0,"total_credit_amount_ex":0,"total_credit_amount_tax":0,"total_credit_amount_inc":0,"total_applied_credit_quantity":0,"total_applied_credit_amount_ex":0,"total_applied_credit_amount_inc":0,"total_applied_credit_tax":0,"created_on":"string","modified_on":"string","supplier_credited_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}],"created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Supplier Return not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["supplierreturns"],"summary":"Updates Supplier Return","description":"Sample request:\r\n\r\n PUT /supplierreturns\r\n {\r\n \"supplier\":{\r\n \"id\": 1\r\n },\r\n \"outlet\":{\r\n \"id\": 1\r\n },\r\n \"supplier_address\":{\r\n \"address_line1\": \"address\",\r\n \"suburb\": \"suburb\",\r\n \"state\": \"state\",\r\n \"postcode\": \"postcode\",\r\n \"country\":{\r\n \"id\": 1,\r\n \"name\": \"country_name\"\r\n }\r\n },\r\n \"notes\": \"notes\",\r\n \"return_authorisation\": \"return authorisation\",\r\n \"include_tax\": false,\r\n \"supplier_return_status\":{\r\n \"id\": 1\r\n }\r\n }","operationId":"put-supplierreturns-id","parameters":[{"name":"id","in":"path","description":"Supplier Return id","required":true,"schema":{"type":"integer","description":"Supplier Return id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Supplier Return model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Returns updated Supplier Return","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturns"},"example":{"id":0,"include_tax":true,"supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"outlet":{"id":0,"name":"string","modified_on":"string"},"supplier_return_status":{"id":0,"name":"string"},"supplier_address":{"address_line1":"string","suburb":"string","state":"string","postcode":"string","country":{"id":0,"name":"string"}},"total_return_quantity":0,"total_claim_amount_ex":0,"total_claim_amount_tax":0,"total_claim_amount_inc":0,"total_credit_received_ex":0,"total_credit_received_inc":0,"notes":"string","return_authorisation":"string","started_on":"string","created_on":"string","modified_on":"string","finalised_on":"string","credit_notes":[{"id":0,"supplier_return_id":0,"supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"outlet":{"id":0,"name":"string","modified_on":"string"},"supplier_reference":"string","include_tax":false,"rounding_adjustment":0,"total_credit_quantity":0,"total_credit_amount_ex":0,"total_credit_amount_tax":0,"total_credit_amount_inc":0,"total_applied_credit_quantity":0,"total_applied_credit_amount_ex":0,"total_applied_credit_amount_inc":0,"total_applied_credit_tax":0,"created_on":"string","modified_on":"string","supplier_credited_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}],"created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Supplier Return Reason not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/supplierreturns/{id}/supplierreturnitems":{"get":{"tags":["supplierreturns"],"summary":"Searches Supplier Return Items by Supplier Return id and other parameters","description":"Searches Supplier Return Items by Supplier Return id and other parameters","operationId":"get-supplierreturns-id-supplierreturnitems","parameters":[{"name":"id","in":"path","description":"Supplier Return id","required":true,"schema":{"type":"integer","description":"Supplier Return id","format":"int32"}},{"name":"ids","in":"query","description":"Supplier Return Items ids. (comma separated)\r\nOther properties are skipped, if used.\r\n Example: 2,3,4","schema":{"type":"string","description":"Supplier Return Items ids. (comma separated)\r\nOther properties are skipped, if used.\r\n Example: 2,3,4","nullable":true}},{"name":"supplier_return_reason_ids","in":"query","description":"Supplier Return reason ids.\r\n Example: 2,3,4","schema":{"type":"string","description":"Supplier Return reason ids.\r\n Example: 2,3,4","nullable":true}},{"name":"supplier_return_item_status_ids","in":"query","description":"Supplier Return Item status ids.\r\n Example: 2,3,4","schema":{"type":"string","description":"Supplier Return Item status ids.\r\n Example: 2,3,4","nullable":true}},{"name":"supplier_return_item_source_ids","in":"query","description":"Supplier Return Item source ids.\r\n Example: 2,3,4","schema":{"type":"string","description":"Supplier Return Item source ids.\r\n Example: 2,3,4","nullable":true}},{"name":"created_since","in":"query","description":"Created since","schema":{"type":"string","description":"Created since","format":"date-time","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"select","in":"query","description":"Select fields.\r\n\r\nAvailable field name values: id\r\n\r\nExample: id","schema":{"type":"string","description":"Select fields.\r\n\r\nAvailable field name values: id\r\n\r\nExample: id","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, product_id, size, colour, supplier_sku, manufacturer_sku, supplier_sku2, short_description, supplier_return_reason, return_quantity, original_buy_ex, total_original_buy_ex, supplier_return_item_status, supplier_return_item_source, original_supplier_invoice, total_claim_amount_ex, total_claim_amount_tax, total_claim_amount_inc, claim_amount_ex, credit_note_id, credit_note_item_id, credit_amount_ex, supplier_return_item_notes, total_credit_amount_ex, total_credit_amount_inc, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, product_id desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, product_id, size, colour, supplier_sku, manufacturer_sku, supplier_sku2, short_description, supplier_return_reason, return_quantity, original_buy_ex, total_original_buy_ex, supplier_return_item_status, supplier_return_item_source, original_supplier_invoice, total_claim_amount_ex, total_claim_amount_tax, total_claim_amount_inc, claim_amount_ex, credit_note_id, credit_note_item_id, credit_amount_ex, supplier_return_item_notes, total_credit_amount_ex, total_credit_amount_inc, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, product_id desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Supplier Return Items","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturnItem.PagingResponse"},"example":{"data":[{"id":0,"supplier_return_id":0,"product":{"id":0,"supplier_sku":"string","manufacturer_sku":"string","supplier_sku2":"string","short_description":"string","size":{"id":0,"name":"string","list_order":0},"colour":{"id":0,"name":"string","list_order":0}},"supplier_return_reason":{"id":0,"name":"string","created_on":"string","modified_on":"string","deleted":false,"deleted_on":"string"},"credit_note_item":{"id":0,"credit_note_id":0,"credit_amount_ex":0,"total_credit_amount_ex":0,"total_credit_amount_inc":0},"return_quantity":0,"original_buy_ex":0,"total_original_buy_ex":0,"supplier_return_item_status":{"id":0,"name":"string"},"supplier_return_item_source":{"id":0,"name":"string"},"original_supplier_invoice":"string","claim_amount_ex":0,"supplier_return_item_notes":"string","total_claim_amount_ex":0,"total_claim_amount_tax":0,"total_claim_amount_inc":0,"created_on":"string","modified_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["supplierreturns"],"summary":"Creates Supplier Return Item","description":"Sample request:\r\n\r\n POST /supplierreturns/1/supplierreturnitems\r\n {\r\n \"product\": {\r\n \"id\": 1\r\n },\r\n \"supplier_return_reason\": {\r\n \"id\": 1\r\n },\r\n \"return_quantity\": 1,\r\n \"original_buy_ex\": 1.1,\r\n \"claim_amount_ex\": 1.1,\r\n \"supplier_return_item_source\": {\r\n \"id\": 1\r\n },\r\n \"original_supplier_invoice\": \"original supplier invoice\",\r\n \"supplier_return_item_notes\": \"notes\"\r\n }","operationId":"post-supplierreturns-id-supplierreturnitems","parameters":[{"name":"id","in":"path","description":"Supplier Return id","required":true,"schema":{"type":"integer","description":"Supplier Return id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Supplier Return Item to be created","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Supplier Return Item was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturnItem"},"example":{"id":0,"supplier_return_id":0,"product":{"id":0,"supplier_sku":"string","manufacturer_sku":"string","supplier_sku2":"string","short_description":"string","size":{"id":0,"name":"string","list_order":0},"colour":{"id":0,"name":"string","list_order":0}},"supplier_return_reason":{"id":0,"name":"string","created_on":"string","modified_on":"string","deleted":false,"deleted_on":"string"},"credit_note_item":{"id":0,"credit_note_id":0,"credit_amount_ex":0,"total_credit_amount_ex":0,"total_credit_amount_inc":0},"return_quantity":0,"original_buy_ex":0,"total_original_buy_ex":0,"supplier_return_item_status":{"id":0,"name":"string"},"supplier_return_item_source":{"id":0,"name":"string"},"original_supplier_invoice":"string","claim_amount_ex":0,"supplier_return_item_notes":"string","total_claim_amount_ex":0,"total_claim_amount_tax":0,"total_claim_amount_inc":0,"created_on":"string","modified_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/supplierreturns/{id}/supplierreturnitems/{item_id}":{"get":{"tags":["supplierreturns"],"summary":"Get specific Supplier Return Item by Supplier Return id and Supplier Return Item id","description":"Get specific Supplier Return Item by Supplier Return id and Supplier Return Item id","operationId":"get-supplierreturns-id-supplierreturnitems-item_id","parameters":[{"name":"id","in":"path","description":"Supplier Return id","required":true,"schema":{"type":"integer","description":"Supplier Return id","format":"int32"}},{"name":"item_id","in":"path","description":"Supplier Return Item id","required":true,"schema":{"type":"integer","description":"Supplier Return Item id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Supplier Return Item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturnItem"},"example":{"id":0,"supplier_return_id":0,"product":{"id":0,"supplier_sku":"string","manufacturer_sku":"string","supplier_sku2":"string","short_description":"string","size":{"id":0,"name":"string","list_order":0},"colour":{"id":0,"name":"string","list_order":0}},"supplier_return_reason":{"id":0,"name":"string","created_on":"string","modified_on":"string","deleted":false,"deleted_on":"string"},"credit_note_item":{"id":0,"credit_note_id":0,"credit_amount_ex":0,"total_credit_amount_ex":0,"total_credit_amount_inc":0},"return_quantity":0,"original_buy_ex":0,"total_original_buy_ex":0,"supplier_return_item_status":{"id":0,"name":"string"},"supplier_return_item_source":{"id":0,"name":"string"},"original_supplier_invoice":"string","claim_amount_ex":0,"supplier_return_item_notes":"string","total_claim_amount_ex":0,"total_claim_amount_tax":0,"total_claim_amount_inc":0,"created_on":"string","modified_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Supplier Return Item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["supplierreturns"],"summary":"Deletes specific Supplier Return Item by id","description":"Deletes specific Supplier Return Item by id","operationId":"delete-supplierreturns-id-supplierreturnitems-item_id","parameters":[{"name":"id","in":"path","description":"Supplier Return Id","required":true,"schema":{"type":"integer","description":"Supplier Return Id","format":"int32"}},{"name":"item_id","in":"path","description":"Supplier Return Item Id","required":true,"schema":{"type":"integer","description":"Supplier Return Item Id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Supplier Return Item was deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["supplierreturns"],"summary":"Updates Supplier Return Item","description":"Sample request:\r\n\r\n PUT /supplierreturns/1/supplierreturnitems/1\r\n {\r\n \"product\": {\r\n \"id\": 1\r\n },\r\n \"supplier_return_reason\": {\r\n \"id\": 1\r\n },\r\n \"return_quantity\": 1,\r\n \"original_buy_ex\": 1.1,\r\n \"claim_amount_ex\": 1.1,\r\n \"supplier_return_item_status\": {\r\n \"id\": 1\r\n },\r\n \"supplier_return_item_source\": {\r\n \"id\": 1\r\n },\r\n \"original_supplier_invoice\": \"original supplier invoice\",\r\n \"supplier_return_item_notes\": \"notes\"\r\n }","operationId":"put-supplierreturns-id-supplierreturnitems-item_id","parameters":[{"name":"id","in":"path","description":"Supplier Return id","required":true,"schema":{"type":"integer","description":"Supplier Return id","format":"int32"}},{"name":"item_id","in":"path","description":"Supplier Return Item id","required":true,"schema":{"type":"integer","description":"Supplier Return Item id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Supplier Return Item model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Returns updated Supplier Return Item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturnItem"},"example":{"id":0,"supplier_return_id":0,"product":{"id":0,"supplier_sku":"string","manufacturer_sku":"string","supplier_sku2":"string","short_description":"string","size":{"id":0,"name":"string","list_order":0},"colour":{"id":0,"name":"string","list_order":0}},"supplier_return_reason":{"id":0,"name":"string","created_on":"string","modified_on":"string","deleted":false,"deleted_on":"string"},"credit_note_item":{"id":0,"credit_note_id":0,"credit_amount_ex":0,"total_credit_amount_ex":0,"total_credit_amount_inc":0},"return_quantity":0,"original_buy_ex":0,"total_original_buy_ex":0,"supplier_return_item_status":{"id":0,"name":"string"},"supplier_return_item_source":{"id":0,"name":"string"},"original_supplier_invoice":"string","claim_amount_ex":0,"supplier_return_item_notes":"string","total_claim_amount_ex":0,"total_claim_amount_tax":0,"total_claim_amount_inc":0,"created_on":"string","modified_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Supplier Return not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/supplierreturns/{id}/creditnotes":{"post":{"tags":["supplierreturns"],"summary":"Creates Credit Note with Credit Note Items","description":"Sample request:\r\n\r\n POST /supplierreturns/{id}/creditnotes\r\n {\r\n \"supplier_reference\": \"supplier_reference\",\r\n \"supplier_credited_on\": \"2022-11-18\",\r\n \"credit_note_items\": [\r\n {\r\n \"supplier_return_item_id\": 1\r\n },\r\n {\r\n \"supplier_return_item_id\": 2\r\n }\r\n ]\r\n }","operationId":"post-supplierreturns-id-creditnotes","parameters":[{"name":"id","in":"path","description":"Supplier Return id","required":true,"schema":{"type":"integer","description":"Supplier Return id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Credit Note to be created","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Credit Note model with Credit Note Items were created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturnsCreditNote"},"example":{"id":0,"supplier_return_id":0,"supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"outlet":{"id":0,"name":"string","modified_on":"string"},"supplier_reference":"string","include_tax":false,"rounding_adjustment":0,"total_credit_quantity":0,"total_credit_amount_ex":0,"total_credit_amount_tax":0,"total_credit_amount_inc":0,"total_applied_credit_quantity":0,"total_applied_credit_amount_ex":0,"total_applied_credit_amount_inc":0,"total_applied_credit_tax":0,"credit_note_items":[{"id":0,"supplier_return_item_id":0}],"created_on":"string","modified_on":"string","supplier_credited_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"get":{"tags":["supplierreturns"],"summary":"Searches Supplier Return Credit Notes by parameters","description":"Searches Supplier Return Credit Notes by parameters","operationId":"get-supplierreturns-id-creditnotes","parameters":[{"name":"id","in":"path","description":"Supplier Return id","required":true,"schema":{"type":"integer","description":"Supplier Return id","format":"int32"}},{"name":"ids","in":"query","description":"Сredit note Ids. (comma separated)\r\nOther properties are skipped, if used.\r\nExample: 2,3,4","schema":{"type":"string","description":"Сredit note Ids. (comma separated)\r\nOther properties are skipped, if used.\r\nExample: 2,3,4","nullable":true}},{"name":"supplier_reference","in":"query","description":"Supplier reference.","schema":{"type":"string","description":"Supplier reference.","nullable":true}},{"name":"created_since","in":"query","description":"Created since","schema":{"type":"string","description":"Created since","format":"date-time","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\nAvailable field name values: id, supplier, outlet, supplier_reference, total_credit_quantity, total_credit_amount_ex, total_credit_amount_tax, total_credit_amount_inc, created_on, modified_on, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname, supplier_credited_on.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432","schema":{"type":"string","description":"Filter by. \r\nAvailable field name values: id, supplier, outlet, supplier_reference, total_credit_quantity, total_credit_amount_ex, total_credit_amount_tax, total_credit_amount_inc, created_on, modified_on, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname, supplier_credited_on.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, supplier_return_id, supplier, outlet, supplier_reference, total_credit_quantity, total_credit_amount_ex, total_credit_amount_tax, total_credit_amount_inc, created_on, modified_on, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname, supplier_credited_on. \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, supplier_reference desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, supplier_return_id, supplier, outlet, supplier_reference, total_credit_quantity, total_credit_amount_ex, total_credit_amount_tax, total_credit_amount_inc, created_on, modified_on, created_by_id, created_by_first_name, created_by_surname, modified_by_id, modified_by_first_name, modified_by_surname, supplier_credited_on. \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, supplier_reference desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Credit Notes with Credit Note Items","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturnsCreditNote.PagingResponse"},"example":{"data":[{"id":0,"supplier_return_id":0,"supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"outlet":{"id":0,"name":"string","modified_on":"string"},"supplier_reference":"string","include_tax":false,"rounding_adjustment":0,"total_credit_quantity":0,"total_credit_amount_ex":0,"total_credit_amount_tax":0,"total_credit_amount_inc":0,"total_applied_credit_quantity":0,"total_applied_credit_amount_ex":0,"total_applied_credit_amount_inc":0,"total_applied_credit_tax":0,"credit_note_items":[{"id":0,"supplier_return_item_id":0}],"created_on":"string","modified_on":"string","supplier_credited_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/supplierreturns/{id}/creditnotes/{note_id}":{"get":{"tags":["supplierreturns"],"summary":"Gets a Credit Note with Credit Note Items by Supplier Return id and Credit Note id","description":"Gets a Credit Note with Credit Note Items by Supplier Return id and Credit Note id","operationId":"get-supplierreturns-id-creditnotes-note_id","parameters":[{"name":"id","in":"path","description":"Supplier Return id","required":true,"schema":{"type":"integer","description":"Supplier Return id","format":"int32"}},{"name":"note_id","in":"path","description":"Credit Note id","required":true,"schema":{"type":"integer","description":"Credit Note id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Credit Note","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturnsCreditNote"},"example":{"id":0,"supplier_return_id":0,"supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"outlet":{"id":0,"name":"string","modified_on":"string"},"supplier_reference":"string","include_tax":false,"rounding_adjustment":0,"total_credit_quantity":0,"total_credit_amount_ex":0,"total_credit_amount_tax":0,"total_credit_amount_inc":0,"total_applied_credit_quantity":0,"total_applied_credit_amount_ex":0,"total_applied_credit_amount_inc":0,"total_applied_credit_tax":0,"credit_note_items":[{"id":0,"supplier_return_item_id":0}],"created_on":"string","modified_on":"string","supplier_credited_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Credit Note not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["supplierreturns"],"summary":"Updates Credite Note by Supplier Return id and Credit Note id","description":"Sample request:\r\n\r\n PUT /supplierreturns/1/creditnotes/1\r\n {\r\n \"supplier_credited_on\": \"2022-11-18\",\r\n \"supplier_reference\": \"ref\"\r\n }","operationId":"put-supplierreturns-id-creditnotes-note_id","parameters":[{"name":"id","in":"path","description":"Supplier Return id","required":true,"schema":{"type":"integer","description":"Supplier Return id","format":"int32"}},{"name":"note_id","in":"path","description":"Credit Note id","required":true,"schema":{"type":"integer","description":"Credit Note id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Credit Note to be updated","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Returns updated Credit Note","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturnsCreditNote"},"example":{"id":0,"supplier_return_id":0,"supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"outlet":{"id":0,"name":"string","modified_on":"string"},"supplier_reference":"string","include_tax":false,"rounding_adjustment":0,"total_credit_quantity":0,"total_credit_amount_ex":0,"total_credit_amount_tax":0,"total_credit_amount_inc":0,"total_applied_credit_quantity":0,"total_applied_credit_amount_ex":0,"total_applied_credit_amount_inc":0,"total_applied_credit_tax":0,"credit_note_items":[{"id":0,"supplier_return_item_id":0}],"created_on":"string","modified_on":"string","supplier_credited_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Credit Note not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/supplierreturnstatus":{"get":{"tags":["supplierreturnstatus"],"summary":"Searches Supplier Return Statuses by parameters","description":"Searches Supplier Return Statuses by parameters","operationId":"get-supplierreturnstatus","parameters":[{"name":"name","in":"query","description":"SupplierReturnStatus name.","schema":{"type":"string","description":"SupplierReturnStatus name.","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, name. \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, name. \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Supplier Return Statuses data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturnStatus.PagingResponse"},"example":{"data":[{"id":0,"name":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/supplierreturnstatus/{id}":{"get":{"tags":["supplierreturnstatus"],"summary":"Gets specific Supplier Return Status by unique id","description":"Gets specific Supplier Return Status by unique id","operationId":"get-supplierreturnstatus-id","parameters":[{"name":"id","in":"path","description":"Supplier Return Status id","required":true,"schema":{"type":"integer","description":"Supplier Return Status id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Supplier Return Status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierReturnStatus"},"example":{"id":0,"name":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Supplier Return Status not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/countries":{"get":{"tags":["countries"],"summary":"Searches Countries by parameters","description":"Searches Countries by parameters","operationId":"get-countries","parameters":[{"name":"code","in":"query","description":"Search by Code","schema":{"type":"string","description":"Search by Code","nullable":true}},{"name":"name","in":"query","description":"Search by Name","schema":{"type":"string","description":"Search by Name","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since search parameter","schema":{"type":"string","description":"Modified since search parameter","format":"date-time","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id (default), code, name, modified_on\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: modified_on desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id (default), code, name, modified_on\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: modified_on desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Countries data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Country.PagingResponse"},"example":{"data":[{"id":0,"code":"string","name":"string","tax_rate":0,"tax_label":"string","currency_multiplier":0,"fob_currency":{"id":0,"currency_code":"string","currency_name":"string","modified_on":"string"},"modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/countries/{id}":{"get":{"tags":["countries"],"summary":"Gets Country by id","description":"Gets Country by id","operationId":"get-countries-id","parameters":[{"name":"id","in":"path","description":"Country id","required":true,"schema":{"type":"integer","description":"Country id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Country","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Country"},"example":{"id":0,"code":"string","name":"string","tax_rate":0,"tax_label":"string","currency_multiplier":0,"fob_currency":{"id":0,"currency_code":"string","currency_name":"string","modified_on":"string"},"modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"NotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/currencies":{"get":{"tags":["currencies"],"summary":"Searches Currencies by parameters","description":"Searches Currencies by parameters","operationId":"get-currencies","parameters":[{"name":"modified_since","in":"query","description":"Modified since search parameter","schema":{"type":"string","description":"Modified since search parameter","format":"date-time","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id (default), currency_code, currency_name, modified_on\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: description asc, modified_on desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id (default), currency_code, currency_name, modified_on\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: description asc, modified_on desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Currencies data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Currency.PagingResponse"},"example":{"data":[{"id":0,"currency_code":"string","currency_name":"string","modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/currencies/{id}":{"get":{"tags":["currencies"],"summary":"Gets Currency by id","description":"Gets Currency by id","operationId":"get-currencies-id","parameters":[{"name":"id","in":"path","description":"Gets Currency by id","required":true,"schema":{"type":"integer","description":"Gets Currency by id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Currency","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Currency"},"example":{"id":0,"currency_code":"string","currency_name":"string","modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"NotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/maxdiscountrules":{"get":{"tags":["maxdiscountrules"],"summary":"Searches Max Discount Rules by parameters","description":"Searches Max Discount Rules by parameters","operationId":"get-maxdiscountrules","parameters":[{"name":"ids","in":"query","description":"Max discount rule Ids. (comma separated)\r\nOther properties are skipped, if used.\r\nExample: 2,3,4","schema":{"type":"string","description":"Max discount rule Ids. (comma separated)\r\nOther properties are skipped, if used.\r\nExample: 2,3,4","nullable":true}},{"name":"name","in":"query","description":"Max discount rule name","schema":{"type":"string","description":"Max discount rule name","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id (default), name, type, value, modified_on\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: name asc, type asc, modified_on desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id (default), name, type, value, modified_on\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: name asc, type asc, modified_on desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Max Discount Rules data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaxDiscountRule.PagingResponse"},"example":{"data":[{"id":0,"name":"string","value":0,"type":"string","modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/maxdiscountrules/{id}":{"get":{"tags":["maxdiscountrules"],"summary":"Gets specific Max Discount Rule by unique id","description":"Gets specific Max Discount Rule by unique id","operationId":"get-maxdiscountrules-id","parameters":[{"name":"id","in":"path","description":"Max Discount Rule id","required":true,"schema":{"type":"integer","description":"Max Discount Rule id","format":"int32","example":10}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Max Discount Rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaxDiscountRule"},"example":{"id":0,"name":"string","value":0,"type":"string","modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Max Discount Rule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/orderfulfilments":{"get":{"tags":["orderfulfilments"],"summary":"Searches Order Fulfilments by parameters","description":"Searches Order Fulfilments by parameters","operationId":"get-orderfulfilments","parameters":[{"name":"id","in":"query","description":"Fulfilment Id or Collection of Fulfilment Ids (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Fulfilment Id or Collection of Fulfilment Ids (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"order_id","in":"query","description":"Order Id or Collection of Order Ids (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Order Id or Collection of Order Ids (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"order_number","in":"query","description":"Order Number or Collection of Order Numbers (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Order Number or Collection of Order Numbers (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"order_item_id","in":"query","description":"Order Item Id or Collection of Order Item Ids (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Order Item Id or Collection of Order Item Ids (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"fulfil_outlet","in":"query","description":"Fulfilment Outlet or Collection of Fulfilment Outlets (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Fulfilment Outlet or Collection of Fulfilment Outlets (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"created_since","in":"query","description":"Created since","schema":{"type":"string","description":"Created since","format":"date-time","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, order_id, order_number, order_item_id, fulfil_outlet, created_on, serial_number.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,id:in:2|3","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, order_id, order_number, order_item_id, fulfil_outlet, created_on, serial_number.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,id:in:2|3","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, order_id, order_number, order_item_id, fulfil_outlet, created_on.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: order_id asc, order_number desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, order_id, order_number, order_item_id, fulfil_outlet, created_on.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: order_id asc, order_number desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Order Fulfilments","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtendedFulfilment.PagingResponse"},"example":{"data":[{"id":0,"order_item_id":0,"quantity_fulfiled":0,"fulfil_outlet":{"id":0,"name":"string","modified_on":"string"},"created_on":"string","serial_number":"string","order_id":0,"order_number":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/orderfulfilments/{id}":{"get":{"tags":["orderfulfilments"],"summary":"Gets specific Order Fulfilment","description":"Gets specific Order Fulfilment","operationId":"get-orderfulfilments-id","parameters":[{"name":"id","in":"path","description":"Fulfilment id","required":true,"schema":{"type":"integer","description":"Fulfilment id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Order Fulfilment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtendedFulfilment"},"example":{"id":0,"order_item_id":0,"quantity_fulfiled":0,"fulfil_outlet":{"id":0,"name":"string","modified_on":"string"},"created_on":"string","serial_number":"string","order_id":0,"order_number":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Order Fulfilment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/orderitems":{"get":{"tags":["orderitems"],"summary":"Searches Order Items by parameters","description":"Searches Order Items by parameters","operationId":"get-orderitems","parameters":[{"name":"id","in":"query","description":"Order Item Id or Collection of Order Item Ids (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Order Item Id or Collection of Order Item Ids (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"order_id","in":"query","description":"Order Id or Collection of Order Ids (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Order Id or Collection of Order Ids (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"order_number","in":"query","description":"Order Number or Collection of Order Numbers (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Order Number or Collection of Order Numbers (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"order_item_type","in":"query","description":"Order Item Type or Collection of Order Item Types (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Order Item Type or Collection of Order Item Types (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"fulfil_outlet","in":"query","description":"Fulfilment Outlet or Collection of Fulfilment Outlets (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Fulfilment Outlet or Collection of Fulfilment Outlets (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"source_outlet","in":"query","description":"Source Outlet or Collection of Source Outlets (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Source Outlet or Collection of Source Outlets (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"created_since","in":"query","description":"Created since","schema":{"type":"string","description":"Created since","format":"date-time","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, order_id, order_number, order_item_type, return_reason_id, return_reason_name, original_order_item_id, notes, fulfil_outlet, source_outlet, created_on, modified_on, serial_number.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,id:in:2|3","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, order_id, order_number, order_item_type, return_reason_id, return_reason_name, original_order_item_id, notes, fulfil_outlet, source_outlet, created_on, modified_on, serial_number.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,id:in:2|3","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, order_id, order_number, order_item_type, return_reason_name, notes, fulfil_outlet, source_outlet, created_on, modified_on.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: order_id asc, order_number desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, order_id, order_number, order_item_type, return_reason_name, notes, fulfil_outlet, source_outlet, created_on, modified_on.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: order_id asc, order_number desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Order Items","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtendedOrderItem.PagingResponse"},"example":{"data":[{"id":0,"external_id":"string","order_item_type":"string","product":{"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier_sku":"string","supplier_sku2":"string","sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","id":0},"original_price":0,"sell_price":0,"order_item_total":0,"order_item_discount_total":0,"taxable":true,"tax_rate":0,"supplier_buy_ex":0,"direct_costs_ex":0,"cogs_ex":0,"fulfilment_method":"string","due_date":"string","delivery_driver":{"id":0,"name":"string"},"delivery_zone":{"id":0,"name":"string"},"delivery_time":{"id":0,"name":"string"},"quantity_ordered":0,"quantity_fulfiled":0,"notes":"string","original_order_item_id":0,"return_reason":{"id":0,"name":"string"},"fulfil_outlet":{"id":0,"name":"string","modified_on":"string"},"source_outlet":{"id":0,"name":"string","modified_on":"string"},"applied_promotional_campaigns":[{"id":0,"name":"string"}],"created_on":"string","modified_on":"string","linked_purchase_order":{"id":0,"status":{"id":0,"name":"string"},"eta":"string","supplier_invoice_number":"string","created_on":"string","modified_on":"string","received_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}},"serial_number":"string","order_id":0,"order_number":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/orderitems/{id}":{"get":{"tags":["orderitems"],"summary":"Gets specific Order Item","description":"Gets specific Order Item","operationId":"get-orderitems-id","parameters":[{"name":"id","in":"path","description":"Order Item id","required":true,"schema":{"type":"integer","description":"Order Item id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Order Item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtendedOrderItem"},"example":{"id":0,"external_id":"string","order_item_type":"string","product":{"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier_sku":"string","supplier_sku2":"string","sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","id":0},"original_price":0,"sell_price":0,"order_item_total":0,"order_item_discount_total":0,"taxable":true,"tax_rate":0,"supplier_buy_ex":0,"direct_costs_ex":0,"cogs_ex":0,"fulfilment_method":"string","due_date":"string","delivery_driver":{"id":0,"name":"string"},"delivery_zone":{"id":0,"name":"string"},"delivery_time":{"id":0,"name":"string"},"quantity_ordered":0,"quantity_fulfiled":0,"notes":"string","original_order_item_id":0,"return_reason":{"id":0,"name":"string"},"fulfil_outlet":{"id":0,"name":"string","modified_on":"string"},"source_outlet":{"id":0,"name":"string","modified_on":"string"},"applied_promotional_campaigns":[{"id":0,"name":"string"}],"created_on":"string","modified_on":"string","linked_purchase_order":{"id":0,"status":{"id":0,"name":"string"},"eta":"string","supplier_invoice_number":"string","created_on":"string","modified_on":"string","received_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}},"serial_number":"string","order_id":0,"order_number":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Order Item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/orderpayments":{"get":{"tags":["orderpayments"],"summary":"Searches Order Payments by parameters","description":"Searches Order Payments by parameters","operationId":"get-orderpayments","parameters":[{"name":"id","in":"query","description":"Order Payment Id or Collection of Order Payment Ids (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Order Payment Id or Collection of Order Payment Ids (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"order_id","in":"query","description":"Order Id or Collection of Order Ids (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Order Id or Collection of Order Ids (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"order_number","in":"query","description":"Order Number or Collection of Order Numbers (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Order Number or Collection of Order Numbers (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"payment_method","in":"query","description":"Payment Method or Collection of Payment Methods (comma separated)\r\nExample: 1,2,3","schema":{"type":"string","description":"Payment Method or Collection of Payment Methods (comma separated)\r\nExample: 1,2,3","nullable":true}},{"name":"created_since","in":"query","description":"Created since","schema":{"type":"string","description":"Created since","format":"date-time","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, order_id, order_number, payment_method, created_on.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,id:in:2|3","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, order_id, order_number, payment_method, created_on.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,id:in:2|3","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, order_id, order_number, payment_method, created_on.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: order_id asc, order_number desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, order_id, order_number, payment_method, created_on.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: order_id asc, order_number desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Order Payments data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtendedOrderPayment.PagingResponse"},"example":{"data":[{"id":0,"external_id":"string","payment_method":{"id":0,"name":"string"},"amount":0,"created_on":"string","order_id":0,"order_number":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/orderpayments/{id}":{"get":{"tags":["orderpayments"],"summary":"Gets specific Order Payment","description":"Gets specific Order Payment","operationId":"get-orderpayments-id","parameters":[{"name":"id","in":"path","description":"Payment id","required":true,"schema":{"type":"integer","description":"Payment id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Order Payment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtendedOrderPayment"},"example":{"id":0,"external_id":"string","payment_method":{"id":0,"name":"string"},"amount":0,"created_on":"string","order_id":0,"order_number":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/productreplenishmentmethods":{"get":{"tags":["productreplenishmentmethods"],"summary":"Searches Product Replenishment Methods by parameters","description":"Searches Product Replenishment Methods by parameters","operationId":"get-productreplenishmentmethods","parameters":[{"name":"ids","in":"query","description":"Product replenishment method Ids. (comma separated)\r\nOther properties are skipped, if used.","schema":{"type":"string","description":"Product replenishment method Ids. (comma separated)\r\nOther properties are skipped, if used.","nullable":true}},{"name":"code","in":"query","description":"Product replenishment method code","schema":{"type":"string","description":"Product replenishment method code","nullable":true}},{"name":"name","in":"query","description":"Product replenishment method name","schema":{"type":"string","description":"Product replenishment method name","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id (default), code, name\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: name asc, code desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id (default), code, name\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: name asc, code desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Product Replenishment Methods data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductReplenishmentMethod.PagingResponse"},"example":{"data":[{"id":0,"code":"string","name":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/productreplenishmentmethods/{id}":{"get":{"tags":["productreplenishmentmethods"],"summary":"Gets specific Product Replenishment Method by unique id","description":"Gets specific Product Replenishment Method by unique id","operationId":"get-productreplenishmentmethods-id","parameters":[{"name":"id","in":"path","description":"Product Replenishment Method id","required":true,"schema":{"type":"integer","description":"Product Replenishment Method id","format":"int32","example":10}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Product Replenishment Method","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductReplenishmentMethod"},"example":{"id":0,"code":"string","name":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Product Replenishment Method not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/shippingports":{"get":{"tags":["shippingports"],"summary":"Searches Shipping Ports by parameters","description":"Searches Shipping Ports by parameters","operationId":"get-shippingports","parameters":[{"name":"name","in":"query","description":"Shipping Port name","schema":{"type":"string","description":"Shipping Port name","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Shipping Ports data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierShippingPort.PagingResponse"},"example":{"data":[{"id":0,"name":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["shippingports"],"summary":"Creates Shipping Port","description":"Sample request:\r\n\r\n POST /shippingports\r\n {\r\n \"name\": \"Mexico\"\r\n }","operationId":"post-shippingports","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Shipping Port to be created","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Shipping Port created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierShippingPort"},"example":{"id":0,"name":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/shippingports/{id}":{"get":{"tags":["shippingports"],"summary":"Gets specific Shipping Port by unique id","description":"Gets specific Shipping Port by unique id","operationId":"get-shippingports-id","parameters":[{"name":"id","in":"path","description":"Shipping Port id","required":true,"schema":{"type":"integer","description":"Shipping Port id","format":"int32","example":10}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Shipping Port","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierShippingPort"},"example":{"id":0,"name":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Shipping Port not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["shippingports"],"summary":"Deletes Shipping Port by id","description":"Deletes Shipping Port by id","operationId":"delete-shippingports-id","parameters":[{"name":"id","in":"path","description":"Shipping Port id","required":true,"schema":{"type":"integer","description":"Shipping Port id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Shipping Port deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Supplier not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["shippingports"],"summary":"Updates Shipping Port by id","description":"Sample request:\r\n\r\n PUT /shippingport\r\n {\r\n \"name\": \"Mexico\" \r\n }","operationId":"put-shippingports-id","parameters":[{"name":"id","in":"path","description":"Shipping Port id","required":true,"schema":{"type":"integer","description":"Shipping Port id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Shipping Port model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Returns updated Shipping Port","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierShippingPort"},"example":{"id":0,"name":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Shipping Port not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/suppliers":{"get":{"tags":["suppliers"],"summary":"Searches Suppliers by parameters","description":"Searches Suppliers by parameters","operationId":"get-suppliers","parameters":[{"name":"admin_only_orders","in":"query","description":"Admin only orders flag","schema":{"type":"boolean","description":"Admin only orders flag","nullable":true}},{"name":"id","in":"query","description":"Supplier Id. Other properties are skipped, if used","schema":{"type":"integer","description":"Supplier Id. Other properties are skipped, if used","format":"int32","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"is_enabled","in":"query","description":"Admin only orders flag","schema":{"type":"boolean","description":"Admin only orders flag","nullable":true}},{"name":"select","in":"query","description":"Select fields.\r\n\r\nAvailable field name values: id, supplier_code, name\r\n\r\nExample: id","schema":{"type":"string","description":"Select fields.\r\n\r\nAvailable field name values: id, supplier_code, name\r\n\r\nExample: id","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: is_enabled\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: is_enabled asc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: is_enabled\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: is_enabled asc","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\nAvailable field name values: is_enabled\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: is_enabled:eq:true","schema":{"type":"string","description":"Filter by. \r\nAvailable field name values: is_enabled\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: is_enabled:eq:true","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Suppliers data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier.PagingResponse"},"example":{"data":[{"id":0,"supplier_code":"string","name":"string","address":{"address_line1":"string","suburb":"string","state":"string","postcode":"string","country":{"id":0,"name":"string"}},"phone":"string","fax":"string","contact_name":"string","contact_email":"string","order_email":"string","admin_only_orders":true,"deposit_required":true,"shipping_port":{"id":0,"name":"string"},"country_of_origin":{"id":0,"name":"string"},"shipping_terms":"string","payment_terms":"string","comments":"string","purchase_order_template":"string","po_sku1_enabled":true,"po_sku2_enabled":true,"is_enabled":true,"modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["suppliers"],"summary":"Creates Supplier","description":"Sample request:\r\n\r\n POST /suppliers\r\n {\r\n \"supplier_code\": \"Test code\",\r\n \"name\": \"Test name\",\r\n \"address\": {\r\n \"address_line1\": \"string\",\r\n \"suburb\": \"string\",\r\n \"state\": \"string\",\r\n \"postcode\": \"string\",\r\n \"country\": {\r\n \"id\": 2,\r\n \"name\": \"string\"\r\n }\r\n },\r\n \"phone\": \"string\",\r\n \"fax\": \"string\",\r\n \"contact_name\": \"string\",\r\n \"contact_email\": \"contact_email@com.au\",\r\n \"order_email\": \"order_email@com.au\",\r\n \"admin_only_orders\": false,\r\n \"deposit_required\": false,\r\n \"shipping_port\": {\r\n \"id\": 2,\r\n \"name\": \"string\"\r\n },\r\n \"country_of_origin\": {\r\n \"id\": 2,\r\n \"name\": \"string\"\r\n },\r\n \"shipping_terms\": \"string\",\r\n \"payment_terms\": \"string\",\r\n \"comments\": \"string comment\",\r\n \"purchase_order_template\": \"Standard\",\r\n \"is_enabled\": true,\r\n \"po_sku1_enabled\": true,\r\n \"po_sku2_enabled\": true\r\n }","operationId":"post-suppliers","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Supplier to be created","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"},"example":{"id":0,"supplier_code":"string","name":"string","address":{"address_line1":"string","suburb":"string","state":"string","postcode":"string","country":{"id":0,"name":"string"}},"phone":"string","fax":"string","contact_name":"string","contact_email":"string","order_email":"string","admin_only_orders":true,"deposit_required":true,"shipping_port":{"id":0,"name":"string"},"country_of_origin":{"id":0,"name":"string"},"shipping_terms":"string","payment_terms":"string","comments":"string","purchase_order_template":"string","po_sku1_enabled":true,"po_sku2_enabled":true,"is_enabled":true,"modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/suppliers/{id}":{"get":{"tags":["suppliers"],"summary":"Gets Supplier by id","description":"Gets Supplier by id","operationId":"get-suppliers-id","parameters":[{"name":"id","in":"path","description":"Supplier id","required":true,"schema":{"type":"integer","description":"Supplier id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Supplier","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"},"example":{"id":0,"supplier_code":"string","name":"string","address":{"address_line1":"string","suburb":"string","state":"string","postcode":"string","country":{"id":0,"name":"string"}},"phone":"string","fax":"string","contact_name":"string","contact_email":"string","order_email":"string","admin_only_orders":true,"deposit_required":true,"shipping_port":{"id":0,"name":"string"},"country_of_origin":{"id":0,"name":"string"},"shipping_terms":"string","payment_terms":"string","comments":"string","purchase_order_template":"string","po_sku1_enabled":true,"po_sku2_enabled":true,"is_enabled":true,"modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"NotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["suppliers"],"summary":"Updates Supplier by id","description":"Sample request:\r\n\r\n PUT /supplier\r\n {\r\n \"supplier_code\": \"supplier code\",\r\n \"name\": \"Supplier test\",\r\n \"address\": {\r\n \"address_line1\": \"string\",\r\n \"suburb\": \"string\",\r\n \"state\": \"string\",\r\n \"postcode\": \"string\",\r\n \"country\": {\r\n \"id\": 2 \r\n }\r\n },\r\n \"phone\": \"string\",\r\n \"fax\": \"string\",\r\n \"contact_name\": \"string\",\r\n \"contact_email\": \"string@com.au\",\r\n \"order_email\": \"string@com.au\",\r\n \"admin_only_orders\": false,\r\n \"deposit_required\": false,\r\n \"shipping_port\": {\r\n \"id\": 2,\r\n \"name\": \"string\"\r\n },\r\n \"country_of_origin\": {\r\n \"id\": 2,\r\n \"name\": \"string\"\r\n },\r\n \"shipping_terms\": \"string\",\r\n \"payment_terms\": \"string\",\r\n \"comments\": \"Supplier comments\",\r\n \"purchase_order_template\": \"Standard\",\r\n \"is_enabled\": true,\r\n \"po_sku1_enabled\": true,\r\n \"po_sku2_enabled\": true\r\n }","operationId":"put-suppliers-id","parameters":[{"name":"id","in":"path","description":"Supplier id","required":true,"schema":{"type":"integer","description":"Supplier id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Supplier model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Returns updated Supplier","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"},"example":{"id":0,"supplier_code":"string","name":"string","address":{"address_line1":"string","suburb":"string","state":"string","postcode":"string","country":{"id":0,"name":"string"}},"phone":"string","fax":"string","contact_name":"string","contact_email":"string","order_email":"string","admin_only_orders":true,"deposit_required":true,"shipping_port":{"id":0,"name":"string"},"country_of_origin":{"id":0,"name":"string"},"shipping_terms":"string","payment_terms":"string","comments":"string","purchase_order_template":"string","po_sku1_enabled":true,"po_sku2_enabled":true,"is_enabled":true,"modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Supplier not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["suppliers"],"summary":"Deletes Supplier by id","description":"Deletes Supplier by id","operationId":"delete-suppliers-id","parameters":[{"name":"id","in":"path","description":"Supplier id","required":true,"schema":{"type":"integer","description":"Supplier id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Supplier deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Supplier not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/productbarcodes":{"get":{"tags":["productbarcodes"],"summary":"Searches Barcodes by parameters","description":"Searches Barcodes by parameters","operationId":"get-productbarcodes","parameters":[{"name":"product_id","in":"query","description":"Product Id","schema":{"type":"integer","description":"Product Id","format":"int32","nullable":true}},{"name":"product_status","in":"query","description":"Product status. Accepted values: \"enabled\", \"disabled\", not specified.","schema":{"type":"string","description":"Product status. Accepted values: \"enabled\", \"disabled\", not specified.","nullable":true}},{"name":"barcode","in":"query","description":"Product barcode name","schema":{"type":"string","description":"Product barcode name","nullable":true}},{"name":"enabled","in":"query","description":"Product barcode enabled","schema":{"type":"boolean","description":"Product barcode enabled","nullable":true}},{"name":"created_since","in":"query","description":"Created since","schema":{"type":"string","description":"Created since","format":"date-time","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Barcodes data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBarcode.PagingResponse"},"example":{"data":[{"id":0,"barcode":"string","enabled":true,"product_id":0,"created_on":"string","modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/producteta":{"get":{"tags":["producteta"],"summary":"Searches Product Estimated Times of Arrival by parameters","description":"This method allows the retrieval of the next available ETA for a specific product. Either a Product ID or SKU is required, as well as either a Sales Channel ID or a Fulfilment Outlet ID. You can only retrieve a single ETA for a single product at a time.\r\n\r\nWARNING: This is a highly complex operation and will use considerable amounts of resource to generate the request.Please use this request sparingly and limit the number of calls.\r\n \r\nThe ETA is derived from the Order of Sourcing Priority in the Source Group definition, any Purchase Orders in the Status “On-Order” and any available stock in the fulfilment outlet.If a product has Available Stock, the returned ETA date will be today’s date. If a product does not have available stock and would be sourced from a Purchase Order, the returned ETA date will be the ETA stored against the Purchase Order.
\r\nRead more about Source & Fulfilment Concepts here.\r\n \r\nUsing the 'available_for_preorder' Boolean set to TRUE, you can limit the ETA calculation to only the Purchase Orders that have been flagged as ‘Available for Preorder’ within Retail Express PO Management.
\r\n\r\nWARNING: This Option is exclusive for users with the Retail Express Shopify Connector utilising Preorder Setting Option 2 \"Accept Pre-Orders for On-Order Stock\".","operationId":"get-producteta","parameters":[{"name":"product_id","in":"query","description":"Product Id. Supplier SKU property are skipped, if used.","schema":{"type":"integer","description":"Product Id. Supplier SKU property are skipped, if used.","format":"int32","nullable":true}},{"name":"sku","in":"query","description":"SKU. Product Id property are skipped, if used.","schema":{"type":"string","description":"SKU. Product Id property are skipped, if used.","nullable":true}},{"name":"quantity_ordered","in":"query","description":"Quantity ordered. Required and must be other than 0","schema":{"type":"integer","description":"Quantity ordered. Required and must be other than 0","format":"int32"}},{"name":"fulfilment_outlet_id","in":"query","description":"Fulfilment Outlet Id. Must be other than 0","schema":{"type":"integer","description":"Fulfilment Outlet Id. Must be other than 0","format":"int32","nullable":true}},{"name":"sales_channel_id","in":"query","description":"Sales channel Id","schema":{"type":"integer","description":"Sales channel Id","format":"int32","nullable":true}},{"name":"available_for_preorder","in":"query","description":"Available for preorder","schema":{"type":"boolean","description":"Available for preorder","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Product Estimated Times of Arrival data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductETA.PagingResponse"},"example":{"data":[{"product_id":0,"sku":"string","quantity_ordered":0,"eta":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/shipmenttypes":{"get":{"tags":["shipmenttypes"],"summary":"Searches Shipment Types by parameters","description":"Searches Shipment Types by parameters","operationId":"get-shipmenttypes","parameters":[{"name":"name","in":"query","description":"Name","schema":{"type":"string","description":"Name","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Shipment Types data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentType.PagingResponse"},"example":{"data":[{"id":0,"name":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["shipmenttypes"],"summary":"Creates Shipment Type","description":"Sample request:\r\n\r\n POST /shipmenttypes\r\n {\r\n \"name\": \"AIR EXPRESS\"\r\n }","operationId":"post-shipmenttypes","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Shipment Type to be created","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Shipment Type created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentType"},"example":{"id":0,"name":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/shipmenttypes/{id}":{"get":{"tags":["shipmenttypes"],"summary":"Gets Shipment Type by id","description":"Gets Shipment Type by id","operationId":"get-shipmenttypes-id","parameters":[{"name":"id","in":"path","description":"Gets Shipment Type by id","required":true,"schema":{"type":"integer","description":"Gets Shipment Type by id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Shipment Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentType"},"example":{"id":0,"name":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"NotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["shipmenttypes"],"summary":"Updates Shipment Type","description":"Sample request:\r\n\r\n PUT /shipmenttypes\r\n {\r\n \"name\": \"Type A\"\r\n }","operationId":"put-shipmenttypes-id","parameters":[{"name":"id","in":"path","description":"Shipment Type id","required":true,"schema":{"type":"integer","description":"Shipment Type id","format":"int32","example":100000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Shipment Type model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Returns updated Shipment Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentType"},"example":{"id":0,"name":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Shipment Type not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["shipmenttypes"],"summary":"Deletes Shipment Type by id","description":"Deletes Shipment Type by id","operationId":"delete-shipmenttypes-id","parameters":[{"name":"id","in":"path","description":"Shipment Type id","required":true,"schema":{"type":"integer","description":"Shipment Type id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Shipment Type deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Shipment Type not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/shippingstatus":{"get":{"tags":["shippingstatus"],"summary":"Searches Shipping Statuses by parameters","description":"Searches Shipping Statuses by parameters","operationId":"get-shippingstatus","parameters":[{"name":"name","in":"query","description":"Name","schema":{"type":"string","description":"Name","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Shipping Statuses data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShippingStatus.PagingResponse"},"example":{"data":[{"id":0,"name":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["shippingstatus"],"summary":"Creates Shipping Status","description":"Sample request:\r\n\r\n POST /shippingstatus\r\n {\r\n \"name\": \"Test name\"\r\n }","operationId":"post-shippingstatus","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Shipping Status to be created","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Shipping Status created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShippingStatus"},"example":{"id":0,"name":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/shippingstatus/{id}":{"get":{"tags":["shippingstatus"],"summary":"Gets Shipping Status by id","description":"Gets Shipping Status by id","operationId":"get-shippingstatus-id","parameters":[{"name":"id","in":"path","description":"Gets Shipping Status by id","required":true,"schema":{"type":"integer","description":"Gets Shipping Status by id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the Shipping Status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShippingStatus"},"example":{"id":0,"name":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"NotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["shippingstatus"],"summary":"Updates Shipping Status","description":"Sample request:\r\n\r\n PUT /shippingstatus\r\n {\r\n \"name\": \"Status A\"\r\n }","operationId":"put-shippingstatus-id","parameters":[{"name":"id","in":"path","description":"Shipping Status id","required":true,"schema":{"type":"integer","description":"Shipping Status id","format":"int32","example":100000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Shipping Status model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Returns updated Shipping Status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShippingStatus"},"example":{"id":0,"name":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Status not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["shippingstatus"],"summary":"Deletes Shipping Status by id","description":"Deletes Shipping Status by id","operationId":"delete-shippingstatus-id","parameters":[{"name":"id","in":"path","description":"Shipping Status id","required":true,"schema":{"type":"integer","description":"Shipping Status id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Shipping Status deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Status not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/vouchers":{"get":{"tags":["vouchers"],"summary":"Searches vouchers by parameters","description":"Searches vouchers by parameters","operationId":"get-vouchers","parameters":[{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, code, voucher_type, balance, created_on, expires_on, initial_value\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, voucher_type desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, code, voucher_type, balance, created_on, expires_on, initial_value\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, voucher_type desc","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: code, voucher_type_id, initial_value, balance, created_on, expires_on, order_id, order_number, customer_id, customer_number, customer_email\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,order_number:in:order_number1|order_number2","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: code, voucher_type_id, initial_value, balance, created_on, expires_on, order_id, order_number, customer_id, customer_number, customer_email\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,order_number:in:order_number1|order_number2","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns vouchers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Voucher.PagingResponse"},"example":{"data":[{"id":0,"code":"string","type":{"id":0,"name":"string"},"initial_value":0,"balance":0,"created_on":"string","expires_on":"string","order":{"id":0,"customer":{"customer_number":"string","email":"string","first_name":"string","id":0,"last_name":"string","custom_reference":"string"},"order_number":"string","original_order_id":0,"created_on":"string","vouchers":[{"id":0,"code":"string","type":{"id":0,"name":"string"},"initial_value":0,"balance":0,"created_on":"string","expires_on":"string"}]}}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/vouchers/{id}":{"get":{"tags":["vouchers"],"summary":"Get specific voucher by unique id","description":"Get specific voucher by unique id","operationId":"get-vouchers-id","parameters":[{"name":"id","in":"path","description":"voucher id","required":true,"schema":{"type":"integer","description":"voucher id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found voucher","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Voucher"},"example":{"id":0,"code":"string","type":{"id":0,"name":"string"},"initial_value":0,"balance":0,"created_on":"string","expires_on":"string","order":{"id":0,"customer":{"customer_number":"string","email":"string","first_name":"string","id":0,"last_name":"string","custom_reference":"string"},"order_number":"string","original_order_id":0,"created_on":"string","vouchers":[{"id":0,"code":"string","type":{"id":0,"name":"string"},"initial_value":0,"balance":0,"created_on":"string","expires_on":"string"}]}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Voucher not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/vouchertypes":{"get":{"tags":["vouchertypes"],"summary":"Searches Voucher Types by parameters","description":"Searches Voucher Types by parameters","operationId":"get-vouchertypes","parameters":[{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, name\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, name\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Voucher Types data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoucherType.PagingResponse"},"example":{"data":[{"id":0,"name":"string","voucher_text":"string","valid_for_days":0}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/vouchertypes/{id}":{"get":{"tags":["vouchertypes"],"summary":"Gets specific Voucher Type by unique id","description":"Gets specific Voucher Type by unique id","operationId":"get-vouchertypes-id","parameters":[{"name":"id","in":"path","description":"Voucher Type id","required":true,"schema":{"type":"integer","description":"Voucher Type id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Voucher Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoucherType"},"example":{"id":0,"name":"string","voucher_text":"string","valid_for_days":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Voucher Type not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/customers/{id}/deliveryaddresses":{"get":{"tags":["customers"],"summary":"Searches Delivery Addresses by Customer id and other parameters","description":"Searches Delivery Addresses by Customer id and other parameters","operationId":"get-customers-id-deliveryaddresses","parameters":[{"name":"id","in":"path","description":"Customer id","required":true,"schema":{"type":"integer","description":"Customer id","format":"int32"}},{"name":"default","in":"query","description":"Is default","schema":{"type":"boolean","description":"Is default","nullable":true}},{"name":"modified_since","in":"query","description":"Modified since","schema":{"type":"string","description":"Modified since","format":"date-time","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Delivery Address data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryAddress.PagingResponse"},"example":{"data":[{"country":"string","country_code":"string","state":"string","suburb":"string","address_line1":"string","address_line2":"string","postcode":"string","company":"string","mobile":"string","phone":"string","first_name":"string","last_name":"string","id":0,"default":true,"modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["customers"],"summary":"Creates Customer Delivery Address","description":"Sample request:\r\n\r\n POST /customers/{id}/deliveryaddresses\r\n {\r\n \"country\": \"Argentina\",\r\n \"state\": \"QLD\",\r\n \"suburb\": \"Maroochydore\",\r\n \"address_line1\": \"address line 1\",\r\n \"address_line2\": \"address line 2\",\r\n \"postcode\": \"4000\",\r\n \"company\": \"Retail Express\",\r\n \"mobile\": \"0405 966 390\",\r\n \"phone\": \"0405966390\",\r\n \"first_name\": \"Bernie\",\r\n \"last_name\": \"Green\",\r\n \"default\": false\r\n }","operationId":"post-customers-id-deliveryaddresses","parameters":[{"name":"id","in":"path","description":"Customer id","required":true,"schema":{"type":"integer","description":"Customer id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Delivery Address model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Delivery Address was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryAddress"},"example":{"country":"string","country_code":"string","state":"string","suburb":"string","address_line1":"string","address_line2":"string","postcode":"string","company":"string","mobile":"string","phone":"string","first_name":"string","last_name":"string","id":0,"default":true,"modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/customers/{id}/deliveryaddresses/{address_id}":{"get":{"tags":["customers"],"summary":"Gets specific Delivery Address by unique Customer id and Delivery Address id","description":"Gets specific Delivery Address by unique Customer id and Delivery Address id","operationId":"get-customers-id-deliveryaddresses-address_id","parameters":[{"name":"id","in":"path","description":"Customer id","required":true,"schema":{"type":"integer","description":"Customer id","format":"int32"}},{"name":"address_id","in":"path","description":"Delivery Address id","required":true,"schema":{"type":"integer","description":"Delivery Address id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a Delivery Address","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryAddress"},"example":{"country":"string","country_code":"string","state":"string","suburb":"string","address_line1":"string","address_line2":"string","postcode":"string","company":"string","mobile":"string","phone":"string","first_name":"string","last_name":"string","id":0,"default":true,"modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["customers"],"summary":"Deletes specific Delivery Address by unique Customer id and Delivery Address id","description":"Deletes specific Delivery Address by unique Customer id and Delivery Address id","operationId":"delete-customers-id-deliveryaddresses-address_id","parameters":[{"name":"id","in":"path","description":"Customer id","required":true,"schema":{"type":"integer","description":"Customer id","format":"int32","example":10000}},{"name":"address_id","in":"path","description":"Delivery Address id","required":true,"schema":{"type":"integer","description":"Delivery Address id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Customer Delivery Address deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["customers"],"summary":"Updates Delivery Address","description":"Sample request:\r\n\r\n PUT /customers/1/deliveryaddresses/2\r\n {\r\n \"first_name\": \"John\",\r\n \"last_name\": \"Smith\",\r\n \"company\": \"Melbourne School\",\r\n \"address_line1\": \"1 Any Street\",\r\n \"address_line2\": \"2 Any Street\",\r\n \"suburb\": \"Melbourne\",\r\n \"state\": \"VIC\",\r\n \"postcode\": \"4000\",\r\n \"country\": \"Australia\",\r\n \"phone\": \"0458245689\",\r\n \"mobile\": \"0458245689\",\r\n \"default\": false\r\n }","operationId":"put-customers-id-deliveryaddresses-address_id","parameters":[{"name":"id","in":"path","description":"Customer id","required":true,"schema":{"type":"integer","description":"Customer id","format":"int32","example":10000}},{"name":"address_id","in":"path","description":"Delivery Address id","required":true,"schema":{"type":"integer","description":"Delivery Address id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Delivery Address model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Returns updated Delivery Address","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryAddress"},"example":{"country":"string","country_code":"string","state":"string","suburb":"string","address_line1":"string","address_line2":"string","postcode":"string","company":"string","mobile":"string","phone":"string","first_name":"string","last_name":"string","id":0,"default":true,"modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/customersurveysegments":{"get":{"tags":["customersurveysegments"],"summary":"Searches Customer Survey Segments by parameters","description":"Searches Customer Survey Segments by parameters","operationId":"get-customersurveysegments","parameters":[{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id (default), active, name\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: name desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id (default), active, name\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: name desc","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, active, name\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:eq:19","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, active, name\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:eq:19","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Customer Survey Segments data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerSegmentGroup.PagingResponse"},"example":{"data":[{"id":0,"name":"string","active":true,"options":[{"id":0,"name":"string"}]}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/customersurveysegments/{id}":{"get":{"tags":["customersurveysegments"],"summary":"Gets Customer Survey Segment by id","description":"Gets Customer Survey Segment by id","operationId":"get-customersurveysegments-id","parameters":[{"name":"id","in":"path","description":"Customer Survey Segment id","required":true,"schema":{"type":"integer","description":"Customer Survey Segment id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Customer Survey Segment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerSegmentGroup"},"example":{"id":0,"name":"string","active":true,"options":[{"id":0,"name":"string"}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"NotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/customersurveysegments/{id}/options":{"get":{"tags":["customersurveysegments"],"summary":"Searches Options by Customer Survey Segment id and other parameters","description":"Searches Options by Customer Survey Segment id and other parameters","operationId":"get-customersurveysegments-id-options","parameters":[{"name":"id","in":"path","description":"Customer Survey Segment Id","required":true,"schema":{"type":"integer","description":"Customer Survey Segment Id","format":"int32"}},{"name":"order_by","in":"query","description":"Order by\r\n\r\nAvailable field name values: id (default), name\r\n\r\nAvailable direction values: asc, desc\r\n\r\nExample: name desc","schema":{"type":"string","description":"Order by\r\n\r\nAvailable field name values: id (default), name\r\n\r\nAvailable direction values: asc, desc\r\n\r\nExample: name desc","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, name\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:eq:19","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, name\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:eq:19","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Customer Survey Segment Options data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerSegmentOption.PagingResponse"},"example":{"data":[{"id":0,"name":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/customersurveysegments/{id}/options/{option_id}":{"get":{"tags":["customersurveysegments"],"summary":"Gets specific Option by unique Customer Survey Segment id and Option id","description":"Gets specific Option by unique Customer Survey Segment id and Option id","operationId":"get-customersurveysegments-id-options-option_id","parameters":[{"name":"id","in":"path","description":"Customer Survey Segment id","required":true,"schema":{"type":"integer","description":"Customer Survey Segment id","format":"int32"}},{"name":"option_id","in":"path","description":"Customer Survey Segment Option id","required":true,"schema":{"type":"integer","description":"Customer Survey Segment Option id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Customer Survey Segment Option","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerSegmentOption"},"example":{"id":0,"name":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"NotFound","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/customertypes":{"get":{"tags":["customertypes"],"summary":"Searches Customer Types by parameters","description":"Searches Customer Types by parameters","operationId":"get-customertypes","parameters":[{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id (default), active, name, default, modified_on\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, supplier desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id (default), active, name, default, modified_on\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, supplier desc","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, active, name, default, deleted, modified_since\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:eq:303062","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, active, name, default, deleted, modified_since\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:eq:303062","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Customer Types data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2.CustomerType.PagingResponse"},"example":{"data":[{"id":0,"name":"string","active":true,"default":true,"deleted":true,"modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["customertypes"],"summary":"Creates Customer Type","description":"Sample request:\r\n\r\n POST /customertypes\r\n {\r\n \"name\": \"name\",\r\n \"active\": true,\r\n \"default\": false\r\n }","operationId":"post-customertypes","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Customer Type model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Customer Type created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2.CustomerType"},"example":{"id":0,"name":"string","active":true,"default":true,"deleted":true,"modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/customertypes/{id}":{"get":{"tags":["customertypes"],"summary":"Gets specific Customer Type by unique id","description":"Gets specific Customer Type by unique id","operationId":"get-customertypes-id","parameters":[{"name":"id","in":"path","description":"Customer type id","required":true,"schema":{"type":"integer","description":"Customer type id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Customer Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2.CustomerType"},"example":{"id":0,"name":"string","active":true,"default":true,"deleted":true,"modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Customer Type not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["customertypes"],"summary":"Deletes specific Customer Type by id","description":"Deletes specific Customer Type by id","operationId":"delete-customertypes-id","parameters":[{"name":"id","in":"path","description":"Customer Type id","required":true,"schema":{"type":"integer","description":"Customer Type id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Customer Type deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["customertypes"],"summary":"Updates Customer Type","description":"Sample request:\r\n\r\n PUT /customertypes\r\n {\r\n \"name\": \"New customer type name\",\r\n \"active\": true,\r\n \"default\": true,\r\n \"deleted\": false\r\n }","operationId":"put-customertypes-id","parameters":[{"name":"id","in":"path","description":"Customer Type id","required":true,"schema":{"type":"integer","description":"Customer Type id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Customer Type model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Returns updated Customer Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2.CustomerType"},"example":{"id":0,"name":"string","active":true,"default":true,"deleted":true,"modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Customer Type not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/customerlogs":{"get":{"tags":["customerlogs"],"summary":"Searches Customer Logs by parameters","description":"Searches Customer Logs by parameters","operationId":"get-customerlogs","parameters":[{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, created_on \r\n\r\nAvailable direction values: id asc, customer_number desc. \r\n\r\nExample: id asc, customer_id desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, created_on \r\n\r\nAvailable direction values: id asc, customer_number desc. \r\n\r\nExample: id asc, customer_id desc","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, customer_id, customer_number, master_customer_id, master_customer_number, created_on \r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:eq:303062, master_customer_id:3039:eq:true","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, customer_id, customer_number, master_customer_id, master_customer_number, created_on \r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:eq:303062, master_customer_id:3039:eq:true","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Customer Logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerLogVM.PagingResponse"},"example":{"data":[{"id":0,"customer_id":0,"customer_number":"string","master_customer_id":0,"master_customer_number":"string","created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"loyalty_points_balance":0,"price_groups":[{"id":0,"name":"string","type":"string"}],"notes":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/customerlogs/{id}":{"get":{"tags":["customerlogs"],"summary":"Gets specific Customer Logs by unique id","description":"Gets specific Customer Logs by unique id","operationId":"get-customerlogs-id","parameters":[{"name":"id","in":"path","description":"Customer log id","required":true,"schema":{"type":"integer","description":"Customer log id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Customer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerLogVM"},"example":{"id":0,"customer_id":0,"customer_number":"string","master_customer_id":0,"master_customer_number":"string","created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"loyalty_points_balance":0,"price_groups":[{"id":0,"name":"string","type":"string"}],"notes":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Customer logs not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/pricegroups/standard":{"get":{"tags":["pricegroups"],"summary":"Searches PriceGroups by parameters","description":"Searches PriceGroups by parameters","operationId":"get-pricegroups-standard","parameters":[{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: name\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: name desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: name\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: name desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns PriceGroups","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardPriceGroup.PagingResponse"},"example":{"data":[{"id":0,"name":"string","rule":{"type":"string","value":0},"modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/pricegroups/fixed":{"get":{"tags":["pricegroups"],"summary":"Searches Fixed Price Groups by parameters","description":"Searches Fixed Price Groups by parameters","operationId":"get-pricegroups-fixed","parameters":[{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: name\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: name desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: name\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: name desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns PriceGroups2FixedPricings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FixedPriceGroup.PagingResponse"},"example":{"data":[{"id":0,"name":"string","modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["pricegroups"],"summary":"Creates Fixed Price Group","description":"Sample request: \r\n\r\n POST /pricegroups/fixed\r\n { \r\n \"name\": \"Fixed price group 1\"\r\n }","operationId":"post-pricegroups-fixed","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Fixed Price Group","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Fixed Price Group created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FixedPriceGroup"},"example":{"id":0,"name":"string","modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/purchaseorderreceipts":{"post":{"tags":["purchaseorderreceipts"],"summary":"Creates Purchase Order Receipt","description":"Sample request: \r\n\r\n POST /purchaseorderreceipts \r\n { \r\n \"purchase_order_id\": 1,\r\n \"purchase_order_receipt_items\": [ \r\n { \r\n \"purchase_order_item_id\": 3, \r\n \"stock_receipt_id\": 1,\r\n \"quantity_received\": 3,\r\n \"quantity_faulty\": 1,\r\n \"quantity_invoiced\": 1,\r\n \"buy_price_ex\": 1.1,\r\n \"unit_discount_ex\": 1.1,\r\n \"direct_costs_ex\": 1.1,\r\n \"bin\": \"bin\",\r\n \"include_tax\": true,\r\n \"variance_reason\": {\r\n \"id\": 1,\r\n \"name\": \"variance reason name\"\r\n },\r\n \"notes\": \"notes\",\r\n \"supplier_invoice_number\": \"sample invoice number\"\r\n }]\r\n }","operationId":"post-purchaseorderreceipts","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Purchase Order Receipt","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Purchase Order Receipt created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderReceipts"},"example":{"id":0,"purchase_order_id":0,"purchase_order_receipt_items":[{"id":0,"purchase_order_item_id":0,"pricing":{"product_id":0,"outlet_id":0,"sell_price_inc":0,"promotional_price_inc":0,"promotional_price_start":"string","promotional_price_end":"string","taxable":true},"purchase_order_receipt_id":0,"stock_receipt_id":0,"quantity_expected":0,"quantity_received":0,"quantity_faulty":0,"quantity_invoiced":0,"buy_price_ex":0,"supplier_buy_ex":0,"unit_discount_ex":0,"direct_costs_ex":0,"include_tax":true,"quantity_received_variance":0,"product":{"carton_quantity":"string","cubic":0,"rrp_inc":0,"sell_price_inc":0,"breadth":0,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"id":0,"length":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_sku":"string","supplier_sku2":"string","weight":0,"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"made_available_on":"string","made_available_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"finalised_on":"string","finalised_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"total_buy_price_ex":0,"bin":"string","cogs_ex":0,"total_tax":0,"total_buy_price_inc":0,"total_applied_buy_price_ex":0,"total_direct_costs_ex":0,"total_cogs_ex":0,"total_cogs_inc":0,"variance_action":"Leave On-Order","variance_reason":{"id":0,"name":"string"},"notes":"string"}],"supplier_invoices":[{"id":0,"supplier_invoice_number":"string","international_order":true,"landed_costs_calculation":"Manual","currency_conversion":0,"rounding_adjustment":0,"origin_country":{"id":0,"name":"string"},"supplier_invoiced_on":"string"}],"supplier_invoice_number":"string","status":"Available","created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"made_available_on":"string","made_available_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"finalised_on":"string","finalised_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"total_buy_price_ex":0,"total_products_received":0,"total_quantity_received":0,"total_quantity_expected":0,"total_quantity_faulty":0,"total_quantity_received_variance":0,"total_quantity_invoiced":0,"total_tax":0,"total_buy_price_inc":0,"total_applied_buy_price_ex":0,"total_direct_costs_ex":0,"total_cogs_ex":0,"total_cogs_inc":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"get":{"tags":["purchaseorderreceipts"],"summary":"Searches Purchase Order Receipts","description":"Searches Purchase Order Receipts","operationId":"get-purchaseorderreceipts","parameters":[{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, purchase_order_id, status, created_on, created_by_id, created_by_first_name, created_by_surname, modified_on, modified_by_id, modified_by_first_name, modified_by_surname, made_available_on, made_available_by_id, made_available_by_first_name, made_available_by_surname, finalised_on, finalised_by_id, finalised_by_first_name, finalised_by_surname, total_buy_price_ex, total_products_received, total_quantity_received, total_quantity_expected, total_quantity_faulty, total_quantity_received_variance, total_quantity_invoiced, total_tax, total_buy_price_inc, purchase_order_supplier, total_applied_buy_price_ex, total_direct_costs_ex, total_cogs_ex, total_cogs_inc.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, purchase_order_id, status, created_on, created_by_id, created_by_first_name, created_by_surname, modified_on, modified_by_id, modified_by_first_name, modified_by_surname, made_available_on, made_available_by_id, made_available_by_first_name, made_available_by_surname, finalised_on, finalised_by_id, finalised_by_first_name, finalised_by_surname, total_buy_price_ex, total_products_received, total_quantity_received, total_quantity_expected, total_quantity_faulty, total_quantity_received_variance, total_quantity_invoiced, total_tax, total_buy_price_inc, purchase_order_supplier, total_applied_buy_price_ex, total_direct_costs_ex, total_cogs_ex, total_cogs_inc.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, purchase_order_id, status, created_on, created_by_id, created_by_first_name, created_by_surname, modified_on, modified_by_id, modified_by_first_name, modified_by_surname, made_available_on, made_available_by_id, made_available_by_first_name, made_available_by_surname, finalised_on, finalised_by_id, finalised_by_first_name, finalised_by_surname, total_buy_price_ex, total_products_received, total_quantity_received, total_quantity_expected, total_quantity_faulty, total_quantity_received_variance, total_quantity_invoiced, total_tax, total_buy_price_inc, total_applied_buy_price_ex, total_direct_costs_ex, total_cogs_ex, total_cogs_inc.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, status desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, purchase_order_id, status, created_on, created_by_id, created_by_first_name, created_by_surname, modified_on, modified_by_id, modified_by_first_name, modified_by_surname, made_available_on, made_available_by_id, made_available_by_first_name, made_available_by_surname, finalised_on, finalised_by_id, finalised_by_first_name, finalised_by_surname, total_buy_price_ex, total_products_received, total_quantity_received, total_quantity_expected, total_quantity_faulty, total_quantity_received_variance, total_quantity_invoiced, total_tax, total_buy_price_inc, total_applied_buy_price_ex, total_direct_costs_ex, total_cogs_ex, total_cogs_inc.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, status desc","nullable":true}},{"name":"include_items","in":"query","description":"Include items","schema":{"type":"boolean","description":"Include items"}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Purchase Order Receipts data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderReceipts.PagingResponse"},"example":{"data":[{"id":0,"purchase_order_id":0,"purchase_order_receipt_items":[{"id":0,"purchase_order_item_id":0,"pricing":{"product_id":0,"outlet_id":0,"sell_price_inc":0,"promotional_price_inc":0,"promotional_price_start":"string","promotional_price_end":"string","taxable":true},"purchase_order_receipt_id":0,"stock_receipt_id":0,"quantity_expected":0,"quantity_received":0,"quantity_faulty":0,"quantity_invoiced":0,"buy_price_ex":0,"supplier_buy_ex":0,"unit_discount_ex":0,"direct_costs_ex":0,"include_tax":true,"quantity_received_variance":0,"product":{"carton_quantity":"string","cubic":0,"rrp_inc":0,"sell_price_inc":0,"breadth":0,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"id":0,"length":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_sku":"string","supplier_sku2":"string","weight":0,"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"made_available_on":"string","made_available_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"finalised_on":"string","finalised_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"total_buy_price_ex":0,"bin":"string","cogs_ex":0,"total_tax":0,"total_buy_price_inc":0,"total_applied_buy_price_ex":0,"total_direct_costs_ex":0,"total_cogs_ex":0,"total_cogs_inc":0,"variance_action":"Leave On-Order","variance_reason":{"id":0,"name":"string"},"notes":"string"}],"supplier_invoices":[{"id":0,"supplier_invoice_number":"string","international_order":true,"landed_costs_calculation":"Manual","currency_conversion":0,"rounding_adjustment":0,"origin_country":{"id":0,"name":"string"},"supplier_invoiced_on":"string"}],"supplier_invoice_number":"string","status":"Available","created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"made_available_on":"string","made_available_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"finalised_on":"string","finalised_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"total_buy_price_ex":0,"total_products_received":0,"total_quantity_received":0,"total_quantity_expected":0,"total_quantity_faulty":0,"total_quantity_received_variance":0,"total_quantity_invoiced":0,"total_tax":0,"total_buy_price_inc":0,"total_applied_buy_price_ex":0,"total_direct_costs_ex":0,"total_cogs_ex":0,"total_cogs_inc":0}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/purchaseorderreceipts/{id}":{"put":{"tags":["purchaseorderreceipts"],"summary":"Updates specific Purchase Order Receipt by id","description":"Sample request:\r\n\r\n PUT /purchaseorderreceipts/1\r\n {\r\n \"status\": \"Available\"\r\n }","operationId":"put-purchaseorderreceipts-id","parameters":[{"name":"id","in":"path","description":"Purchase Order Receipt id","required":true,"schema":{"type":"integer","description":"Purchase Order Receipt id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Purchase Order Receipt model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Purchase Order Receipt was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderReceipts"},"example":{"id":0,"purchase_order_id":0,"purchase_order_receipt_items":[{"id":0,"purchase_order_item_id":0,"pricing":{"product_id":0,"outlet_id":0,"sell_price_inc":0,"promotional_price_inc":0,"promotional_price_start":"string","promotional_price_end":"string","taxable":true},"purchase_order_receipt_id":0,"stock_receipt_id":0,"quantity_expected":0,"quantity_received":0,"quantity_faulty":0,"quantity_invoiced":0,"buy_price_ex":0,"supplier_buy_ex":0,"unit_discount_ex":0,"direct_costs_ex":0,"include_tax":true,"quantity_received_variance":0,"product":{"carton_quantity":"string","cubic":0,"rrp_inc":0,"sell_price_inc":0,"breadth":0,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"id":0,"length":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_sku":"string","supplier_sku2":"string","weight":0,"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"made_available_on":"string","made_available_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"finalised_on":"string","finalised_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"total_buy_price_ex":0,"bin":"string","cogs_ex":0,"total_tax":0,"total_buy_price_inc":0,"total_applied_buy_price_ex":0,"total_direct_costs_ex":0,"total_cogs_ex":0,"total_cogs_inc":0,"variance_action":"Leave On-Order","variance_reason":{"id":0,"name":"string"},"notes":"string"}],"supplier_invoices":[{"id":0,"supplier_invoice_number":"string","international_order":true,"landed_costs_calculation":"Manual","currency_conversion":0,"rounding_adjustment":0,"origin_country":{"id":0,"name":"string"},"supplier_invoiced_on":"string"}],"supplier_invoice_number":"string","status":"Available","created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"made_available_on":"string","made_available_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"finalised_on":"string","finalised_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"total_buy_price_ex":0,"total_products_received":0,"total_quantity_received":0,"total_quantity_expected":0,"total_quantity_faulty":0,"total_quantity_received_variance":0,"total_quantity_invoiced":0,"total_tax":0,"total_buy_price_inc":0,"total_applied_buy_price_ex":0,"total_direct_costs_ex":0,"total_cogs_ex":0,"total_cogs_inc":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["purchaseorderreceipts"],"summary":"Deletes specific Purchase Order Receipt by id","description":"Deletes specific Purchase Order Receipt by id","operationId":"delete-purchaseorderreceipts-id","parameters":[{"name":"id","in":"path","description":"Purchase Order Receipt id","required":true,"schema":{"type":"integer","description":"Purchase Order Receipt id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Purchase Order Receipt was deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"get":{"tags":["purchaseorderreceipts"],"summary":"Gets specific Purchase Order Receipt by unique id","description":"Gets specific Purchase Order Receipt by unique id","operationId":"get-purchaseorderreceipts-id","parameters":[{"name":"id","in":"path","description":"Purchase Order Receipt id","required":true,"schema":{"type":"integer","description":"Purchase Order Receipt id","format":"int32","example":1}},{"name":"include_items","in":"query","description":"Include items","schema":{"type":"boolean","description":"Include items"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Purchase Order Receipt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderReceipts"},"example":{"id":0,"purchase_order_id":0,"purchase_order_receipt_items":[{"id":0,"purchase_order_item_id":0,"pricing":{"product_id":0,"outlet_id":0,"sell_price_inc":0,"promotional_price_inc":0,"promotional_price_start":"string","promotional_price_end":"string","taxable":true},"purchase_order_receipt_id":0,"stock_receipt_id":0,"quantity_expected":0,"quantity_received":0,"quantity_faulty":0,"quantity_invoiced":0,"buy_price_ex":0,"supplier_buy_ex":0,"unit_discount_ex":0,"direct_costs_ex":0,"include_tax":true,"quantity_received_variance":0,"product":{"carton_quantity":"string","cubic":0,"rrp_inc":0,"sell_price_inc":0,"breadth":0,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"id":0,"length":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_sku":"string","supplier_sku2":"string","weight":0,"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"made_available_on":"string","made_available_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"finalised_on":"string","finalised_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"total_buy_price_ex":0,"bin":"string","cogs_ex":0,"total_tax":0,"total_buy_price_inc":0,"total_applied_buy_price_ex":0,"total_direct_costs_ex":0,"total_cogs_ex":0,"total_cogs_inc":0,"variance_action":"Leave On-Order","variance_reason":{"id":0,"name":"string"},"notes":"string"}],"supplier_invoices":[{"id":0,"supplier_invoice_number":"string","international_order":true,"landed_costs_calculation":"Manual","currency_conversion":0,"rounding_adjustment":0,"origin_country":{"id":0,"name":"string"},"supplier_invoiced_on":"string"}],"supplier_invoice_number":"string","status":"Available","created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"made_available_on":"string","made_available_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"finalised_on":"string","finalised_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"total_buy_price_ex":0,"total_products_received":0,"total_quantity_received":0,"total_quantity_expected":0,"total_quantity_faulty":0,"total_quantity_received_variance":0,"total_quantity_invoiced":0,"total_tax":0,"total_buy_price_inc":0,"total_applied_buy_price_ex":0,"total_direct_costs_ex":0,"total_cogs_ex":0,"total_cogs_inc":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Purchase Order Receipt not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/purchaseorderreceipts/{id}/purchaseorderreceiptitems":{"post":{"tags":["purchaseorderreceipts"],"summary":"Creates a Purchase Order Receipt Item","description":"Sample request:\r\n\r\n POST /purchaseorderreceipts/1/purchaseorderreceiptitems\r\n {\r\n \"purchase_order_item_id\": 1,\r\n \"stock_receipt_id\": 1,\r\n \"buy_price_ex\": 1.1,\r\n \"quantity_received\": 3,\r\n \"quantity_faulty\": 2,\r\n \"quantity_invoiced\": 1,\r\n \"unit_discount_ex\": 1.1,\r\n \"direct_costs_ex\": 1.1,\r\n \"include_tax\": true,\r\n \"variance_reason\": {\r\n \"id\": 1,\r\n \"name\": \"variance reason name\"\r\n },\r\n \"bin\": \"bin\",\r\n \"notes\": \"notes\"\r\n }","operationId":"post-purchaseorderreceipts-id-purchaseorderreceiptitems","parameters":[{"name":"id","in":"path","description":"Purchase Order Receipt Id","required":true,"schema":{"type":"integer","description":"Purchase Order Receipt Id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Purchase Order Receipt Item to be created","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Purchase Order Receipt Item was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderReceiptItem"},"example":{"id":0,"purchase_order_item_id":0,"pricing":{"product_id":0,"outlet_id":0,"sell_price_inc":0,"promotional_price_inc":0,"promotional_price_start":"string","promotional_price_end":"string","taxable":true},"purchase_order_receipt_id":0,"stock_receipt_id":0,"quantity_expected":0,"quantity_received":0,"quantity_faulty":0,"quantity_invoiced":0,"buy_price_ex":0,"supplier_buy_ex":0,"unit_discount_ex":0,"direct_costs_ex":0,"include_tax":true,"quantity_received_variance":0,"product":{"carton_quantity":"string","cubic":0,"rrp_inc":0,"sell_price_inc":0,"breadth":0,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"id":0,"length":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_sku":"string","supplier_sku2":"string","weight":0,"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"made_available_on":"string","made_available_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"finalised_on":"string","finalised_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"total_buy_price_ex":0,"bin":"string","cogs_ex":0,"total_tax":0,"total_buy_price_inc":0,"total_applied_buy_price_ex":0,"total_direct_costs_ex":0,"total_cogs_ex":0,"total_cogs_inc":0,"variance_action":"Leave On-Order","variance_reason":{"id":0,"name":"string"},"notes":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"get":{"tags":["purchaseorderreceipts"],"summary":"Searches Purchase Order Receipt Items by Purchase Order Receipt id and other parameters","description":"Searches Purchase Order Receipt Items by Purchase Order Receipt id and other parameters","operationId":"get-purchaseorderreceipts-id-purchaseorderreceiptitems","parameters":[{"name":"id","in":"path","description":"Purchase Order Receipt id","required":true,"schema":{"type":"integer","description":"Purchase Order Receipt id","format":"int32"}},{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, product_id, product_supplier_sku, product_manufacturer_sku, product_supplier_sku2, product_short_description, product_type, size mapped to value name, colour mapped to value name, brand mapped to value name, season mapped to value name, attribute:id, plu, purchase_order_receipt_id, purchase_order_item_id, created_on, created_by_id, created_by_first_name, created_by_surname, modified_on, modified_by_id, modified_by_first_name, modified_by_surname, made_available_on, made_available_by_id, made_available_by_first_name, made_available_by_surname, finalised_on, finalised_by_id, finalised_by_first_name, finalised_by_surname, quantity_expected, quantity_received, quantity_faulty, quantity_invoiced, buy_price_ex, supplier_buy_ex, unit_discount_ex, total_buy_price_ex, cogs_ex, bin, include_tax, variance_reason_id, variance_reason_name, variance_action, notes, total_applied_buy_price_ex, total_direct_costs_ex, total_cogs_ex, total_cogs_inc, direct_costs_ex, pricing_sell_price_inc, pricing_promotional_price_inc, pricing_promotional_price_start, pricing_promotional_price_end,quantity_received_variance,total_tax,total_buy_price_inc.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n \r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432, attribute:101:isnotnull, attribute:101:eq:Custom Attribute Value 123","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, product_id, product_supplier_sku, product_manufacturer_sku, product_supplier_sku2, product_short_description, product_type, size mapped to value name, colour mapped to value name, brand mapped to value name, season mapped to value name, attribute:id, plu, purchase_order_receipt_id, purchase_order_item_id, created_on, created_by_id, created_by_first_name, created_by_surname, modified_on, modified_by_id, modified_by_first_name, modified_by_surname, made_available_on, made_available_by_id, made_available_by_first_name, made_available_by_surname, finalised_on, finalised_by_id, finalised_by_first_name, finalised_by_surname, quantity_expected, quantity_received, quantity_faulty, quantity_invoiced, buy_price_ex, supplier_buy_ex, unit_discount_ex, total_buy_price_ex, cogs_ex, bin, include_tax, variance_reason_id, variance_reason_name, variance_action, notes, total_applied_buy_price_ex, total_direct_costs_ex, total_cogs_ex, total_cogs_inc, direct_costs_ex, pricing_sell_price_inc, pricing_promotional_price_inc, pricing_promotional_price_start, pricing_promotional_price_end,quantity_received_variance,total_tax,total_buy_price_inc.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n \r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432, attribute:101:isnotnull, attribute:101:eq:Custom Attribute Value 123","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, product_id, product_supplier_sku, product_manufacturer_sku, product_supplier_sku2, product_short_description, product_type, size, colour, brand, season, attribute:id, purchase_order_receipt_id, purchase_order_item_id, created_on, created_by_id, created_by_first_name, created_by_surname, modified_on, modified_by_id, modified_by_first_name, modified_by_surname, made_available_on, made_available_by_id, made_available_by_first_name, made_available_by_surname, finalised_on, finalised_by_id, finalised_by_first_name, finalised_by_surname, quantity_expected, quantity_received, quantity_faulty, quantity_invoiced, buy_price_ex, supplier_buy_ex, unit_discount_ex, total_buy_price_ex, cogs_ex, bin, include_tax, total_tax, total_buy_price_inc, variance_reason_id, variance_reason_name, variance_action, total_applied_buy_price_ex, total_direct_costs_ex, total_cogs_ex, total_cogs_inc, direct_costs_ex, pricing_sell_price_inc, pricing_promotional_price_inc, pricing_promotional_price_start, pricing_promotional_price_end.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, product_supplier_sku desc, attribute:101","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, product_id, product_supplier_sku, product_manufacturer_sku, product_supplier_sku2, product_short_description, product_type, size, colour, brand, season, attribute:id, purchase_order_receipt_id, purchase_order_item_id, created_on, created_by_id, created_by_first_name, created_by_surname, modified_on, modified_by_id, modified_by_first_name, modified_by_surname, made_available_on, made_available_by_id, made_available_by_first_name, made_available_by_surname, finalised_on, finalised_by_id, finalised_by_first_name, finalised_by_surname, quantity_expected, quantity_received, quantity_faulty, quantity_invoiced, buy_price_ex, supplier_buy_ex, unit_discount_ex, total_buy_price_ex, cogs_ex, bin, include_tax, total_tax, total_buy_price_inc, variance_reason_id, variance_reason_name, variance_action, total_applied_buy_price_ex, total_direct_costs_ex, total_cogs_ex, total_cogs_inc, direct_costs_ex, pricing_sell_price_inc, pricing_promotional_price_inc, pricing_promotional_price_start, pricing_promotional_price_end.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, product_supplier_sku desc, attribute:101","nullable":true}},{"name":"select","in":"query","description":"Select fields.\r\n\r\nAvailable field name values: id, product_id, quantity_expected, quantity_received\r\n\r\nExample: id","schema":{"type":"string","description":"Select fields.\r\n\r\nAvailable field name values: id, product_id, quantity_expected, quantity_received\r\n\r\nExample: id","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Purchase Order Receipt Items data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderReceiptItem.PagingResponse"},"example":{"data":[{"id":0,"purchase_order_item_id":0,"pricing":{"product_id":0,"outlet_id":0,"sell_price_inc":0,"promotional_price_inc":0,"promotional_price_start":"string","promotional_price_end":"string","taxable":true},"purchase_order_receipt_id":0,"stock_receipt_id":0,"quantity_expected":0,"quantity_received":0,"quantity_faulty":0,"quantity_invoiced":0,"buy_price_ex":0,"supplier_buy_ex":0,"unit_discount_ex":0,"direct_costs_ex":0,"include_tax":true,"quantity_received_variance":0,"product":{"carton_quantity":"string","cubic":0,"rrp_inc":0,"sell_price_inc":0,"breadth":0,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"id":0,"length":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_sku":"string","supplier_sku2":"string","weight":0,"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"made_available_on":"string","made_available_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"finalised_on":"string","finalised_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"total_buy_price_ex":0,"bin":"string","cogs_ex":0,"total_tax":0,"total_buy_price_inc":0,"total_applied_buy_price_ex":0,"total_direct_costs_ex":0,"total_cogs_ex":0,"total_cogs_inc":0,"variance_action":"Leave On-Order","variance_reason":{"id":0,"name":"string"},"notes":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/purchaseorderreceipts/{id}/purchaseorderreceiptitems/{item_id}":{"get":{"tags":["purchaseorderreceipts"],"summary":"Gets specific Purchase Order Receipt Item by unique Purchase Order Receipt id and Purchase Order Receipt Item id","description":"Gets specific Purchase Order Receipt Item by unique Purchase Order Receipt id and Purchase Order Receipt Item id","operationId":"get-purchaseorderreceipts-id-purchaseorderreceiptitems-item_id","parameters":[{"name":"id","in":"path","description":"Purchase Order Receipt id","required":true,"schema":{"type":"integer","description":"Purchase Order Receipt id","format":"int32"}},{"name":"item_id","in":"path","description":"Purchase Order Receipt Item id","required":true,"schema":{"type":"integer","description":"Purchase Order Receipt Item id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Purchase Order Receipt Item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderReceiptItem"},"example":{"id":0,"purchase_order_item_id":0,"pricing":{"product_id":0,"outlet_id":0,"sell_price_inc":0,"promotional_price_inc":0,"promotional_price_start":"string","promotional_price_end":"string","taxable":true},"purchase_order_receipt_id":0,"stock_receipt_id":0,"quantity_expected":0,"quantity_received":0,"quantity_faulty":0,"quantity_invoiced":0,"buy_price_ex":0,"supplier_buy_ex":0,"unit_discount_ex":0,"direct_costs_ex":0,"include_tax":true,"quantity_received_variance":0,"product":{"carton_quantity":"string","cubic":0,"rrp_inc":0,"sell_price_inc":0,"breadth":0,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"id":0,"length":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_sku":"string","supplier_sku2":"string","weight":0,"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"made_available_on":"string","made_available_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"finalised_on":"string","finalised_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"total_buy_price_ex":0,"bin":"string","cogs_ex":0,"total_tax":0,"total_buy_price_inc":0,"total_applied_buy_price_ex":0,"total_direct_costs_ex":0,"total_cogs_ex":0,"total_cogs_inc":0,"variance_action":"Leave On-Order","variance_reason":{"id":0,"name":"string"},"notes":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["purchaseorderreceipts"],"summary":"Deletes specific Purchase Order Receipt Item by id","description":"Deletes specific Purchase Order Receipt Item by id","operationId":"delete-purchaseorderreceipts-id-purchaseorderreceiptitems-item_id","parameters":[{"name":"id","in":"path","description":"Purchase Order Receipt Id","required":true,"schema":{"type":"integer","description":"Purchase Order Receipt Id","format":"int32"}},{"name":"item_id","in":"path","description":"Purchase Order Receipt Item Id","required":true,"schema":{"type":"integer","description":"Purchase Order Receipt Item Id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Purchase Order Receipt Item was deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["purchaseorderreceipts"],"summary":"Updates Purchase Order Receipt Item","description":"Sample request:\r\n\r\n PUT /purchaseorderreceipts/1/purchaseorderreceiptitems/1\r\n {\r\n \"quantity_expected\": 1,\r\n \"buy_price_ex\": 1.1,\r\n \"quantity_received\": 3,\r\n \"quantity_faulty\": 2,\r\n \"quantity_invoiced\": 1,\r\n \"unit_discount_ex\": 1.1,\r\n \"direct_costs_ex\": 1.1,\r\n \"include_tax\": true,\r\n \"variance_action\": \"Leave On-Order\",\r\n \"variance_reason\": {\r\n \"id\": 1,\r\n \"name\": \"variance reason name\"\r\n },\r\n \"bin\": \"bin\",\r\n \"notes\": \"notes\"\r\n }","operationId":"put-purchaseorderreceipts-id-purchaseorderreceiptitems-item_id","parameters":[{"name":"id","in":"path","description":"Purchase Order Receipt id","required":true,"schema":{"type":"integer","description":"Purchase Order Receipt id","format":"int32"}},{"name":"item_id","in":"path","description":"Purchase Order Receipt Item id","required":true,"schema":{"type":"integer","description":"Purchase Order Receipt Item id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Purchase Order Item model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Returns updated Purchase Order Receipt Item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderReceiptItem"},"example":{"id":0,"purchase_order_item_id":0,"pricing":{"product_id":0,"outlet_id":0,"sell_price_inc":0,"promotional_price_inc":0,"promotional_price_start":"string","promotional_price_end":"string","taxable":true},"purchase_order_receipt_id":0,"stock_receipt_id":0,"quantity_expected":0,"quantity_received":0,"quantity_faulty":0,"quantity_invoiced":0,"buy_price_ex":0,"supplier_buy_ex":0,"unit_discount_ex":0,"direct_costs_ex":0,"include_tax":true,"quantity_received_variance":0,"product":{"carton_quantity":"string","cubic":0,"rrp_inc":0,"sell_price_inc":0,"breadth":0,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"id":0,"length":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_sku":"string","supplier_sku2":"string","weight":0,"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"made_available_on":"string","made_available_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"finalised_on":"string","finalised_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"total_buy_price_ex":0,"bin":"string","cogs_ex":0,"total_tax":0,"total_buy_price_inc":0,"total_applied_buy_price_ex":0,"total_direct_costs_ex":0,"total_cogs_ex":0,"total_cogs_inc":0,"variance_action":"Leave On-Order","variance_reason":{"id":0,"name":"string"},"notes":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Purchase Order Receipt Item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/purchaseorders/{id}":{"get":{"tags":["purchaseorders"],"summary":"Gets Purchase Order","description":"Gets Purchase Order","operationId":"get-purchaseorders-id","parameters":[{"name":"id","in":"path","description":"Purchase Order id","required":true,"schema":{"type":"integer","description":"Purchase Order id","format":"int32","example":10000}},{"name":"include_items","in":"query","description":"Include items","schema":{"type":"boolean","description":"Include items"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Purchase Order","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"},"example":{"id":0,"external_purchase_order_id":"string","reference_purchase_order_id":0,"status":{"id":0,"name":"string"},"outlet":{"id":0,"name":"string"},"supplier":{"id":0,"name":"string"},"sailed":"string","deposit_due":"string","balance_due":"string","supplier_comments":"string","purchase_order_template":"string","update_linked_transfers_on_receipt_to":"string","autoreplenishment_invoice_number":"string","autoreplenishment_invoice_reference":"string","original_departure":"string","eta":"string","container_number":"string","deliver_to":"string","shipping_status":{"id":0,"name":"string"},"shipping_type":{"id":0,"name":"string"},"shipping_port":{"id":0,"name":"string"},"country_of_origin":{"id":0,"name":"string"},"shipping_terms":"string","payment_terms":"string","invoice_documents":"string","packing_list_documents":"string","packing_declaration_documents":"string","fumes_documents":"string","certificate_of_original_documents":"string","bill_of_lading_documents":"string","internal_comments":"string","supplier_invoice_number":"string","deposit":0,"purchase_order_items":[{"po_id":0,"po_item_id":0,"product":{"carton_quantity":"string","cogs_ex":0,"cubic":0,"direct_costs_ex":0,"prevent_disabling":true,"promotional_price_inc":0,"promotional_price_expiry":"string","freight_inc":0,"price_ex":0,"rrp_inc":0,"sell_price_inc":0,"web_price_inc":0,"markup_target":0,"breadth":0,"core_product":true,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"disabled":true,"id":0,"lead_time":0,"length":0,"loyalty_ratio":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"requires_assembly":true,"shipping_cubic":0,"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_buy_ex":0,"supplier_sku":"string","supplier_sku2":"string","weight":0,"buy_price_ex":0,"long_description":"string","voucher_product":true,"max_discount_rule":{"id":0,"name":"string","value":0,"type":"string","modified_on":"string"},"replenishment_method":{"id":0,"code":"string","name":"string"},"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"created_on":"string","modified_on":"string","inventory":[{"outlet":{"id":0,"name":"string","modified_on":"string"},"quantity_available":0,"quantity_on_order":0}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"pricing":{"product_id":0,"outlet_id":0,"sell_price_inc":0,"promotional_price_inc":0,"promotional_price_start":"string","promotional_price_end":"string","taxable":true},"quantity_ordered":0,"quantity_special_order":0,"quantity_back_order":0,"quantity_received":0,"quantity_received_variance":0,"quantity_cancelled":0,"quantity_remaining":0,"variance_reason":{"id":0,"name":"string"},"inventory":{"outlet":{"id":0,"name":"string"},"quantity_available":0,"quantity_on_order":0,"msl":0},"supplier_buy_ex":0,"total_weight":0,"total_cubic":0,"gross_profit":0,"mark_up":0,"total_supplier_buy_ex":0,"is_linked_to_transfer":true,"modified_on":"string","created_on":"string"}],"total_weight":0,"total_cubic":0,"total_quantity_special_order":0,"total_quantity_received":0,"total_quantity_remaining":0,"total_quantity_cancelled":0,"total_quantity_ordered":0,"total_supplier_buy_ex":0,"total_quantity_linked_transfers":0,"fob_currency":{"id":0,"currency_code":"string","currency_name":"string"},"created_on":"string","modified_on":"string","sent_on":"string","received_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/purchaseorders":{"post":{"tags":["purchaseorders"],"summary":"Creates Purchase Order","description":"Sample request:\r\n \r\n POST ​/purchaseorders\r\n {\r\n \"external_purchase_order_id\": \"external purchase order id\",\r\n \"reference_purchase_order_id\": 1,\r\n \"status\": {\r\n \"id\": 1\r\n },\r\n \"outlet\": {\r\n \"id\": 1\r\n },\r\n \"supplier\": {\r\n \"id\": 1\r\n },\r\n \"sailed\": \"2021-08-21\",\r\n \"deposit_due\": \"2021-08-21\",\r\n \"balance_due\": \"2021-08-21\",\r\n \"supplier_comments\": \"supplier_comments\",\r\n \"purchase_order_template\": \"purchase order template\",\r\n \"update_linked_transfers_on_receipt_to\": \"Allocate\",\r\n \"autoreplenishment_invoice_number\": \"100001\",\r\n \"autoreplenishment_invoice_reference\": \"autoreplenishment invoice reference\",\r\n \"original_departure\": \"2021-08-21\",\r\n \"eta\": \"2021-08-21\",\r\n \"container_number\": \"container number\",\r\n \"deliver_to\": \"container number\",\r\n \"shipping_status\": {\r\n \"id\": 1\r\n },\r\n \"shipping_type\": {\r\n \"id\": 1\r\n },\r\n \"shipping_port\": {\r\n \"id\": 1\r\n },\r\n \"country_of_origin\": {\r\n \"id\": 2\r\n },\r\n \"shipping_terms\": \"shipping terms\",\r\n \"payment_terms\": \"payment terms\",\r\n \"invoice_documents\": \"invoice documents\",\r\n \"packing_list_documents\": \"packing list documents\",\r\n \"packing_declaration_documents\": \"packing declaration documents\",\r\n \"fumes_documents\": \"fumes documents\",\r\n \"certificate_of_original_documents\": \"certificate of original documents\",\r\n \"bill_of_lading_documents\": \"bill of lading documents\",\r\n \"internal_comments\": \"internal comments\",\r\n \"deposit\": 0.1,\r\n \"fob_currency\": {\r\n \"id\": 1\r\n },\r\n \"sent_on\": \"2021-08-21\",\r\n \"purchase_order_items\": \r\n [\r\n {\r\n \"product\": {\r\n \"id\" : 124001\r\n },\r\n \"quantity_ordered\": 1,\r\n \"supplier_buy_ex\": 1.1,\r\n \"quantity_received\": 1\r\n }\r\n ]\r\n }","operationId":"post-purchaseorders","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Purchase Order model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Purchase Order created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"},"example":{"id":0,"external_purchase_order_id":"string","reference_purchase_order_id":0,"status":{"id":0,"name":"string"},"outlet":{"id":0,"name":"string"},"supplier":{"id":0,"name":"string"},"sailed":"string","deposit_due":"string","balance_due":"string","supplier_comments":"string","purchase_order_template":"string","update_linked_transfers_on_receipt_to":"string","autoreplenishment_invoice_number":"string","autoreplenishment_invoice_reference":"string","original_departure":"string","eta":"string","container_number":"string","deliver_to":"string","shipping_status":{"id":0,"name":"string"},"shipping_type":{"id":0,"name":"string"},"shipping_port":{"id":0,"name":"string"},"country_of_origin":{"id":0,"name":"string"},"shipping_terms":"string","payment_terms":"string","invoice_documents":"string","packing_list_documents":"string","packing_declaration_documents":"string","fumes_documents":"string","certificate_of_original_documents":"string","bill_of_lading_documents":"string","internal_comments":"string","supplier_invoice_number":"string","deposit":0,"purchase_order_items":[{"po_id":0,"po_item_id":0,"product":{"carton_quantity":"string","cogs_ex":0,"cubic":0,"direct_costs_ex":0,"prevent_disabling":true,"promotional_price_inc":0,"promotional_price_expiry":"string","freight_inc":0,"price_ex":0,"rrp_inc":0,"sell_price_inc":0,"web_price_inc":0,"markup_target":0,"breadth":0,"core_product":true,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"disabled":true,"id":0,"lead_time":0,"length":0,"loyalty_ratio":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"requires_assembly":true,"shipping_cubic":0,"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_buy_ex":0,"supplier_sku":"string","supplier_sku2":"string","weight":0,"buy_price_ex":0,"long_description":"string","voucher_product":true,"max_discount_rule":{"id":0,"name":"string","value":0,"type":"string","modified_on":"string"},"replenishment_method":{"id":0,"code":"string","name":"string"},"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"created_on":"string","modified_on":"string","inventory":[{"outlet":{"id":0,"name":"string","modified_on":"string"},"quantity_available":0,"quantity_on_order":0}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"pricing":{"product_id":0,"outlet_id":0,"sell_price_inc":0,"promotional_price_inc":0,"promotional_price_start":"string","promotional_price_end":"string","taxable":true},"quantity_ordered":0,"quantity_special_order":0,"quantity_back_order":0,"quantity_received":0,"quantity_received_variance":0,"quantity_cancelled":0,"quantity_remaining":0,"variance_reason":{"id":0,"name":"string"},"inventory":{"outlet":{"id":0,"name":"string"},"quantity_available":0,"quantity_on_order":0,"msl":0},"supplier_buy_ex":0,"total_weight":0,"total_cubic":0,"gross_profit":0,"mark_up":0,"total_supplier_buy_ex":0,"is_linked_to_transfer":true,"modified_on":"string","created_on":"string"}],"total_weight":0,"total_cubic":0,"total_quantity_special_order":0,"total_quantity_received":0,"total_quantity_remaining":0,"total_quantity_cancelled":0,"total_quantity_ordered":0,"total_supplier_buy_ex":0,"total_quantity_linked_transfers":0,"fob_currency":{"id":0,"currency_code":"string","currency_name":"string"},"created_on":"string","modified_on":"string","sent_on":"string","received_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"get":{"tags":["purchaseorders"],"summary":"Searches Purchase Orders by parameters","description":"Searches Purchase Orders by parameters","operationId":"get-purchaseorders","parameters":[{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, external_purchase_order_id, reference_purchase_order_id, status, outlet, supplier, eta, created_on, modified_on, product_id, created_by_id, created_by_first_name, created_by_surname\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:gte:1,outlet:in:outlet1|outlet2","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, external_purchase_order_id, reference_purchase_order_id, status, outlet, supplier, eta, created_on, modified_on, product_id, created_by_id, created_by_first_name, created_by_surname\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:gte:1,outlet:in:outlet1|outlet2","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, status, outlet, supplier, eta, created_on, modified_on, created_by_id, created_by_first_name, created_by_surname\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, supplier desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, status, outlet, supplier, eta, created_on, modified_on, created_by_id, created_by_first_name, created_by_surname\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, supplier desc","nullable":true}},{"name":"include_items","in":"query","description":"Include items","schema":{"type":"boolean","description":"Include items"}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Purchase Orders data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder.PagingResponse"},"example":{"data":[{"id":0,"external_purchase_order_id":"string","reference_purchase_order_id":0,"status":{"id":0,"name":"string"},"outlet":{"id":0,"name":"string"},"supplier":{"id":0,"name":"string"},"sailed":"string","deposit_due":"string","balance_due":"string","supplier_comments":"string","purchase_order_template":"string","update_linked_transfers_on_receipt_to":"string","autoreplenishment_invoice_number":"string","autoreplenishment_invoice_reference":"string","original_departure":"string","eta":"string","container_number":"string","deliver_to":"string","shipping_status":{"id":0,"name":"string"},"shipping_type":{"id":0,"name":"string"},"shipping_port":{"id":0,"name":"string"},"country_of_origin":{"id":0,"name":"string"},"shipping_terms":"string","payment_terms":"string","invoice_documents":"string","packing_list_documents":"string","packing_declaration_documents":"string","fumes_documents":"string","certificate_of_original_documents":"string","bill_of_lading_documents":"string","internal_comments":"string","supplier_invoice_number":"string","deposit":0,"purchase_order_items":[{"po_id":0,"po_item_id":0,"product":{"carton_quantity":"string","cogs_ex":0,"cubic":0,"direct_costs_ex":0,"prevent_disabling":true,"promotional_price_inc":0,"promotional_price_expiry":"string","freight_inc":0,"price_ex":0,"rrp_inc":0,"sell_price_inc":0,"web_price_inc":0,"markup_target":0,"breadth":0,"core_product":true,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"disabled":true,"id":0,"lead_time":0,"length":0,"loyalty_ratio":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"requires_assembly":true,"shipping_cubic":0,"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_buy_ex":0,"supplier_sku":"string","supplier_sku2":"string","weight":0,"buy_price_ex":0,"long_description":"string","voucher_product":true,"max_discount_rule":{"id":0,"name":"string","value":0,"type":"string","modified_on":"string"},"replenishment_method":{"id":0,"code":"string","name":"string"},"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"created_on":"string","modified_on":"string","inventory":[{"outlet":{"id":0,"name":"string","modified_on":"string"},"quantity_available":0,"quantity_on_order":0}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"pricing":{"product_id":0,"outlet_id":0,"sell_price_inc":0,"promotional_price_inc":0,"promotional_price_start":"string","promotional_price_end":"string","taxable":true},"quantity_ordered":0,"quantity_special_order":0,"quantity_back_order":0,"quantity_received":0,"quantity_received_variance":0,"quantity_cancelled":0,"quantity_remaining":0,"variance_reason":{"id":0,"name":"string"},"inventory":{"outlet":{"id":0,"name":"string"},"quantity_available":0,"quantity_on_order":0,"msl":0},"supplier_buy_ex":0,"total_weight":0,"total_cubic":0,"gross_profit":0,"mark_up":0,"total_supplier_buy_ex":0,"is_linked_to_transfer":true,"modified_on":"string","created_on":"string"}],"total_weight":0,"total_cubic":0,"total_quantity_special_order":0,"total_quantity_received":0,"total_quantity_remaining":0,"total_quantity_cancelled":0,"total_quantity_ordered":0,"total_supplier_buy_ex":0,"total_quantity_linked_transfers":0,"fob_currency":{"id":0,"currency_code":"string","currency_name":"string"},"created_on":"string","modified_on":"string","sent_on":"string","received_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/purchaseorders/{id}/purchaseorderitems":{"get":{"tags":["purchaseorders"],"summary":"Searches Purchase Order Items by Purchase Order id and other parameters","description":"Searches Purchase Order Items by Purchase Order id and other parameters","operationId":"get-purchaseorders-id-purchaseorderitems","parameters":[{"name":"id","in":"path","description":"Purchase Order id","required":true,"schema":{"type":"integer","description":"Purchase Order id","format":"int32"}},{"name":"filter_by","in":"query","description":"Filter by. \r\nAvailable field name values: quantity_on_order, quantity_received, quantity_ordered, quantity_received_variance, quantity_cancelled, variance_reason_id, po_item_id, product_id, supplier_sku, supplier_sku2, manufacturer_sku, short_description, length, breadth, depth, cubic, total_cubic, carton_quantity, weight, total_weight, rrp_inc, sell_price_inc, product_type, size mapped to value name, colour mapped to value name, brand mapped to value name, season mapped to value name, custom1, custom2, custom3, gross_profit, mark_up, quantity_available, quantity_special_order, quantity_remaining, supplier_buy_ex, total_supplier_buy_ex, attribute, supplier_id, supplier_code, supplier_name, attribute:Id, msl, modified_on, created_on, pricing_sell_price_inc, pricing_promotional_price_inc, pricing_promotional_price_start, pricing_promotional_price_end, is_linked_to_transfer.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: quantity_on_order:eq:2, attribute:101:isnotnull, attribute:101:eq:Custom Attribute Value 123","schema":{"type":"string","description":"Filter by. \r\nAvailable field name values: quantity_on_order, quantity_received, quantity_ordered, quantity_received_variance, quantity_cancelled, variance_reason_id, po_item_id, product_id, supplier_sku, supplier_sku2, manufacturer_sku, short_description, length, breadth, depth, cubic, total_cubic, carton_quantity, weight, total_weight, rrp_inc, sell_price_inc, product_type, size mapped to value name, colour mapped to value name, brand mapped to value name, season mapped to value name, custom1, custom2, custom3, gross_profit, mark_up, quantity_available, quantity_special_order, quantity_remaining, supplier_buy_ex, total_supplier_buy_ex, attribute, supplier_id, supplier_code, supplier_name, attribute:Id, msl, modified_on, created_on, pricing_sell_price_inc, pricing_promotional_price_inc, pricing_promotional_price_start, pricing_promotional_price_end, is_linked_to_transfer.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: quantity_on_order:eq:2, attribute:101:isnotnull, attribute:101:eq:Custom Attribute Value 123","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: quantity_on_order, quantity_received, quantity_ordered, quantity_received_variance, quantity_cancelled, variance_reason_id, po_item_id, product_id, supplier_sku, supplier_sku2, manufacturer_sku, short_description, length, breadth, depth, cubic, total_cubic, carton_quantity, weight, total_weight, rrp_inc, sell_price_inc, product_type, size, colour, custom1, custom2, custom3, gross_profit, mark_up, quantity_available, quantity_special_order, quantity_remaining, total_supplier_buy_ex, brand, season, attribute, supplier_code, supplier_name, attribute:Id, msl, modified_on, created_on, pricing_sell_price_inc, pricing_promotional_price_inc, pricing_promotional_price_start, pricing_promotional_price_end, is_linked_to_transfer.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: quantity_received_variance asc, quantity_on_order desc, attribute:101","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: quantity_on_order, quantity_received, quantity_ordered, quantity_received_variance, quantity_cancelled, variance_reason_id, po_item_id, product_id, supplier_sku, supplier_sku2, manufacturer_sku, short_description, length, breadth, depth, cubic, total_cubic, carton_quantity, weight, total_weight, rrp_inc, sell_price_inc, product_type, size, colour, custom1, custom2, custom3, gross_profit, mark_up, quantity_available, quantity_special_order, quantity_remaining, total_supplier_buy_ex, brand, season, attribute, supplier_code, supplier_name, attribute:Id, msl, modified_on, created_on, pricing_sell_price_inc, pricing_promotional_price_inc, pricing_promotional_price_start, pricing_promotional_price_end, is_linked_to_transfer.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: quantity_received_variance asc, quantity_on_order desc, attribute:101","nullable":true}},{"name":"select","in":"query","description":"Select fields.\r\n\r\nAvailable field name values: id, po_id, quantity_remaining, quantity_ordered, quantity_received, quantity_cancelled, quantity_special_order, quantity_back_order, quantity_received_variance, supplier_buy_ex, product_id, product_supplier_buy_ex.\r\n\r\nExample: id","schema":{"type":"string","description":"Select fields.\r\n\r\nAvailable field name values: id, po_id, quantity_remaining, quantity_ordered, quantity_received, quantity_cancelled, quantity_special_order, quantity_back_order, quantity_received_variance, supplier_buy_ex, product_id, product_supplier_buy_ex.\r\n\r\nExample: id","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Purchase Order Items data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderItem.PagingResponse"},"example":{"data":[{"po_id":0,"po_item_id":0,"product":{"carton_quantity":"string","cogs_ex":0,"cubic":0,"direct_costs_ex":0,"prevent_disabling":true,"promotional_price_inc":0,"promotional_price_expiry":"string","freight_inc":0,"price_ex":0,"rrp_inc":0,"sell_price_inc":0,"web_price_inc":0,"markup_target":0,"breadth":0,"core_product":true,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"disabled":true,"id":0,"lead_time":0,"length":0,"loyalty_ratio":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"requires_assembly":true,"shipping_cubic":0,"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_buy_ex":0,"supplier_sku":"string","supplier_sku2":"string","weight":0,"buy_price_ex":0,"long_description":"string","voucher_product":true,"max_discount_rule":{"id":0,"name":"string","value":0,"type":"string","modified_on":"string"},"replenishment_method":{"id":0,"code":"string","name":"string"},"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"created_on":"string","modified_on":"string","inventory":[{"outlet":{"id":0,"name":"string","modified_on":"string"},"quantity_available":0,"quantity_on_order":0}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"pricing":{"product_id":0,"outlet_id":0,"sell_price_inc":0,"promotional_price_inc":0,"promotional_price_start":"string","promotional_price_end":"string","taxable":true},"quantity_ordered":0,"quantity_special_order":0,"quantity_back_order":0,"quantity_received":0,"quantity_received_variance":0,"quantity_cancelled":0,"quantity_remaining":0,"variance_reason":{"id":0,"name":"string"},"inventory":{"outlet":{"id":0,"name":"string"},"quantity_available":0,"quantity_on_order":0,"msl":0},"supplier_buy_ex":0,"total_weight":0,"total_cubic":0,"gross_profit":0,"mark_up":0,"total_supplier_buy_ex":0,"is_linked_to_transfer":true,"modified_on":"string","created_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/purchaseorders/{id}/purchaseorderitems/{item_id}":{"delete":{"tags":["purchaseorders"],"summary":"Deletes specific Purchase Order Item by id","description":"Deletes specific Purchase Order Item by id","operationId":"delete-purchaseorders-id-purchaseorderitems-item_id","parameters":[{"name":"id","in":"path","description":"Purchase Order id","required":true,"schema":{"type":"integer","description":"Purchase Order id","format":"int32"}},{"name":"item_id","in":"path","description":"Purchase Order Item id","required":true,"schema":{"type":"integer","description":"Purchase Order Item id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Purchase Order Item was deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/receiptvariancereasons/{id}":{"get":{"tags":["receiptvariancereasons"],"summary":"Gets Receipt Variance Reason by id","description":"Gets Receipt Variance Reason by id","operationId":"get-receiptvariancereasons-id","parameters":[{"name":"id","in":"path","description":"Receipt Variance Reason id","required":true,"schema":{"type":"integer","description":"Receipt Variance Reason id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Receipt Variance Reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptVarianceReason"},"example":{"id":0,"name":"string","enabled":true,"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Receipt Variance Reason not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["receiptvariancereasons"],"summary":"Updates specific Receipt Variance Reason by id","description":"Sample request:\r\n\r\n PUT /receiptvariancereasons/1\r\n {\r\n \"name\": \"new name\",\r\n \"enabled\": false\r\n }","operationId":"put-receiptvariancereasons-id","parameters":[{"name":"id","in":"path","description":"Receipt Variance Reason id","required":true,"schema":{"type":"integer","description":"Receipt Variance Reason id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Receipt Variance Reason model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Receipt Variance Reason was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptVarianceReason"},"example":{"id":0,"name":"string","enabled":true,"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/receiptvariancereasons":{"get":{"tags":["receiptvariancereasons"],"summary":"Searches Receipt Variance Reasons by parameters","description":"Searches Receipt Variance Reasons by parameters","operationId":"get-receiptvariancereasons","parameters":[{"name":"filter_by","in":"query","description":"Filter by. \r\nAvailable field name values: enabled\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432","schema":{"type":"string","description":"Filter by. \r\nAvailable field name values: enabled\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, name, enabled, created_on, created_by_id, created_by_first_name, created_by_surname, modified_on, modified_by_id, modified_by_first_name, modified_by_surname\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, product_id desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, name, enabled, created_on, created_by_id, created_by_first_name, created_by_surname, modified_on, modified_by_id, modified_by_first_name, modified_by_surname\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, product_id desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Receipt Variance Reasons data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptVarianceReason.PagingResponse"},"example":{"data":[{"id":0,"name":"string","enabled":true,"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["receiptvariancereasons"],"summary":"Creates Receipt Variance Reason","description":"Sample request:\r\n \r\n POST /receiptvariancereasons\r\n {\r\n \"name\": \"Receipt Variance Reason Name\",\r\n \"enabled\": true\r\n }","operationId":"post-receiptvariancereasons","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Receipt Variance Reason model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Receipt Variance Reason created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceiptVarianceReason"},"example":{"id":0,"name":"string","enabled":true,"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/stockreceipts":{"post":{"tags":["stockreceipts"],"summary":"Creates Stock Receipt","description":"Sample request:\r\n \r\n POST /stockreceipts\r\n {\r\n \"source_type\": \"PO\",\r\n \"source_id\": 1,\r\n \"source_item_id\": 1,\r\n \"source_receipt_item_id\": 1,\r\n \"product\": \r\n {\r\n \"id\": 124001\r\n },\r\n \"outlet\":\r\n {\r\n \"id\": 1\r\n },\r\n \"received_quantity\": 10,\r\n \"buy_price_ex\": 100,\r\n \"direct_costs_ex\": 10.1,\r\n \"tax_rate\": 1.1\r\n }","operationId":"post-stockreceipts","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Stock Receipt model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Stock Receipt created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockReceipt"},"example":{"id":0,"source_type":"string","source_id":0,"source_item_id":0,"source_receipt_item_id":0,"product":{"carton_quantity":"string","cubic":0,"rrp_inc":0,"sell_price_inc":0,"breadth":0,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"id":0,"length":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_sku":"string","supplier_sku2":"string","weight":0,"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"outlet":{"id":0,"name":"string","modified_on":"string"},"received_quantity":0,"buy_price_ex":0,"direct_costs_ex":0,"tax_rate":0,"created_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"get":{"tags":["stockreceipts"],"summary":"Searches Stock Receipts by parameters","description":"Searches Stock Receipts by parameters","operationId":"get-stockreceipts","parameters":[{"name":"filter_by","in":"query","description":"Filter by. \r\nAvailable field name values: id, source_type, source_id, source_item_id, source_receipt_item_id, product_id, outlet (mapped to Warehouse name), created_on.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,product_id:in:2|432","schema":{"type":"string","description":"Filter by. \r\nAvailable field name values: id, source_type, source_id, source_item_id, source_receipt_item_id, product_id, outlet (mapped to Warehouse name), created_on.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,product_id:in:2|432","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, source_type, source_id, source_item_id, source_receipt_item_id, product_id, outlet (mapped to Warehouse name), received_quantity, created_on.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, product_id desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, source_type, source_id, source_item_id, source_receipt_item_id, product_id, outlet (mapped to Warehouse name), received_quantity, created_on.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, product_id desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Stock Receipts data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockReceipt.PagingResponse"},"example":{"data":[{"id":0,"source_type":"string","source_id":0,"source_item_id":0,"source_receipt_item_id":0,"product":{"carton_quantity":"string","cubic":0,"rrp_inc":0,"sell_price_inc":0,"breadth":0,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"id":0,"length":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_sku":"string","supplier_sku2":"string","weight":0,"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"outlet":{"id":0,"name":"string","modified_on":"string"},"received_quantity":0,"buy_price_ex":0,"direct_costs_ex":0,"tax_rate":0,"created_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/stockreceipts/{id}":{"get":{"tags":["stockreceipts"],"summary":"Gets Stock Receipt by id","description":"Gets Stock Receipt by id","operationId":"get-stockreceipts-id","parameters":[{"name":"id","in":"path","description":"Stock Receipt id","required":true,"schema":{"type":"integer","description":"Stock Receipt id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Stock Receipt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockReceipt"},"example":{"id":0,"source_type":"string","source_id":0,"source_item_id":0,"source_receipt_item_id":0,"product":{"carton_quantity":"string","cubic":0,"rrp_inc":0,"sell_price_inc":0,"breadth":0,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"id":0,"length":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_sku":"string","supplier_sku2":"string","weight":0,"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"outlet":{"id":0,"name":"string","modified_on":"string"},"received_quantity":0,"buy_price_ex":0,"direct_costs_ex":0,"tax_rate":0,"created_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Stock Receipt not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/supplierinvoices/{id}":{"get":{"tags":["supplierinvoices"],"summary":"Gets Supplier Invoice by id","description":"Gets Supplier Invoice by id","operationId":"get-supplierinvoices-id","parameters":[{"name":"id","in":"path","description":"Supplier Invoice id","required":true,"schema":{"type":"integer","description":"Supplier Invoice id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Supplier Invoice","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierInvoice"},"example":{"id":0,"supplier_invoice_number":"string","status":"string","notes":"string","international_order":true,"landed_costs_calculation":"Manual","currency_conversion":0,"rounding_adjustment":0,"origin_country":{"id":0,"name":"string"},"distribute_costs_by":"string","direct_costs":{"applied_on":"string","apply_pending":true,"freight":{"total_ex":0,"includes_tax":true,"total_tax":0,"total_inc":0},"duty":{"total_ex":0,"includes_tax":true,"total_tax":0,"total_inc":0},"misc":{"total_ex":0,"includes_tax":true,"total_tax":0,"total_inc":0}},"purchase_order_receipts":[{"id":0,"purchase_order_id":0,"purchase_order_receipt_items":[{"purchase_order_item_id":0,"buy_price_ex":0,"supplier_buy_ex":0,"quantity_received":0,"quantity_faulty":0,"quantity_invoiced":0,"bin":"string","include_tax":true,"notes":"string"}]}],"total_buy_price_ex":0,"total_tax":0,"total_buy_price_inc":0,"total_applied_buy_price_ex":0,"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"finalised_on":"string","finalised_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"supplier_invoiced_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["supplierinvoices"],"summary":"Updates Supplier Invoice","description":"Sample request:\r\n \r\n PUT /supplierinvoices/1\r\n {\r\n \"supplier_invoice_number\": \"1235\",\r\n \"supplier_invoiced_on\": \"2022-01-01\",\r\n \"status\": \"Finalised\",\r\n \"notes\": \"notes\",\r\n \"distribute_costs_by\": \"Weight\",\r\n \"international_order\": true,\r\n \"landed_costs_calculation\": \"Currency Conversion\",\r\n \"origin_country\": {\r\n \"id\": 2\r\n },\r\n \"currency_conversion\": 1.14,\r\n \"rounding_adjustment\": 1.5\r\n }","operationId":"put-supplierinvoices-id","parameters":[{"name":"id","in":"path","description":"Supplier Invoice id","required":true,"schema":{"type":"integer","description":"Supplier Invoice id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Supplier Invoice model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Supplier Invoice updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierInvoice"},"example":{"id":0,"supplier_invoice_number":"string","status":"string","notes":"string","international_order":true,"landed_costs_calculation":"Manual","currency_conversion":0,"rounding_adjustment":0,"origin_country":{"id":0,"name":"string"},"distribute_costs_by":"string","direct_costs":{"applied_on":"string","apply_pending":true,"freight":{"total_ex":0,"includes_tax":true,"total_tax":0,"total_inc":0},"duty":{"total_ex":0,"includes_tax":true,"total_tax":0,"total_inc":0},"misc":{"total_ex":0,"includes_tax":true,"total_tax":0,"total_inc":0}},"purchase_order_receipts":[{"id":0,"purchase_order_id":0,"purchase_order_receipt_items":[{"purchase_order_item_id":0,"buy_price_ex":0,"supplier_buy_ex":0,"quantity_received":0,"quantity_faulty":0,"quantity_invoiced":0,"bin":"string","include_tax":true,"notes":"string"}]}],"total_buy_price_ex":0,"total_tax":0,"total_buy_price_inc":0,"total_applied_buy_price_ex":0,"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"finalised_on":"string","finalised_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"supplier_invoiced_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/supplierinvoices":{"get":{"tags":["supplierinvoices"],"summary":"Searches Supplier Invoices by parameters","description":"Searches Supplier Invoices by parameters","operationId":"get-supplierinvoices","parameters":[{"name":"filter_by","in":"query","description":"Filter by. \r\nAvailable field name values: id, supplier_invoice_number, created_on, created_by_id, created_by_first_name, created_by_surname, modified_on, modified_by_id, modified_by_first_name, modified_by_surname, finalised_on, finalised_by_id, finalised_by_first_name, finalised_by_surname, status, total_buy_price_ex, distribute_costs_by, freight_total_ex, freight_includes_tax, freight_total_tax, freight_total_inc, duty_total_ex, duty_includes_tax, duty_total_tax, duty_total_inc, misc_total_ex, misc_includes_tax, misc_total_tax, misc_total_inc, purchase_order_supplier, purchase_order_id, total_tax, total_buy_price_inc, total_applied_buy_price_ex, supplier_invoiced_on\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432","schema":{"type":"string","description":"Filter by. \r\nAvailable field name values: id, supplier_invoice_number, created_on, created_by_id, created_by_first_name, created_by_surname, modified_on, modified_by_id, modified_by_first_name, modified_by_surname, finalised_on, finalised_by_id, finalised_by_first_name, finalised_by_surname, status, total_buy_price_ex, distribute_costs_by, freight_total_ex, freight_includes_tax, freight_total_tax, freight_total_inc, duty_total_ex, duty_includes_tax, duty_total_tax, duty_total_inc, misc_total_ex, misc_includes_tax, misc_total_tax, misc_total_inc, purchase_order_supplier, purchase_order_id, total_tax, total_buy_price_inc, total_applied_buy_price_ex, supplier_invoiced_on\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, supplier_invoice_number, created_on, created_by_id, created_by_first_name, created_by_surname, modified_on, modified_by_id, modified_by_first_name, modified_by_surname, finalised_on, finalised_by_id, finalised_by_first_name, finalised_by_surname, status, total_buy_price_ex, distribute_costs_by, freight_total_ex, freight_includes_tax, freight_total_tax, freight_total_inc, duty_total_ex, duty_includes_tax, duty_total_tax, duty_total_inc, misc_total_ex, misc_includes_tax, misc_total_tax, misc_total_inc, total_tax, total_buy_price_inc, total_applied_buy_price_ex, supplier_invoiced_on\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, product_id desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, supplier_invoice_number, created_on, created_by_id, created_by_first_name, created_by_surname, modified_on, modified_by_id, modified_by_first_name, modified_by_surname, finalised_on, finalised_by_id, finalised_by_first_name, finalised_by_surname, status, total_buy_price_ex, distribute_costs_by, freight_total_ex, freight_includes_tax, freight_total_tax, freight_total_inc, duty_total_ex, duty_includes_tax, duty_total_tax, duty_total_inc, misc_total_ex, misc_includes_tax, misc_total_tax, misc_total_inc, total_tax, total_buy_price_inc, total_applied_buy_price_ex, supplier_invoiced_on\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, product_id desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Supplier Invoices data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierInvoice.PagingResponse"},"example":{"data":[{"id":0,"supplier_invoice_number":"string","status":"string","notes":"string","international_order":true,"landed_costs_calculation":"Manual","currency_conversion":0,"rounding_adjustment":0,"origin_country":{"id":0,"name":"string"},"distribute_costs_by":"string","direct_costs":{"applied_on":"string","apply_pending":true,"freight":{"total_ex":0,"includes_tax":true,"total_tax":0,"total_inc":0},"duty":{"total_ex":0,"includes_tax":true,"total_tax":0,"total_inc":0},"misc":{"total_ex":0,"includes_tax":true,"total_tax":0,"total_inc":0}},"purchase_order_receipts":[{"id":0,"purchase_order_id":0,"purchase_order_receipt_items":[{"purchase_order_item_id":0,"buy_price_ex":0,"supplier_buy_ex":0,"quantity_received":0,"quantity_faulty":0,"quantity_invoiced":0,"bin":"string","include_tax":true,"notes":"string"}]}],"total_buy_price_ex":0,"total_tax":0,"total_buy_price_inc":0,"total_applied_buy_price_ex":0,"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"finalised_on":"string","finalised_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"supplier_invoiced_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["supplierinvoices"],"summary":"Creates Supplier Invoice","description":"Sample request:\r\n \r\n POST /supplierinvoices\r\n {\r\n \"status\": \"In Progress\",\r\n \"notes\": \"notes\",\r\n \"supplier_invoice_number\": \"1235\",\r\n \"supplier_invoiced_on\": \"2022-01-01\",\r\n \"rounding_adjustment\": -2.1,\r\n \"purchase_order_receipts\": [\r\n {\r\n \"id\": 1,\r\n \"purchase_order_id\": 1,\r\n \"purchase_order_receipt_items\": [ \r\n { \r\n \"purchase_order_item_id\": 3,\r\n \"quantity_received\": 6,\r\n \"quantity_faulty\": 1,\r\n \"quantity_invoiced\": 1,\r\n \"buy_price_ex\": 2,\r\n \"bin\": \"bin\",\r\n \"include_tax\": true,\r\n \"notes\": \"notes\"\r\n }, \r\n { \r\n \"purchase_order_item_id\": 4,\r\n \"quantity_received\": 4,\r\n \"quantity_faulty\": 1,\r\n \"quantity_invoiced\": 1,\r\n \"buy_price_ex\": 2,\r\n \"bin\": \"bin\",\r\n \"include_tax\": true,\r\n \"notes\": \"notes\"\r\n }]\r\n }],\r\n \"distribute_costs_by\": \"Value\",\r\n \"direct_costs\":\r\n {\r\n \"freight\":\r\n {\r\n \"includes_tax\": false,\r\n \"total_ex\": 10\r\n },\r\n \"misc\":\r\n {\r\n \"includes_tax\": false,\r\n \"total_ex\": 10\r\n },\r\n \"duty\":\r\n {\r\n \"total_ex\": 20.5\r\n }\r\n }\r\n }","operationId":"post-supplierinvoices","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Supplier Invoice model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Supplier Invoice created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierInvoice"},"example":{"id":0,"supplier_invoice_number":"string","status":"string","notes":"string","international_order":true,"landed_costs_calculation":"Manual","currency_conversion":0,"rounding_adjustment":0,"origin_country":{"id":0,"name":"string"},"distribute_costs_by":"string","direct_costs":{"applied_on":"string","apply_pending":true,"freight":{"total_ex":0,"includes_tax":true,"total_tax":0,"total_inc":0},"duty":{"total_ex":0,"includes_tax":true,"total_tax":0,"total_inc":0},"misc":{"total_ex":0,"includes_tax":true,"total_tax":0,"total_inc":0}},"purchase_order_receipts":[{"id":0,"purchase_order_id":0,"purchase_order_receipt_items":[{"purchase_order_item_id":0,"buy_price_ex":0,"supplier_buy_ex":0,"quantity_received":0,"quantity_faulty":0,"quantity_invoiced":0,"bin":"string","include_tax":true,"notes":"string"}]}],"total_buy_price_ex":0,"total_tax":0,"total_buy_price_inc":0,"total_applied_buy_price_ex":0,"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_on":"string","modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"finalised_on":"string","finalised_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"supplier_invoiced_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/supplierinvoices/{id}/directcosts":{"put":{"tags":["supplierinvoices"],"summary":"Updates Supplier Invoice Direct Costs","description":"Sample request:\r\n \r\n PUT /supplierinvoices/1/directcosts\r\n {\r\n \"freight\":\r\n {\r\n \"total_ex\": 10,\r\n \"includes_tax\": false\r\n },\r\n \"misc\":\r\n {\r\n \"total_ex\": 32.1,\r\n \"includes_tax\": true\r\n },\r\n \"duty\":\r\n {\r\n \"total_ex\": 20.5\r\n }\r\n }","operationId":"put-supplierinvoices-id-directcosts","parameters":[{"name":"id","in":"path","description":"Supplier Invoice id","required":true,"schema":{"type":"integer","description":"Supplier Invoice id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Supplier Invoice Direct Costs model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Supplier Invoice Direct Costs updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierInvoiceDirectCosts"},"example":{"applied_on":"string","apply_pending":true,"freight":{"total_ex":0,"includes_tax":true,"total_tax":0,"total_inc":0},"duty":{"total_ex":0,"includes_tax":true,"total_tax":0,"total_inc":0},"misc":{"total_ex":0,"includes_tax":true,"total_tax":0,"total_inc":0}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/inventorymovementlogs/{id}":{"get":{"tags":["inventorymovementlogs"],"summary":"Gets specific Inventory Movement Log by unique id","description":"Gets specific Inventory Movement Log by unique id","operationId":"get-inventorymovementlogs-id","parameters":[{"name":"id","in":"path","description":"Inventory Movement Log id","required":true,"schema":{"type":"integer","description":"Inventory Movement Log id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Inventory Movement Log","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryMovementLogs"},"example":{"id":0,"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"outlet":{"id":0,"name":"string"},"product":{"id":0,"supplier_sku":"string","short_description":"string","product_type":{"id":0,"name":"string","modified_on":"string"}},"movement_type":"string","origin":"string","comment":"string","reference_id":"string","quantity_available":{"before":0,"delta":0,"after":0},"quantity_allocated":{"before":0,"delta":0,"after":0},"quantity_picked":{"before":0,"delta":0,"after":0},"quantity_in_transit_outbound":{"before":0,"delta":0,"after":0},"quantity_in_transit_inbound":{"before":0,"delta":0,"after":0},"quantity_received":{"before":0,"delta":0,"after":0},"quantity_requested":{"before":0,"delta":0,"after":0},"quantity_onorder":{"before":0,"delta":0,"after":0},"quantity_faulty":{"before":0,"delta":0,"after":0},"quantity_onreturn":{"before":0,"delta":0,"after":0},"quantity_soh":{"before":0,"delta":0,"after":0},"buy_price_ex":{"before":0,"change":0,"after":0},"direct_costs_ex":{"before":0,"change":0,"after":0},"cogs_ex":{"before":0,"change":0,"after":0},"total_cogs_ex":{"before":0,"change":0,"after":0}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Inventory Movement Log not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/inventorymovementlogs":{"get":{"tags":["inventorymovementlogs"],"summary":"Searches Inventory Movement Logs","description":"Searches Inventory Movement Logs","operationId":"get-inventorymovementlogs","parameters":[{"name":"plu","in":"query","description":"Product Look-Up code (PLU) It can be Product Id, Supplier SKU, Manufacturer SKU, Supplier SKU 2 or any Barcodes for a product. If specified, product_id, product_supplier_sku, product_short_description, product_type_name, supplier_id filters are ignored.","schema":{"type":"string","description":"Product Look-Up code (PLU) It can be Product Id, Supplier SKU, Manufacturer SKU, Supplier SKU 2 or any Barcodes for a product. If specified, product_id, product_supplier_sku, product_short_description, product_type_name, supplier_id filters are ignored.","nullable":true}},{"name":"reference_ids","in":"query","description":"Reference Id or Collection of Reference Ids (comma separated). If specified, plu, product_id, product_supplier_sku, product_short_description filters are ignored. movement_types is optional and can only contain single value.\r\nExample: 1,5,7,23-00000001","schema":{"type":"string","description":"Reference Id or Collection of Reference Ids (comma separated). If specified, plu, product_id, product_supplier_sku, product_short_description filters are ignored. movement_types is optional and can only contain single value.\r\nExample: 1,5,7,23-00000001","nullable":true}},{"name":"movement_types","in":"query","description":"Movement Type or Collection of Movement Types (comma separated).\r\nExample: PO,Invoice","schema":{"type":"string","description":"Movement Type or Collection of Movement Types (comma separated).\r\nExample: PO,Invoice","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, created_on, outlet_id, outlet_name, country_id, store_type_id, product_id, product_supplier_sku, product_short_description, product_type_name, supplier_id, supplier_code, supplier_name, origin, comment, quantity_available_before, quantity_available_delta, quantity_available_after, quantity_allocated_before, quantity_allocated_delta, quantity_allocated_after, quantity_picked_before, quantity_picked_delta, quantity_picked_after, quantity_in_transit_outbound_before, quantity_in_transit_outbound_delta, quantity_in_transit_outbound_after, quantity_in_transit_inbound_before, quantity_in_transit_inbound_delta, quantity_in_transit_inbound_after, quantity_received_before, quantity_received_delta, quantity_received_after, quantity_requested_before, quantity_requested_delta, quantity_requested_after, quantity_onorder_before, quantity_onorder_delta, quantity_onorder_after, quantity_faulty_before, quantity_faulty_delta, quantity_faulty_after, quantity_onreturn_before, quantity_onreturn_delta, quantity_onreturn_after, buy_price_ex_before, buy_price_ex_change, buy_price_ex_after, direct_costs_ex_before, direct_costs_ex_change, direct_costs_ex_after, cogs_ex_before, cogs_ex_change, cogs_ex_after, quantity_soh_before, quantity_soh_delta, quantity_soh_after, total_cogs_ex_before, total_cogs_ex_change, total_cogs_ex_after.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,product_id:in:124001|124002","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, created_on, outlet_id, outlet_name, country_id, store_type_id, product_id, product_supplier_sku, product_short_description, product_type_name, supplier_id, supplier_code, supplier_name, origin, comment, quantity_available_before, quantity_available_delta, quantity_available_after, quantity_allocated_before, quantity_allocated_delta, quantity_allocated_after, quantity_picked_before, quantity_picked_delta, quantity_picked_after, quantity_in_transit_outbound_before, quantity_in_transit_outbound_delta, quantity_in_transit_outbound_after, quantity_in_transit_inbound_before, quantity_in_transit_inbound_delta, quantity_in_transit_inbound_after, quantity_received_before, quantity_received_delta, quantity_received_after, quantity_requested_before, quantity_requested_delta, quantity_requested_after, quantity_onorder_before, quantity_onorder_delta, quantity_onorder_after, quantity_faulty_before, quantity_faulty_delta, quantity_faulty_after, quantity_onreturn_before, quantity_onreturn_delta, quantity_onreturn_after, buy_price_ex_before, buy_price_ex_change, buy_price_ex_after, direct_costs_ex_before, direct_costs_ex_change, direct_costs_ex_after, cogs_ex_before, cogs_ex_change, cogs_ex_after, quantity_soh_before, quantity_soh_delta, quantity_soh_after, total_cogs_ex_before, total_cogs_ex_change, total_cogs_ex_after.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,product_id:in:124001|124002","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, created_on, outlet_name, product_id, product_supplier_sku, product_short_description, product_type_name, movement_type, supplier_code, supplier_name, origin, comment, reference_id, quantity_available_before, quantity_available_delta, quantity_available_after, quantity_allocated_before, quantity_allocated_delta, quantity_allocated_after, quantity_picked_before, quantity_picked_delta, quantity_picked_after, quantity_in_transit_outbound_before, quantity_in_transit_outbound_delta, quantity_in_transit_outbound_after, quantity_in_transit_inbound_before, quantity_in_transit_inbound_delta, quantity_in_transit_inbound_after, quantity_received_before, quantity_received_delta, quantity_received_after, quantity_requested_before, quantity_requested_delta, quantity_requested_after, quantity_onorder_before, quantity_onorder_delta, quantity_onorder_after, quantity_faulty_before, quantity_faulty_delta, quantity_faulty_after, quantity_onreturn_before, quantity_onreturn_delta, quantity_onreturn_after, buy_price_ex_before, buy_price_ex_change, buy_price_ex_after, direct_costs_ex_before, direct_costs_ex_change, direct_costs_ex_after, cogs_ex_before, cogs_ex_change, cogs_ex_after, quantity_soh_before, quantity_soh_delta, quantity_soh_after, total_cogs_ex_before, total_cogs_ex_change, total_cogs_ex_after.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, created_on desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, created_on, outlet_name, product_id, product_supplier_sku, product_short_description, product_type_name, movement_type, supplier_code, supplier_name, origin, comment, reference_id, quantity_available_before, quantity_available_delta, quantity_available_after, quantity_allocated_before, quantity_allocated_delta, quantity_allocated_after, quantity_picked_before, quantity_picked_delta, quantity_picked_after, quantity_in_transit_outbound_before, quantity_in_transit_outbound_delta, quantity_in_transit_outbound_after, quantity_in_transit_inbound_before, quantity_in_transit_inbound_delta, quantity_in_transit_inbound_after, quantity_received_before, quantity_received_delta, quantity_received_after, quantity_requested_before, quantity_requested_delta, quantity_requested_after, quantity_onorder_before, quantity_onorder_delta, quantity_onorder_after, quantity_faulty_before, quantity_faulty_delta, quantity_faulty_after, quantity_onreturn_before, quantity_onreturn_delta, quantity_onreturn_after, buy_price_ex_before, buy_price_ex_change, buy_price_ex_after, direct_costs_ex_before, direct_costs_ex_change, direct_costs_ex_after, cogs_ex_before, cogs_ex_change, cogs_ex_after, quantity_soh_before, quantity_soh_delta, quantity_soh_after, total_cogs_ex_before, total_cogs_ex_change, total_cogs_ex_after.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, created_on desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Inventory Movement Logs data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryMovementLogs.PagingResponse"},"example":{"data":[{"id":0,"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"outlet":{"id":0,"name":"string"},"product":{"id":0,"supplier_sku":"string","short_description":"string","product_type":{"id":0,"name":"string","modified_on":"string"}},"movement_type":"string","origin":"string","comment":"string","reference_id":"string","quantity_available":{"before":0,"delta":0,"after":0},"quantity_allocated":{"before":0,"delta":0,"after":0},"quantity_picked":{"before":0,"delta":0,"after":0},"quantity_in_transit_outbound":{"before":0,"delta":0,"after":0},"quantity_in_transit_inbound":{"before":0,"delta":0,"after":0},"quantity_received":{"before":0,"delta":0,"after":0},"quantity_requested":{"before":0,"delta":0,"after":0},"quantity_onorder":{"before":0,"delta":0,"after":0},"quantity_faulty":{"before":0,"delta":0,"after":0},"quantity_onreturn":{"before":0,"delta":0,"after":0},"quantity_soh":{"before":0,"delta":0,"after":0},"buy_price_ex":{"before":0,"change":0,"after":0},"direct_costs_ex":{"before":0,"change":0,"after":0},"cogs_ex":{"before":0,"change":0,"after":0},"total_cogs_ex":{"before":0,"change":0,"after":0}}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/returnreasons":{"get":{"tags":["returnreasons"],"summary":"Searches Return Reasons by parameters","description":"Searches Return Reasons by parameters","operationId":"get-returnreasons","parameters":[{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, name, enabled, created_on, modified_on. \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, name, enabled, created_on, modified_on. \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\nAvailable field name values: id, name, enabled, created_on, modified_on.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: name:eq:Cashier Error","schema":{"type":"string","description":"Filter by. \r\nAvailable field name values: id, name, enabled, created_on, modified_on.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: name:eq:Cashier Error","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Return Reasons data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnReason.PagingResponse"},"example":{"data":[{"id":0,"name":"string","enabled":true,"created_on":"string","modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/returnreasons/{id}":{"get":{"tags":["returnreasons"],"summary":"Gets specific Return Reason by unique id","description":"Gets specific Return Reason by unique id","operationId":"get-returnreasons-id","parameters":[{"name":"id","in":"path","description":"Return Reason id","required":true,"schema":{"type":"integer","description":"Return Reason id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Return Reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnReason"},"example":{"id":0,"name":"string","enabled":true,"created_on":"string","modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Return Reason not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/transferitems":{"get":{"tags":["transferitems"],"summary":"Searches Transfer Items by parameters","description":"Searches Transfer Items by parameters","operationId":"get-transferitems","parameters":[{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, transfer_id, product_id, quantity_proposed, quantity_requested, quantity_allocated, quantity_picked, quantity_dispatched, quantity_received, quantity_made_available, buy_price_ex, direct_costs_ex, commited_on, created_on, modified_on\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:eq:2, quantity_proposed:gt:1","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, transfer_id, product_id, quantity_proposed, quantity_requested, quantity_allocated, quantity_picked, quantity_dispatched, quantity_received, quantity_made_available, buy_price_ex, direct_costs_ex, commited_on, created_on, modified_on\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:eq:2, quantity_proposed:gt:1","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, transfer_id, product_id, quantity_proposed, quantity_requested, quantity_allocated, quantity_picked, quantity_dispatched, quantity_received, quantity_made_available, buy_price_ex, direct_costs_ex, commited_on, created_on, modified_on \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc,product_id desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, transfer_id, product_id, quantity_proposed, quantity_requested, quantity_allocated, quantity_picked, quantity_dispatched, quantity_received, quantity_made_available, buy_price_ex, direct_costs_ex, commited_on, created_on, modified_on \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc,product_id desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Transfers Items data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferItem.PagingResponse"},"example":{"data":[{"id":0,"transfer_id":0,"product":{"carton_quantity":"string","cubic":0,"rrp_inc":0,"sell_price_inc":0,"breadth":0,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"id":0,"length":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_sku":"string","supplier_sku2":"string","weight":0,"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"quantity_proposed":0,"quantity_requested":0,"quantity_allocated":0,"quantity_picked":0,"quantity_dispatched":0,"quantity_received":0,"quantity_made_available":0,"buy_price_ex":0,"direct_costs_ex":0,"commited_on":"string","created_on":"string","modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/transfers":{"get":{"tags":["transfers"],"summary":"Searches Transfers","description":"Searches Transfers","operationId":"get-transfers","parameters":[{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, created_on, modified_on, created_by_id, created_by_first_name, created_by_surname, approved_by_id, approved_by_first_name, approved_by_surname, purchase_order_id, order_id, order_number, outlet_from_id, outlet_to_id, status_id, transfer_type_id\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:gte:1,created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, created_on, modified_on, created_by_id, created_by_first_name, created_by_surname, approved_by_id, approved_by_first_name, approved_by_surname, purchase_order_id, order_id, order_number, outlet_from_id, outlet_to_id, status_id, transfer_type_id\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:gte:1,created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, created_on, modified_on, created_by_id, created_by_first_name, created_by_surname, approved_by_id, approved_by_first_name, approved_by_surname, purchase_order_id, order_id, order_number, outlet_from_id, outlet_to_id, status_id, transfer_type_id\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc,order_id desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, created_on, modified_on, created_by_id, created_by_first_name, created_by_surname, approved_by_id, approved_by_first_name, approved_by_surname, purchase_order_id, order_id, order_number, outlet_from_id, outlet_to_id, status_id, transfer_type_id\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc,order_id desc","nullable":true}},{"name":"include_items","in":"query","description":"Include items","schema":{"type":"boolean","description":"Include items"}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response withTransfers data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transfer.PagingResponse"},"example":{"data":[{"id":0,"status":{"id":0,"name":"string"},"transfer_type":{"id":0,"name":"string"},"outlet_from":{"id":0,"name":"string"},"outlet_to":{"id":0,"name":"string"},"notes":"string","approved":true,"approved_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"purchase_order":{"id":0,"status":{"id":0,"name":"string"},"eta":"string","supplier_invoice_number":"string","created_on":"string","modified_on":"string","received_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}},"order":{"id":0,"customer":{"customer_number":"string","email":"string","first_name":"string","id":0,"last_name":"string","custom_reference":"string"},"order_number":"string","original_order_id":0,"created_on":"string","vouchers":[{"id":0,"code":"string","type":{"id":0,"name":"string"},"initial_value":0,"balance":0,"created_on":"string","expires_on":"string"}]},"created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"created_on":"string","modified_on":"string","total_picked_buy_price_ex":0,"total_picked_direct_costs_ex":0,"total_picked_cogs_ex":0,"transfer_items":[{"id":0,"transfer_id":0,"product":{"carton_quantity":"string","cubic":0,"rrp_inc":0,"sell_price_inc":0,"breadth":0,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"id":0,"length":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_sku":"string","supplier_sku2":"string","weight":0,"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"quantity_proposed":0,"quantity_requested":0,"quantity_allocated":0,"quantity_picked":0,"quantity_dispatched":0,"quantity_received":0,"quantity_made_available":0,"buy_price_ex":0,"direct_costs_ex":0,"commited_on":"string","created_on":"string","modified_on":"string"}],"simple_mode":true}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["transfers"],"summary":"Creates Transfer","description":"Sample request:\r\n \r\n POST ​/transfers\r\n {\r\n \"transfer_type\": {\r\n \"id\": 3\r\n },\r\n \"outlet_from\": {\r\n \"id\": 1\r\n },\r\n \"outlet_to\": {\r\n \"id\": 2\r\n },\r\n \"approved\": true,\r\n \"notes\": \"text\",\r\n \"transfer_items\": \r\n [\r\n {\r\n \"product\": {\r\n \"id\" : 124001\r\n },\r\n \"quantity_proposed\": 1\r\n }\r\n ],\r\n \"simple_mode\": true\r\n }","operationId":"post-transfers","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Transfer model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Purchase Order created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transfer"},"example":{"id":0,"status":{"id":0,"name":"string"},"transfer_type":{"id":0,"name":"string"},"outlet_from":{"id":0,"name":"string"},"outlet_to":{"id":0,"name":"string"},"notes":"string","approved":true,"approved_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"purchase_order":{"id":0,"status":{"id":0,"name":"string"},"eta":"string","supplier_invoice_number":"string","created_on":"string","modified_on":"string","received_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}},"order":{"id":0,"customer":{"customer_number":"string","email":"string","first_name":"string","id":0,"last_name":"string","custom_reference":"string"},"order_number":"string","original_order_id":0,"created_on":"string","vouchers":[{"id":0,"code":"string","type":{"id":0,"name":"string"},"initial_value":0,"balance":0,"created_on":"string","expires_on":"string"}]},"created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"created_on":"string","modified_on":"string","total_picked_buy_price_ex":0,"total_picked_direct_costs_ex":0,"total_picked_cogs_ex":0,"transfer_items":[{"id":0,"transfer_id":0,"product":{"carton_quantity":"string","cubic":0,"rrp_inc":0,"sell_price_inc":0,"breadth":0,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"id":0,"length":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_sku":"string","supplier_sku2":"string","weight":0,"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"quantity_proposed":0,"quantity_requested":0,"quantity_allocated":0,"quantity_picked":0,"quantity_dispatched":0,"quantity_received":0,"quantity_made_available":0,"buy_price_ex":0,"direct_costs_ex":0,"commited_on":"string","created_on":"string","modified_on":"string"}],"simple_mode":true}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/transfers/{id}":{"get":{"tags":["transfers"],"summary":"Gets specific Transfer by unique id","description":"Gets specific Transfer by unique id","operationId":"get-transfers-id","parameters":[{"name":"id","in":"path","description":"Transfer id","required":true,"schema":{"type":"integer","description":"Transfer id","format":"int32","example":1}},{"name":"include_items","in":"query","description":"Include items","schema":{"type":"boolean","description":"Include items"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Transfer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transfer"},"example":{"id":0,"status":{"id":0,"name":"string"},"transfer_type":{"id":0,"name":"string"},"outlet_from":{"id":0,"name":"string"},"outlet_to":{"id":0,"name":"string"},"notes":"string","approved":true,"approved_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"purchase_order":{"id":0,"status":{"id":0,"name":"string"},"eta":"string","supplier_invoice_number":"string","created_on":"string","modified_on":"string","received_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}},"order":{"id":0,"customer":{"customer_number":"string","email":"string","first_name":"string","id":0,"last_name":"string","custom_reference":"string"},"order_number":"string","original_order_id":0,"created_on":"string","vouchers":[{"id":0,"code":"string","type":{"id":0,"name":"string"},"initial_value":0,"balance":0,"created_on":"string","expires_on":"string"}]},"created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"created_on":"string","modified_on":"string","total_picked_buy_price_ex":0,"total_picked_direct_costs_ex":0,"total_picked_cogs_ex":0,"transfer_items":[{"id":0,"transfer_id":0,"product":{"carton_quantity":"string","cubic":0,"rrp_inc":0,"sell_price_inc":0,"breadth":0,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"id":0,"length":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_sku":"string","supplier_sku2":"string","weight":0,"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"quantity_proposed":0,"quantity_requested":0,"quantity_allocated":0,"quantity_picked":0,"quantity_dispatched":0,"quantity_received":0,"quantity_made_available":0,"buy_price_ex":0,"direct_costs_ex":0,"commited_on":"string","created_on":"string","modified_on":"string"}],"simple_mode":true}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Transfer not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/transfers/{id}/transferitems":{"get":{"tags":["transfers"],"summary":"Searches Transfer Items by parameters","description":"Searches Transfer Items by parameters","operationId":"get-transfers-id-transferitems","parameters":[{"name":"id","in":"path","description":"Transfer id","required":true,"schema":{"type":"integer","description":"Transfer id","format":"int32"}},{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, product_id, quantity_proposed, quantity_requested, quantity_allocated, quantity_picked, quantity_dispatched, quantity_received, quantity_made_available, buy_price_ex, direct_costs_ex, commited_on, created_on, modified_on\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:eq:2, quantity_proposed:gt:1","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, product_id, quantity_proposed, quantity_requested, quantity_allocated, quantity_picked, quantity_dispatched, quantity_received, quantity_made_available, buy_price_ex, direct_costs_ex, commited_on, created_on, modified_on\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: id:eq:2, quantity_proposed:gt:1","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, product_id, quantity_proposed, quantity_requested, quantity_allocated, quantity_picked, quantity_dispatched, quantity_received, quantity_made_available, buy_price_ex, direct_costs_ex, commited_on, created_on, modified_on \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc,product_id desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, product_id, quantity_proposed, quantity_requested, quantity_allocated, quantity_picked, quantity_dispatched, quantity_received, quantity_made_available, buy_price_ex, direct_costs_ex, commited_on, created_on, modified_on \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc,product_id desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Transfers Items data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferItem.PagingResponse"},"example":{"data":[{"id":0,"transfer_id":0,"product":{"carton_quantity":"string","cubic":0,"rrp_inc":0,"sell_price_inc":0,"breadth":0,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"id":0,"length":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_sku":"string","supplier_sku2":"string","weight":0,"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"quantity_proposed":0,"quantity_requested":0,"quantity_allocated":0,"quantity_picked":0,"quantity_dispatched":0,"quantity_received":0,"quantity_made_available":0,"buy_price_ex":0,"direct_costs_ex":0,"commited_on":"string","created_on":"string","modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["transfers"],"summary":"Creates Transfer Item","description":"Sample request:\r\n\r\n POST /transfers/1/transferitems\r\n {\r\n \"product\": {\r\n \"id\" : 124001\r\n },\r\n \"quantity_proposed\": 1\r\n }","operationId":"post-transfers-id-transferitems","parameters":[{"name":"id","in":"path","description":"Transfer Id","required":true,"schema":{"type":"integer","description":"Transfer Id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Transfer Item to be created","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Transfer Item was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferItem"},"example":{"id":0,"transfer_id":0,"product":{"carton_quantity":"string","cubic":0,"rrp_inc":0,"sell_price_inc":0,"breadth":0,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"id":0,"length":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_sku":"string","supplier_sku2":"string","weight":0,"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"quantity_proposed":0,"quantity_requested":0,"quantity_allocated":0,"quantity_picked":0,"quantity_dispatched":0,"quantity_received":0,"quantity_made_available":0,"buy_price_ex":0,"direct_costs_ex":0,"commited_on":"string","created_on":"string","modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/transfers/{id}/transferitems/{item_id}":{"get":{"tags":["transfers"],"summary":"Gets specific Transfer Item by unique id","description":"Gets specific Transfer Item by unique id","operationId":"get-transfers-id-transferitems-item_id","parameters":[{"name":"id","in":"path","description":"Transfer id","required":true,"schema":{"type":"integer","description":"Transfer id","format":"int32"}},{"name":"item_id","in":"path","description":"Transfer Item id","required":true,"schema":{"type":"integer","description":"Transfer Item id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Transfer Item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transfer"},"example":{"id":0,"status":{"id":0,"name":"string"},"transfer_type":{"id":0,"name":"string"},"outlet_from":{"id":0,"name":"string"},"outlet_to":{"id":0,"name":"string"},"notes":"string","approved":true,"approved_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"purchase_order":{"id":0,"status":{"id":0,"name":"string"},"eta":"string","supplier_invoice_number":"string","created_on":"string","modified_on":"string","received_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}},"order":{"id":0,"customer":{"customer_number":"string","email":"string","first_name":"string","id":0,"last_name":"string","custom_reference":"string"},"order_number":"string","original_order_id":0,"created_on":"string","vouchers":[{"id":0,"code":"string","type":{"id":0,"name":"string"},"initial_value":0,"balance":0,"created_on":"string","expires_on":"string"}]},"created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"created_on":"string","modified_on":"string","total_picked_buy_price_ex":0,"total_picked_direct_costs_ex":0,"total_picked_cogs_ex":0,"transfer_items":[{"id":0,"transfer_id":0,"product":{"carton_quantity":"string","cubic":0,"rrp_inc":0,"sell_price_inc":0,"breadth":0,"custom_properties":[{"name":"string","value":"string"}],"depth":0,"id":0,"length":0,"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier":{"id":0,"supplier_code":"string","name":"string","is_enabled":true,"modified_on":"string"},"supplier_sku":"string","supplier_sku2":"string","weight":0,"attributes":[{"id":0,"name":"string","type":"string","modified_on":"string","value":{"id":0,"name":"string","list_order":0}}],"sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","external_links":[{"id":0,"name":"string","url":"string"}],"fixed_price_groups":[{"id":0,"name":"string","sell_price_inc":0,"modified_on":"string"}],"price_groups":[{"id":0,"name":"string","sell_price_inc":0,"web_price_inc":0,"modified_on":"string"}]},"quantity_proposed":0,"quantity_requested":0,"quantity_allocated":0,"quantity_picked":0,"quantity_dispatched":0,"quantity_received":0,"quantity_made_available":0,"buy_price_ex":0,"direct_costs_ex":0,"commited_on":"string","created_on":"string","modified_on":"string"}],"simple_mode":true}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Transfer Item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/transferstatus":{"get":{"tags":["transferstatus"],"summary":"Searches Transfer Statuses by parameters","description":"Searches Transfer Statuses by parameters","operationId":"get-transferstatus","parameters":[{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Transfer Statuses","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferStatus.PagingResponse"},"example":{"data":[{"id":0,"name":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/transferstatus/{id}":{"get":{"tags":["transferstatus"],"summary":"Gets specific Transfer Status by unique id","description":"Gets specific Transfer Status by unique id","operationId":"get-transferstatus-id","parameters":[{"name":"id","in":"path","description":"Transfer Status id","required":true,"schema":{"type":"integer","description":"Transfer Status id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Transfer Status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferStatus"},"example":{"id":0,"name":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Transfer Status not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/transfertypes":{"get":{"tags":["transfertypes"],"summary":"Searches Transfer Types by parameters","description":"Searches Transfer Types by parameters","operationId":"get-transfertypes","parameters":[{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Transfer Types","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferType.PagingResponse"},"example":{"data":[{"id":0,"name":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/transfertypes/{id}":{"get":{"tags":["transfertypes"],"summary":"Gets specific Transfer Type by unique id","description":"Gets specific Transfer Type by unique id","operationId":"get-transfertypes-id","parameters":[{"name":"id","in":"path","description":"Transfer Type id","required":true,"schema":{"type":"integer","description":"Transfer Type id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Transfer Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferType"},"example":{"id":0,"name":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Transfer Type not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/users":{"get":{"tags":["users"],"summary":"Searches Users by parameters","description":"Searches Users by parameters","operationId":"get-users","parameters":[{"name":"id","in":"query","description":"User Id. Other properties are ignored, if used.","schema":{"type":"integer","description":"User Id. Other properties are ignored, if used.","format":"int32","nullable":true}},{"name":"user_code","in":"query","description":"User code.","schema":{"type":"string","description":"User code.","nullable":true}},{"name":"first_name","in":"query","description":"First name.","schema":{"type":"string","description":"First name.","nullable":true}},{"name":"surname","in":"query","description":"Surname.","schema":{"type":"string","description":"Surname.","nullable":true}},{"name":"enabled","in":"query","description":"Enabled.","schema":{"type":"boolean","description":"Enabled.","nullable":true}},{"name":"is_admin","in":"query","description":"Is admin?","schema":{"type":"boolean","description":"Is admin?","nullable":true}},{"name":"select","in":"query","description":"Select fields.\r\n\r\nAvailable field name values: id, user_code, first_name, surname, enabled, is_system, is_admin\r\n\r\nExample: id, user_code, is_system","schema":{"type":"string","description":"Select fields.\r\n\r\nAvailable field name values: id, user_code, first_name, surname, enabled, is_system, is_admin\r\n\r\nExample: id, user_code, is_system","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, user_code, first_name, surname, security_profile, modified_on, is_admin. \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, user_code desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, user_code, first_name, surname, security_profile, modified_on, is_admin. \r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, user_code desc","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\nAvailable field name values: id, user_code, first_name, surname, security_profile, modified_on, is_admin.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: first_name:eq:alex,is_admin:eq:true","schema":{"type":"string","description":"Filter by. \r\nAvailable field name values: id, user_code, first_name, surname, security_profile, modified_on, is_admin.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: first_name:eq:alex,is_admin:eq:true","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Users data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User.PagingResponse"},"example":{"data":[{"id":0,"user_code":"string","first_name":"string","surname":"string","security_profile":{"id":0,"name":"string"},"is_admin":true,"enabled":true,"modified_on":"string","outlets":[{"id":0,"name":"string"}],"stock_outlets":[{"id":0,"name":"string"}]}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/users/{id}":{"get":{"tags":["users"],"summary":"Gets specific User by unique id","description":"Gets specific User by unique id","operationId":"get-users-id","parameters":[{"name":"id","in":"path","description":"User id","required":true,"schema":{"type":"integer","description":"User id","format":"int32","example":10000}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":{"id":0,"user_code":"string","first_name":"string","surname":"string","security_profile":{"id":0,"name":"string"},"is_admin":true,"enabled":true,"modified_on":"string","outlets":[{"id":0,"name":"string"}],"stock_outlets":[{"id":0,"name":"string"}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"User not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/customers/{id}/loyaltyhistory":{"get":{"tags":["customers"],"summary":"Searches Loyalty History by Customer id and other parameters","description":"Searches Loyalty History by Customer id and other parameters","operationId":"get-customers-id-loyaltyhistory","parameters":[{"name":"id","in":"path","description":"Customer id","required":true,"schema":{"type":"integer","description":"Customer id","format":"int32"}},{"name":"filter_by","in":"query","description":"Filter by. \r\nAvailable field name values: created_on, order_id, order_number, product_id, supplier_sku, adjustment_reason_id, loyalty_points_delta, loyalty_points_available, ratio.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: order_id:eq:1, supplier_sku:eq:test","schema":{"type":"string","description":"Filter by. \r\nAvailable field name values: created_on, order_id, order_number, product_id, supplier_sku, adjustment_reason_id, loyalty_points_delta, loyalty_points_available, ratio.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: order_id:eq:1, supplier_sku:eq:test","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, created_on, order_id, product_id, adjustment_reason, loyalty_points_delta.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, created_on, order_id, product_id, adjustment_reason, loyalty_points_delta.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Loyalty History data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerLoyaltyHistory.PagingResponse"},"example":{"data":[{"id":0,"created_on":"string","order_item":{"id":0,"external_id":"string","order_item_type":"string","product":{"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier_sku":"string","supplier_sku2":"string","sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","id":0},"original_price":0,"sell_price":0,"order_item_total":0,"order_item_discount_total":0,"taxable":true,"tax_rate":0,"supplier_buy_ex":0,"direct_costs_ex":0,"cogs_ex":0,"fulfilment_method":"string","due_date":"string","delivery_driver":{"id":0,"name":"string"},"delivery_zone":{"id":0,"name":"string"},"delivery_time":{"id":0,"name":"string"},"quantity_ordered":0,"quantity_fulfiled":0,"notes":"string","original_order_item_id":0,"return_reason":{"id":0,"name":"string"},"fulfil_outlet":{"id":0,"name":"string","modified_on":"string"},"source_outlet":{"id":0,"name":"string","modified_on":"string"},"applied_promotional_campaigns":[{"id":0,"name":"string"}],"created_on":"string","modified_on":"string","linked_purchase_order":{"id":0,"status":{"id":0,"name":"string"},"eta":"string","supplier_invoice_number":"string","created_on":"string","modified_on":"string","received_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}},"serial_number":"string","order_id":0,"order_number":"string"},"adjustment_reason":{"id":0,"name":"string","is_system":true,"is_deleted":true},"loyalty_points_delta":0,"loyalty_points_available":0,"ratio":0}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/customers/{id}/loyaltyhistory/{loyalty_history_id}":{"get":{"tags":["customers"],"summary":"Gets specific Loyalty History by unique Customer id and Loyalty History id","description":"Gets specific Loyalty History by unique Customer id and Loyalty History id","operationId":"get-customers-id-loyaltyhistory-loyalty_history_id","parameters":[{"name":"id","in":"path","description":"Customer id","required":true,"schema":{"type":"integer","description":"Customer id","format":"int32"}},{"name":"loyalty_history_id","in":"path","description":"Loyalty History id","required":true,"schema":{"type":"integer","description":"Loyalty History id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a Loyalty History","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerLoyaltyHistory"},"example":{"id":0,"created_on":"string","order_item":{"id":0,"external_id":"string","order_item_type":"string","product":{"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier_sku":"string","supplier_sku2":"string","sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","id":0},"original_price":0,"sell_price":0,"order_item_total":0,"order_item_discount_total":0,"taxable":true,"tax_rate":0,"supplier_buy_ex":0,"direct_costs_ex":0,"cogs_ex":0,"fulfilment_method":"string","due_date":"string","delivery_driver":{"id":0,"name":"string"},"delivery_zone":{"id":0,"name":"string"},"delivery_time":{"id":0,"name":"string"},"quantity_ordered":0,"quantity_fulfiled":0,"notes":"string","original_order_item_id":0,"return_reason":{"id":0,"name":"string"},"fulfil_outlet":{"id":0,"name":"string","modified_on":"string"},"source_outlet":{"id":0,"name":"string","modified_on":"string"},"applied_promotional_campaigns":[{"id":0,"name":"string"}],"created_on":"string","modified_on":"string","linked_purchase_order":{"id":0,"status":{"id":0,"name":"string"},"eta":"string","supplier_invoice_number":"string","created_on":"string","modified_on":"string","received_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}},"serial_number":"string","order_id":0,"order_number":"string"},"adjustment_reason":{"id":0,"name":"string","is_system":true,"is_deleted":true},"loyalty_points_delta":0,"loyalty_points_available":0,"ratio":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/loyaltyadjustmentreasons":{"get":{"tags":["loyaltyadjustmentreasons"],"summary":"Searches Loyalty Adjustment Reasons by parameters","description":"Searches Loyalty Adjustment Reasons by parameters","operationId":"get-loyaltyadjustmentreasons","parameters":[{"name":"filter_by","in":"query","description":"Filter by. \r\nAvailable field name values: id, name, is_system, is_deleted\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: name:eq:reason name, is_system:eq:true","schema":{"type":"string","description":"Filter by. \r\nAvailable field name values: id, name, is_system, is_deleted\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: name:eq:reason name, is_system:eq:true","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, name, is_system, is_deleted\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, name, is_system, is_deleted\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Loyalty Adjustment Reasons data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoyaltyAdjustmentReason.PagingResponse"},"example":{"data":[{"id":0,"name":"string","is_system":true,"is_deleted":true}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"post":{"tags":["loyaltyadjustmentreasons"],"summary":"Creates Loyalty Adjustment Reason","description":"Sample request:\r\n\r\n POST /loyaltyadjustmentreasons\r\n {\r\n \"name\": \"Loyalty Adjustment Reason Name\"\r\n }","operationId":"post-loyaltyadjustmentreasons","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Loyalty Adjustment Reason model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Loyalty Adjustment Reason created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoyaltyAdjustmentReason"},"example":{"id":0,"name":"string","is_system":true,"is_deleted":true}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/loyaltyadjustmentreasons/{id}":{"get":{"tags":["loyaltyadjustmentreasons"],"summary":"Gets specific Loyalty Adjustment Reason by unique id","description":"Gets specific Loyalty Adjustment Reason by unique id","operationId":"get-loyaltyadjustmentreasons-id","parameters":[{"name":"id","in":"path","description":"Loyalty Adjustment Reason id","required":true,"schema":{"type":"integer","description":"Loyalty Adjustment Reason id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Loyalty Adjustment Reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoyaltyAdjustmentReason"},"example":{"id":0,"name":"string","is_system":true,"is_deleted":true}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Loyalty Adjustment Reason not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["loyaltyadjustmentreasons"],"summary":"Updates Loyalty Adjustment Reason","description":"Sample request:\r\n\r\n PUT /loyaltyadjustmentreasons/12\r\n {\r\n \"name\": \"Updated Loyalty Adjustment Reason name\",\r\n \"is_deleted\": false\r\n }","operationId":"put-loyaltyadjustmentreasons-id","parameters":[{"name":"id","in":"path","description":"Loyalty Adjustment Reason id","required":true,"schema":{"type":"integer","description":"Loyalty Adjustment Reason id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Loyalty Adjustment Reason model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Returns updated Loyalty Adjustment Reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoyaltyAdjustmentReason"},"example":{"id":0,"name":"string","is_system":true,"is_deleted":true}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Loyalty Adjustment Reason not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["loyaltyadjustmentreasons"],"summary":"Deletes Loyalty Adjustment Reason by id","description":"Deletes Loyalty Adjustment Reason by id","operationId":"delete-loyaltyadjustmentreasons-id","parameters":[{"name":"id","in":"path","description":"Loyalty Adjustment Reason id","required":true,"schema":{"type":"integer","description":"Loyalty Adjustment Reason id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Loyalty Adjustment Reason deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Loyalty Adjustment Reason not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/loyaltyadjustments":{"post":{"tags":["loyaltyadjustments"],"summary":"Creates Loyalty Adjustment","description":"Sample request:\r\n\r\n POST /loyaltyadjustments\r\n {\r\n \"customer_id\": 100001,\r\n \"customer_number\": \"100001\",\r\n \"loyalty_points_delta\": 50,\r\n \"adjustment_reason\": {\r\n \"id\": 1\r\n }\r\n }","operationId":"post-loyaltyadjustments","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Loyalty Adjustment created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerLoyaltyHistory"},"example":{"id":0,"created_on":"string","order_item":{"id":0,"external_id":"string","order_item_type":"string","product":{"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier_sku":"string","supplier_sku2":"string","sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","id":0},"original_price":0,"sell_price":0,"order_item_total":0,"order_item_discount_total":0,"taxable":true,"tax_rate":0,"supplier_buy_ex":0,"direct_costs_ex":0,"cogs_ex":0,"fulfilment_method":"string","due_date":"string","delivery_driver":{"id":0,"name":"string"},"delivery_zone":{"id":0,"name":"string"},"delivery_time":{"id":0,"name":"string"},"quantity_ordered":0,"quantity_fulfiled":0,"notes":"string","original_order_item_id":0,"return_reason":{"id":0,"name":"string"},"fulfil_outlet":{"id":0,"name":"string","modified_on":"string"},"source_outlet":{"id":0,"name":"string","modified_on":"string"},"applied_promotional_campaigns":[{"id":0,"name":"string"}],"created_on":"string","modified_on":"string","linked_purchase_order":{"id":0,"status":{"id":0,"name":"string"},"eta":"string","supplier_invoice_number":"string","created_on":"string","modified_on":"string","received_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}},"serial_number":"string","order_id":0,"order_number":"string"},"adjustment_reason":{"id":0,"name":"string","is_system":true,"is_deleted":true},"loyalty_points_delta":0,"loyalty_points_available":0,"ratio":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/pricegroups/fixed/{id}":{"put":{"tags":["pricegroups"],"summary":"Updates specific Fixed Price Group by id","description":"Sample request:\r\n\r\n PUT /pricegroups/fixed/1\r\n {\r\n \"name\": \"Renamed fixed price group\"\r\n }","operationId":"put-pricegroups-fixed-id","parameters":[{"name":"id","in":"path","description":"Fixed Price Group id","required":true,"schema":{"type":"integer","description":"Fixed Price Group id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Fixed Price Group model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Fixed Price Group was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FixedPriceGroup"},"example":{"id":0,"name":"string","modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["pricegroups"],"summary":"Deletes specific Fixed Price Group by id","description":"Deletes specific Fixed Price Group by id","operationId":"delete-pricegroups-fixed-id","parameters":[{"name":"id","in":"path","description":"Fixed Price Group id","required":true,"schema":{"type":"integer","description":"Fixed Price Group id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Fixed Price Group was deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/stockadjustmentreasons":{"post":{"tags":["stockadjustmentreasons"],"summary":"Creates Stock Adjustment Reason","description":"Sample request:\r\n\r\n POST /stockadjustmentreasons\r\n {\r\n \"name\": \"Stock Adjustment Reason Name\",\r\n \"disabled\": true\r\n }","operationId":"post-stockadjustmentreasons","parameters":[{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Stock Adjustment Reason model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Stock Adjustment Reason created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockAdjustmentReason"},"example":{"id":0,"name":"string","disabled":true,"created_on":"string","modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"get":{"tags":["stockadjustmentreasons"],"summary":"Searches Stock Adjustment Reasons by parameters","description":"Searches Stock Adjustment Reasons by parameters","operationId":"get-stockadjustmentreasons","parameters":[{"name":"filter_by","in":"query","description":"Filter by. \r\nAvailable field name values: id, name, created_on, modified_on, disabled\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,disabled:eq:true","schema":{"type":"string","description":"Filter by. \r\nAvailable field name values: id, name, created_on, modified_on, disabled\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,disabled:eq:true","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, name, created_on, modified_on, disabled\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, name, created_on, modified_on, disabled\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Stock Adjustment Reasons data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockAdjustmentReason.PagingResponse"},"example":{"data":[{"id":0,"name":"string","disabled":true,"created_on":"string","modified_on":"string"}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/stockadjustmentreasons/{id}":{"put":{"tags":["stockadjustmentreasons"],"summary":"Updates Stock Adjustment Reason","description":"Sample request:\r\n\r\n PUT /stockadjustmentreasons/12\r\n {\r\n \"name\": \"Updated Stock Adjustment Reason name\",\r\n \"disabled\": true\r\n }","operationId":"put-stockadjustmentreasons-id","parameters":[{"name":"id","in":"path","description":"Stock Adjustment Reason id","required":true,"schema":{"type":"integer","description":"Stock Adjustment Reason id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Stock Adjustment Reason model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Returns updated Stock Adjustment Reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockAdjustmentReason"},"example":{"id":0,"name":"string","disabled":true,"created_on":"string","modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Stock Adjustment Reason not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["stockadjustmentreasons"],"summary":"Deletes Stock Adjustment Reason by id when not used in any stock adjustment","description":"Deletes Stock Adjustment Reason by id when not used in any stock adjustment","operationId":"delete-stockadjustmentreasons-id","parameters":[{"name":"id","in":"path","description":"Stock Adjustment Reason id","required":true,"schema":{"type":"integer","description":"Stock Adjustment Reason id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Stock Adjustment Reason deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Stock Adjustment Reason not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"get":{"tags":["stockadjustmentreasons"],"summary":"Gets specific Stock Adjustment Reason by unique id","description":"Gets specific Stock Adjustment Reason by unique id","operationId":"get-stockadjustmentreasons-id","parameters":[{"name":"id","in":"path","description":"Stock Adjustment Reason id","required":true,"schema":{"type":"integer","description":"Stock Adjustment Reason id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Stock Adjustment Reason","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockAdjustmentReason"},"example":{"id":0,"name":"string","disabled":true,"created_on":"string","modified_on":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Stock Adjustment Reason not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/productdetailslog":{"get":{"tags":["productdetailslog"],"summary":"Searches Product Details Logs","description":"Searches Product Details Logs","operationId":"get-productdetailslog","parameters":[{"name":"plu","in":"query","description":"Product Look-Up code (PLU) It can be Product Id, Supplier SKU, Manufacturer SKU, Supplier SKU 2 or any Barcodes for a product. If specified, product_id, product_supplier_sku, product_short_description, product_created_on filters are ignored.","schema":{"type":"string","description":"Product Look-Up code (PLU) It can be Product Id, Supplier SKU, Manufacturer SKU, Supplier SKU 2 or any Barcodes for a product. If specified, product_id, product_supplier_sku, product_short_description, product_created_on filters are ignored.","nullable":true}},{"name":"movement_types","in":"query","description":"Movement Type or Collection of Movement Types (comma separated).\r\nExample: Product Initialisation,Product Details Edited","schema":{"type":"string","description":"Movement Type or Collection of Movement Types (comma separated).\r\nExample: Product Initialisation,Product Details Edited","nullable":true}},{"name":"filter_by","in":"query","description":"Filter by. \r\n\r\nAvailable field name values: id, created_on, product_id, product_supplier_sku, product_short_description, product_created_on, origin, supplier_buy_ex_before, supplier_buy_ex_change, supplier_buy_ex_after, buy_price_ex_before, buy_price_ex_change, buy_price_ex_after, direct_costs_ex_before, direct_costs_ex_change, direct_costs_ex_after, sell_price_inc_before, sell_price_inc_change, sell_price_inc_after, discount_price_before, discount_price_change, discount_price_after, rrp_inc_before, rrp_inc_change, rrp_inc_after, web_price_inc_before, web_price_inc_change, web_price_inc_after, product_type_before, product_type_after, disabled_before, disabled_after.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,product_id:in:124001|124002","schema":{"type":"string","description":"Filter by. \r\n\r\nAvailable field name values: id, created_on, product_id, product_supplier_sku, product_short_description, product_created_on, origin, supplier_buy_ex_before, supplier_buy_ex_change, supplier_buy_ex_after, buy_price_ex_before, buy_price_ex_change, buy_price_ex_after, direct_costs_ex_before, direct_costs_ex_change, direct_costs_ex_after, sell_price_inc_before, sell_price_inc_change, sell_price_inc_after, discount_price_before, discount_price_change, discount_price_after, rrp_inc_before, rrp_inc_change, rrp_inc_after, web_price_inc_before, web_price_inc_change, web_price_inc_after, product_type_before, product_type_after, disabled_before, disabled_after.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable\r\n \r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: created_on:gte:2021-06-03T05:48:09+10:00,product_id:in:124001|124002","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, created_on, product_id, product_supplier_sku, product_short_description, product_created_on, movement_type, origin, supplier_buy_ex_before, supplier_buy_ex_change, supplier_buy_ex_after, buy_price_ex_before, buy_price_ex_change, buy_price_ex_after, direct_costs_ex_before, direct_costs_ex_change, direct_costs_ex_after, sell_price_inc_before, sell_price_inc_change, sell_price_inc_after, discount_price_before, discount_price_change, discount_price_after, rrp_inc_before, rrp_inc_change, rrp_inc_after, web_price_inc_before, web_price_inc_change, web_price_inc_after, product_type_before, product_type_after, disabled_before, disabled_after.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, created_on desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, created_on, product_id, product_supplier_sku, product_short_description, product_created_on, movement_type, origin, supplier_buy_ex_before, supplier_buy_ex_change, supplier_buy_ex_after, buy_price_ex_before, buy_price_ex_change, buy_price_ex_after, direct_costs_ex_before, direct_costs_ex_change, direct_costs_ex_after, sell_price_inc_before, sell_price_inc_change, sell_price_inc_after, discount_price_before, discount_price_change, discount_price_after, rrp_inc_before, rrp_inc_change, rrp_inc_after, web_price_inc_before, web_price_inc_change, web_price_inc_after, product_type_before, product_type_after, disabled_before, disabled_after.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, created_on desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Paging Response with Product Details Logs data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDetailLog.PagingResponse"},"example":{"data":[{"id":0,"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"product":{"id":0,"supplier_sku":"string","short_description":"string","created_on":"string"},"movement_type":"string","origin":"string","supplier_buy_ex":{"before":0,"change":0,"after":0},"buy_price_ex":{"before":0,"change":0,"after":0},"direct_costs_ex":{"before":0,"change":0,"after":0},"sell_price_inc":{"before":0,"change":0,"after":0},"discount_price":{"before":0,"change":0,"after":0},"rrp_inc":{"before":0,"change":0,"after":0},"web_price_inc":{"before":0,"change":0,"after":0},"product_type":{"before":"string","after":"string"},"disabled":{"before":true,"after":true}}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/productdetailslog/{id}":{"get":{"tags":["productdetailslog"],"summary":"Gets specific Product Details Log by unique id","description":"Gets specific Product Details Log by unique id","operationId":"get-productdetailslog-id","parameters":[{"name":"id","in":"path","description":"Product Details Log id","required":true,"schema":{"type":"integer","description":"Product Details Log id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns found Product Details Log","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDetailLog"},"example":{"id":0,"created_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"product":{"id":0,"supplier_sku":"string","short_description":"string","created_on":"string"},"movement_type":"string","origin":"string","supplier_buy_ex":{"before":0,"change":0,"after":0},"buy_price_ex":{"before":0,"change":0,"after":0},"direct_costs_ex":{"before":0,"change":0,"after":0},"sell_price_inc":{"before":0,"change":0,"after":0},"discount_price":{"before":0,"change":0,"after":0},"rrp_inc":{"before":0,"change":0,"after":0},"web_price_inc":{"before":0,"change":0,"after":0},"product_type":{"before":"string","after":"string"},"disabled":{"before":true,"after":true}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Product Details Log not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/purchaseorderreceipts/{id}/discount":{"post":{"tags":["purchaseorderreceipts"],"summary":"Applies a discount during Purchase Order Receipt","description":"Sample request:\r\n \r\n POST /purchaseorderreceipts/1/discount\r\n {\r\n \"discount_amount_type\": \"Amount\",\r\n \"distribute_by\": \"Value\",\r\n \"discount_amount\": 1.1,\r\n \"purchase_order_receipt_item_ids\": [1, 2]\r\n }","operationId":"post-purchaseorderreceipts-id-discount","parameters":[{"name":"id","in":"path","description":"Purchase Order Receipt id","required":true,"schema":{"type":"integer","description":"Purchase Order Receipt id","format":"int32","example":1}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Purchase Order Receipt discount model","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/loyaltyhistory":{"get":{"tags":["loyaltyhistory"],"summary":"Searches Loyalty History","description":"Searches Loyalty History","operationId":"get-loyaltyhistory","parameters":[{"name":"filter_by","in":"query","description":"Filter by. \r\nAvailable field name values: created_on, order_id, order_number, product_id, supplier_sku, adjustment_reason_id, loyalty_points_delta, loyalty_points_available, ratio.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: order_id:eq:1, supplier_sku:eq:test","schema":{"type":"string","description":"Filter by. \r\nAvailable field name values: created_on, order_id, order_number, product_id, supplier_sku, adjustment_reason_id, loyalty_points_delta, loyalty_points_available, ratio.\r\n \r\nIn string values: '|' and ',' characters have to be escaped with slash, i.e. '\\\\,' '\\\\|'\r\n \r\nFor operators that support multiple values (in, notin): multiple values are delimited using '|' character\r\n\r\nAvailable operators:\r\n\r\neq - Equal\r\n\r\nneq - Not equals\r\n\r\nlt - Less\r\n\r\nlte - Less or equal\r\n\r\ngt - Greater\r\n\r\ngte - Greater or equal\r\n\r\nin - In\r\n\r\nnotin - Not In\r\n \r\ncontains - Contains\r\n\r\nisnull - Is Null\r\n \r\nisnullorempty - Is Null Or Empty\r\n\r\nisnotnull - Is Not Null\r\n\r\nstartswith - Starts with\r\n\r\nendswith - Ends with\r\n\r\ndoesnotcontain - Does not contain\r\n \r\nFor non-nullable fields operators isnull and isnotnull are unavailable\r\n\r\nFor strings operators: lt, lte, gt, gte are unavailable\r\n \r\nExample: order_id:eq:1, supplier_sku:eq:test","nullable":true}},{"name":"order_by","in":"query","description":"Order by. \r\n\r\nAvailable field name values: id, created_on, order_id, product_id, adjustment_reason, loyalty_points_delta.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","schema":{"type":"string","description":"Order by. \r\n\r\nAvailable field name values: id, created_on, order_id, product_id, adjustment_reason, loyalty_points_delta.\r\n\r\nAvailable direction values: asc, desc. \r\n\r\nExample: id asc, name desc","nullable":true}},{"name":"page_number","in":"query","schema":{"maximum":100000,"minimum":1,"type":"integer","format":"int32"}},{"name":"page_size","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns Loyalty History data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoyaltyHistory.PagingResponse"},"example":{"data":[{"id":0,"created_on":"string","order_item":{"id":0,"external_id":"string","order_item_type":"string","product":{"manufacturer_sku":"string","product_type":{"id":0,"name":"string","modified_on":"string"},"short_description":"string","supplier_sku":"string","supplier_sku2":"string","sales_channels":[{"id":0,"name":"string","shopify_channel":true,"source_group":{"id":0,"name":"string"},"enabled":true}],"export_to_web":true,"package":true,"has_package_products":true,"last_sold_on":"string","require_serial_number":0,"last_fulfiled_on":"string","id":0},"original_price":0,"sell_price":0,"order_item_total":0,"order_item_discount_total":0,"taxable":true,"tax_rate":0,"supplier_buy_ex":0,"direct_costs_ex":0,"cogs_ex":0,"fulfilment_method":"string","due_date":"string","delivery_driver":{"id":0,"name":"string"},"delivery_zone":{"id":0,"name":"string"},"delivery_time":{"id":0,"name":"string"},"quantity_ordered":0,"quantity_fulfiled":0,"notes":"string","original_order_item_id":0,"return_reason":{"id":0,"name":"string"},"fulfil_outlet":{"id":0,"name":"string","modified_on":"string"},"source_outlet":{"id":0,"name":"string","modified_on":"string"},"applied_promotional_campaigns":[{"id":0,"name":"string"}],"created_on":"string","modified_on":"string","linked_purchase_order":{"id":0,"status":{"id":0,"name":"string"},"eta":"string","supplier_invoice_number":"string","created_on":"string","modified_on":"string","received_on":"string","created_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"},"modified_by":{"id":0,"user_code":"string","first_name":"string","surname":"string"}},"serial_number":"string","order_id":0,"order_number":"string"},"adjustment_reason":{"id":0,"name":"string","is_system":true,"is_deleted":true},"loyalty_points_delta":0,"loyalty_points_available":0,"ratio":0,"order_number":"string","customer_id":0}],"page_number":0,"page_size":0,"total_records":0}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/products/{id}/suppliers":{"post":{"tags":["products"],"summary":"Creates product suppliers for a specific product","description":"Sample request:\r\n \r\n POST /products/123/suppliers\r\n [\r\n {\r\n \"supplier_code\": \"00\",\r\n \"supplier_buy_ex\": 1.1,\r\n \"supplier_sku2\": \"SupplierSKU2\",\r\n \"lead_time\": 4,\r\n \"is_default\": true,\r\n \"notes\": \"This is a Note.\"\r\n }\r\n ]","operationId":"post-products-id-suppliers","parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"schema":{"type":"integer","description":"Product ID","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"List of product suppliers to create","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"201":{"description":"Product suppliers created successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProductSupplier"}},"example":[{"product_id":0,"supplier_code":"string","supplier_name":"string","supplier_status":true,"supplier_buy_ex":0,"supplier_sku2":"string","lead_time":0,"is_default":true,"notes":"string","is_deleted":true}]}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Product not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"get":{"tags":["products"],"summary":"Gets all suppliers for a specific product","description":"Gets all suppliers for a specific product","operationId":"get-products-id-suppliers","parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"schema":{"type":"integer","description":"Product ID","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Product suppliers retrieved successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProductSupplier"}},"example":[{"product_id":0,"supplier_code":"string","supplier_name":"string","supplier_status":true,"supplier_buy_ex":0,"supplier_sku2":"string","lead_time":0,"is_default":true,"notes":"string","is_deleted":true}]}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["products"],"summary":"Deletes all Product Supplier by product id","description":"Deletes all Product Supplier by product id","operationId":"delete-products-id-suppliers","parameters":[{"name":"id","in":"path","description":"Product id","required":true,"schema":{"type":"integer","description":"Product id","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Product Supplier's were deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["products"],"summary":"Bulk updates product suppliers for a specific product","description":"Sample request:\r\n \r\n PUT /products/123/suppliers\r\n [\r\n {\r\n \"supplier_code\": \"00\",\r\n \"supplier_buy_ex\": 1.1,\r\n \"supplier_sku2\": \"SupplierSKU2\",\r\n \"lead_time\": 4,\r\n \"is_default\": true,\r\n \"notes\": \"This is a Note.\"\r\n }\r\n ]","operationId":"put-products-id-suppliers","parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"schema":{"type":"integer","description":"Product ID","format":"int32"}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"List of product suppliers to update","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Product suppliers updated successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProductSupplier"}},"example":[{"product_id":0,"supplier_code":"string","supplier_name":"string","supplier_status":true,"supplier_buy_ex":0,"supplier_sku2":"string","lead_time":0,"is_default":true,"notes":"string","is_deleted":true}]}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Product not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}},"/products/{id}/suppliers/{supplier_code}":{"get":{"tags":["products"],"summary":"Gets a specific supplier for a product","description":"Gets a specific supplier for a product","operationId":"get-products-id-suppliers-supplier_code","parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"schema":{"type":"integer","description":"Product ID","format":"int32"}},{"name":"supplier_code","in":"path","description":"Supplier Code","required":true,"schema":{"type":"string","description":"Supplier Code","nullable":true}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"200":{"description":"Product supplier retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSupplier"},"example":{"product_id":0,"supplier_code":"string","supplier_name":"string","supplier_status":true,"supplier_buy_ex":0,"supplier_sku2":"string","lead_time":0,"is_default":true,"notes":"string","is_deleted":true}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"delete":{"tags":["products"],"summary":"Deletes specific Product Supplier by supplier code","description":"Deletes specific Product Supplier by supplier code","operationId":"delete-products-id-suppliers-supplier_code","parameters":[{"name":"id","in":"path","description":"Product id","required":true,"schema":{"type":"integer","description":"Product id","format":"int32"}},{"name":"supplier_code","in":"path","description":"Product Supplier code","required":true,"schema":{"type":"string","description":"Product Supplier code","nullable":true}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"responses":{"204":{"description":"Product Supplier was deleted"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}},"put":{"tags":["products"],"summary":"Updates a specific product supplier by product ID and supplier code","description":"Sample request:\r\n \r\n PUT /products/123/suppliers/00\r\n {\r\n \"supplier_buy_ex\": 1.1,\r\n \"supplier_sku2\": \"SupplierSKU2\",\r\n \"lead_time\": 4,\r\n \"is_default\": true,\r\n \"notes\": \"This is a Note.\"\r\n }","operationId":"put-products-id-suppliers-supplier_code","parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"schema":{"type":"integer","description":"Product ID","format":"int32"}},{"name":"supplier_code","in":"path","description":"Supplier code","required":true,"schema":{"type":"string","description":"Supplier code","nullable":true}},{"name":"x-api-key","in":"header","description":"Api subscription key","required":true,"schema":{"type":"string"}},{"name":"Cache-Control","in":"header","required":false,"schema":{"type":"string","default":"no-cache"}},{"name":"Authorization","in":"header","required":true,"description":"Bearer token for authorization (e.g., Bearer )","schema":{"type":"string"}}],"requestBody":{"description":"Product supplier to update","content":{"application/json":{"schema":{"title":"EmptyExample","type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Product supplier updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSupplier"},"example":{"product_id":0,"supplier_code":"string","supplier_name":"string","supplier_status":true,"supplier_buy_ex":0,"supplier_sku2":"string","lead_time":0,"is_default":true,"notes":"string","is_deleted":true}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}},"404":{"description":"Product or supplier not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"},"example":{"type":"string","title":"string","status":0,"detail":"string","instance":"string"}}}}}}}},"components":{"schemas":{"AccountCustomer":{"title":"","type":"object","properties":{"credit_blocked":{"type":"boolean","description":"Is credit blocked"},"credit_limit":{"type":"number","description":"Credit limit","format":"double"},"credit_remaining":{"type":"number","description":"Credit remaining","format":"double","nullable":true},"enabled":{"type":"boolean","description":"Is enabled"},"payment_terms":{"type":"integer","description":"Payment terms","format":"int32","nullable":true}},"additionalProperties":false,"description":"Account customer view model"},"Attribute":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Attribute Id","format":"int32","nullable":true},"name":{"type":"string","description":"Attribute Name","nullable":true},"type":{"type":"string","description":"Attribute Type","nullable":true,"readOnly":true},"modified_on":{"type":"string","format":"date-time","nullable":true},"value":{"$ref":"#/components/schemas/AttributeValueLimited"}},"additionalProperties":false},"Attribute.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"AttributeValue":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Attribute Value Id","format":"int32","nullable":true},"attribute_id":{"type":"integer","description":"Attribute Id","format":"int32"},"name":{"type":"string","description":"Attribute Value Name","nullable":true},"list_order":{"type":"integer","description":"Attribute Value List Order","format":"int32","nullable":true},"modified_on":{"type":"string","description":"Modified on","format":"date-time"}},"additionalProperties":false,"description":"Product attribute value model"},"AttributeValue.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AttributeValue"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"AttributeValueLimited":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Attribute Value Id","format":"int32","nullable":true},"name":{"type":"string","description":"Attribute Value Name","nullable":true},"list_order":{"type":"integer","description":"Attribute Value List Order","format":"int32","nullable":true}},"additionalProperties":false},"auth.AuthenticationResult":{"title":"","type":"object","properties":{"token_type":{"type":"string","description":"Access token type.","nullable":true},"access_token":{"type":"string","description":"Access token.","nullable":true},"expires_on":{"type":"string","description":"The point in time in which access token ceases to be valid.","format":"date-time"}},"additionalProperties":false,"description":"Authentication result."},"BillingAddress":{"title":"","type":"object","properties":{"country":{"type":"string","description":"Country","nullable":true},"country_code":{"type":"string","description":"Country Code","nullable":true},"state":{"type":"string","description":"State","nullable":true},"suburb":{"type":"string","description":"Suburb","nullable":true},"address_line1":{"type":"string","description":"Address line 1","nullable":true},"address_line2":{"type":"string","description":"Address line 2","nullable":true},"postcode":{"type":"string","description":"Post code","nullable":true},"company":{"type":"string","description":"Company","nullable":true},"mobile":{"type":"string","description":"Mobile phone","nullable":true},"phone":{"type":"string","description":"Phone","nullable":true},"first_name":{"type":"string","description":"First name","nullable":true},"last_name":{"type":"string","description":"Last Name","nullable":true},"email":{"type":"string","description":"Email","nullable":true}},"additionalProperties":false,"description":"Billing address model"},"Boolean.BeforeAfter":{"title":"","type":"object","properties":{"before":{"type":"boolean","description":"Before"},"after":{"type":"boolean","description":"After"}},"additionalProperties":false},"Campaign":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Campaign id","format":"int32","nullable":true},"name":{"maxLength":100,"minLength":0,"type":"string","description":"Campaign name","nullable":true}},"additionalProperties":false,"description":"Campaign Model"},"Country":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"id","format":"int32","nullable":true},"code":{"type":"string","description":"code","nullable":true},"name":{"type":"string","description":"name","nullable":true},"tax_rate":{"type":"number","description":"tax_rate","format":"double"},"tax_label":{"type":"string","description":"tax_label","nullable":true},"currency_multiplier":{"type":"number","description":"currency_multiplier","format":"double"},"fob_currency":{"$ref":"#/components/schemas/Currency"},"modified_on":{"type":"string","description":"Modified on","format":"date-time"}},"additionalProperties":false,"description":"CountryVM Model"},"Country.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Country"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"CountryLimited":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"id","format":"int32","nullable":true},"name":{"type":"string","description":"name","nullable":true}},"additionalProperties":false},"CreditNote":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Credit Note id","format":"int32","nullable":true},"supplier_return_id":{"type":"integer","description":"Supplier Return id","format":"int32","nullable":true},"supplier":{"$ref":"#/components/schemas/SupplierLimited"},"outlet":{"$ref":"#/components/schemas/OutletExtended"},"supplier_reference":{"maxLength":50,"minLength":0,"type":"string","description":"Supplier reference","nullable":true},"include_tax":{"type":"boolean","description":"Include tax","default":false,"nullable":true},"rounding_adjustment":{"type":"number","description":"Rounding Adjustment","format":"double"},"total_credit_quantity":{"type":"integer","description":"Total credit quantity","format":"int32"},"total_credit_amount_ex":{"type":"number","description":"Total Credit Amount Ex","format":"double"},"total_credit_amount_tax":{"type":"number","description":"Total Credit Amount Tax","format":"double"},"total_credit_amount_inc":{"type":"number","description":"Total Credit Amount Inc","format":"double"},"total_applied_credit_quantity":{"type":"integer","description":"Total Applied Credit Quantity","format":"int32"},"total_applied_credit_amount_ex":{"type":"number","description":"Total Applied Credit Amount Ex","format":"double"},"total_applied_credit_amount_inc":{"type":"number","description":"Total Applied Credit Amount Inc","format":"double"},"total_applied_credit_tax":{"type":"number","description":"Total Applied Credit Tax","format":"double"},"created_on":{"type":"string","description":"Created on","format":"date-time"},"modified_on":{"type":"string","description":"Modified on","format":"date-time"},"supplier_credited_on":{"type":"string","description":"Supplier Credited On","format":"date-time","nullable":true},"created_by":{"$ref":"#/components/schemas/UserExtended"},"modified_by":{"$ref":"#/components/schemas/UserExtended"}},"additionalProperties":false,"description":"Credit Note model"},"CreditNote.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CreditNote"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"CreditNoteItem":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Credit Note Item id","format":"int32","nullable":true},"credit_note_id":{"type":"integer","description":"Credit Note id","format":"int32"},"supplier_return_item_id":{"type":"integer","description":"Supplier Return Item id","format":"int32","nullable":true},"product":{"$ref":"#/components/schemas/CreditNoteProduct"},"credit_quantity":{"type":"integer","description":"Credit Quantity","format":"int32","nullable":true},"credit_amount_ex":{"type":"number","description":"Credit Amount Ex","format":"double","nullable":true},"total_credit_amount_ex":{"type":"number","description":"Total Credit Amount Ex","format":"double","nullable":true},"applied_credit_quantity":{"type":"integer","description":"Applied Credit Quantity","format":"int32","nullable":true},"applied_credit_tax":{"type":"number","description":"Applied Credit Tax","format":"double","nullable":true},"applied_credit_amount_inc":{"type":"number","description":"Applied Credit Amount Inc","format":"double","nullable":true},"applied_credit_amount_ex":{"type":"number","description":"Applied Credit Amount Ex","format":"double","nullable":true},"total_applied_credit_amount_ex":{"type":"number","description":"Total Applied Credit Amount Ex","format":"double","nullable":true},"total_credit_amount_inc":{"type":"number","description":"Total Credit Amount Inc","format":"double","nullable":true},"total_credit_amount_tax":{"type":"number","description":"Total Credit Amount Tax","format":"double","nullable":true},"total_applied_credit_amount_inc":{"type":"number","description":"Total Applied Credit Amount Inc","format":"double","nullable":true},"total_applied_credit_tax":{"type":"number","description":"Total Applied Credit Tax","format":"double","nullable":true},"created_on":{"type":"string","description":"Created on","format":"date-time"},"modified_on":{"type":"string","description":"Modified on","format":"date-time"},"created_by":{"$ref":"#/components/schemas/UserExtended"},"modified_by":{"$ref":"#/components/schemas/UserExtended"}},"additionalProperties":false,"description":"Credit Note model"},"CreditNoteItem.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CreditNoteItem"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"CreditNoteItemExtended":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Credit Note Item id","format":"int32","nullable":true},"credit_note_id":{"type":"integer","description":"Credit Note id","format":"int32"},"credit_amount_ex":{"type":"number","description":"Credit Amount Ex","format":"double","nullable":true},"total_credit_amount_ex":{"type":"number","description":"Total Credit Amount Ex","format":"double","nullable":true},"total_credit_amount_inc":{"type":"number","description":"Total Credit Amount Inc","format":"double","nullable":true}},"additionalProperties":false},"CreditNoteItemLimited":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Credit Note Item id","format":"int32","nullable":true},"supplier_return_item_id":{"type":"integer","description":"Supplier Return Item id","format":"int32","nullable":true}},"additionalProperties":false},"CreditNoteProduct":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Product id","format":"int32","nullable":true},"supplier_sku":{"type":"string","description":"Supplier SKU","nullable":true},"manufacturer_sku":{"type":"string","description":"Manufacturer SKU","nullable":true},"supplier_sku2":{"type":"string","description":"Supplier SKU 2","nullable":true},"short_description":{"type":"string","description":"Short Description","nullable":true},"size":{"$ref":"#/components/schemas/AttributeValueLimited"},"colour":{"$ref":"#/components/schemas/AttributeValueLimited"},"modified_on":{"type":"string","description":"Modified on","format":"date-time"}},"additionalProperties":false,"description":"Product model for Credit Notes"},"Currency":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Currency Id","format":"int32","nullable":true},"currency_code":{"type":"string","description":"Currency Code","nullable":true},"currency_name":{"type":"string","description":"Currency Name","nullable":true},"modified_on":{"type":"string","description":"Last Modified On","format":"date-time"}},"additionalProperties":false,"description":"Currencies model"},"Currency.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Currency"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"CurrencyLimited":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Currency Id","format":"int32","nullable":true},"currency_code":{"type":"string","description":"Currency Code","nullable":true},"currency_name":{"type":"string","description":"Currency Name","nullable":true}},"additionalProperties":false},"Customer":{"title":"","type":"object","properties":{"account_customer":{"$ref":"#/components/schemas/AccountCustomer"},"acn":{"type":"string","description":"Acn","nullable":true},"billing_address":{"$ref":"#/components/schemas/CustomerBillingAddress"},"company":{"type":"string","description":"Company","nullable":true},"customer_number":{"type":"string","description":"Customer number","nullable":true},"customer_type":{"$ref":"#/components/schemas/CustomerType"},"date_of_birth":{"type":"string","description":"Date of birth","nullable":true},"date_of_birth_withheld":{"type":"boolean","description":"Date of birth with held"},"delivery_addresses":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryAddress"},"description":"Delivery address","nullable":true},"email":{"type":"string","description":"Email","nullable":true},"fax":{"type":"string","description":"Fax","nullable":true},"first_name":{"type":"string","description":"First name","nullable":true},"id":{"type":"integer","description":"Identifier","format":"int32"},"last_name":{"type":"string","description":"Last name","nullable":true},"loyalty_program":{"$ref":"#/components/schemas/LoyaltyProgram"},"marketing":{"$ref":"#/components/schemas/Marketing"},"mobile":{"type":"string","description":"Mobile","nullable":true},"phone":{"type":"string","description":"Phone","nullable":true},"price_groups":{"type":"array","items":{"$ref":"#/components/schemas/PriceGroup"},"description":"Price group","nullable":true},"survey_responses":{"type":"array","items":{"$ref":"#/components/schemas/SurveyResponse"},"description":"Survey responses","nullable":true},"website":{"type":"string","description":"Website","nullable":true},"home_outlet":{"$ref":"#/components/schemas/OutletExtended"},"custom_reference":{"type":"string","description":"Custom reference","nullable":true},"export_to_web":{"type":"boolean","description":"Export to web"},"total_payments":{"type":"number","description":"Total Payments","format":"double","nullable":true},"total_transactions":{"type":"integer","description":"Total Transactions","format":"int32","nullable":true},"sales_channels":{"type":"array","items":{"$ref":"#/components/schemas/CustomerSalesChannel"},"description":"Sales Channels","nullable":true},"created_on":{"type":"string","description":"Created on","format":"date-time"},"modified_on":{"type":"string","description":"Modified on","format":"date-time"}},"additionalProperties":false,"description":"Customer model"},"Customer.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Customer"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"CustomerBillingAddress":{"title":"","type":"object","properties":{"country":{"type":"string","description":"Country","nullable":true},"country_code":{"type":"string","description":"Country Code","nullable":true},"state":{"type":"string","description":"State","nullable":true},"suburb":{"type":"string","description":"Suburb","nullable":true},"address_line1":{"type":"string","description":"Address line 1","nullable":true},"address_line2":{"type":"string","description":"Address line 2","nullable":true},"postcode":{"type":"string","description":"Post code","nullable":true},"first_name":{"type":"string","description":"First name","nullable":true},"last_name":{"type":"string","description":"Last Name","nullable":true}},"additionalProperties":false,"description":"Billing address model"},"CustomerLimited":{"title":"","type":"object","properties":{"customer_number":{"type":"string","description":"Customer number","nullable":true},"email":{"type":"string","description":"Email","nullable":true},"first_name":{"type":"string","description":"First name","nullable":true},"id":{"type":"integer","description":"Identifier","format":"int32"},"last_name":{"type":"string","description":"Last name","nullable":true},"custom_reference":{"type":"string","description":"Custom reference","nullable":true}},"additionalProperties":false},"CustomerLogVM":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"customer_id":{"type":"integer","description":"Customer Identifier","format":"int32"},"customer_number":{"type":"string","description":"Customer Number","nullable":true},"master_customer_id":{"type":"integer","description":"Master Customer Identifier","format":"int32","nullable":true},"master_customer_number":{"type":"string","nullable":true},"created_on":{"type":"string","description":"Created On","format":"date-time"},"created_by":{"$ref":"#/components/schemas/UserExtended"},"loyalty_points_balance":{"type":"number","description":"Loyalty Points Balance","format":"double","nullable":true},"price_groups":{"type":"array","items":{"$ref":"#/components/schemas/PriceGroup"},"description":"Price Group","nullable":true},"notes":{"type":"string","description":"Notes","nullable":true}},"additionalProperties":false},"CustomerLogVM.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerLogVM"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"CustomerLoyaltyHistory":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Id","format":"int32"},"created_on":{"type":"string","description":"Created On","format":"date-time"},"order_item":{"$ref":"#/components/schemas/ExtendedOrderItem"},"adjustment_reason":{"$ref":"#/components/schemas/LoyaltyAdjustmentReason"},"loyalty_points_delta":{"type":"number","description":"Loyalty Points Delta","format":"double"},"loyalty_points_available":{"type":"number","description":"Loyalty Points Available","format":"double"},"ratio":{"type":"number","description":"Ratio","format":"double","nullable":true}},"additionalProperties":false,"description":"Customer Loyalty History model"},"CustomerLoyaltyHistory.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerLoyaltyHistory"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"CustomerSalesChannel":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Channel name","nullable":true},"shopify_channel":{"type":"boolean","description":"Is shopify channel"},"enabled":{"type":"boolean","description":"Is enabled"}},"additionalProperties":false,"description":"CustomerSalesChannel Model"},"CustomerSegmentGroup":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Customer Segment Group Identifier","format":"int32"},"name":{"type":"string","description":"Name","nullable":true},"active":{"type":"boolean","description":"Active status"},"options":{"type":"array","items":{"$ref":"#/components/schemas/CustomerSegmentOption"},"description":"Customer segment options","nullable":true}},"additionalProperties":false,"description":"Customer segment group model"},"CustomerSegmentGroup.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerSegmentGroup"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"CustomerSegmentOption":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Customer segment option identifier","format":"int32"},"name":{"type":"string","description":"Customer segment option name","nullable":true}},"additionalProperties":false,"description":"Customer segment option model"},"CustomerSegmentOption.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerSegmentOption"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"CustomerType":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Customer type identifier","format":"int32"},"name":{"type":"string","description":"Customer type name","nullable":true}},"additionalProperties":false,"description":"Customer type model"},"CustomProperty":{"title":"","type":"object","properties":{"name":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false,"description":"Custom Property Model"},"Decimal.BeforeChangeAfter":{"title":"","type":"object","properties":{"before":{"type":"number","description":"Before","format":"double"},"change":{"type":"number","description":"Change","format":"double"},"after":{"type":"number","description":"After","format":"double"}},"additionalProperties":false},"DeliveryAddress":{"title":"","type":"object","properties":{"country":{"type":"string","description":"Country","nullable":true},"country_code":{"type":"string","description":"Country Code","nullable":true},"state":{"type":"string","description":"State","nullable":true},"suburb":{"type":"string","description":"Suburb","nullable":true},"address_line1":{"type":"string","description":"Address line 1","nullable":true},"address_line2":{"type":"string","description":"Address line 2","nullable":true},"postcode":{"type":"string","description":"Post code","nullable":true},"company":{"type":"string","description":"Company","nullable":true},"mobile":{"type":"string","description":"Mobile phone","nullable":true},"phone":{"type":"string","description":"Phone","nullable":true},"first_name":{"type":"string","description":"First name","nullable":true},"last_name":{"type":"string","description":"Last Name","nullable":true},"id":{"type":"integer","description":"Identifier","format":"int32"},"default":{"type":"boolean","description":"Is Default","nullable":true},"modified_on":{"type":"string","description":"Modified on","format":"date-time"}},"additionalProperties":false,"description":"Delivery Address model"},"DeliveryAddress.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryAddress"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"DeliveryDriver":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Id.","format":"int32"},"name":{"type":"string","description":"Name.","nullable":true}},"additionalProperties":false},"DeliveryTime":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Id.","format":"int32"},"name":{"type":"string","description":"Name.","nullable":true}},"additionalProperties":false},"DeliveryZone":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Id.","format":"int32"},"name":{"type":"string","description":"Name.","nullable":true}},"additionalProperties":false},"DirectCosts":{"title":"","type":"object","properties":{"applied_on":{"type":"string","description":"DirectCosts AppliedOn","format":"date-time","nullable":true},"apply_pending":{"type":"boolean","description":"Is DirectCosts Apply Pending"},"freight":{"$ref":"#/components/schemas/DirectCostsItem"},"duty":{"$ref":"#/components/schemas/DirectCostsItem"},"misc":{"$ref":"#/components/schemas/DirectCostsItem"}},"additionalProperties":false,"description":"Direct costs model"},"DirectCostsItem":{"title":"","type":"object","properties":{"total_ex":{"type":"number","description":"Total ex","format":"double"},"includes_tax":{"type":"boolean","description":"Includes tax","nullable":true},"total_tax":{"type":"number","description":"Total tax","format":"double"},"total_inc":{"type":"number","description":"Total inc","format":"double"}},"additionalProperties":false,"description":"Direct Costs Item model"},"ExtendedFulfilment":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Fulfilment id","format":"int32"},"order_item_id":{"type":"integer","description":"Order Item Id","format":"int32"},"quantity_fulfiled":{"type":"integer","description":"Fulfiled quantity of products","format":"int32"},"fulfil_outlet":{"$ref":"#/components/schemas/OutletExtended"},"created_on":{"type":"string","description":"Created On","format":"date-time"},"serial_number":{"type":"string","description":"Serial Number","nullable":true},"order_id":{"type":"integer","description":"Order Id .","format":"int32","nullable":true},"order_number":{"type":"string","description":"Order Number.","nullable":true}},"additionalProperties":false,"description":"Fulfilment model"},"ExtendedFulfilment.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ExtendedFulfilment"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"ExtendedOrderItem":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Order item id.","format":"int32","nullable":true},"external_id":{"type":"string","description":"External unique id","nullable":true},"order_item_type":{"type":"string","description":"Order item type","nullable":true},"product":{"$ref":"#/components/schemas/ProductLimited"},"original_price":{"type":"number","description":"Original price","format":"double","nullable":true},"sell_price":{"type":"number","description":"Sell price","format":"double"},"order_item_total":{"type":"number","description":"Order item total","format":"double","readOnly":true},"order_item_discount_total":{"type":"number","description":"Order item discount total","format":"double","nullable":true},"taxable":{"type":"boolean","description":"Is taxable","nullable":true},"tax_rate":{"type":"number","description":"Tax rate","format":"double","nullable":true},"supplier_buy_ex":{"type":"number","description":"Supplier Buy Ex","format":"double","nullable":true},"direct_costs_ex":{"type":"number","description":"Direct Costs Ex","format":"double","nullable":true},"cogs_ex":{"type":"number","description":"COGS Ex","format":"double","nullable":true,"readOnly":true},"fulfilment_method":{"type":"string","description":"Fulfilment Method","nullable":true},"due_date":{"type":"string","description":"Due date","format":"date-time","nullable":true},"delivery_driver":{"$ref":"#/components/schemas/DeliveryDriver"},"delivery_zone":{"$ref":"#/components/schemas/DeliveryZone"},"delivery_time":{"$ref":"#/components/schemas/DeliveryTime"},"quantity_ordered":{"type":"integer","description":"Quantity Ordered","format":"int32"},"quantity_fulfiled":{"type":"integer","description":"Quantity Fulfiled","format":"int32"},"notes":{"type":"string","description":"Notes","nullable":true},"original_order_item_id":{"type":"integer","description":"Original Order Item Id","format":"int32","nullable":true},"return_reason":{"$ref":"#/components/schemas/ReturnReasonLimited"},"fulfil_outlet":{"$ref":"#/components/schemas/OutletExtended"},"source_outlet":{"$ref":"#/components/schemas/OutletExtended"},"applied_promotional_campaigns":{"type":"array","items":{"$ref":"#/components/schemas/Campaign"},"description":"Promotional campaigns","nullable":true},"created_on":{"type":"string","description":"Created on","format":"date-time"},"modified_on":{"type":"string","description":"Modified on","format":"date-time","nullable":true},"linked_purchase_order":{"$ref":"#/components/schemas/PurchaseOrderLimited"},"serial_number":{"type":"string","description":"Serial Number","nullable":true},"order_id":{"type":"integer","description":"Order Id .","format":"int32"},"order_number":{"type":"string","description":"Order Number.","nullable":true}},"additionalProperties":false,"description":"Order Item Model"},"ExtendedOrderItem.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ExtendedOrderItem"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"ExtendedOrderPayment":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Order Payment Id .","format":"int32"},"external_id":{"type":"string","description":"External Id.","nullable":true},"payment_method":{"$ref":"#/components/schemas/PaymentMethod"},"amount":{"type":"number","description":"Amount.","format":"double"},"created_on":{"type":"string","description":"Created On.","format":"date-time"},"order_id":{"type":"integer","description":"Order Id .","format":"int32"},"order_number":{"type":"string","description":"Order Number.","nullable":true}},"additionalProperties":false,"description":"Order Payment Model"},"ExtendedOrderPayment.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ExtendedOrderPayment"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"FixedPriceGroup":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Name","nullable":true},"modified_on":{"type":"string","description":"Date of last modification of Fixed Price Group","format":"date-time"}},"additionalProperties":false},"FixedPriceGroup.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FixedPriceGroup"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"FreightType":{"title":"","required":["name"],"type":"object","properties":{"name":{"maxLength":100,"minLength":0,"type":"string","description":"Freight Type name."},"id":{"type":"integer","description":"Freight Type Id.","format":"int32","nullable":true},"deleted":{"type":"boolean","description":"Is Freight Type deleted (enabled/disabled)?."},"modified_on":{"type":"string","description":"Modified on","format":"date-time"}},"additionalProperties":false,"description":"Freight Type Model"},"FreightType.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FreightType"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"FreightTypeLimited":{"title":"","required":["name"],"type":"object","properties":{"id":{"type":"integer","description":"Freight Type Id.","format":"int32","nullable":true},"name":{"maxLength":100,"minLength":0,"type":"string","description":"Freight Type name."}},"additionalProperties":false},"Fulfilment":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Fulfilment id","format":"int32"},"order_item_id":{"type":"integer","description":"Order Item Id","format":"int32"},"quantity_fulfiled":{"type":"integer","description":"Fulfiled quantity of products","format":"int32"},"fulfil_outlet":{"$ref":"#/components/schemas/OutletExtended"},"created_on":{"type":"string","description":"Created On","format":"date-time"},"serial_number":{"type":"string","description":"Serial Number","nullable":true}},"additionalProperties":false,"description":"Fulfilment model"},"fulfilment.Order":{"title":"","required":["fulfilment_service_id"],"type":"object","properties":{"fulfilment_service_id":{"type":"string","description":"Fulfilment service id.","format":"uuid"},"order_item_id":{"type":"integer","description":"Order item id.","format":"int32"},"order_id":{"type":"integer","description":"Order id.","format":"int32"},"status":{"type":"string","description":"Order Status.","nullable":true},"error":{"type":"string","description":"Error Message.","nullable":true},"fulfilment_service_name":{"type":"string","description":"Fulfilment service name.","nullable":true},"fulfilment_id":{"type":"integer","description":"Fulfilment id","format":"int32"},"fulfilment_qty":{"type":"integer","description":"Fulfilment quantity","format":"int32"},"fulfilment_date":{"type":"string","description":"Fulfilment date","format":"date-time"}},"additionalProperties":false,"description":"Order model."},"fulfilment.Order.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/fulfilment.ShippitOrder"}],"description":"Order model.","discriminator":{"propertyName":"fulfilment_service_id","mapping":{"afc01107-0905-4172-b0be-5787a8e6e0a5":"#/components/schemas/fulfilment.ShippitOrder"}}},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"Fulfilment.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Fulfilment"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"fulfilment.ShippitOrder":{"title":"","type":"object","allOf":[{"$ref":"#/components/schemas/fulfilment.Order"}],"properties":{"tracking_number":{"type":"string","description":"Tracking number","nullable":true},"tracking_link":{"type":"string","description":"Tracking link to fulfilment service","nullable":true},"delivery_service":{"type":"string","description":"Name of delivery service used for order","nullable":true}},"additionalProperties":false,"description":"Shippit order model."},"Inventory":{"title":"","type":"object","properties":{"allocated":{"type":"integer","description":"Qty allocated","format":"int32"},"available":{"type":"integer","description":"Qty available","format":"int32"},"stock_on_hand":{"type":"integer","description":"Qty allocated + Qty available","format":"int64"},"bin_location":{"type":"string","description":"Bin location","nullable":true},"faulty":{"type":"integer","description":"Qty faulty","format":"int32"},"msl":{"type":"integer","description":"Msl","format":"int32"},"on_order":{"type":"integer","description":"Qty onOrder","format":"int32"},"outlet_id":{"type":"integer","description":"Outlet Id","format":"int32"},"picked":{"type":"integer","description":"Qty available","format":"int32"},"product_id":{"type":"integer","description":"Product Id","format":"int32"},"received":{"type":"integer","description":"Qty received","format":"int32"},"requested":{"type":"integer","description":"Qty requested","format":"int32"},"transit_in":{"type":"integer","description":"Qty transit in","format":"int32"},"transit_out":{"type":"integer","description":"Qty transit out","format":"int32"},"modified_on":{"type":"string","description":"Modified on","format":"date-time"},"last_sold_on":{"type":"string","description":"Last Sold","format":"date-time","nullable":true},"last_fulfiled_on":{"type":"string","description":"Last Fulfiled","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Inventory view model"},"Inventory.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Inventory"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"InventoryMovementLogs":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Inventory Movement Logs identifier","format":"int32","nullable":true},"created_on":{"type":"string","description":"Created on","format":"date-time"},"created_by":{"$ref":"#/components/schemas/UserExtended"},"outlet":{"$ref":"#/components/schemas/OutletLimited"},"product":{"$ref":"#/components/schemas/InventoryMovementLogsProduct"},"movement_type":{"type":"string","description":"Source type","nullable":true},"origin":{"type":"string","description":"Origin","nullable":true},"comment":{"type":"string","description":"Comment","nullable":true},"reference_id":{"type":"string","description":"Reference id","nullable":true},"quantity_available":{"$ref":"#/components/schemas/InventoryMovementLogsDelta"},"quantity_allocated":{"$ref":"#/components/schemas/InventoryMovementLogsDelta"},"quantity_picked":{"$ref":"#/components/schemas/InventoryMovementLogsDelta"},"quantity_in_transit_outbound":{"$ref":"#/components/schemas/InventoryMovementLogsDelta"},"quantity_in_transit_inbound":{"$ref":"#/components/schemas/InventoryMovementLogsDelta"},"quantity_received":{"$ref":"#/components/schemas/InventoryMovementLogsDelta"},"quantity_requested":{"$ref":"#/components/schemas/InventoryMovementLogsDelta"},"quantity_onorder":{"$ref":"#/components/schemas/InventoryMovementLogsDelta"},"quantity_faulty":{"$ref":"#/components/schemas/InventoryMovementLogsDelta"},"quantity_onreturn":{"$ref":"#/components/schemas/InventoryMovementLogsDelta"},"quantity_soh":{"$ref":"#/components/schemas/InventoryMovementLogsDelta"},"buy_price_ex":{"$ref":"#/components/schemas/InventoryMovementLogsChange"},"direct_costs_ex":{"$ref":"#/components/schemas/InventoryMovementLogsChange"},"cogs_ex":{"$ref":"#/components/schemas/InventoryMovementLogsChange"},"total_cogs_ex":{"$ref":"#/components/schemas/InventoryMovementLogsChange"}},"additionalProperties":false,"description":"Inventory Movement Logs model"},"InventoryMovementLogs.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InventoryMovementLogs"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"InventoryMovementLogsChange":{"title":"","type":"object","properties":{"before":{"type":"number","description":"Before","format":"double","nullable":true},"change":{"type":"number","description":"Delta","format":"double","nullable":true},"after":{"type":"number","description":"After","format":"double","nullable":true}},"additionalProperties":false,"description":"Inventory Movement Logs Change model"},"InventoryMovementLogsDelta":{"title":"","type":"object","properties":{"before":{"type":"integer","description":"Before","format":"int32","nullable":true},"delta":{"type":"integer","description":"Delta","format":"int32","nullable":true},"after":{"type":"integer","description":"After","format":"int32","nullable":true}},"additionalProperties":false,"description":"Inventory Movement Logs Delta model"},"InventoryMovementLogsProduct":{"title":"","type":"object","properties":{"id":{"type":"integer","format":"int32","nullable":true},"supplier_sku":{"type":"string","nullable":true},"short_description":{"type":"string","nullable":true},"product_type":{"$ref":"#/components/schemas/ProductType"}},"additionalProperties":false,"description":"Inventory Movement Logs model"},"LandedCostsCalculation":{"title":"","enum":["Manual","Currency Conversion"],"type":"string"},"LogoLimited":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32","nullable":true},"description":{"type":"string","description":"Logo description","nullable":true}},"additionalProperties":false},"LoyaltyAdjustmentReason":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Loyalty Adjustment Reason Id.","format":"int32"},"name":{"type":"string","description":"Loyalty Adjustment Reason name","nullable":true},"is_system":{"type":"boolean","description":"Loyalty Adjustment Reason IsSystem flag"},"is_deleted":{"type":"boolean","description":"Loyalty Adjustment Reason IsDeleted flag","nullable":true}},"additionalProperties":false,"description":"Loyalty Adjustment Reason Model"},"LoyaltyAdjustmentReason.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyAdjustmentReason"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"LoyaltyHistory":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Id","format":"int32"},"created_on":{"type":"string","description":"Created On","format":"date-time"},"order_item":{"$ref":"#/components/schemas/ExtendedOrderItem"},"adjustment_reason":{"$ref":"#/components/schemas/LoyaltyAdjustmentReason"},"loyalty_points_delta":{"type":"number","description":"Loyalty Points Delta","format":"double"},"loyalty_points_available":{"type":"number","description":"Loyalty Points Available","format":"double"},"ratio":{"type":"number","description":"Ratio","format":"double","nullable":true},"order_number":{"type":"string","description":"Order Number","nullable":true},"customer_id":{"type":"integer","description":"Customer Id","format":"int32"}},"additionalProperties":false,"description":"Loyalty History model"},"LoyaltyHistory.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LoyaltyHistory"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"LoyaltyProgram":{"title":"","type":"object","properties":{"enabled":{"type":"boolean","description":"Is enabled"},"points_available":{"type":"number","description":"Points available","format":"double"},"points_redeemed":{"type":"number","description":"Points redeemed","format":"double"},"points_to_date":{"type":"number","description":"Points to date","format":"double"},"auto_price_group":{"type":"boolean","description":"Auto price group"},"points_available_value":{"type":"number","description":"Points available value","format":"double","nullable":true}},"additionalProperties":false,"description":"Loyalty program model"},"Marketing":{"title":"","type":"object","properties":{"receive_email":{"type":"boolean","description":"Receive email"},"receive_post":{"type":"boolean","description":"Receive post"},"receive_sms":{"type":"boolean","description":"Receive sms"}},"additionalProperties":false,"description":"Marketing view model"},"MaxDiscountRule":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Max Discount Rule Id.","format":"int32","nullable":true},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Max Discount Rule name.","nullable":true},"value":{"type":"number","description":"Max Discount Rule value.","format":"double"},"type":{"type":"string","description":"Discount Type.","nullable":true},"modified_on":{"type":"string","description":"Modified on","format":"date-time"}},"additionalProperties":false,"description":"Max Discount Rule Model"},"MaxDiscountRule.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MaxDiscountRule"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"Order":{"title":"","type":"object","properties":{"billing_address":{"$ref":"#/components/schemas/BillingAddress"},"private_comments":{"type":"string","nullable":true},"delivery_address":{"$ref":"#/components/schemas/DeliveryAddress"},"ext_unique_id":{"type":"string","description":"External ID of the payment, if applicable.","nullable":true},"freight_total":{"type":"number","description":"Freight total","format":"double","nullable":true},"freight_type":{"$ref":"#/components/schemas/FreightTypeLimited"},"id":{"type":"integer","description":"Order Id.","format":"int32","nullable":true},"customer":{"$ref":"#/components/schemas/CustomerLimited"},"order_number":{"type":"string","description":"The Order identifier in Retail Express.","nullable":true},"original_order_id":{"type":"integer","description":"Original Order Id.","format":"int32","nullable":true},"sales_channel":{"$ref":"#/components/schemas/SalesChannelLimited"},"sales_person":{"$ref":"#/components/schemas/UserLimited"},"order_status":{"$ref":"#/components/schemas/OrderStatus"},"order_total":{"type":"number","description":"Order total","format":"double","nullable":true},"outlet":{"$ref":"#/components/schemas/OutletExtended"},"public_comments":{"type":"string","description":"Public comments","nullable":true},"taxable":{"type":"integer","description":"Is taxable","format":"int32","readOnly":true},"created_on":{"type":"string","description":"Created on","format":"date-time"},"modified_on":{"type":"string","description":"Modified on","format":"date-time"},"fulfilled_in_full_on":{"type":"string","description":"Fulfilled in full on","format":"date-time","nullable":true},"paid_in_full_on":{"type":"string","description":"Paid in full on","format":"date-time","nullable":true},"order_items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"},"description":"Order items.","nullable":true},"fulfilments":{"type":"array","items":{"$ref":"#/components/schemas/Fulfilment"},"description":"Fulfilments.","nullable":true},"payments":{"type":"array","items":{"$ref":"#/components/schemas/OrderPayment"},"description":"Payments.","nullable":true},"vouchers":{"type":"array","items":{"$ref":"#/components/schemas/OrderVoucher"},"description":"Vouchers.","nullable":true}},"additionalProperties":false,"description":"Order Model"},"Order.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Order"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"OrderItem":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Order item id.","format":"int32","nullable":true},"external_id":{"type":"string","description":"External unique id","nullable":true},"order_item_type":{"type":"string","description":"Order item type","nullable":true},"product":{"$ref":"#/components/schemas/ProductLimited"},"original_price":{"type":"number","description":"Original price","format":"double","nullable":true},"sell_price":{"type":"number","description":"Sell price","format":"double"},"order_item_total":{"type":"number","description":"Order item total","format":"double","readOnly":true},"order_item_discount_total":{"type":"number","description":"Order item discount total","format":"double","nullable":true},"taxable":{"type":"boolean","description":"Is taxable","nullable":true},"tax_rate":{"type":"number","description":"Tax rate","format":"double","nullable":true},"supplier_buy_ex":{"type":"number","description":"Supplier Buy Ex","format":"double","nullable":true},"direct_costs_ex":{"type":"number","description":"Direct Costs Ex","format":"double","nullable":true},"cogs_ex":{"type":"number","description":"COGS Ex","format":"double","nullable":true,"readOnly":true},"fulfilment_method":{"type":"string","description":"Fulfilment Method","nullable":true},"due_date":{"type":"string","description":"Due date","format":"date-time","nullable":true},"delivery_driver":{"$ref":"#/components/schemas/DeliveryDriver"},"delivery_zone":{"$ref":"#/components/schemas/DeliveryZone"},"delivery_time":{"$ref":"#/components/schemas/DeliveryTime"},"quantity_ordered":{"type":"integer","description":"Quantity Ordered","format":"int32"},"quantity_fulfiled":{"type":"integer","description":"Quantity Fulfiled","format":"int32"},"notes":{"type":"string","description":"Notes","nullable":true},"original_order_item_id":{"type":"integer","description":"Original Order Item Id","format":"int32","nullable":true},"return_reason":{"$ref":"#/components/schemas/ReturnReasonLimited"},"fulfil_outlet":{"$ref":"#/components/schemas/OutletExtended"},"source_outlet":{"$ref":"#/components/schemas/OutletExtended"},"applied_promotional_campaigns":{"type":"array","items":{"$ref":"#/components/schemas/Campaign"},"description":"Promotional campaigns","nullable":true},"created_on":{"type":"string","description":"Created on","format":"date-time"},"modified_on":{"type":"string","description":"Modified on","format":"date-time","nullable":true},"linked_purchase_order":{"$ref":"#/components/schemas/PurchaseOrderLimited"},"serial_number":{"type":"string","description":"Serial Number","nullable":true}},"additionalProperties":false,"description":"Order Item Model"},"OrderItem.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"OrderLimited":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Order Id.","format":"int32","nullable":true},"customer":{"$ref":"#/components/schemas/CustomerLimited"},"order_number":{"type":"string","description":"The Order identifier in Retail Express.","nullable":true},"original_order_id":{"type":"integer","description":"Original Order Id.","format":"int32","nullable":true},"created_on":{"type":"string","description":"Created on","format":"date-time"},"vouchers":{"type":"array","items":{"$ref":"#/components/schemas/OrderVoucher"},"description":"Vouchers.","nullable":true}},"additionalProperties":false},"OrderPayment":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Order Payment Id .","format":"int32"},"external_id":{"type":"string","description":"External Id.","nullable":true},"payment_method":{"$ref":"#/components/schemas/PaymentMethod"},"amount":{"type":"number","description":"Amount.","format":"double"},"created_on":{"type":"string","description":"Created On.","format":"date-time"}},"additionalProperties":false,"description":"Order Payment Model"},"OrderPayment.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrderPayment"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"OrderStatus":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Order Id.","format":"int32","nullable":true},"status":{"type":"string","description":"Order Id.","nullable":true}},"additionalProperties":false},"OrderVoucher":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Voucher Id.","format":"int32","nullable":true},"code":{"type":"string","description":"Voucher code","nullable":true},"type":{"$ref":"#/components/schemas/VoucherVoucherType"},"initial_value":{"type":"number","description":"Initial value","format":"double","nullable":true},"balance":{"type":"number","description":"Balance","format":"double","nullable":true},"created_on":{"type":"string","description":"Created on","format":"date-time"},"expires_on":{"type":"string","description":"Modified on","format":"date-time","nullable":true}},"additionalProperties":false},"Outlet":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Outlet id","format":"int32","nullable":true},"name":{"maxLength":255,"minLength":0,"type":"string","description":"Outlet name","nullable":true},"external_reference":{"maxLength":30,"minLength":0,"type":"string","description":"External outlet code","nullable":true},"enabled":{"type":"boolean","description":"Enabled"},"company_name":{"maxLength":100,"minLength":0,"type":"string","description":"Company","nullable":true},"company_registration_number":{"maxLength":50,"minLength":0,"type":"string","description":"Company registration number","nullable":true},"company_registration_label":{"maxLength":15,"minLength":0,"type":"string","description":"Company registration label","nullable":true},"billing_type":{"type":"integer","description":"Billing type","format":"int32","nullable":true},"fob_currency":{"$ref":"#/components/schemas/CurrencyLimited"},"store_type":{"$ref":"#/components/schemas/StoreType"},"address":{"$ref":"#/components/schemas/OutletAddress"},"phone":{"maxLength":50,"minLength":0,"type":"string","description":"Phone","nullable":true},"fax":{"maxLength":50,"minLength":0,"type":"string","description":"Fax","nullable":true},"email":{"maxLength":50,"minLength":0,"type":"string","description":"Email","nullable":true},"bank_details":{"$ref":"#/components/schemas/OutletBankDetails"},"default_source_outlet":{"$ref":"#/components/schemas/OutletLimited"},"default_fulfil_outlet":{"$ref":"#/components/schemas/OutletLimited"},"minimum_replenishment_quantity":{"maximum":2147483647,"minimum":0,"type":"integer","description":"Minimum replenishment quantity","format":"int32","nullable":true},"logo":{"$ref":"#/components/schemas/LogoLimited"},"invoice_email_template":{"$ref":"#/components/schemas/OutletEmailFromTemplate"},"invoice_receipt_comments":{"maxLength":8000,"minLength":0,"pattern":"^(?!.*<[^>]+>).*","type":"string","description":"Invoice receipt comments","nullable":true},"display_address_on_invoice":{"type":"boolean","description":"Display address on invoice"},"purchase_order_comments":{"maxLength":8000,"minLength":0,"pattern":"^(?!.*<[^>]+>).*","type":"string","description":"Purchase order comments","nullable":true},"modified_on":{"type":"string","description":"Modified on","format":"date-time"}},"additionalProperties":false,"description":"Outlet model"},"Outlet.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Outlet"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"OutletAddress":{"title":"","type":"object","properties":{"address_line1":{"maxLength":255,"minLength":0,"type":"string","description":"Adress","nullable":true},"address_line2":{"maxLength":100,"minLength":0,"type":"string","description":"Adress2","nullable":true},"address_line3":{"maxLength":100,"minLength":0,"type":"string","description":"Adress3","nullable":true},"suburb":{"maxLength":100,"minLength":0,"type":"string","description":"Suburb","nullable":true},"state":{"maxLength":50,"minLength":0,"type":"string","description":"State","nullable":true},"postcode":{"maxLength":10,"minLength":0,"type":"string","description":"Postcode","nullable":true},"country":{"$ref":"#/components/schemas/CountryLimited"}},"additionalProperties":false,"description":"Outlet address model"},"OutletBankDetails":{"title":"","type":"object","properties":{"bank_name":{"maxLength":128,"minLength":0,"type":"string","description":"Bank name","nullable":true},"bsb":{"maxLength":16,"minLength":0,"type":"string","description":"Bank bsb","nullable":true},"account_number":{"maxLength":32,"minLength":0,"type":"string","description":"Account number","nullable":true},"account_name":{"maxLength":128,"minLength":0,"type":"string","description":"Account name","nullable":true}},"additionalProperties":false,"description":"Outlet bank details model"},"OutletEmailFromTemplate":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32","nullable":true},"name":{"type":"string","description":"Email from template name","nullable":true}},"additionalProperties":false,"description":"Outlet email from template model"},"OutletExtended":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Outlet id","format":"int32","nullable":true},"name":{"maxLength":255,"minLength":0,"type":"string","description":"Outlet name","nullable":true},"modified_on":{"type":"string","description":"Modified on","format":"date-time"}},"additionalProperties":false},"OutletLimited":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Outlet id","format":"int32","nullable":true},"name":{"maxLength":255,"minLength":0,"type":"string","description":"Outlet name","nullable":true}},"additionalProperties":false},"PaymentMethod":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Payment Method Id.","format":"int32"},"name":{"type":"string","description":"Payment Method Name.","nullable":true}},"additionalProperties":false,"description":"Payment Method Model"},"PriceGroup":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Name","nullable":true},"type":{"type":"string","description":"Type","nullable":true}},"additionalProperties":false,"description":"Price group model"},"PriceGroupRule":{"title":"","type":"object","properties":{"type":{"type":"string","description":"Type","nullable":true},"value":{"type":"number","description":"Value","format":"double"}},"additionalProperties":false},"ProblemDetails":{"title":"","type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"Product":{"title":"","type":"object","properties":{"carton_quantity":{"type":"string","description":"Carton quantity","nullable":true},"cogs_ex":{"type":"number","description":"Cogs ex","format":"double"},"cubic":{"type":"number","description":"Cubic","format":"double"},"direct_costs_ex":{"type":"number","description":"Direct costs","format":"double","nullable":true},"prevent_disabling":{"type":"boolean","description":"Is product disabled","nullable":true},"promotional_price_inc":{"type":"number","description":"Discount price","format":"double","nullable":true},"promotional_price_expiry":{"type":"string","description":"Discount price expiry","format":"date-time","nullable":true},"freight_inc":{"type":"number","description":"Freight inc","format":"double","nullable":true},"price_ex":{"type":"number","description":"Price ex","format":"double","nullable":true},"rrp_inc":{"type":"number","description":"Rpr inc","format":"double","nullable":true},"sell_price_inc":{"maximum":922337203685477.6,"minimum":-922337203685477.6,"type":"number","description":"Sell Price, cannot be used along with markup_target","format":"double","nullable":true},"web_price_inc":{"type":"number","description":"Web price","format":"double","nullable":true},"markup_target":{"type":"number","description":"Markup Target %, cannot be used along with sell_price_inc","format":"double","nullable":true},"breadth":{"maximum":9999.9999,"minimum":-9999.9999,"type":"number","description":"Breadth","format":"double","nullable":true},"core_product":{"type":"boolean","description":"Is core product flag"},"custom_properties":{"type":"array","items":{"$ref":"#/components/schemas/CustomProperty"},"description":"List of custom properties","nullable":true},"depth":{"maximum":9999.9999,"minimum":-9999.9999,"type":"number","description":"Depth","format":"double","nullable":true},"disabled":{"type":"boolean","description":"Disabled","nullable":true},"id":{"type":"integer","description":"Product id.","format":"int32","nullable":true},"lead_time":{"type":"integer","description":"Lead time","format":"int32","nullable":true},"length":{"maximum":9999.9999,"minimum":-9999.9999,"type":"number","description":"Length","format":"double","nullable":true},"loyalty_ratio":{"type":"number","description":"Loyalty Ratio","format":"double","nullable":true},"manufacturer_sku":{"type":"string","description":"Manufacture SKU","nullable":true},"product_type":{"$ref":"#/components/schemas/ProductType"},"requires_assembly":{"type":"boolean","description":"Requires Assembly"},"shipping_cubic":{"maximum":999999.9999,"minimum":-999999.9999,"type":"number","description":"Shipping Cubic","format":"double","nullable":true},"short_description":{"type":"string","description":"Product description.","nullable":true},"supplier":{"$ref":"#/components/schemas/SupplierLimited"},"supplier_buy_ex":{"maximum":922337203685477.6,"minimum":-922337203685477.6,"type":"number","description":"Supplier Buy Ex","format":"double","nullable":true},"supplier_sku":{"type":"string","description":"Supplier SKU.","nullable":true},"supplier_sku2":{"type":"string","description":"Supplier SKU2.","nullable":true},"weight":{"maximum":99999999.9999,"minimum":-99999999.9999,"type":"number","description":"Weight","format":"double","nullable":true},"buy_price_ex":{"type":"number","description":"Buy price ex","format":"double","nullable":true},"long_description":{"type":"string","description":"Long description","nullable":true},"voucher_product":{"type":"boolean","description":"Voucher product"},"max_discount_rule":{"$ref":"#/components/schemas/MaxDiscountRule"},"replenishment_method":{"$ref":"#/components/schemas/ProductReplenishmentMethod"},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"},"description":"Product attributes","nullable":true},"created_on":{"type":"string","description":"Created on","format":"date-time","nullable":true},"modified_on":{"type":"string","description":"Modified on","format":"date-time","nullable":true},"inventory":{"type":"array","items":{"$ref":"#/components/schemas/ProductInventory"},"description":"Inventory","nullable":true},"sales_channels":{"type":"array","items":{"$ref":"#/components/schemas/ProductSalesChannelVM"},"description":"Product Sales Chanels","nullable":true},"export_to_web":{"type":"boolean","description":"Export To Web","nullable":true},"package":{"type":"boolean","description":"Package"},"has_package_products":{"type":"boolean","description":"Has Package Products"},"last_sold_on":{"type":"string","description":"Last Processed Sold","format":"date-time","nullable":true},"require_serial_number":{"type":"integer","description":"Require SerialNumber","format":"int32"},"last_fulfiled_on":{"type":"string","description":"Last Fulfiled","format":"date-time","nullable":true},"external_links":{"type":"array","items":{"$ref":"#/components/schemas/ProductExternalLinks"},"description":"Product External Links.","nullable":true},"fixed_price_groups":{"type":"array","items":{"$ref":"#/components/schemas/ProductFixedPriceGroupVM"},"description":"Product Fixed Price Groups","nullable":true},"price_groups":{"type":"array","items":{"$ref":"#/components/schemas/ProductPriceGroupVM"},"description":"Product Standart Price Groups","nullable":true}},"additionalProperties":false,"description":"Product Model"},"Product.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"ProductBarcode":{"title":"","required":["barcode"],"type":"object","properties":{"id":{"type":"integer","description":"Product Barcode id.","format":"int32","nullable":true},"barcode":{"maxLength":50,"minLength":0,"pattern":"^[A-Za-z\\d/-]*$","type":"string","description":"Product Barcode name."},"enabled":{"type":"boolean","description":"Product Barcode enabled."},"product_id":{"type":"integer","description":"Product id","format":"int32"},"created_on":{"type":"string","description":"Date of creation of Product Barcode","format":"date-time"},"modified_on":{"type":"string","description":"Date of last modification of Product Barcode","format":"date-time"}},"additionalProperties":false,"description":"Product Barcode model"},"ProductBarcode.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProductBarcode"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"ProductDetailLog":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Id","format":"int32"},"created_on":{"type":"string","description":"Created on","format":"date-time"},"created_by":{"$ref":"#/components/schemas/UserExtended"},"product":{"$ref":"#/components/schemas/ProductDetailLogProduct"},"movement_type":{"type":"string","description":"Source type","nullable":true},"origin":{"type":"string","description":"Origin","nullable":true},"supplier_buy_ex":{"$ref":"#/components/schemas/Decimal.BeforeChangeAfter"},"buy_price_ex":{"$ref":"#/components/schemas/Decimal.BeforeChangeAfter"},"direct_costs_ex":{"$ref":"#/components/schemas/Decimal.BeforeChangeAfter"},"sell_price_inc":{"$ref":"#/components/schemas/Decimal.BeforeChangeAfter"},"discount_price":{"$ref":"#/components/schemas/Decimal.BeforeChangeAfter"},"rrp_inc":{"$ref":"#/components/schemas/Decimal.BeforeChangeAfter"},"web_price_inc":{"$ref":"#/components/schemas/Decimal.BeforeChangeAfter"},"product_type":{"$ref":"#/components/schemas/String.BeforeAfter"},"disabled":{"$ref":"#/components/schemas/Boolean.BeforeAfter"}},"additionalProperties":false,"description":"Product Detail Log model"},"ProductDetailLog.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProductDetailLog"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"ProductDetailLogProduct":{"title":"","type":"object","properties":{"id":{"type":"integer","format":"int32"},"supplier_sku":{"type":"string","nullable":true},"short_description":{"type":"string","nullable":true},"created_on":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Product Detail Log Product model"},"ProductETA":{"title":"","type":"object","properties":{"product_id":{"type":"integer","description":"Product Id","format":"int32","nullable":true},"sku":{"type":"string","description":"Supplier SKU","nullable":true},"quantity_ordered":{"type":"integer","description":"Quantity Ordered","format":"int32"},"eta":{"type":"string","description":"Estimated Time of Arrival","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Product ETA model"},"ProductETA.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProductETA"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"ProductExtended":{"title":"","type":"object","properties":{"carton_quantity":{"type":"string","description":"Carton quantity","nullable":true},"cubic":{"type":"number","description":"Cubic","format":"double"},"rrp_inc":{"type":"number","description":"Rpr inc","format":"double","nullable":true},"sell_price_inc":{"maximum":922337203685477.6,"minimum":-922337203685477.6,"type":"number","description":"Sell Price, cannot be used along with markup_target","format":"double","nullable":true},"breadth":{"maximum":9999.9999,"minimum":-9999.9999,"type":"number","description":"Breadth","format":"double","nullable":true},"custom_properties":{"type":"array","items":{"$ref":"#/components/schemas/CustomProperty"},"description":"List of custom properties","nullable":true},"depth":{"maximum":9999.9999,"minimum":-9999.9999,"type":"number","description":"Depth","format":"double","nullable":true},"id":{"type":"integer","description":"Product id.","format":"int32","nullable":true},"length":{"maximum":9999.9999,"minimum":-9999.9999,"type":"number","description":"Length","format":"double","nullable":true},"manufacturer_sku":{"type":"string","description":"Manufacture SKU","nullable":true},"product_type":{"$ref":"#/components/schemas/ProductType"},"short_description":{"type":"string","description":"Product description.","nullable":true},"supplier":{"$ref":"#/components/schemas/SupplierLimited"},"supplier_sku":{"type":"string","description":"Supplier SKU.","nullable":true},"supplier_sku2":{"type":"string","description":"Supplier SKU2.","nullable":true},"weight":{"maximum":99999999.9999,"minimum":-99999999.9999,"type":"number","description":"Weight","format":"double","nullable":true},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"},"description":"Product attributes","nullable":true},"sales_channels":{"type":"array","items":{"$ref":"#/components/schemas/ProductSalesChannelVM"},"description":"Product Sales Chanels","nullable":true},"export_to_web":{"type":"boolean","description":"Export To Web","nullable":true},"package":{"type":"boolean","description":"Package"},"has_package_products":{"type":"boolean","description":"Has Package Products"},"last_sold_on":{"type":"string","description":"Last Processed Sold","format":"date-time","nullable":true},"require_serial_number":{"type":"integer","description":"Require SerialNumber","format":"int32"},"last_fulfiled_on":{"type":"string","description":"Last Fulfiled","format":"date-time","nullable":true},"external_links":{"type":"array","items":{"$ref":"#/components/schemas/ProductExternalLinks"},"description":"Product External Links.","nullable":true},"fixed_price_groups":{"type":"array","items":{"$ref":"#/components/schemas/ProductFixedPriceGroupVM"},"description":"Product Fixed Price Groups","nullable":true},"price_groups":{"type":"array","items":{"$ref":"#/components/schemas/ProductPriceGroupVM"},"description":"Product Standart Price Groups","nullable":true}},"additionalProperties":false},"ProductExternalLinks":{"title":"","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"url":{"type":"string","nullable":true}},"additionalProperties":false,"description":"Product External Links"},"ProductFixedPriceGroupVM":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Fixed Price Group Id.","format":"int32"},"name":{"type":"string","description":"Fixed Price Group Name.","nullable":true},"sell_price_inc":{"type":"number","description":"Fixed Price Group Price.","format":"double","nullable":true},"modified_on":{"type":"string","description":"Fixed Price Group Modified On.","format":"date-time","nullable":true}},"additionalProperties":false},"ProductInventory":{"title":"","type":"object","properties":{"outlet":{"$ref":"#/components/schemas/ProductInventoryOutlet"},"quantity_available":{"type":"integer","description":"Available Quantity","format":"int32"},"quantity_on_order":{"type":"integer","description":"On-order Quantity","format":"int32"}},"additionalProperties":false,"description":"Product Inventory Model"},"ProductInventoryOutlet":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Outlet Id","format":"int32"},"name":{"type":"string","description":"Name","nullable":true},"modified_on":{"type":"string","description":"Modified on","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Product Inventory Outlet Model"},"ProductLimited":{"title":"","type":"object","properties":{"manufacturer_sku":{"type":"string","description":"Manufacture SKU","nullable":true},"product_type":{"$ref":"#/components/schemas/ProductType"},"short_description":{"type":"string","description":"Product description.","nullable":true},"supplier_sku":{"type":"string","description":"Supplier SKU.","nullable":true},"supplier_sku2":{"type":"string","description":"Supplier SKU2.","nullable":true},"sales_channels":{"type":"array","items":{"$ref":"#/components/schemas/ProductSalesChannelVM"},"description":"Product Sales Chanels","nullable":true},"export_to_web":{"type":"boolean","description":"Export To Web","nullable":true},"package":{"type":"boolean","description":"Package"},"has_package_products":{"type":"boolean","description":"Has Package Products"},"last_sold_on":{"type":"string","description":"Last Processed Sold","format":"date-time","nullable":true},"require_serial_number":{"type":"integer","description":"Require SerialNumber","format":"int32"},"last_fulfiled_on":{"type":"string","description":"Last Fulfiled","format":"date-time","nullable":true},"id":{"type":"integer","format":"int32","nullable":true}},"additionalProperties":false},"ProductPriceGroupVM":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Name","nullable":true},"sell_price_inc":{"type":"number","description":"Calculated POS Price","format":"double"},"web_price_inc":{"type":"number","description":"Calculated Web Price","format":"double"},"modified_on":{"type":"string","format":"date-time"}},"additionalProperties":false},"ProductPricing":{"title":"","type":"object","properties":{"product_id":{"type":"integer","description":"Product Id","format":"int32"},"outlet_id":{"type":"integer","description":"Outlet Id","format":"int32"},"supplier_buy_ex":{"type":"number","description":"Supplier Buy Ex","format":"double","nullable":true},"direct_costs_ex":{"type":"number","description":"Direct Costs (Ex Tax)","format":"double","nullable":true},"cogs_ex":{"type":"number","description":"Cost of Goods Sold (Ex Tax)","format":"double","nullable":true},"sell_price_inc":{"type":"number","description":"Sell Price (Inc Tax)","format":"double","nullable":true},"promotional_price_inc":{"type":"number","description":"Promotional Price (Inc Tax)","format":"double","nullable":true},"promotional_price_start":{"type":"string","description":"Promotional Price Start","format":"date-time","nullable":true},"promotional_price_end":{"type":"string","description":"Promotional Price End","format":"date-time","nullable":true},"taxable":{"type":"boolean","description":"Is taxable"}},"additionalProperties":false},"ProductPricing.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProductPricing"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"ProductPricingLimited":{"title":"","type":"object","properties":{"product_id":{"type":"integer","description":"Product Id","format":"int32"},"outlet_id":{"type":"integer","description":"Outlet Id","format":"int32"},"sell_price_inc":{"type":"number","description":"Sell Price (Inc Tax)","format":"double","nullable":true},"promotional_price_inc":{"type":"number","description":"Promotional Price (Inc Tax)","format":"double","nullable":true},"promotional_price_start":{"type":"string","description":"Promotional Price Start","format":"date-time","nullable":true},"promotional_price_end":{"type":"string","description":"Promotional Price End","format":"date-time","nullable":true},"taxable":{"type":"boolean","description":"Is taxable"}},"additionalProperties":false},"ProductReplenishmentMethod":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Product Replenishment Method Id.","format":"int32","nullable":true},"code":{"type":"string","description":"Product Replenishment Method code.","nullable":true},"name":{"type":"string","description":"Product Replenishment Method name.","nullable":true}},"additionalProperties":false},"ProductReplenishmentMethod.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProductReplenishmentMethod"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"ProductSalesChannelVM":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Channel Id.","format":"int32"},"name":{"type":"string","description":"Channel Name.","nullable":true},"shopify_channel":{"type":"boolean","description":"Shopify Channel."},"source_group":{"$ref":"#/components/schemas/SourceGroupVM"},"enabled":{"type":"boolean","description":"Enabled."}},"additionalProperties":false},"ProductSupplier":{"title":"","type":"object","properties":{"product_id":{"type":"integer","description":"Product ID","format":"int32"},"supplier_code":{"type":"string","description":"Supplier Code","nullable":true},"supplier_name":{"type":"string","description":"Supplier Name","nullable":true},"supplier_status":{"type":"boolean","description":"Supplier Status (true - Enabled, false - Disabled)"},"supplier_buy_ex":{"maximum":922337203685477.6,"minimum":-922337203685477.6,"type":"number","description":"Supplier Buy Ex","format":"double","nullable":true},"supplier_sku2":{"type":"string","description":"Supplier SKU2","nullable":true},"lead_time":{"type":"integer","description":"Lead Time in days","format":"int32","nullable":true},"is_default":{"type":"boolean","description":"Indicates if the product supplier is a default supplier","nullable":true},"notes":{"type":"string","description":"Notes","nullable":true},"is_deleted":{"type":"boolean","description":"Indicates if the product supplier is soft deleted","nullable":true}},"additionalProperties":false},"ProductType":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Product type Id.","format":"int32","nullable":true},"name":{"maxLength":50,"minLength":0,"pattern":"^[a-zA-Z0-9\\s./;:\\-_+()*&^%$#@]+$","type":"string","description":"Product type description (Name)","nullable":true},"modified_on":{"type":"string","description":"Modified on","format":"date-time"}},"additionalProperties":false,"description":"Product Type Model"},"ProductType.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProductType"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"PurchaseOrder":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Purchase order id","format":"int32","nullable":true},"external_purchase_order_id":{"type":"string","description":"External purchase order id","nullable":true},"reference_purchase_order_id":{"type":"integer","description":"Reference purchase order id","format":"int32","nullable":true},"status":{"$ref":"#/components/schemas/PurchaseOrderStatus"},"outlet":{"$ref":"#/components/schemas/OutletLimited"},"supplier":{"$ref":"#/components/schemas/PurchaseOrderSupplier"},"sailed":{"type":"string","description":"Sailed date","format":"date-time","nullable":true},"deposit_due":{"type":"string","description":"Deposit due date","format":"date-time","nullable":true},"balance_due":{"type":"string","description":"balance due date","format":"date-time","nullable":true},"supplier_comments":{"type":"string","description":"Supplier comments","nullable":true},"purchase_order_template":{"type":"string","description":"Purchase order template","nullable":true},"update_linked_transfers_on_receipt_to":{"type":"string","description":"Update linked transfers on receipt to\r\nAvalable values are: qty_allocated or Allocate, qty_picked or Pick, qty_dispatched or Dispatch\r\nCan be updated only when PO has status Incomplete, OnOrder, ReceivingInProgress","nullable":true},"autoreplenishment_invoice_number":{"type":"string","description":"Autoreplenishment invoice number","nullable":true},"autoreplenishment_invoice_reference":{"type":"string","description":"Autoreplenishment invoice reference","nullable":true},"original_departure":{"type":"string","description":"Original departure","format":"date-time","nullable":true},"eta":{"type":"string","description":"Eta","format":"date-time","nullable":true},"container_number":{"type":"string","description":"Container number","nullable":true},"deliver_to":{"type":"string","description":"Deliver to","nullable":true},"shipping_status":{"$ref":"#/components/schemas/PurchaseOrderShippingStatus"},"shipping_type":{"$ref":"#/components/schemas/PurchaseOrderShippingType"},"shipping_port":{"$ref":"#/components/schemas/PurchaseOrderShippingPort"},"country_of_origin":{"$ref":"#/components/schemas/CountryLimited"},"shipping_terms":{"type":"string","description":"Shipping terms","nullable":true},"payment_terms":{"type":"string","description":"Payment terms","nullable":true},"invoice_documents":{"type":"string","description":"Invoice documents","nullable":true},"packing_list_documents":{"type":"string","description":"Packing list documents","nullable":true},"packing_declaration_documents":{"type":"string","description":"Packing declaration documents","nullable":true},"fumes_documents":{"type":"string","description":"Fumes documents","nullable":true},"certificate_of_original_documents":{"type":"string","description":"Certificate of original documents","nullable":true},"bill_of_lading_documents":{"type":"string","description":"Bill of lading documents","nullable":true},"internal_comments":{"type":"string","description":"Internal comments","nullable":true},"supplier_invoice_number":{"type":"string","description":"Supplier Invoice Number","nullable":true},"deposit":{"type":"number","description":"Deposit","format":"double","nullable":true},"purchase_order_items":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseOrderItem"},"description":"Purchase Order Items","nullable":true},"total_weight":{"type":"number","description":"Total weight","format":"double","nullable":true},"total_cubic":{"type":"number","description":"Total cubic","format":"double","nullable":true},"total_quantity_special_order":{"type":"integer","description":"Total quantity special order","format":"int64","nullable":true},"total_quantity_received":{"type":"integer","description":"Total quantity received","format":"int64","nullable":true},"total_quantity_remaining":{"type":"integer","description":"Total quantity remaining","format":"int64","nullable":true},"total_quantity_cancelled":{"type":"integer","description":"Total quantity cancelled","format":"int64","nullable":true},"total_quantity_ordered":{"type":"integer","description":"Total quantity ordered","format":"int64","nullable":true},"total_supplier_buy_ex":{"type":"number","description":"Total supplier buy ex","format":"double","nullable":true},"total_quantity_linked_transfers":{"type":"integer","description":"Total quantity linked transfers","format":"int32"},"fob_currency":{"$ref":"#/components/schemas/CurrencyLimited"},"created_on":{"type":"string","description":"Created on","format":"date-time","nullable":true},"modified_on":{"type":"string","description":"Modified on","format":"date-time"},"sent_on":{"type":"string","description":"Sent on","format":"date-time","nullable":true},"received_on":{"type":"string","description":"Received on","format":"date-time","nullable":true},"created_by":{"$ref":"#/components/schemas/UserExtended"},"modified_by":{"$ref":"#/components/schemas/UserExtended"}},"additionalProperties":false,"description":"Purchase order model"},"PurchaseOrder.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseOrder"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"PurchaseOrderItem":{"title":"","type":"object","properties":{"po_id":{"type":"integer","description":"Purchase Order entity Id","format":"int32"},"po_item_id":{"type":"integer","description":"Id of Purchase Order Item","format":"int32","nullable":true},"product":{"$ref":"#/components/schemas/Product"},"pricing":{"$ref":"#/components/schemas/ProductPricingLimited"},"quantity_ordered":{"type":"integer","description":"Quantity ordered","format":"int32"},"quantity_special_order":{"type":"integer","description":"Quantity special order","format":"int32"},"quantity_back_order":{"type":"integer","description":"Quantity back order","format":"int32"},"quantity_received":{"type":"integer","description":"Quantity received","format":"int32"},"quantity_received_variance":{"type":"integer","description":"Quantity received variance","format":"int32","nullable":true},"quantity_cancelled":{"type":"integer","description":"Quantity Cancelled","format":"int32","nullable":true},"quantity_remaining":{"type":"integer","description":"Quantity Remaining","format":"int32","nullable":true},"variance_reason":{"$ref":"#/components/schemas/PurchaseOrderItemVarianceReason"},"inventory":{"$ref":"#/components/schemas/PurchaseOrderItemInventory"},"supplier_buy_ex":{"type":"number","description":"Supplier Buy Ex","format":"double","nullable":true},"total_weight":{"type":"number","description":"Total weight","format":"double"},"total_cubic":{"type":"number","description":"Total cubic","format":"double"},"gross_profit":{"type":"number","description":"Gross profit","format":"double"},"mark_up":{"type":"number","description":"Mark Up","format":"double"},"total_supplier_buy_ex":{"type":"number","description":"Total supplier buy ex","format":"double"},"is_linked_to_transfer":{"type":"boolean","description":"Is Linked to ITO flag"},"modified_on":{"type":"string","description":"Last Modified On date","format":"date-time","nullable":true},"created_on":{"type":"string","description":"Created On date","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Purchase Order Item"},"PurchaseOrderItem.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseOrderItem"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"PurchaseOrderItemInventory":{"title":"","type":"object","properties":{"outlet":{"$ref":"#/components/schemas/OutletLimited"},"quantity_available":{"type":"integer","description":"Quantity Available","format":"int32","nullable":true},"quantity_on_order":{"type":"integer","description":"Quantity on order","format":"int32"},"msl":{"type":"integer","description":"MSL","format":"int32"}},"additionalProperties":false,"description":"Purchase Order Item Inventory"},"PurchaseOrderItemVarianceReason":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Variance Reason Id","format":"int32","nullable":true},"name":{"type":"string","description":"Name","nullable":true}},"additionalProperties":false,"description":"Purchase Order Item Variance Reason"},"PurchaseOrderLimited":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Purchase order id","format":"int32","nullable":true},"status":{"$ref":"#/components/schemas/PurchaseOrderStatus"},"eta":{"type":"string","description":"Eta","format":"date-time","nullable":true},"supplier_invoice_number":{"type":"string","description":"Supplier Invoice Number","nullable":true},"created_on":{"type":"string","description":"Created on","format":"date-time","nullable":true},"modified_on":{"type":"string","description":"Modified on","format":"date-time"},"received_on":{"type":"string","description":"Received on","format":"date-time","nullable":true},"created_by":{"$ref":"#/components/schemas/UserExtended"},"modified_by":{"$ref":"#/components/schemas/UserExtended"}},"additionalProperties":false,"description":"Purchase order model"},"PurchaseOrderReceiptItem":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Purchase order receipt item identifier","format":"int32","nullable":true},"purchase_order_item_id":{"type":"integer","description":"Purchase order item identifier","format":"int32","nullable":true},"pricing":{"$ref":"#/components/schemas/ProductPricingLimited"},"purchase_order_receipt_id":{"type":"integer","description":"Purchase order receipt identifier","format":"int32","nullable":true},"stock_receipt_id":{"type":"integer","description":"Stock receipt identifier","format":"int32","nullable":true},"quantity_expected":{"type":"integer","description":"Quantity expected","format":"int32","nullable":true},"quantity_received":{"type":"integer","description":"Quantity received","format":"int32"},"quantity_faulty":{"type":"integer","description":"Quantity faulty","format":"int32"},"quantity_invoiced":{"type":"integer","description":"Quantity invoiced","format":"int32","nullable":true},"buy_price_ex":{"type":"number","description":"Buy price ex","format":"double","nullable":true},"supplier_buy_ex":{"type":"number","description":"Supplier buy ex","format":"double","nullable":true},"unit_discount_ex":{"type":"number","description":"Unit discount ex","format":"double","nullable":true},"direct_costs_ex":{"type":"number","description":"Direct costs ex","format":"double"},"include_tax":{"type":"boolean","description":"Include tax","nullable":true},"quantity_received_variance":{"type":"integer","description":"Quantity received variance","format":"int32","nullable":true},"product":{"$ref":"#/components/schemas/ProductExtended"},"created_on":{"type":"string","description":"Created on","format":"date-time"},"created_by":{"$ref":"#/components/schemas/UserExtended"},"modified_on":{"type":"string","description":"Modified On","format":"date-time"},"modified_by":{"$ref":"#/components/schemas/UserExtended"},"made_available_on":{"type":"string","description":"Made Available On","format":"date-time","nullable":true},"made_available_by":{"$ref":"#/components/schemas/UserExtended"},"finalised_on":{"type":"string","description":"Finalised on","format":"date-time","nullable":true},"finalised_by":{"$ref":"#/components/schemas/UserExtended"},"total_buy_price_ex":{"type":"number","description":"Total buy price ex","format":"double","nullable":true},"bin":{"type":"string","description":"Bin","nullable":true},"cogs_ex":{"type":"number","description":"Cogs ex","format":"double"},"total_tax":{"type":"number","description":"Total tax","format":"double","nullable":true},"total_buy_price_inc":{"type":"number","description":"Total buy price inc","format":"double","nullable":true},"total_applied_buy_price_ex":{"type":"number","description":"Total applied buy price ex","format":"double","nullable":true},"total_direct_costs_ex":{"type":"number","description":"Total direct costs ex","format":"double","nullable":true},"total_cogs_ex":{"type":"number","description":"Total cogs ex","format":"double","nullable":true},"total_cogs_inc":{"type":"number","description":"Total cogs inc","format":"double","nullable":true},"variance_action":{"$ref":"#/components/schemas/VarianceAction"},"variance_reason":{"$ref":"#/components/schemas/PurchaseOrderReceiptItemVarianceReason"},"notes":{"type":"string","description":"Notes","nullable":true}},"additionalProperties":false,"description":"Purchase order receipt item"},"PurchaseOrderReceiptItem.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseOrderReceiptItem"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"PurchaseOrderReceiptItemVarianceReason":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Variance reason identifier","format":"int32"},"name":{"type":"string","description":"Variance reason name","nullable":true}},"additionalProperties":false,"description":"Purchase order receipt item variance reason"},"PurchaseOrderReceipts":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Purchase order receipts identifier","format":"int32","nullable":true},"purchase_order_id":{"type":"integer","description":"Purchase order identifier","format":"int32","nullable":true},"purchase_order_receipt_items":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseOrderReceiptItem"},"description":"Purchase order receipts items","nullable":true},"supplier_invoices":{"type":"array","items":{"$ref":"#/components/schemas/SupplierInvoiceLimited"},"description":"Purchase order receipt supplier invoices","nullable":true},"supplier_invoice_number":{"type":"string","description":"Supplier invoice number (max length = 50)","nullable":true},"status":{"$ref":"#/components/schemas/PurchaseOrderReceiptStatusName"},"created_on":{"type":"string","description":"Created on","format":"date-time"},"created_by":{"$ref":"#/components/schemas/UserExtended"},"modified_on":{"type":"string","description":"Modified On","format":"date-time"},"modified_by":{"$ref":"#/components/schemas/UserExtended"},"made_available_on":{"type":"string","description":"Made available on","format":"date-time","nullable":true},"made_available_by":{"$ref":"#/components/schemas/UserExtended"},"finalised_on":{"type":"string","description":"Finalised on","format":"date-time","nullable":true},"finalised_by":{"$ref":"#/components/schemas/UserExtended"},"total_buy_price_ex":{"type":"number","description":"Total buy price ex","format":"double","nullable":true},"total_products_received":{"type":"integer","description":"Total products received","format":"int32","nullable":true},"total_quantity_received":{"type":"integer","description":"Total quantity received","format":"int64","nullable":true},"total_quantity_expected":{"type":"integer","description":"Total quantity expected","format":"int64","nullable":true},"total_quantity_faulty":{"type":"integer","description":"Total quantity faulty","format":"int64","nullable":true},"total_quantity_received_variance":{"type":"integer","description":"Total quantity received variance","format":"int64","nullable":true},"total_quantity_invoiced":{"type":"integer","description":"Total quantity invoiced","format":"int64","nullable":true},"total_tax":{"type":"number","description":"Total tax","format":"double","nullable":true},"total_buy_price_inc":{"type":"number","description":"Total buy price inc","format":"double","nullable":true},"total_applied_buy_price_ex":{"type":"number","description":"Total applied buy price ex","format":"double","nullable":true},"total_direct_costs_ex":{"type":"number","description":"Total direct costs ex","format":"double","nullable":true},"total_cogs_ex":{"type":"number","description":"Total cogs ex","format":"double","nullable":true},"total_cogs_inc":{"type":"number","description":"Total cogs inc","format":"double","nullable":true}},"additionalProperties":false,"description":"Purchase order receipts model"},"PurchaseOrderReceipts.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseOrderReceipts"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"PurchaseOrderReceiptStatusName":{"title":"","enum":["Available","In Progress","Finalised"],"type":"string"},"PurchaseOrderShippingPort":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Shipping port identifier","format":"int32","nullable":true},"name":{"type":"string","description":"Shipping port name","nullable":true}},"additionalProperties":false,"description":"Purchase order shipping port model"},"PurchaseOrderShippingStatus":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Shipping status identifier","format":"int32","nullable":true},"name":{"type":"string","description":"Shipping status name","nullable":true}},"additionalProperties":false,"description":"Purchase order shipping status model"},"PurchaseOrderShippingType":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Shipping type identifier","format":"int32","nullable":true},"name":{"type":"string","description":"Shipping type name","nullable":true}},"additionalProperties":false,"description":"Purchase order shipping type model"},"PurchaseOrderStatus":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Status identifier","format":"int32","nullable":true},"name":{"type":"string","description":"Status name","nullable":true}},"additionalProperties":false,"description":"Purchase order status model"},"PurchaseOrderSupplier":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Supplier identifier","format":"int32","nullable":true},"name":{"type":"string","description":"Supplier name","nullable":true}},"additionalProperties":false,"description":"Purchase order supplier model"},"ReceiptVarianceReason":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Receipt Variance Reason Id.","format":"int32"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"Receipt Variance Reason name","nullable":true},"enabled":{"type":"boolean","description":"Is Receipt Variance Reason Enabled","default":true},"created_on":{"type":"string","description":"Created on","format":"date-time","nullable":true},"created_by":{"$ref":"#/components/schemas/UserExtended"},"modified_on":{"type":"string","description":"Modified on","format":"date-time","nullable":true},"modified_by":{"$ref":"#/components/schemas/UserExtended"}},"additionalProperties":false,"description":"Receipt Variance Reason Model"},"ReceiptVarianceReason.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ReceiptVarianceReason"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"ReturnReason":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Return Reason Id.","format":"int32"},"name":{"type":"string","description":"Return Reason name","nullable":true},"enabled":{"type":"boolean","description":"Return Reason enabled flag"},"created_on":{"type":"string","description":"Return Reason creation date and time","format":"date-time"},"modified_on":{"type":"string","description":"Return Reason modification date and time","format":"date-time"}},"additionalProperties":false,"description":"Return Reason Model"},"ReturnReason.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ReturnReason"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"ReturnReasonLimited":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Return Reason Id.","format":"int32"},"name":{"type":"string","description":"Return Reason name","nullable":true}},"additionalProperties":false,"description":"Return Reason Limited Model"},"SalesChannelLimited":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32","nullable":true},"name":{"maxLength":100,"minLength":0,"type":"string","description":"name","nullable":true},"shopify_channel":{"type":"boolean","description":"Is shopify channel"}},"additionalProperties":false},"ShipmentType":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32","nullable":true},"name":{"maxLength":50,"minLength":0,"type":"string","description":"name","nullable":true}},"additionalProperties":false,"description":"Shipment Type model"},"ShipmentType.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentType"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"ShippingStatus":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32","nullable":true},"name":{"maxLength":50,"minLength":0,"type":"string","description":"name","nullable":true}},"additionalProperties":false,"description":"Shipping Status model"},"ShippingStatus.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ShippingStatus"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"SourceGroupVM":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Source Group Id.","format":"int32","nullable":true},"name":{"type":"string","description":"Source Group Name.","nullable":true}},"additionalProperties":false},"StandardPriceGroup":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Name","nullable":true},"rule":{"$ref":"#/components/schemas/PriceGroupRule"},"modified_on":{"type":"string","format":"date-time"}},"additionalProperties":false},"StandardPriceGroup.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/StandardPriceGroup"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"StockAdjustmentReason":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Stock Adjustment Reason Id.","format":"int32"},"name":{"type":"string","description":"Stock Adjustment Reason name","nullable":true},"disabled":{"type":"boolean","description":"Stock Adjustment Reason disabled flag"},"created_on":{"type":"string","description":"Stock Adjustment Reason creation date and time","format":"date-time"},"modified_on":{"type":"string","description":"Stock Adjustment Reason modification date and time","format":"date-time"}},"additionalProperties":false,"description":"Stock Adjustment Reason Model"},"StockAdjustmentReason.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/StockAdjustmentReason"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"StockReceipt":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Stock receipt id","format":"int32"},"source_type":{"type":"string","description":"Source type Available values: 'PO' or 'ITO'","nullable":true},"source_id":{"type":"integer","description":"Source id \r\nrepresents id of source - can be for either dbo.PO or dbo.tblITO","format":"int32"},"source_item_id":{"type":"integer","description":"Source item id \r\nrepresents id of source item","format":"int32","nullable":true},"source_receipt_item_id":{"type":"integer","description":"Source receipt item id\r\nrepresents id of receipt item","format":"int32","nullable":true},"product":{"$ref":"#/components/schemas/ProductExtended"},"outlet":{"$ref":"#/components/schemas/OutletExtended"},"received_quantity":{"type":"integer","description":"Received quantity (must be > 0)","format":"int32"},"buy_price_ex":{"type":"number","description":"Buy price ex (must be >= 0)","format":"double"},"direct_costs_ex":{"type":"number","description":"Direct costs ex","format":"double"},"tax_rate":{"type":"number","description":"Tax rate","format":"double"},"created_on":{"type":"string","description":"Created on","format":"date-time"}},"additionalProperties":false,"description":"Stock Receipt model"},"StockReceipt.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/StockReceipt"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"StoreType":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32","nullable":true},"name":{"type":"string","description":"Store type name","nullable":true}},"additionalProperties":false,"description":"Sore type model"},"String.BeforeAfter":{"title":"","type":"object","properties":{"before":{"type":"string","description":"Before","nullable":true},"after":{"type":"string","description":"After","nullable":true}},"additionalProperties":false},"Supplier":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Supplier Id","format":"int32","nullable":true},"supplier_code":{"maxLength":20,"minLength":0,"type":"string","description":"Supplier Code","nullable":true},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Supplier Name","nullable":true},"address":{"$ref":"#/components/schemas/SupplierAddress"},"phone":{"maxLength":20,"minLength":0,"type":"string","description":"Supplier Phone Number","nullable":true},"fax":{"maxLength":20,"minLength":0,"type":"string","description":"Supplier Fax Number","nullable":true},"contact_name":{"maxLength":50,"minLength":0,"type":"string","description":"Supplier Contact Name","nullable":true},"contact_email":{"maxLength":120,"minLength":0,"type":"string","description":"Supplier Contact Email","format":"email","nullable":true},"order_email":{"maxLength":120,"minLength":0,"type":"string","description":"Supplier Order Email","format":"email","nullable":true},"admin_only_orders":{"type":"boolean","description":"Admin Only Orders Flag"},"deposit_required":{"type":"boolean","description":"Deposit Required Flag"},"shipping_port":{"$ref":"#/components/schemas/SupplierShippingPort"},"country_of_origin":{"$ref":"#/components/schemas/CountryLimited"},"shipping_terms":{"maxLength":50,"minLength":0,"type":"string","description":"Supplier Shipping Terms","nullable":true},"payment_terms":{"maxLength":50,"minLength":0,"type":"string","description":"Supplier Payment Terms","nullable":true},"comments":{"maxLength":255,"minLength":0,"pattern":"^[^*|\":<>[\\]{}`\\()';@&$#!-/?]+$","type":"string","description":"Supplier Comments","nullable":true},"purchase_order_template":{"type":"string","description":"Supplier Purchase Order Template type","nullable":true},"po_sku1_enabled":{"type":"boolean","description":"PO SKU 1 Enabled (FALSE by default)","nullable":true},"po_sku2_enabled":{"type":"boolean","description":"PO SKU 2 Enabled (TRUE by default)","nullable":true},"is_enabled":{"type":"boolean","description":"Is enabled flag"},"modified_on":{"type":"string","description":"Modified On","format":"date-time"}},"additionalProperties":false,"description":"Supplier model"},"Supplier.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Supplier"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"SupplierAddress":{"title":"","type":"object","properties":{"address_line1":{"maxLength":255,"minLength":0,"type":"string","description":"Address line 1","nullable":true},"suburb":{"maxLength":50,"minLength":0,"type":"string","description":"Suburb","nullable":true},"state":{"maxLength":50,"minLength":0,"type":"string","description":"State","nullable":true},"postcode":{"maxLength":10,"minLength":0,"type":"string","description":"Post code","nullable":true},"country":{"$ref":"#/components/schemas/CountryLimited"}},"additionalProperties":false,"description":"Supplier address model"},"SupplierInvoice":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Id","format":"int32"},"supplier_invoice_number":{"type":"string","description":"Supplier Invoice Number","nullable":true},"status":{"type":"string","description":"Supplier Invoice status","nullable":true},"notes":{"type":"string","description":"Supplier Invoice notes","nullable":true},"international_order":{"type":"boolean","description":"Is International Order"},"landed_costs_calculation":{"$ref":"#/components/schemas/LandedCostsCalculation"},"currency_conversion":{"type":"number","description":"Currency multiplier","format":"double","nullable":true},"rounding_adjustment":{"type":"number","description":"Rounding Adjustment","format":"double"},"origin_country":{"$ref":"#/components/schemas/CountryLimited"},"distribute_costs_by":{"type":"string","description":"Distribute costs by","nullable":true},"direct_costs":{"$ref":"#/components/schemas/DirectCosts"},"purchase_order_receipts":{"type":"array","items":{"$ref":"#/components/schemas/SupplierInvoicePurchaseOrderReceipt"},"description":"Purchase Order Receipts","nullable":true},"total_buy_price_ex":{"type":"number","description":"Total buy price ex","format":"double"},"total_tax":{"type":"number","description":"Total tax","format":"double","nullable":true},"total_buy_price_inc":{"type":"number","description":"Total buy price inc","format":"double","nullable":true},"total_applied_buy_price_ex":{"type":"number","description":"Total applied buy price ex","format":"double","nullable":true},"created_on":{"type":"string","description":"Created on","format":"date-time"},"created_by":{"$ref":"#/components/schemas/UserExtended"},"modified_on":{"type":"string","description":"Modified on","format":"date-time","nullable":true},"modified_by":{"$ref":"#/components/schemas/UserExtended"},"finalised_on":{"type":"string","description":"Finalised on","format":"date-time","nullable":true},"finalised_by":{"$ref":"#/components/schemas/UserExtended"},"supplier_invoiced_on":{"type":"string","description":"Supplier Invoiced On","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Suplier Invoice Model"},"SupplierInvoice.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SupplierInvoice"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"SupplierInvoiceDirectCosts":{"title":"","type":"object","properties":{"applied_on":{"type":"string","description":"DirectCosts AppliedOn","format":"date-time","nullable":true},"apply_pending":{"type":"boolean","description":"Is DirectCosts Apply Pending"},"freight":{"$ref":"#/components/schemas/DirectCostsItem"},"duty":{"$ref":"#/components/schemas/DirectCostsItem"},"misc":{"$ref":"#/components/schemas/DirectCostsItem"}},"additionalProperties":false,"description":"Supplier Invoice Direct Costs Model"},"SupplierInvoiceLimited":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Id","format":"int32"},"supplier_invoice_number":{"type":"string","description":"Supplier Invoice Number","nullable":true},"international_order":{"type":"boolean","description":"Is International Order"},"landed_costs_calculation":{"$ref":"#/components/schemas/LandedCostsCalculation"},"currency_conversion":{"type":"number","description":"Currency multiplier","format":"double","nullable":true},"rounding_adjustment":{"type":"number","description":"Rounding Adjustment","format":"double"},"origin_country":{"$ref":"#/components/schemas/CountryLimited"},"supplier_invoiced_on":{"type":"string","description":"Supplier Invoiced On","format":"date-time","nullable":true}},"additionalProperties":false},"SupplierInvoicePurchaseOrderReceipt":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"PurchaseOrderReceipt Id","format":"int32","nullable":true},"purchase_order_id":{"type":"integer","description":"Purchase order identifier","format":"int32","nullable":true},"purchase_order_receipt_items":{"type":"array","items":{"$ref":"#/components/schemas/SupplierInvoicePurchaseOrderReceiptItem"},"description":"Purchase order receipts items","nullable":true}},"additionalProperties":false,"description":"Supplier Invoice Purchase Order Receipt Model"},"SupplierInvoicePurchaseOrderReceiptItem":{"title":"","type":"object","properties":{"purchase_order_item_id":{"type":"integer","description":"Purchase order item identifier","format":"int32","nullable":true},"buy_price_ex":{"type":"number","description":"Buy price ex","format":"double","nullable":true},"supplier_buy_ex":{"type":"number","description":"Supplier buy ex","format":"double","nullable":true},"quantity_received":{"type":"integer","description":"Quantity received","format":"int32"},"quantity_faulty":{"type":"integer","description":"Quantity faulty","format":"int32"},"quantity_invoiced":{"type":"integer","description":"Quantity invoiced","format":"int32","nullable":true},"bin":{"type":"string","description":"Bin","nullable":true},"include_tax":{"type":"boolean","description":"Include tax","nullable":true},"notes":{"type":"string","description":"Notes","nullable":true}},"additionalProperties":false,"description":"Purchase order receipt item"},"SupplierLimited":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Supplier Id","format":"int32","nullable":true},"supplier_code":{"maxLength":20,"minLength":0,"type":"string","description":"Supplier Code","nullable":true},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Supplier Name","nullable":true},"is_enabled":{"type":"boolean","description":"Is enabled flag"},"modified_on":{"type":"string","description":"Modified On","format":"date-time"}},"additionalProperties":false},"SupplierReturnItem":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Supplier Return Item identifier","format":"int32"},"supplier_return_id":{"type":"integer","description":"Supplier Return id","format":"int32"},"product":{"$ref":"#/components/schemas/SupplierReturnItemProduct"},"supplier_return_reason":{"$ref":"#/components/schemas/SupplierReturnReasons"},"credit_note_item":{"$ref":"#/components/schemas/CreditNoteItemExtended"},"return_quantity":{"type":"integer","description":"Return Quantity","format":"int32","nullable":true},"original_buy_ex":{"type":"number","description":"Supplier price ex","format":"double","nullable":true},"total_original_buy_ex":{"type":"number","description":"Total supplier buy ex","format":"double","nullable":true},"supplier_return_item_status":{"$ref":"#/components/schemas/SupplierReturnItemStatus"},"supplier_return_item_source":{"$ref":"#/components/schemas/SupplierReturnItemSource"},"original_supplier_invoice":{"type":"string","description":"Supplier invoice number","nullable":true},"claim_amount_ex":{"type":"number","description":"Claim amount ex","format":"double","nullable":true},"supplier_return_item_notes":{"type":"string","description":"Notes","nullable":true},"total_claim_amount_ex":{"type":"number","description":"Total claim amount ex","format":"double","nullable":true},"total_claim_amount_tax":{"type":"number","description":"Total claim amount tax","format":"double","nullable":true},"total_claim_amount_inc":{"type":"number","description":"Total claim amount inc","format":"double","nullable":true},"created_on":{"type":"string","description":"Created on","format":"date-time"},"modified_on":{"type":"string","description":"Modified on","format":"date-time"},"created_by":{"$ref":"#/components/schemas/UserExtended"},"modified_by":{"$ref":"#/components/schemas/UserExtended"}},"additionalProperties":false,"description":"Supplier Return Item"},"SupplierReturnItem.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SupplierReturnItem"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"SupplierReturnItemProduct":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Product Id.","format":"int32","nullable":true},"supplier_sku":{"type":"string","description":"Supplier SKU.","nullable":true},"manufacturer_sku":{"type":"string","description":"Manufacture SKU","nullable":true},"supplier_sku2":{"type":"string","description":"Supplier SKU 2.","nullable":true},"short_description":{"type":"string","description":"Product description.","nullable":true},"size":{"$ref":"#/components/schemas/AttributeValueLimited"},"colour":{"$ref":"#/components/schemas/AttributeValueLimited"}},"additionalProperties":false,"description":"Supplier Return Item Product Model"},"SupplierReturnItemSource":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Supplier Return Item source Id.","format":"int32","nullable":true},"name":{"type":"string","description":"Supplier Return Item source name","nullable":true}},"additionalProperties":false,"description":"Supplier Return Item Product Model"},"SupplierReturnItemSource.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SupplierReturnItemSource"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"SupplierReturnItemStatus":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Supplier Return Item Status Id.","format":"int32","nullable":true},"name":{"type":"string","description":"Supplier Return Item Status name","nullable":true}},"additionalProperties":false,"description":"Supplier Return Item Status Model"},"SupplierReturnItemStatus.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SupplierReturnItemStatus"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"SupplierReturnReasons":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Supplier Return Reason Id.","format":"int32","nullable":true},"name":{"type":"string","description":"Supplier Return Reason name","nullable":true},"created_on":{"type":"string","description":"Created on","format":"date-time"},"modified_on":{"type":"string","description":"Modified on","format":"date-time"},"deleted":{"type":"boolean","description":"Is Supplier Return Reason deleted","default":false},"deleted_on":{"type":"string","description":"Deleted on","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Supplier Return Reason model"},"SupplierReturnReasons.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SupplierReturnReasons"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"SupplierReturns":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Supplier Return identifier","format":"int32","nullable":true},"include_tax":{"type":"boolean","description":"Include Tax","default":true,"nullable":true},"supplier":{"$ref":"#/components/schemas/SupplierLimited"},"outlet":{"$ref":"#/components/schemas/OutletExtended"},"supplier_return_status":{"$ref":"#/components/schemas/SupplierReturnStatus"},"supplier_address":{"$ref":"#/components/schemas/SupplierAddress"},"total_return_quantity":{"type":"integer","description":"Total return quantity","format":"int64"},"total_claim_amount_ex":{"type":"number","description":"Total claim amount ex","format":"double"},"total_claim_amount_tax":{"type":"number","description":"Total claim amount tax","format":"double"},"total_claim_amount_inc":{"type":"number","description":"Total claim amount inc","format":"double"},"total_credit_received_ex":{"type":"number","description":"Total credit received ex","format":"double"},"total_credit_received_inc":{"type":"number","description":"Total credit received inc","format":"double"},"notes":{"maxLength":8000,"minLength":0,"type":"string","description":"Notes","nullable":true},"return_authorisation":{"maxLength":100,"minLength":0,"type":"string","description":"Return Authorisation","nullable":true},"started_on":{"type":"string","description":"Started on","format":"date-time","nullable":true},"created_on":{"type":"string","description":"Created on","format":"date-time"},"modified_on":{"type":"string","description":"Modified on","format":"date-time"},"finalised_on":{"type":"string","description":"Finalised on","format":"date-time","nullable":true},"credit_notes":{"type":"array","items":{"$ref":"#/components/schemas/CreditNote"},"description":"Credit Notes linked to Supplier Return","nullable":true},"created_by":{"$ref":"#/components/schemas/UserExtended"},"modified_by":{"$ref":"#/components/schemas/UserExtended"}},"additionalProperties":false,"description":"Supplier Returns VM"},"SupplierReturns.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SupplierReturns"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"SupplierReturnsCreditNote":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Credit Note id","format":"int32","nullable":true},"supplier_return_id":{"type":"integer","description":"Supplier Return id","format":"int32","nullable":true},"supplier":{"$ref":"#/components/schemas/SupplierLimited"},"outlet":{"$ref":"#/components/schemas/OutletExtended"},"supplier_reference":{"maxLength":50,"minLength":0,"type":"string","description":"Supplier reference","nullable":true},"include_tax":{"type":"boolean","description":"Include tax","default":false,"nullable":true},"rounding_adjustment":{"type":"number","description":"Rounding Adjustment","format":"double"},"total_credit_quantity":{"type":"integer","description":"Total credit quantity","format":"int32"},"total_credit_amount_ex":{"type":"number","description":"Total Credit Amount Ex","format":"double"},"total_credit_amount_tax":{"type":"number","description":"Total Credit Amount Tax","format":"double"},"total_credit_amount_inc":{"type":"number","description":"Total Credit Amount Inc","format":"double"},"total_applied_credit_quantity":{"type":"integer","description":"Total Applied Credit Quantity","format":"int32"},"total_applied_credit_amount_ex":{"type":"number","description":"Total Applied Credit Amount Ex","format":"double"},"total_applied_credit_amount_inc":{"type":"number","description":"Total Applied Credit Amount Inc","format":"double"},"total_applied_credit_tax":{"type":"number","description":"Total Applied Credit Tax","format":"double"},"credit_note_items":{"type":"array","items":{"$ref":"#/components/schemas/CreditNoteItemLimited"},"description":"List of Credit Note items","nullable":true},"created_on":{"type":"string","description":"Created on","format":"date-time"},"modified_on":{"type":"string","description":"Modified on","format":"date-time"},"supplier_credited_on":{"type":"string","description":"Supplier Credited On","format":"date-time","nullable":true},"created_by":{"$ref":"#/components/schemas/UserExtended"},"modified_by":{"$ref":"#/components/schemas/UserExtended"}},"additionalProperties":false,"description":"Credit Note model for ​/supplierreturn​/{id}​/creditnotes endpoint"},"SupplierReturnsCreditNote.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SupplierReturnsCreditNote"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"SupplierReturnStatus":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Supplier Return Status Id.","format":"int32","nullable":true},"name":{"type":"string","description":"Supplier Return Status name","nullable":true}},"additionalProperties":false,"description":"Supplier Return Status Model"},"SupplierReturnStatus.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SupplierReturnStatus"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"SupplierShippingPort":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Supplier shipping port id","format":"int32"},"name":{"maxLength":100,"minLength":0,"type":"string","description":"Supplier shipping port name","nullable":true}},"additionalProperties":false},"SupplierShippingPort.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SupplierShippingPort"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"SurveyResponse":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Survey response id","format":"int32"},"question":{"type":"string","description":"Survey response question","nullable":true},"answer":{"type":"string","description":"Survey response answer","nullable":true}},"additionalProperties":false,"description":"Survey Response model"},"Transfer":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Transfer Identifier","format":"int32","nullable":true},"status":{"$ref":"#/components/schemas/TransferStatus"},"transfer_type":{"$ref":"#/components/schemas/TransferType"},"outlet_from":{"$ref":"#/components/schemas/OutletLimited"},"outlet_to":{"$ref":"#/components/schemas/OutletLimited"},"notes":{"type":"string","description":"Notes","nullable":true},"approved":{"type":"boolean","description":"Approved"},"approved_by":{"$ref":"#/components/schemas/UserExtended"},"purchase_order":{"$ref":"#/components/schemas/PurchaseOrderLimited"},"order":{"$ref":"#/components/schemas/OrderLimited"},"created_by":{"$ref":"#/components/schemas/UserExtended"},"created_on":{"type":"string","description":"Created On","format":"date-time"},"modified_on":{"type":"string","description":"Modified On","format":"date-time","nullable":true},"total_picked_buy_price_ex":{"type":"number","description":"Total Picked Buy Price Ex","format":"double","nullable":true},"total_picked_direct_costs_ex":{"type":"number","description":"Total Picked Direct Costs Ex","format":"double","nullable":true},"total_picked_cogs_ex":{"type":"number","description":"Total Picked Cogs Ex","format":"double","nullable":true},"transfer_items":{"type":"array","items":{"$ref":"#/components/schemas/TransferItem"},"description":"Transfer Items","nullable":true},"simple_mode":{"type":"boolean","description":"Simple Mode"}},"additionalProperties":false,"description":"Transfer model"},"Transfer.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Transfer"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"TransferItem":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Transfer Item Identifier","format":"int32","nullable":true},"transfer_id":{"type":"integer","description":"Transfer Identifier","format":"int32"},"product":{"$ref":"#/components/schemas/ProductExtended"},"quantity_proposed":{"type":"integer","description":"Quantity Proposed","format":"int32","nullable":true},"quantity_requested":{"type":"integer","description":"Quantity Requested","format":"int32","nullable":true},"quantity_allocated":{"type":"integer","description":"Quantity Allocated","format":"int32","nullable":true},"quantity_picked":{"type":"integer","description":"Quantity Picked","format":"int32","nullable":true},"quantity_dispatched":{"type":"integer","description":"Quantity Dispatched","format":"int32","nullable":true},"quantity_received":{"type":"integer","description":"Quantity Received","format":"int32","nullable":true},"quantity_made_available":{"type":"integer","description":"Quantity Made Available","format":"int32","nullable":true},"buy_price_ex":{"type":"number","description":"Buy Price Ex","format":"double","nullable":true},"direct_costs_ex":{"type":"number","description":"Direct Costs Ex","format":"double","nullable":true},"commited_on":{"type":"string","description":"Commited On","format":"date-time","nullable":true},"created_on":{"type":"string","description":"Created On","format":"date-time","nullable":true},"modified_on":{"type":"string","description":"Modified On","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Transfer Item model"},"TransferItem.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TransferItem"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"TransferStatus":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Id","format":"int32"},"name":{"type":"string","description":"Type Name","nullable":true}},"additionalProperties":false,"description":"Transfer Status"},"TransferStatus.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TransferStatus"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"TransferType":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Id","format":"int32"},"name":{"type":"string","description":"Type Name","nullable":true}},"additionalProperties":false,"description":"Transfer Type"},"TransferType.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TransferType"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"User":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Id.","format":"int32","nullable":true},"user_code":{"type":"string","description":"User code.","nullable":true},"first_name":{"type":"string","description":"First name.","nullable":true},"surname":{"type":"string","description":"Surname.","nullable":true},"security_profile":{"$ref":"#/components/schemas/UserSecurityProfile"},"is_admin":{"type":"boolean","description":"Is admin."},"enabled":{"type":"boolean","description":"Is enabled.","nullable":true},"modified_on":{"type":"string","description":"Modified on","format":"date-time","nullable":true},"outlets":{"type":"array","items":{"$ref":"#/components/schemas/UserOutlet"},"description":"Contain list of outlets that user has access to","nullable":true},"stock_outlets":{"type":"array","items":{"$ref":"#/components/schemas/UserOutlet"},"description":"Contain list of stock outlets that user has access to","nullable":true}},"additionalProperties":false,"description":"User model"},"User.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/User"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"UserExtended":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Id.","format":"int32","nullable":true},"user_code":{"type":"string","description":"User code.","nullable":true},"first_name":{"type":"string","description":"First name.","nullable":true},"surname":{"type":"string","description":"Surname.","nullable":true}},"additionalProperties":false},"UserLimited":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Id.","format":"int32","nullable":true},"user_code":{"type":"string","description":"User code.","nullable":true},"first_name":{"type":"string","description":"First name.","nullable":true},"surname":{"type":"string","description":"Surname.","nullable":true}},"additionalProperties":false},"UserOutlet":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Id.","format":"int32"},"name":{"type":"string","description":"Name.","nullable":true}},"additionalProperties":false,"description":"User outlet model"},"UserSecurityProfile":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Id","format":"int32","nullable":true},"name":{"type":"string","description":"Security profile name","nullable":true}},"additionalProperties":false,"description":"User security profile model"},"V2.CustomerType":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Customer type identifier","format":"int32"},"name":{"maxLength":60,"minLength":0,"type":"string","description":"Customer type name","nullable":true},"active":{"type":"boolean","description":"Customer type active","nullable":true},"default":{"type":"boolean","description":"Customer type default","nullable":true},"deleted":{"type":"boolean","description":"Customer type deleted","nullable":true},"modified_on":{"type":"string","description":"Customer type last modified","format":"date-time"}},"additionalProperties":false,"description":"Customer type model"},"V2.CustomerType.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/V2.CustomerType"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"VarianceAction":{"title":"","enum":["Leave On-Order","Cancel Balance","Receive Balance","Review Later","Create Supplier Return"],"type":"string"},"Voucher":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Voucher Id.","format":"int32","nullable":true},"code":{"type":"string","description":"Voucher code","nullable":true},"type":{"$ref":"#/components/schemas/VoucherTypeLimited"},"initial_value":{"type":"number","description":"Initial value","format":"double","nullable":true},"balance":{"type":"number","description":"Balance","format":"double","nullable":true},"created_on":{"type":"string","description":"Created on","format":"date-time"},"expires_on":{"type":"string","description":"Modified on","format":"date-time","nullable":true},"order":{"$ref":"#/components/schemas/OrderLimited"}},"additionalProperties":false},"Voucher.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Voucher"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"VoucherType":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Voucher type Id.","format":"int32","nullable":true},"name":{"type":"string","description":"Voucher type code","nullable":true},"voucher_text":{"type":"string","description":"Voucher type code","nullable":true},"valid_for_days":{"type":"integer","description":"Voucher type code","format":"int32","nullable":true}},"additionalProperties":false},"VoucherType.PagingResponse":{"title":"","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VoucherType"},"nullable":true},"page_number":{"type":"integer","format":"int32"},"page_size":{"type":"integer","format":"int32"},"total_records":{"type":"integer","format":"int32"}},"additionalProperties":false},"VoucherTypeLimited":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Voucher type Id.","format":"int32","nullable":true},"name":{"type":"string","description":"Voucher name","nullable":true}},"additionalProperties":false},"VoucherVoucherType":{"title":"","type":"object","properties":{"id":{"type":"integer","description":"Voucher type Id.","format":"int32","nullable":true},"name":{"type":"string","description":"Voucher type code","nullable":true}},"additionalProperties":false}},"securitySchemes":{}},"security":[],"tags":[{"name":"countries"},{"name":"creditnotes"},{"name":"currencies"},{"name":"customerlogs"},{"name":"customers"},{"name":"customersurveysegments"},{"name":"customertypes"},{"name":"freighttypes"},{"name":"fulfilmentorders"},{"name":"inventory"},{"name":"inventorymovementlogs"},{"name":"loyaltyadjustmentreasons"},{"name":"loyaltyadjustments"},{"name":"loyaltyhistory"},{"name":"maxdiscountrules"},{"name":"orderfulfilments"},{"name":"orderitems"},{"name":"orderpayments"},{"name":"orders"},{"name":"outlets"},{"name":"pricegroups"},{"name":"productattributes"},{"name":"productbarcodes"},{"name":"productdetailslog"},{"name":"producteta"},{"name":"productprices"},{"name":"productreplenishmentmethods"},{"name":"products"},{"name":"producttypes"},{"name":"purchaseorderreceipts"},{"name":"purchaseorders"},{"name":"receiptvariancereasons"},{"name":"returnreasons"},{"name":"shipmenttypes"},{"name":"shippingports"},{"name":"shippingstatus"},{"name":"stockadjustmentreasons"},{"name":"stockreceipts"},{"name":"supplierinvoices"},{"name":"supplierreturnitemsource"},{"name":"supplierreturnitemstatus"},{"name":"supplierreturnreasons"},{"name":"supplierreturns"},{"name":"supplierreturnstatus"},{"name":"suppliers"},{"name":"token"},{"name":"transferitems"},{"name":"transfers"},{"name":"transferstatus"},{"name":"transfertypes"},{"name":"users"},{"name":"vouchers"},{"name":"vouchertypes"}]} ```