{"info":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"20959885","collectionId":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","publishedId":"UyxnEQdR","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"111111","highlight":"EF5B25"},"publishDate":"2022-05-19T10:38:01.000Z"},"item":[{"name":"Introduction","item":[{"name":"Authorization","id":"dcb8908b-bcd9-457d-8c76-a89a806875ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/oauth/token?grant_type=authorization_code&client_id=&code=
&client_secret=&redirect_uri=","description":"Required Headers
\nThere are two required headers for most calls:
\n\nContent-Type: application/json
\nAuthorization: Bearer
\n
\nWe need those two to understand and authenticate your call. The black code pane on this page shows an example of a call that sends these headers correctly.
\nCreating your application on Reactive
\nCreate an account by visiting our sign up page. If you already have a Reactive account, log in by visiting our log in page.
\n\nOnce you login to the admin go to the top right drop down and click on Apps.
\nFrom that page create a new app. Make sure to include the name of the application and redirect URI in the application form. The name of the application has to be unique as it will be used to display on the Reactive app store and on a Reactive's user’s integrations page once they have connected with your application. The redirect URI should be an endpoint in your application that will receive the authorization code and will use it to retrieve the bearer token and refresh token. These will be necessary to make authenticated calls to the Reactive API. To get more information on our authentication process visit our Oauth documentation.
\nSave your application.
\n
\nBefore you start
\nHere’s a quick checklist of some of the things we require to consider any integration an A+ integration:
\nIt's always better to test your integration before you push it to production.
\n\nGo to the top right drop menu and click on Sandbox.
\nFrom there create a sandbox account that you can use to test your integration.
\nAfter creating the sandbox account you will see it in the list of accounts and you can quickly access it from your admin.
\nClick the three vertical dots on the sandbox account you have created and go to your sandbox admin.
\nFrom there follow the steps above to create an app and also go to the administrators page to invite your developers.
\nYou can easily purge data from the sandbox account at any time or entirely delete it and create another. This makes it very easy for you to test as much you want to.
\n
\nReach our Developer Experts Team
\nStay connected to the latest with the Reactive API by joining our mailing list.
\nIf you would like to list your application on our App Store send us an email at: developers@reactiveonline.io
\nReactive API use the OAuth 2.0 protocol for authentication and authorization.
OAuth2 is an authorization framework that enables applications to obtain limited access to user accounts over HTTP. It is used by services like Google, Facebook, Stripe, and Slack. This method creates a token that lasts for 2 hours to keep your account secure and connected. For more details about OAuth2 itself, check out: the official documentation.
\nBasic Flow
\n\nA user visits your Authorization link, which you supply on your admin, and which we supply clickable versions of under app settings on your app management page. They are sent to an Authorization page that Reactive hosts.
\nThe user logs in and sees the Scopes your App will have access to and clicks ‘Authorize’. For now all scopes are available via the v.1 API.
\nThey are redirected back to your website which you provided in the app settings (redirect URI), with a ‘code’ parameter in the URL known as the ‘authorization code’.
\nYou send us a request from your server containing the authorization code, your client id, client secret, and the redirect URI the user followed
\nWe return to you a pair of tokens, an access token (called a Bearer token) and a refresh token (used to get a new access token when it expires).
\nYour app can now make successful calls on that user’s behalf using the Bearer token. Congrats!
\n
\nRedirect URI Limitations
\nFor security reasons, redirect URIs must specify HTTPS as their protocol. While testing/developing your application, if you are unable to set up a self signed certificate to use or to work in a secured public test environment, you may manually change the URL to HTTP in your browser to complete the connection.
\nRedirect URIs also cannot contain query string parameters. Your application may instead url-encode arbitrary data and pass into an Authorize link via an additional state parameter. That state parameter and its value will be inserted into the Redirect URI when the client is sent there after granting permission to your application to continue.
\nMultiple Redirect URIs are not yet allowed per application. We are working on having those in the future.
\nIf you wish to manage that complexity yourself, you can request a Bearer and Refresh token pair from our auth/token endpoint using the process described in the code pane on this page.
\nAuthorization URL
\nAuthorization URLs for your Reactive integration will look like the following:
\nhttps:///oauth/authorize/?response_type=code&redirect_uri=&client_id=&state=
\nUse a Library!
\nIf you’re a developer of a web application using Python, Ruby, or Javascript, it’s recommended that you use a popular library written in your language of choice to manage the details of connecting via OAuth2. Such libraries typically provide configuration options for you to include your client_id, client_secret, and redirect_uri, then allow you to make higher level calls in your program to initiate or refresh authorization.
\nAsk us!
\nOAuth can get pretty complicated. If you’ve given this all a try and read as much documentation as you can find and you’re still running into problems, shoot us an email at developers@reactiveonline.io with information about what you’re doing, what you tried, and what went wrong, and we’ll do our best to help.
\nGood luck!
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["oauth","token"],"host":[""],"query":[{"key":"grant_type","value":"authorization_code"},{"key":"client_id","value":""},{"key":"code","value":""},{"key":"client_secret","value":""},{"key":"redirect_uri","value":""}],"variable":[]}},"response":[],"_postman_id":"dcb8908b-bcd9-457d-8c76-a89a806875ea"},{"name":"Refresh Token","id":"c39725d6-98ac-4421-a24f-c08e729e5eea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/oauth/token?grant_type=refresh_token&client_id=&refresh_token=&client_secret=&redirect_uri=","description":"Refresh Tokens and Token Lifespans
\nBearer Tokens are not long lived. They last for 2 hours, after which they are no longer able to authenticate requests, and may produce different errors depending upon the service being called. The remedy to use in these situations is a Refresh Token.
\nRefresh Tokens live forever, but are one-time-use, and only one Refresh Token can be alive at any time per user per application. A new Refresh Token is generated every time a Bearer Token is issued for a given user of a given application, and all old Refresh Tokens immediately become invalid. Make sure that whenever you receive a new Bearer Token, you write its companion Refresh token down somewhere safe to refresh your access, or you’ll have to re-authorize your application again manually.
\nBearer Tokens don’t interfere with each other’s lives the same way, so you could have several valid Bearer Tokens at any given point in time. They only expire when you manually POST to the token/revoke endpoint or when their time runs out.
\nMaking a Refresh Token Call
\nMake a Refresh call by following the same template shown in the code pane on this page, but supply a grant type of ‘refresh_token’ instead of ‘authorization’, and instead of a ‘code’ argument, supply a ‘refresh_token’ argument with the most recent Refresh Token you were granted.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["oauth","token"],"host":[""],"query":[{"key":"grant_type","value":"refresh_token"},{"key":"client_id","value":""},{"key":"refresh_token","value":""},{"key":"client_secret","value":""},{"key":"redirect_uri","value":""}],"variable":[]}},"response":[],"_postman_id":"c39725d6-98ac-4421-a24f-c08e729e5eea"},{"name":"API Rate Limits","id":"f6fb1b10-3c10-492e-b793-2fa1cab46cc1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"To ensure our platform remains stable and fair for everyone, all Reactive Online APIs are rate-limited. We use a variety of strategies to enforce rate limits. We ask developers to use industry standard techniques for limiting calls, caching results, and re-trying requests responsibly.
\nCompare rate limits by API
\nReactive Online APIs use several different rate-limiting methods. They’re described in more detail below, but these are the key figures in brief:
\nThe leaky bucket algorithm
\nAll Reactive Online APIs use a leaky bucket algorithm to manage requests. This algorithm lets your app make an unlimited amount of requests in infrequent bursts over time.
\nThe main points to understand about the leaky bucket metaphor are as follows:
\n\nEach app has access to a bucket. It can hold, say, 60 “marbles”.
\nEach second, a marble is removed from the bucket (if there are any). That way there’s always more room.
\nEach API request requires you to toss a marble in the bucket.
\nIf the bucket gets full, you get an error and have to wait for room to become available in the bucket.
\n
\nThis model ensures that apps that manage API calls responsibly will always have room in their buckets to make a burst of requests if needed. For example, if you average 20 requests (“marbles”) per second but suddenly need to make 30 requests all at once, you can still do so without hitting your rate limit.
\nThe basic principles of the leaky bucket algorithm apply to all our rate limits, regardless of the specific methods used to apply them.
\nRate limiting methods
\nReactive Online uses three different methods for managing rate limits. Different APIs use different methods depending on use case, so make sure you understand the various types of rate limits your apps will encounter:
\nRequest-based limits
\nApps can make a maximum number of requests per minute. For example: 40 API requests within 60 seconds. Each request counts equally, regardless of how much or how little data is returned.
\nThis method is used by the REST API.
\nTime-based limits
\nApps can make requests that take a maximum amount of time per minute. For example: 120 requests within 60 seconds, with each request taking 0.5 seconds to return. More complex requests take longer, and therefore take up a proportionally larger share of the limit.
\nThis method is used by the Storefront API.
\nMaximum input array size limit
\nInput arguments that accept an array have a maximum size of 250. Queries and mutations return an error if an input array exceeds 250 items
\nBulk operations
\nTo query and fetch large amounts of data, you should use bulk operations instead of single queries. Bulk operations are designed for handling large amounts of data, and they don't have the max cost limits or rate limits that single queries have.
\nREST API rate limits
\nCalls to the REST API are governed by request-based limits, which means you should consider the total number of API calls your app makes. In addition, there are resource-based rate limits and throttles.
\nREST API rate limits are based on the combination of the app and store. This means that calls from one app don't affect the rate limits of another app, even on the same store. Similarly, calls to one store don't affect the rate limits of another store, even from the same app.
\nLimits are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket. You can see the current state of the throttle for a store by using the rate limits header.
\nThe bucket size and leak rate properties determine the API’s burst behavior and request rate.
\nThe default settings are as follows:
\n\nBucket size: 40 requests/app/store
\nLeak rate: 2/second
\n
\nRate limits header
\nYou can check how many requests you’ve already made using the Reactive Online X-Reactive-Api-Call-Limit header that was sent in response to your API request. This header lists how many requests you’ve made for a particular store. For example:
\nCopy
\n1X-Reactive-Api-Call-Limit: 32/40\n\n
\nIn this example, 32 is the current request count and 40 is the bucket size. The request count decreases according to the leak rate over time. For example, if the header displays 39/40 requests, then after a wait period of ten seconds, the header displays 19/40 requests.
\nRetry-After header
\nWhen a request goes over a rate limit, a 429 Too Many Requests error and a Retry-After header are returned. The Retry-After header contains the number of seconds to wait until you can make a request again. Any request made before the wait time has elapsed is throttled.
\nCopy
\n1X-Reactive-Api-Call-Limit: 40/402  Retry-After: 2.0\n\n
Bucket limit example
\nSuppose the client makes several parallel API requests when a user loads your app:
\n\n20 simple queries that each take 0.5 seconds or less
\n15 more complex queries that take 1 second each
\n10 highly complex queries that take 2 seconds each
\n
\nThe total cost would be: (20 ⨉ 0.5) + (15 ⨉ 1.0) + (10 ⨉ 2.0) = 45 seconds.
\nIn this scenario you would still have 15 seconds’ worth of queries available.
\nMaximum input array size limit
\nInput arguments that accept an array have a maximum size of 250. Queries and mutations return an error if an input array exceeds 250 items.
\nResource-based rate limits
\nThe following API resources, have an additional throttle that takes effect when a store has 50,000 product variants. After this threshold is reached, no more than 1,000 new variants can be created per day.
\nIn certain cases, Reactive Online needs to enforce rate limiting in order to prevent abuse of the platform. Therefore, your app should be prepared to handle rate limiting on all endpoints, rather than just those listed here.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"f6fb1b10-3c10-492e-b793-2fa1cab46cc1"}],"id":"77ae8ac4-9228-4b14-a7c1-e7204595ce2c","description":"Introduction
\nThe Reactive API is an interface for accessing your Reactive's data using JSON. The API makes it easy to create web applications that integrate with your account. Possible uses for it include automatically creating and updating products, orders, pulling lists of client information, copying data to 3rd party services, and more.
\nCheck out our API Reference sections to see what to expect, and when you’re ready, sign up for a Reactive account if you don’t have one, and proceed to the developer page to create an application and start development.
\nQuick Start
\nThe column on the right-hand side has a curl call that demonstrates the required Headers and general format of requests to the Reactive API.
\nRequests are authenticated using OAuth2 Bearer tokens which you receive in exchange for a code we issue after a logged-in user performs an authorization grant request. You can create an OAuth application and get a client id and secret in your developer page
\n","_postman_id":"77ae8ac4-9228-4b14-a7c1-e7204595ce2c","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}},{"name":"Retail endpoints","item":[{"name":"Product(s)","item":[{"name":"Variant(s)","item":[{"name":"List Variants","id":"3ad30659-4b68-45a6-bb60-0495c9ff5548","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/products/product_uid/variants?page=1","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","products","product_uid","variants"],"host":[""],"query":[{"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"3ad30659-4b68-45a6-bb60-0495c9ff5548"},{"name":"Get Single Variant","id":"7939201e-6a9a-481c-9ac9-29629a5264ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/products/product_uid/variants/variant_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","products","product_uid","variants","variant_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"7939201e-6a9a-481c-9ac9-29629a5264ae"},{"name":"Delete Variant","id":"c7adf3c2-a49a-4a0a-aa45-73dac5541763","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/admapi/v1/products/product_uid/variants/variant_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","products","product_uid","variants","variant_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"c7adf3c2-a49a-4a0a-aa45-73dac5541763"},{"name":"Create Variant","id":"d712a570-023a-47ca-92aa-fa237a8e83cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"variant\": {\n        \"sku\": \"00001451\",\n        \"price\": 12,\n        \"compare_to_price\": 16,\n        \"weight\": 1.4,\n        \"max_purchasable_quantity\": 6,\n        \"product_api_uid\": 773307306839123,\n        \"variant_order_status\": {\n            \"can_backorder\": false,\n            \"can_preorder\": true,\n            \"available_on\": \"2023-11-26\"\n        },\n        \"options\": [249178860921123, 38063772404345],\n        \"variant_image_url\": \"https//example.com/image1.jpg\",\n        \"prices\": [{\n            \"price_list_uid\": 941615867930123, \n            \"price\": 9, \n            \"compare_to_price\": 16 \n        },{\n            \"price_list_uid\": 445643306463345, \n            \"price\": 11, \n            \"compare_to_price\": 20 \n        }],\n        \"stock_items\": [\n            {\n                \"store_uid\": 444686109884789,\n                \"quantity\": 15\n            },{\n                \"store_uid\": 699304110431123,\n                \"quantity\": 35\n            }\n        ],\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"custom-field-key-1\", \n                \"value\": \"custom-field-value-1\",\n                \"type\": \"text\"\n            },\n            \"custom_field2\": {\n                \"key\": \"custom-field-key-2\", \n                \"value\": \"custom-field-value-2\",\n                \"type\": \"html\"\n            }, \n            \"custom_field3\": {\n                \"key\": \"custom-field-key-3\", \n                \"value\": \"custom-field-value-3\",\n                \"type\": \"json\"\n            },\n            \"custom_field4\": {\n                \"key\": \"custom-field-key-4\", \n                \"value\": \"custom-field-value-4\",\n                \"type\": \"text\"\n            },\n            \"custom_field5\": {\n                \"key\": \"custom-field-key-5\", \n                \"value\": \"custom-field-value-5\",\n                \"type\": \"text\"\n            },\n            \"custom_field6\": {\n                \"key\": \"custom-field-key-6\", \n                \"value\": \"custom-field-value-6\",\n                \"type\": \"text\"\n            },\n            \"custom_field7\": {\n                \"key\": \"custom-field-key-7\", \n                \"value\": \"custom-field-value-7\",\n                \"type\": \"text\"\n            },\n            \"custom_field8\": {\n                \"key\": \"custom-field-key-8\", \n                \"value\": \"custom-field-value-8\",\n                \"type\": \"text\"\n            },\n            \"custom_field9\": {\n                \"key\": \"custom-field-key-9\", \n                \"value\": \"custom-field-value-9\",\n                \"type\": \"text\"\n            },\n            \"custom_field10\": {\n                \"key\": \"custom-field-key-10\", \n                \"value\": \"custom-field-value-10\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/products/product_uid/variants","description":"Creates a variant
\nA custom field value can be of type html, text or json
\"available_on\" accepts string of form \"YYYY-MM-DD\"
Can have only one option from a option type
\nParameters
\n{\n    \"variant\": {\n        \"sku\": \"00001451\",\n        \"price\": 12,\n        \"compare_to_price\": 16,\n        \"weight\": 1.4,\n        \"max_purchasable_quantity\": 6,\n        \"product_api_uid\": 773307306839123,\n        \"variant_order_status\": {\n            \"can_backorder\": false,\n            \"can_preorder\": true,\n            \"available_on\": \"2023-11-26\"\n        },\n        \"options\": [249178860921123, 38063772404345],\n        \"variant_image_url\": \"https//example.com/image1.jpg\",\n        \"prices\": [{\n            \"price_list_uid\": 941615867930123, \n            \"price\": 9, \n            \"compare_to_price\": 16 \n        },{\n            \"price_list_uid\": 445643306463345, \n            \"price\": 11, \n            \"compare_to_price\": 20 \n        }],\n        \"stock_items\": [\n            {\n                \"store_uid\": 444686109884789,\n                \"quantity\": 15\n            },{\n                \"store_uid\": 699304110431123,\n                \"quantity\": 35\n            }\n        ],\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"custom-field-key-1\", \n                \"value\": \"custom-field-value-1\",\n                \"type\": \"text\"\n            },\n            \"custom_field2\": {\n                \"key\": \"custom-field-key-2\", \n                \"value\": \"custom-field-value-2\",\n                \"type\": \"html\"\n            }, \n            \"custom_field3\": {\n                \"key\": \"custom-field-key-3\", \n                \"value\": \"custom-field-value-3\",\n                \"type\": \"json\"\n            },\n            \"custom_field4\": {\n                \"key\": \"custom-field-key-4\", \n                \"value\": \"custom-field-value-4\",\n                \"type\": \"text\"\n            },\n            \"custom_field5\": {\n                \"key\": \"custom-field-key-5\", \n                \"value\": \"custom-field-value-5\",\n                \"type\": \"text\"\n            },\n            \"custom_field6\": {\n                \"key\": \"custom-field-key-6\", \n                \"value\": \"custom-field-value-6\",\n                \"type\": \"text\"\n            },\n            \"custom_field7\": {\n                \"key\": \"custom-field-key-7\", \n                \"value\": \"custom-field-value-7\",\n                \"type\": \"text\"\n            },\n            \"custom_field8\": {\n                \"key\": \"custom-field-key-8\", \n                \"value\": \"custom-field-value-8\",\n                \"type\": \"text\"\n            },\n            \"custom_field9\": {\n                \"key\": \"custom-field-key-9\", \n                \"value\": \"custom-field-value-9\",\n                \"type\": \"text\"\n            },\n            \"custom_field10\": {\n                \"key\": \"custom-field-key-10\", \n                \"value\": \"custom-field-value-10\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}\n\n
\nWe send a variant object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
sku String The sku of the variant
price Float The price of the variant
compare_to_price Float The compare to price of the variant
weight Float The weight of the variant(kg)
max_purchasable_quantity Integer Maximum purchasable quantity of variant per order
product_api_uid Bigint Api uid of product that variant is based on
variant_order_status Object An object with variant's order status parameters
can_backorder Boolean Whether the variant can be ordered regardless of its available stock
can_preorder Boolean Whether the variant can be ordered before it comes to stock
available_on String The date that variant will be available
options Array An array of product option's api uids that define the variant
variant_image_url String The url of variant's image
prices Array An array of variant's price list prices
price_list_uid Bigint Price list's api uid
stock_items Array An array of variant's stock items
store_uid Bigint Api uid of stock item's store
quantity Integer Quantity of variant in the store
custom_fields Array An array of the category's custom fields
key String Key of the custom field
value String Value of the custom field
type String What type is the value of custom field
\n
Response
\n{\n    \"response\": {\n        \"variant\": {\n            \"uid\": 209253706666865,\n            \"sku\": \"00001451\",\n            \"compare_to_price\": 16.0,\n            \"price\": 12.0,\n            \"upc\": \"\",\n            \"weight\": \"1.4\",\n            \"options\": [\n                {\n                    \"option_uid\": 249178860921535,\n                    \"option_type_uid\": 176873152631259\n                },\n                {\n                    \"option_uid\": 38063772404705,\n                    \"option_type_uid\": 840761750808776\n                }\n            ],\n            \"images\": [\n                {\n                    \"id\": 12116,\n                    \"file_name\": \"Apple_i_Phone_Pro_max_OR_DUO_1f265af478.png\",\n                    \"thumbnail\": \"https://storage.googleapis.com/myshop_1665646692/products/fd2599895fcf4ccc51f6ec7294fea6f6e394cb90/thumbnails/apple_i_phone_pro_max_or_duo_1f265af478_1691763841.png\",\n                    \"preview\": \"https://storage.googleapis.com/myshop_1665646692/products/fd2599895fcf4ccc51f6ec7294fea6f6e394cb90/previews/apple_i_phone_pro_max_or_duo_1f265af478_1691763841.png\",\n                    \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/fd2599895fcf4ccc51f6ec7294fea6f6e394cb90/lists/apple_i_phone_pro_max_or_duo_1f265af478_1691763841.png\",\n                    \"banner\": \"https://storage.googleapis.com/myshop_1665646692/products/fd2599895fcf4ccc51f6ec7294fea6f6e394cb90/banners/apple_i_phone_pro_max_or_duo_1f265af478_1691763841.png\"\n                }\n            ],\n            \"stock_items\": [\n                {\n                    \"store_uid\": 444686109884420,\n                    \"quantity\": 15,\n                    \"created_at\": \"11/08/2023 14:24:01\",\n                    \"updated_at\": \"11/08/2023 14:24:01\"\n                },\n                {\n                    \"store_uid\": 699304110431578,\n                    \"quantity\": 35,\n                    \"created_at\": \"11/08/2023 14:24:01\",\n                    \"updated_at\": \"11/08/2023 14:24:01\"\n                },\n                {\n                    \"store_uid\": 346326890542861,\n                    \"quantity\": null,\n                    \"created_at\": \"11/08/2023 14:24:01\",\n                    \"updated_at\": \"11/08/2023 14:24:01\"\n                },\n                {\n                    \"store_uid\": 473251864538157,\n                    \"quantity\": null,\n                    \"created_at\": \"11/08/2023 14:24:01\",\n                    \"updated_at\": \"11/08/2023 14:24:01\"\n                },\n                {\n                    \"store_uid\": 512592570248121,\n                    \"quantity\": null,\n                    \"created_at\": \"11/08/2023 14:24:01\",\n                    \"updated_at\": \"11/08/2023 14:24:01\"\n                }\n            ],\n            \"created_at\": \"11/08/2023 14:24:01\",\n            \"updated_at\": \"11/08/2023 14:24:01\"\n        },\n        \"custom_fields\": [],\n        \"logs\": []\n    }\n}\n\n
\nReturns a new variant object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the variant
sku String The sku of the variant
compare_to_price Float The compare to price of variant
price Float The price of the variant
upc String The UPC of the variant
weight Float The weight of the variant(kg)
options Array An array of variant's options
option_uid Bigint The ID of product option
option_type_uid Bigint The ID of product option type
images Array An array of variant's images
id Int The ID of variant image
file_name String Name of variant's image file
thumbnail String URL of variant's thumbnail image
preview String URL of variant's preview image
list_view String URL of variant's list view image
banner String URL of variant's banner image
stock_items Array URL of variant's banner image
store_uid Bigint URL of variant's banner image
quantity Int URL of variant's banner image
created_at DateTime When the item was created.
updated_at DateTime When the item was last updated.
\n
Also return an array of variant's custom fields and an array of logs about the POST .
\nErrors
\nExample: missing product
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"product_not_found\",\n        \"message\": \"Parent product with specified uid does not exist\"\n    }\n}\n\n
\nExample: empty options
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"empty_options\",\n        \"message\": \"You must select at least one product option\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","products","product_uid","variants"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"d712a570-023a-47ca-92aa-fa237a8e83cf"},{"name":"Update Variant","id":"b6cfadb7-5cbe-4046-a0a8-75e145f5d18b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n    \"variant\": {\n        \"sku\": \"00001455\",\n        \"price\": 15,\n        \"compare_to_price\": 26,\n        \"weight\": 1.2,\n        \"max_purchasable_quantity\": 12,\n        \"product_api_uid\": 773307306839469,\n        \"variant_image_url\": \"https//example.com/image1.jpg\",\n        \"variant_order_status\": {\n            \"can_backorder\": true,\n            \"can_preorder\": false,\n            \"available_on\": null\n        },\n        \"options\": [249178860921123],\n        \"stock_items\": [\n            {\n                \"store_uid\": 444686109884789,\n                \"quantity\": 15\n            },{\n                \"store_uid\": 699304110431123,\n                \"quantity\": 35\n            }\n        ],\n        \"prices\": [{\n            \"price_list_uid\": 941615867930123, \n            \"price\": 12, \n            \"compare_to_price\": 25 \n        },{\n            \"price_list_uid\": 445643306463345, \n            \"price\": 14, \n            \"compare_to_price\": 30 \n        }],\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"custom-field-key-1\", \n                \"value\": \"custom-field-value-1\",\n                \"type\": \"text\"\n            },\n            \"custom_field2\": {\n                \"key\": \"custom-field-key-2\", \n                \"value\": \"custom-field-value-2\",\n                \"type\": \"html\"\n            }, \n            \"custom_field3\": {\n                \"key\": \"custom-field-key-3\", \n                \"value\": \"custom-field-value-3\",\n                \"type\": \"json\"\n            },\n            \"custom_field4\": {\n                \"key\": \"custom-field-key-4\", \n                \"value\": \"custom-field-value-4\",\n                \"type\": \"text\"\n            },\n            \"custom_field5\": {\n                \"key\": \"custom-field-key-5\", \n                \"value\": \"custom-field-value-5\",\n                \"type\": \"text\"\n            },\n            \"custom_field6\": {\n                \"key\": \"custom-field-key-6\", \n                \"value\": \"custom-field-value-6\",\n                \"type\": \"text\"\n            },\n            \"custom_field7\": {\n                \"key\": \"custom-field-key-7\", \n                \"value\": \"custom-field-value-7\",\n                \"type\": \"text\"\n            },\n            \"custom_field8\": {\n                \"key\": \"custom-field-key-8\", \n                \"value\": \"custom-field-value-8\",\n                \"type\": \"text\"\n            },\n            \"custom_field9\": {\n                \"key\": \"custom-field-key-9\", \n                \"value\": \"custom-field-value-9\",\n                \"type\": \"text\"\n            },\n            \"custom_field10\": {\n                \"key\": \"custom-field-key-10\", \n                \"value\": \"custom-field-value-10\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/products/product_uid/variants/variant_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","products","product_uid","variants","variant_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"b6cfadb7-5cbe-4046-a0a8-75e145f5d18b"}],"id":"6d845f5d-b280-4a01-93c0-74028ae4c1a1","_postman_id":"6d845f5d-b280-4a01-93c0-74028ae4c1a1","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}},{"name":"List Products","id":"7dcb351e-992c-42e5-9210-eadd5a7177a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/products?page=1&keyword=product_keyword&prototype_uid=product_prototype_uid&only_published=product_only_published","description":"Returns a list of products and bundles.
\nParameters
\npage <**_**Integer> -_ Indicates the page of products to fetch. If not specified the first page is returned.
\nkeyword <**_**String> -_ Indicates a search term for products.
\nprototype_uid <**_**Bigint> -_ The ID of a category. If specified, products of only this category will be returned.
\nonly_published <**_**Boolean> -_ Indicates whether to fetch unpublished products. If not specified unpublished products are returned too.
\nResponse
\n{\n    \"response\": {\n        \"products\": [\n            {\n                \"uid\": 66961353639720,\n                \"type\": \"product\",\n                \"translations\": [\n                    {\n                        \"title\": \"Starfield Collector's Edition For Xbox Series X\",\n                        \"subtitle\": \"\",\n                        \"slug\": \"starfield-collectors-edition-for-xbox-series-x\",\n                        \"description\": \"\",\n                        \"locale\": \"en\"\n                    },\n                    {\n                        \"title\": \"Starfield Collector's Edition For Xbox Series X\",\n                        \"subtitle\": \"\",\n                        \"slug\": \"starfield-collectors-edition-for-xbox-series-x-932342\",\n                        \"description\": \"\",\n                        \"locale\": \"el\"\n                    }\n                ],\n                \"sku\": \"18700332\",\n                \"compare_to_price\": 222.0,\n                \"price\": 123.99,\n                \"published\": true,\n                \"prototype_uid\": 508610039944329,\n                \"attributes\": [\n                    {\n                        \"uid\": 52551778438350,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 605218566287547,\n                        \"prototype_attribute_key\": \"UPC\",\n                        \"created_at\": \"31/08/2023 09:12:39\",\n                        \"updated_at\": \"31/08/2023 09:12:44\"\n                    },\n                    {\n                        \"uid\": 539404257675281,\n                        \"filterable_key\": \"bethesda\",\n                        \"translations\": [\n                            {\n                                \"title\": \"Bethesda\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"Bethesda\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 75427828319792,\n                        \"prototype_attribute_key\": \"Brand\",\n                        \"created_at\": \"31/08/2023 09:12:39\",\n                        \"updated_at\": \"31/08/2023 09:12:44\"\n                    },\n                    {\n                        \"uid\": 709255984541221,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 341868595651900,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"31/08/2023 09:12:39\",\n                        \"updated_at\": \"31/08/2023 09:12:44\"\n                    },\n                    {\n                        \"uid\": 965823280502370,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 925098014791791,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"31/08/2023 09:12:39\",\n                        \"updated_at\": \"31/08/2023 09:12:44\"\n                    },\n                    {\n                        \"uid\": 961368379231464,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 140055824201294,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"31/08/2023 09:12:39\",\n                        \"updated_at\": \"31/08/2023 09:12:44\"\n                    },\n                    {\n                        \"uid\": 48602618395287,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 216976544688651,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"31/08/2023 09:12:39\",\n                        \"updated_at\": \"31/08/2023 09:12:44\"\n                    }\n                ],\n                \"meta_tags\": {\n                    \"translations\": [\n                        {\n                            \"title\": \"test title\",\n                            \"description\": \"test description \",\n                            \"keywords\": \"keyword_one, keyword_two\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"og_images\": []\n                },\n                \"option_types\": [\n                    {\n                        \"uid\": 334702311955931,\n                        \"filterable_key\": \"test_option_type_one\",\n                        \"input_type\": 0,\n                        \"preselect_default\": true,\n                        \"translations\": [\n                            {\n                                \"title\": \"test option type one\",\n                                \"locale\": \"el\"\n                            },\n                            {\n                                \"title\": \"test option type one eng\",\n                                \"locale\": \"en\"\n                            }\n                        ],\n                        \"options\": [\n                            {\n                                \"uid\": 311792935687528,\n                                \"filterable_key\": \"test_option_one\",\n                                \"translations\": [\n                                    {\n                                        \"title\": \"test option one\",\n                                        \"locale\": \"el\"\n                                    },\n                                    {\n                                        \"title\": \"test option one eng\",\n                                        \"locale\": \"en\"\n                                    }\n                                ],\n                                \"price_operator\": 0,\n                                \"price_operand\": 0,\n                                \"price\": 5.0,\n                                \"display_price_value\": \"+€5\",\n                                \"default\": true,\n                                \"created_at\": \"20/09/2023 09:05:28\",\n                                \"updated_at\": \"20/09/2023 11:47:03\"\n                            },\n                            {\n                                \"uid\": 520547302133366,\n                                \"filterable_key\": \"test_option_two\",\n                                \"translations\": [\n                                    {\n                                        \"title\": \"test option two\",\n                                        \"locale\": \"el\"\n                                    },\n                                    {\n                                        \"title\": \"test option two eng\",\n                                        \"locale\": \"en\"\n                                    }\n                                ],\n                                \"price_operator\": 0,\n                                \"price_operand\": 0,\n                                \"price\": 11.0,\n                                \"display_price_value\": \"+€11\",\n                                \"default\": false,\n                                \"created_at\": \"20/09/2023 09:05:28\",\n                                \"updated_at\": \"20/09/2023 11:47:03\"\n                            }\n                        ],\n                        \"created_at\": \"20/09/2023 09:05:28\",\n                        \"updated_at\": \"20/09/2023 11:47:03\"\n                    }\n                ],\n                \"variants\": [\n                    {\n                        \"uid\": 277032461709847,\n                        \"type\": \"variant\",\n                        \"translations\": [\n                            {\n                                \"title\": \"Starfield Collector's Edition For Xbox Series X\",\n                                \"subtitle\": \"\",\n                                \"slug\": \"starfield-collectors-edition-for-xbox-series-x\",\n                                \"description\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"Starfield Collector's Edition For Xbox Series X\",\n                                \"subtitle\": \"\",\n                                \"slug\": \"starfield-collectors-edition-for-xbox-series-x-932342\",\n                                \"description\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"sku\": \"18700332\",\n                        \"compare_to_price\": 0.0,\n                        \"price\": 80.6,\n                        \"upc\": \"\",\n                        \"weight\": \"1.0\",\n                        \"options\": [\n                            {\n                                \"option_uid\": 311792935687528,\n                                \"option_type_uid\": 334702311955931\n                            }\n                        ],\n                        \"option_types\": [\n                            {\n                                \"uid\": 334702311955931,\n                                \"filterable_key\": \"test_option_type_one\",\n                                \"input_type\": 0,\n                                \"preselect_default\": true,\n                                \"translations\": [\n                                    {\n                                        \"title\": \"test option type one\",\n                                        \"locale\": \"el\"\n                                    },\n                                    {\n                                        \"title\": \"test option type one eng\",\n                                        \"locale\": \"en\"\n                                    }\n                                ],\n                                \"options\": [\n                                    {\n                                        \"uid\": 311792935687528,\n                                        \"filterable_key\": \"test_option_one\",\n                                        \"translations\": [\n                                            {\n                                                \"title\": \"test option one\",\n                                                \"locale\": \"el\"\n                                            },\n                                            {\n                                                \"title\": \"test option one eng\",\n                                                \"locale\": \"en\"\n                                            }\n                                        ],\n                                        \"price_operator\": 0,\n                                        \"price_operand\": 0,\n                                        \"price\": 5.0,\n                                        \"display_price_value\": \"+€5\",\n                                        \"default\": true,\n                                        \"created_at\": \"20/09/2023 09:05:28\",\n                                        \"updated_at\": \"20/09/2023 11:47:03\"\n                                    },\n                                    {\n                                        \"uid\": 520547302133366,\n                                        \"filterable_key\": \"test_option_two\",\n                                        \"translations\": [\n                                            {\n                                                \"title\": \"test option two\",\n                                                \"locale\": \"el\"\n                                            },\n                                            {\n                                                \"title\": \"test option two eng\",\n                                                \"locale\": \"en\"\n                                            }\n                                        ],\n                                        \"price_operator\": 0,\n                                        \"price_operand\": 0,\n                                        \"price\": 11.0,\n                                        \"display_price_value\": \"+€11\",\n                                        \"default\": false,\n                                        \"created_at\": \"20/09/2023 09:05:28\",\n                                        \"updated_at\": \"20/09/2023 11:47:03\"\n                                    }\n                                ],\n                                \"created_at\": \"20/09/2023 09:05:28\",\n                                \"updated_at\": \"20/09/2023 11:47:03\"\n                            }\n                        ],\n                        \"images\": [\n                            {\n                                \"id\": 12136,\n                                \"file_name\": \"18700332.jpg\",\n                                \"thumbnail\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/thumbnails/18700332_1693473159.jpg\",\n                                \"preview\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/previews/18700332_1693473159.jpg\",\n                                \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/lists/18700332_1693473159.jpg\",\n                                \"banner\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/banners/18700332_1693473159.jpg\"\n                            }\n                        ],\n                        \"max_purchasable_quantity\": null,\n                        \"max_product_quantity\": 14,\n                        \"order_status\": {\n                            \"can_backorder\": true,\n                            \"can_preorder\": false,\n                            \"available_on\": null\n                        },\n                        \"created_at\": \"20/09/2023 09:51:12\",\n                        \"updated_at\": \"20/09/2023 09:51:12\",\n                        \"display_total_compare_to_price\": \"€0.00\",\n                        \"display_price\": \"€65.00\",\n                        \"display_tax_price\": \"€15.60\",\n                        \"display_total_price\": \"€80.60\",\n                        \"on_sale\": false,\n                        \"on_sale_percentage\": null,\n                        \"show_price\": true,\n                        \"has_tax\": true,\n                        \"stock_items\": [\n                            {\n                                \"store\": {\n                                    \"uid\": 346326890542861,\n                                    \"translations\": [\n                                        {\n                                            \"title\": \"Warehouse - Nicosia Store\",\n                                            \"locale\": \"el\"\n                                        }\n                                    ],\n                                    \"email\": \"\",\n                                    \"visible\": true,\n                                    \"pickup_allowed\": true,\n                                    \"created_at\": \"13/02/2023 10:04:49\",\n                                    \"updated_at\": \"24/08/2023 10:22:02\"\n                                },\n                                \"quantity\": 0,\n                                \"created_at\": \"20/09/2023 09:51:12\",\n                                \"updated_at\": \"20/09/2023 09:51:12\"\n                            },\n                            {\n                                \"store\": {\n                                    \"uid\": 473251864538157,\n                                    \"translations\": [\n                                        {\n                                            \"title\": \"Nicosia Store\",\n                                            \"locale\": \"el\"\n                                        }\n                                    ],\n                                    \"email\": \"\",\n                                    \"visible\": true,\n                                    \"pickup_allowed\": true,\n                                    \"created_at\": \"13/02/2023 10:05:10\",\n                                    \"updated_at\": \"15/06/2023 12:02:12\"\n                                },\n                                \"quantity\": 0,\n                                \"created_at\": \"20/09/2023 09:51:13\",\n                                \"updated_at\": \"20/09/2023 09:51:13\"\n                            },\n                            {\n                                \"store\": {\n                                    \"uid\": 444686109884420,\n                                    \"translations\": [\n                                        {\n                                            \"title\": \"Limassol Store\",\n                                            \"locale\": \"el\"\n                                        }\n                                    ],\n                                    \"email\": \"\",\n                                    \"visible\": true,\n                                    \"pickup_allowed\": true,\n                                    \"created_at\": \"13/02/2023 10:05:26\",\n                                    \"updated_at\": \"15/06/2023 12:02:12\"\n                                },\n                                \"quantity\": 33,\n                                \"created_at\": \"20/09/2023 09:51:13\",\n                                \"updated_at\": \"20/09/2023 09:51:13\"\n                            },\n                            {\n                                \"store\": {\n                                    \"uid\": 512592570248121,\n                                    \"translations\": [\n                                        {\n                                            \"title\": \"Pafos Store\",\n                                            \"locale\": \"el\"\n                                        }\n                                    ],\n                                    \"email\": \"safdsfdaaaffffa\",\n                                    \"visible\": true,\n                                    \"pickup_allowed\": true,\n                                    \"created_at\": \"13/02/2023 10:05:46\",\n                                    \"updated_at\": \"30/08/2023 08:32:48\"\n                                },\n                                \"quantity\": 0,\n                                \"created_at\": \"20/09/2023 09:51:13\",\n                                \"updated_at\": \"20/09/2023 09:51:13\"\n                            },\n                            {\n                                \"store\": {\n                                    \"uid\": 699304110431578,\n                                    \"translations\": [\n                                        {\n                                            \"title\": \"Clearance Warehouse - Nicosia Store\",\n                                            \"locale\": \"el\"\n                                        }\n                                    ],\n                                    \"email\": \"\",\n                                    \"visible\": true,\n                                    \"pickup_allowed\": true,\n                                    \"created_at\": \"13/02/2023 10:06:18\",\n                                    \"updated_at\": \"15/06/2023 12:02:12\"\n                                },\n                                \"quantity\": 0,\n                                \"created_at\": \"20/09/2023 09:51:13\",\n                                \"updated_at\": \"20/09/2023 09:51:13\"\n                            }\n                        ]\n                    }\n                ],\n                \"measurements\": {\n                    \"weight\": \"1.0\",\n                    \"length\": \"0.0\",\n                    \"width\": \"0.0\",\n                    \"height\": \"0.0\"\n                },\n                \"order_status\": {\n                    \"can_backorder\": false,\n                    \"can_preorder\": false,\n                    \"available_on\": null\n                },\n                \"images\": [\n                    {\n                        \"id\": 12136,\n                        \"file_name\": \"18700332.jpg\",\n                        \"thumbnail\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/thumbnails/18700332_1693473159.jpg\",\n                        \"preview\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/previews/18700332_1693473159.jpg\",\n                        \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/lists/18700332_1693473159.jpg\",\n                        \"banner\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/banners/18700332_1693473159.jpg\"\n                    }\n                ],\n                \"max_purchasable_quantity\": null,\n                \"max_product_quantity\": 14,\n                \"created_at\": \"31/08/2023 09:12:39\",\n                \"updated_at\": \"20/09/2023 11:47:03\",\n                \"display_total_compare_to_price\": \"€275.28\",\n                \"display_price\": \"€99.99\",\n                \"display_tax_price\": \"€24.00\",\n                \"display_total_price\": \"€123.99\",\n                \"on_sale\": true,\n                \"on_sale_percentage\": 54.95945945945946,\n                \"show_price\": true,\n                \"has_tax\": true,\n                \"stock_items\": [\n                    {\n                        \"store\": {\n                            \"uid\": 346326890542861,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Warehouse - Nicosia Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:04:49\",\n                            \"updated_at\": \"24/08/2023 10:22:02\"\n                        },\n                        \"quantity\": 0,\n                        \"created_at\": \"31/08/2023 09:13:02\",\n                        \"updated_at\": \"31/08/2023 09:13:02\"\n                    },\n                    {\n                        \"store\": {\n                            \"uid\": 473251864538157,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Nicosia Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:05:10\",\n                            \"updated_at\": \"15/06/2023 12:02:12\"\n                        },\n                        \"quantity\": 0,\n                        \"created_at\": \"31/08/2023 09:13:02\",\n                        \"updated_at\": \"01/09/2023 08:32:41\"\n                    },\n                    {\n                        \"store\": {\n                            \"uid\": 444686109884420,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Limassol Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:05:26\",\n                            \"updated_at\": \"15/06/2023 12:02:12\"\n                        },\n                        \"quantity\": 33,\n                        \"created_at\": \"31/08/2023 09:13:02\",\n                        \"updated_at\": \"18/09/2023 12:08:14\"\n                    },\n                    {\n                        \"store\": {\n                            \"uid\": 512592570248121,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Pafos Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"safdsfdaaaffffa\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:05:46\",\n                            \"updated_at\": \"30/08/2023 08:32:48\"\n                        },\n                        \"quantity\": 0,\n                        \"created_at\": \"31/08/2023 09:13:02\",\n                        \"updated_at\": \"31/08/2023 09:13:02\"\n                    },\n                    {\n                        \"store\": {\n                            \"uid\": 699304110431578,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Clearance Warehouse - Nicosia Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:06:18\",\n                            \"updated_at\": \"15/06/2023 12:02:12\"\n                        },\n                        \"quantity\": 0,\n                        \"created_at\": \"31/08/2023 09:13:02\",\n                        \"updated_at\": \"31/08/2023 09:13:02\"\n                    }\n                ],\n                \"taxes\": [\n                    {\n                        \"uid\": 481258870904813,\n                        \"translations\": [\n                            {\n                                \"title\": \"Φ.Π.Α\",\n                                \"locale\": \"el\"\n                            },\n                            {\n                                \"title\": \"Default tax\",\n                                \"locale\": \"en\"\n                            }\n                        ],\n                        \"is_default\": true,\n                        \"rate\": 0.24,\n                        \"applies_to\": \"subtotal\",\n                        \"included_in_price\": false,\n                        \"created_at\": \"13/10/2022 07:38:20\",\n                        \"updated_at\": \"07/09/2023 08:27:49\"\n                    }\n                ],\n                \"prices\": [\n                    {\n                        \"price_list_title\": \"1. Retail incl.VAT\",\n                        \"price_list_api_uid\": 941615867930108,\n                        \"price\": 99.99,\n                        \"compare_to_price\": 222.0\n                    },\n                    {\n                        \"price_list_title\": \"2. Retail Price no VAT\",\n                        \"price_list_api_uid\": 445643306463029,\n                        \"price\": 99.99,\n                        \"compare_to_price\": 222.0\n                    },\n                    {\n                        \"price_list_title\": \"3. Wholesale Price no VAT\",\n                        \"price_list_api_uid\": 633311263925896,\n                        \"price\": 170.0,\n                        \"compare_to_price\": 222.0\n                    },\n                    {\n                        \"price_list_title\": \"4. Dealer Price no VAT\",\n                        \"price_list_api_uid\": 924804050700710,\n                        \"price\": 99.99,\n                        \"compare_to_price\": 222.0\n                    }\n                ]\n            },\n            {\n                \"uid\": 350944728165206,\n                \"type\": \"product\",\n                \"translations\": [\n                    {\n                        \"title\": \"Starfield Premium Upgrade (Must have the base Game)\",\n                        \"subtitle\": \"\",\n                        \"slug\": \"starfield-premium-upgrade-must-have-the-base-game\",\n                        \"description\": \"\",\n                        \"locale\": \"en\"\n                    },\n                    {\n                        \"title\": \"Starfield Premium Upgrade (Must have the base Game)\",\n                        \"subtitle\": \"\",\n                        \"slug\": \"starfield-premium-upgrade-must-have-the-base-game-543369\",\n                        \"description\": \"\",\n                        \"locale\": \"el\"\n                    }\n                ],\n                \"sku\": \"18700334\",\n                \"compare_to_price\": 0.0,\n                \"price\": 112.84,\n                \"published\": true,\n                \"prototype_uid\": 508610039944329,\n                \"attributes\": [\n                    {\n                        \"uid\": 648161782088590,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 605218566287547,\n                        \"prototype_attribute_key\": \"UPC\",\n                        \"created_at\": \"31/08/2023 08:54:07\",\n                        \"updated_at\": \"31/08/2023 08:54:11\"\n                    },\n                    {\n                        \"uid\": 297416340279863,\n                        \"filterable_key\": \"bethesda\",\n                        \"translations\": [\n                            {\n                                \"title\": \"Bethesda\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"Bethesda\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 75427828319792,\n                        \"prototype_attribute_key\": \"Brand\",\n                        \"created_at\": \"31/08/2023 08:54:07\",\n                        \"updated_at\": \"31/08/2023 08:54:11\"\n                    },\n                    {\n                        \"uid\": 735225584162572,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 341868595651900,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"31/08/2023 08:54:07\",\n                        \"updated_at\": \"31/08/2023 08:54:11\"\n                    },\n                    {\n                        \"uid\": 768461164146261,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 925098014791791,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"31/08/2023 08:54:07\",\n                        \"updated_at\": \"31/08/2023 08:54:11\"\n                    },\n                    {\n                        \"uid\": 186595422646981,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 140055824201294,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"31/08/2023 08:54:07\",\n                        \"updated_at\": \"31/08/2023 08:54:11\"\n                    },\n                    {\n                        \"uid\": 372959999544453,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 216976544688651,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"31/08/2023 08:54:07\",\n                        \"updated_at\": \"31/08/2023 08:54:11\"\n                    }\n                ],\n                \"meta_tags\": {\n                    \"translations\": [],\n                    \"og_images\": []\n                },\n                \"option_types\": [],\n                \"variants\": [],\n                \"measurements\": {\n                    \"weight\": \"0.4\",\n                    \"length\": \"0.0\",\n                    \"width\": \"0.0\",\n                    \"height\": \"0.0\"\n                },\n                \"order_status\": {\n                    \"can_backorder\": false,\n                    \"can_preorder\": false,\n                    \"available_on\": null\n                },\n                \"images\": [\n                    {\n                        \"id\": 12132,\n                        \"file_name\": \"18700334.jpg\",\n                        \"thumbnail\": \"https://storage.googleapis.com/myshop_1665646692/products/b87b9052b4f8281854997acee8a51792ee53466c/thumbnails/18700334_1693472047.jpg\",\n                        \"preview\": \"https://storage.googleapis.com/myshop_1665646692/products/b87b9052b4f8281854997acee8a51792ee53466c/previews/18700334_1693472047.jpg\",\n                        \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/b87b9052b4f8281854997acee8a51792ee53466c/lists/18700334_1693472047.jpg\",\n                        \"banner\": \"https://storage.googleapis.com/myshop_1665646692/products/b87b9052b4f8281854997acee8a51792ee53466c/banners/18700334_1693472047.jpg\"\n                    }\n                ],\n                \"max_purchasable_quantity\": null,\n                \"max_product_quantity\": 14,\n                \"created_at\": \"31/08/2023 08:54:07\",\n                \"updated_at\": \"18/09/2023 12:07:45\",\n                \"display_total_compare_to_price\": \"€0.00\",\n                \"display_price\": \"€91.00\",\n                \"display_tax_price\": \"€21.84\",\n                \"display_total_price\": \"€112.84\",\n                \"on_sale\": false,\n                \"on_sale_percentage\": null,\n                \"show_price\": true,\n                \"has_tax\": true,\n                \"stock_items\": [\n                    {\n                        \"store\": {\n                            \"uid\": 346326890542861,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Warehouse - Nicosia Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:04:49\",\n                            \"updated_at\": \"24/08/2023 10:22:02\"\n                        },\n                        \"quantity\": 0,\n                        \"created_at\": \"31/08/2023 08:55:45\",\n                        \"updated_at\": \"18/09/2023 12:07:45\"\n                    },\n                    {\n                        \"store\": {\n                            \"uid\": 473251864538157,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Nicosia Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:05:10\",\n                            \"updated_at\": \"15/06/2023 12:02:12\"\n                        },\n                        \"quantity\": 22,\n                        \"created_at\": \"31/08/2023 08:55:45\",\n                        \"updated_at\": \"18/09/2023 12:07:45\"\n                    },\n                    {\n                        \"store\": {\n                            \"uid\": 444686109884420,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Limassol Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:05:26\",\n                            \"updated_at\": \"15/06/2023 12:02:12\"\n                        },\n                        \"quantity\": 0,\n                        \"created_at\": \"31/08/2023 08:55:45\",\n                        \"updated_at\": \"01/09/2023 08:05:45\"\n                    },\n                    {\n                        \"store\": {\n                            \"uid\": 512592570248121,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Pafos Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"safdsfdaaaffffa\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:05:46\",\n                            \"updated_at\": \"30/08/2023 08:32:48\"\n                        },\n                        \"quantity\": 0,\n                        \"created_at\": \"31/08/2023 08:55:45\",\n                        \"updated_at\": \"01/09/2023 08:05:45\"\n                    },\n                    {\n                        \"store\": {\n                            \"uid\": 699304110431578,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Clearance Warehouse - Nicosia Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:06:18\",\n                            \"updated_at\": \"15/06/2023 12:02:12\"\n                        },\n                        \"quantity\": 0,\n                        \"created_at\": \"31/08/2023 08:55:45\",\n                        \"updated_at\": \"01/09/2023 08:05:45\"\n                    }\n                ],\n                \"taxes\": [\n                    {\n                        \"uid\": 481258870904813,\n                        \"translations\": [\n                            {\n                                \"title\": \"Φ.Π.Α\",\n                                \"locale\": \"el\"\n                            },\n                            {\n                                \"title\": \"Default tax\",\n                                \"locale\": \"en\"\n                            }\n                        ],\n                        \"is_default\": true,\n                        \"rate\": 0.24,\n                        \"applies_to\": \"subtotal\",\n                        \"included_in_price\": false,\n                        \"created_at\": \"13/10/2022 07:38:20\",\n                        \"updated_at\": \"07/09/2023 08:27:49\"\n                    }\n                ],\n                \"prices\": [\n                    {\n                        \"price_list_title\": \"1. Retail incl.VAT\",\n                        \"price_list_api_uid\": 941615867930108,\n                        \"price\": 70.0,\n                        \"compare_to_price\": 0.0\n                    },\n                    {\n                        \"price_list_title\": \"2. Retail Price no VAT\",\n                        \"price_list_api_uid\": 445643306463029,\n                        \"price\": 70.0,\n                        \"compare_to_price\": 0.0\n                    },\n                    {\n                        \"price_list_title\": \"3. Wholesale Price no VAT\",\n                        \"price_list_api_uid\": 633311263925896,\n                        \"price\": 20.0,\n                        \"compare_to_price\": 0.0\n                    },\n                    {\n                        \"price_list_title\": \"4. Dealer Price no VAT\",\n                        \"price_list_api_uid\": 924804050700710,\n                        \"price\": 70.0,\n                        \"compare_to_price\": 0.0\n                    }\n                ]\n            }\n        ],\n        \"page\": 1,\n        \"pages\": 1,\n        \"per_page\": 25,\n        \"total\": 2\n    }\n}\n\n
\nReturns a products object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the product
type String The type of item
translations Array An array of product's translations. Every translation is an object with the following fields:  
- title  
- subtitle  
- slug  
- description  
- locale
sku String The sku of the product
compare_to_price Float The compare to price of the product
price Float The price of the product
published Boolean Whether the product is published or not
prototype_uid Bigint The ID of product's category
attributes Array An array of product's attributes. Every attribute is an object with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- prototype_attribute_uid  
- prototype_attribute_key  
- created_at  
- updated_at
meta_tags Object An object with informations about product's meta_tags:  
- translations - an array of meta tag's translations. Every translation is an object with following fields:  
- title  
- description  
- keywords  
- locale
option_types Array An array with product's option types. Every option type is an object with the following fields:  
- uid  
- filterable_key  
- input_type  
- preselect_default  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- options - an array of option type's options. Every option is an abject with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- price_operator  
- price_operand  
- price  
- default_price_value  
- default  
- created_at  
- updated_at  
- created_at  
- updated_at
variants Array An array of product's variants. Every variant is an object. For variant's fields see below
measurements Object An object with informations about product's measuments. It contains the following fields:  
- weight  
- length  
- width  
- height
order_status Object An object with informations about product's order status. It contains the following fields:  
- can_backorder  
- can_preorder  
- available_on
images Array An array of product's images. Every image is an object with the following fields:  
- id  
- file_name  
- thumbnail  
- preview  
- list_view  
- banner
max_purchasable_quantity Integer The maximum purchasable quantity of this product per order
max_product_quantity Integer The maximum purchasable quantity of products per order
created_at String The date that product was created
updated_at String The date that product was updated
display_total_compare_to_price String The total compare to price of product in display format
display_price String The price of product in display format
display_tax_price String The tax price of product in display format
display_total_price String The total price of product in display format
on_sale Boolean Whether the product is on sale or not
on_sale_percentage Float The percentage of discount of product
show_price Boolean Whether to show product's price or not
has_tax Boolean Whether the product has tax or not
stock_items Array An array of product's stock items. Every stock item is an object with the following fields:  
- store - an object with information about stock item's store. This object contains the following fields:  
- uid  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- email  
- visible  
- pickup_allowed  
- created_at  
- updated_at  
- quantity  
- created_at  
- updated_at
taxes Array An array of product's taxes. Every tax is an object with the following fields:  
- uid  
- translations - an array of tax's translations. Every translation is an object with following fields:  
- title  
- locale  
- is_default  
- rate  
- applies_to  
- included_in_price  
- created_at  
- updated_at
prices Array An array of product's price list prices. Every price is an object with the following fields:  
- price_list_title  
- price_list_api_uid  
- price  
- compare_to_price
\n
Variant has the following fields:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the variant
type String The type of item
translations Array An array of variant's translations. Every translation is an object with the following fields:  
- title  
- subtitle  
- slug  
- description  
- locale
sku String The sku of the variant
compare_to_price Float The compare to price of the variant
price Float The price of the variant
upc String The upc of the variant
weight String The weight of the variant
options Array An array with options of the variant. Every option is an object with the following fields:  
- option_uid  
- option_type_uid
option_types Array An array with option types of the variant. Every option type is an object with the following fields:  
- uid  
- filterable_key  
- input_type  
- preselect_default  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- options - an array of option type's options. Every option is an abject with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- price_operator  
- price_operand  
- price  
- default_price_value  
- default  
- created_at  
- updated_at  
- created_at  
- updated_at
images Array An array of variant's images. Every image is an object with the following fields:  
- id  
- file_name  
- thumbnail  
- preview  
- list_view  
- banner
max_purchasable_quantity Integer The maximum purchasable quantity of this variant per order
max_product_quantity Integer The maximum purchasable quantity of products per order
order_status Object An object with informations about variant's order status. It contains the following fields:  
- can_backorder  
- can_preorder  
- available_on
created_at String The date that variant was created
updated_at String The date that variant was updated
display_total_compare_to_price String The total compare to price of variant in display format
display_price String The price of variant in display format
display_tax_price String The tax price of variant in display format
display_total_price String The total price of variant in display format
on_sale Boolean Whether the variant is on sale or not
on_sale_percentage Float The percentage of discount of variant
show_price Boolean Whether to show variant's price or not
has_tax Boolean Whether the variant has tax or not
stock_items Array An array of variant's stock items. Every stock item is an object with the following fields:  
- store - an object with information about stock item's store. This object contains the following fields:  
- uid  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- email  
- visible  
- pickup_allowed  
- created_at  
- updated_at  
- quantity  
- created_at  
- updated_at
\n
products - <**_**List of Products>_ - The list of products.
page - Current page
pages - Total amount of pages
per_page - Products shown per page
total - Total products
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","products"],"host":[""],"query":[{"key":"page","value":"1"},{"key":"keyword","value":"product_keyword"},{"key":"prototype_uid","value":"product_prototype_uid"},{"key":"only_published","value":"product_only_published"}],"variable":[]}},"response":[],"_postman_id":"7dcb351e-992c-42e5-9210-eadd5a7177a3"},{"name":"Get Single Product","id":"126871f1-b890-4064-b5ad-c55e91fda635","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/products/product_uid","description":"Returns a requested product.
\nParameters
\nproduct_uid <**_**Bigint> -_ Indicates the id of the requested product.
\nResponse
\n{\n    \"response\": {\n        \"product\": {\n            \"uid\": 66961353639720,\n            \"type\": \"product\",\n            \"translations\": [\n                {\n                    \"title\": \"Starfield Collector's Edition For Xbox Series X\",\n                    \"subtitle\": \"\",\n                    \"slug\": \"starfield-collectors-edition-for-xbox-series-x\",\n                    \"description\": \"\",\n                    \"locale\": \"en\"\n                },\n                {\n                    \"title\": \"Starfield Collector's Edition For Xbox Series X\",\n                    \"subtitle\": \"\",\n                    \"slug\": \"starfield-collectors-edition-for-xbox-series-x-932342\",\n                    \"description\": \"\",\n                    \"locale\": \"el\"\n                }\n            ],\n            \"sku\": \"18700332\",\n            \"compare_to_price\": 222.0,\n            \"price\": 123.99,\n            \"published\": true,\n            \"prototype_uid\": 508610039944329,\n            \"attributes\": [\n                {\n                    \"uid\": 52551778438350,\n                    \"filterable_key\": null,\n                    \"translations\": [\n                        {\n                            \"title\": \"\",\n                            \"locale\": \"en\"\n                        },\n                        {\n                            \"title\": \"\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 605218566287547,\n                    \"prototype_attribute_key\": \"UPC\",\n                    \"created_at\": \"31/08/2023 09:12:39\",\n                    \"updated_at\": \"31/08/2023 09:12:44\"\n                },\n                {\n                    \"uid\": 539404257675281,\n                    \"filterable_key\": \"bethesda\",\n                    \"translations\": [\n                        {\n                            \"title\": \"Bethesda\",\n                            \"locale\": \"en\"\n                        },\n                        {\n                            \"title\": \"Bethesda\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 75427828319792,\n                    \"prototype_attribute_key\": \"Brand\",\n                    \"created_at\": \"31/08/2023 09:12:39\",\n                    \"updated_at\": \"31/08/2023 09:12:44\"\n                },\n                {\n                    \"uid\": 709255984541221,\n                    \"filterable_key\": null,\n                    \"translations\": [\n                        {\n                            \"title\": \"\",\n                            \"locale\": \"en\"\n                        },\n                        {\n                            \"title\": \"\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 341868595651900,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"31/08/2023 09:12:39\",\n                    \"updated_at\": \"31/08/2023 09:12:44\"\n                },\n                {\n                    \"uid\": 965823280502370,\n                    \"filterable_key\": null,\n                    \"translations\": [\n                        {\n                            \"title\": \"\",\n                            \"locale\": \"en\"\n                        },\n                        {\n                            \"title\": \"\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 925098014791791,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"31/08/2023 09:12:39\",\n                    \"updated_at\": \"31/08/2023 09:12:44\"\n                },\n                {\n                    \"uid\": 961368379231464,\n                    \"filterable_key\": null,\n                    \"translations\": [\n                        {\n                            \"title\": \"\",\n                            \"locale\": \"en\"\n                        },\n                        {\n                            \"title\": \"\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 140055824201294,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"31/08/2023 09:12:39\",\n                    \"updated_at\": \"31/08/2023 09:12:44\"\n                },\n                {\n                    \"uid\": 48602618395287,\n                    \"filterable_key\": null,\n                    \"translations\": [\n                        {\n                            \"title\": \"\",\n                            \"locale\": \"en\"\n                        },\n                        {\n                            \"title\": \"\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 216976544688651,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"31/08/2023 09:12:39\",\n                    \"updated_at\": \"31/08/2023 09:12:44\"\n                }\n            ],\n            \"meta_tags\": {\n                \"translations\": [\n                    {\n                        \"title\": \"ojmnomjknmkj\",\n                        \"description\": \"oinnonnonnononoioninononon\",\n                        \"keywords\": \"ojnnjnjknkjn\",\n                        \"locale\": \"el\"\n                    }\n                ],\n                \"og_images\": []\n            },\n            \"option_types\": [\n                {\n                    \"uid\": 334702311955931,\n                    \"filterable_key\": \"test_option_type_one\",\n                    \"input_type\": 0,\n                    \"preselect_default\": true,\n                    \"translations\": [\n                        {\n                            \"title\": \"test option type one\",\n                            \"locale\": \"el\"\n                        },\n                        {\n                            \"title\": \"test option type one eng\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"options\": [\n                        {\n                            \"uid\": 311792935687528,\n                            \"filterable_key\": \"test_option_one\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"test option one\",\n                                    \"locale\": \"el\"\n                                },\n                                {\n                                    \"title\": \"test option one eng\",\n                                    \"locale\": \"en\"\n                                }\n                            ],\n                            \"price_operator\": 0,\n                            \"price_operand\": 0,\n                            \"price\": 5.0,\n                            \"display_price_value\": \"+€5\",\n                            \"default\": true,\n                            \"created_at\": \"20/09/2023 09:05:28\",\n                            \"updated_at\": \"20/09/2023 11:47:03\"\n                        },\n                        {\n                            \"uid\": 520547302133366,\n                            \"filterable_key\": \"test_option_two\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"test option two\",\n                                    \"locale\": \"el\"\n                                },\n                                {\n                                    \"title\": \"test option two eng\",\n                                    \"locale\": \"en\"\n                                }\n                            ],\n                            \"price_operator\": 0,\n                            \"price_operand\": 0,\n                            \"price\": 11.0,\n                            \"display_price_value\": \"+€11\",\n                            \"default\": false,\n                            \"created_at\": \"20/09/2023 09:05:28\",\n                            \"updated_at\": \"20/09/2023 11:47:03\"\n                        }\n                    ],\n                    \"created_at\": \"20/09/2023 09:05:28\",\n                    \"updated_at\": \"20/09/2023 11:47:03\"\n                }\n            ],\n            \"variants\": [\n                {\n                    \"uid\": 277032461709847,\n                    \"type\": \"variant\",\n                    \"translations\": [\n                        {\n                            \"title\": \"Starfield Collector's Edition For Xbox Series X\",\n                            \"subtitle\": \"\",\n                            \"slug\": \"starfield-collectors-edition-for-xbox-series-x\",\n                            \"description\": \"\",\n                            \"locale\": \"en\"\n                        },\n                        {\n                            \"title\": \"Starfield Collector's Edition For Xbox Series X\",\n                            \"subtitle\": \"\",\n                            \"slug\": \"starfield-collectors-edition-for-xbox-series-x-932342\",\n                            \"description\": \"\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"sku\": \"18700332\",\n                    \"compare_to_price\": 0.0,\n                    \"price\": 80.6,\n                    \"upc\": \"\",\n                    \"weight\": \"1.0\",\n                    \"options\": [\n                        {\n                            \"option_uid\": 311792935687528,\n                            \"option_type_uid\": 334702311955931\n                        }\n                    ],\n                    \"option_types\": [\n                        {\n                            \"uid\": 334702311955931,\n                            \"filterable_key\": \"test_option_type_one\",\n                            \"input_type\": 0,\n                            \"preselect_default\": true,\n                            \"translations\": [\n                                {\n                                    \"title\": \"test option type one\",\n                                    \"locale\": \"el\"\n                                },\n                                {\n                                    \"title\": \"test option type one eng\",\n                                    \"locale\": \"en\"\n                                }\n                            ],\n                            \"options\": [\n                                {\n                                    \"uid\": 311792935687528,\n                                    \"filterable_key\": \"test_option_one\",\n                                    \"translations\": [\n                                        {\n                                            \"title\": \"test option one\",\n                                            \"locale\": \"el\"\n                                        },\n                                        {\n                                            \"title\": \"test option one eng\",\n                                            \"locale\": \"en\"\n                                        }\n                                    ],\n                                    \"price_operator\": 0,\n                                    \"price_operand\": 0,\n                                    \"price\": 5.0,\n                                    \"display_price_value\": \"+€5\",\n                                    \"default\": true,\n                                    \"created_at\": \"20/09/2023 09:05:28\",\n                                    \"updated_at\": \"20/09/2023 11:47:03\"\n                                },\n                                {\n                                    \"uid\": 520547302133366,\n                                    \"filterable_key\": \"test_option_two\",\n                                    \"translations\": [\n                                        {\n                                            \"title\": \"test option two\",\n                                            \"locale\": \"el\"\n                                        },\n                                        {\n                                            \"title\": \"test option two eng\",\n                                            \"locale\": \"en\"\n                                        }\n                                    ],\n                                    \"price_operator\": 0,\n                                    \"price_operand\": 0,\n                                    \"price\": 11.0,\n                                    \"display_price_value\": \"+€11\",\n                                    \"default\": false,\n                                    \"created_at\": \"20/09/2023 09:05:28\",\n                                    \"updated_at\": \"20/09/2023 11:47:03\"\n                                }\n                            ],\n                            \"created_at\": \"20/09/2023 09:05:28\",\n                            \"updated_at\": \"20/09/2023 11:47:03\"\n                        }\n                    ],\n                    \"images\": [\n                        {\n                            \"id\": 12136,\n                            \"file_name\": \"18700332.jpg\",\n                            \"thumbnail\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/thumbnails/18700332_1693473159.jpg\",\n                            \"preview\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/previews/18700332_1693473159.jpg\",\n                            \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/lists/18700332_1693473159.jpg\",\n                            \"banner\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/banners/18700332_1693473159.jpg\"\n                        }\n                    ],\n                    \"max_purchasable_quantity\": null,\n                    \"max_product_quantity\": 14,\n                    \"order_status\": {\n                        \"can_backorder\": true,\n                        \"can_preorder\": false,\n                        \"available_on\": null\n                    },\n                    \"created_at\": \"20/09/2023 09:51:12\",\n                    \"updated_at\": \"20/09/2023 09:51:12\",\n                    \"display_total_compare_to_price\": \"€0.00\",\n                    \"display_price\": \"€65.00\",\n                    \"display_tax_price\": \"€15.60\",\n                    \"display_total_price\": \"€80.60\",\n                    \"on_sale\": false,\n                    \"on_sale_percentage\": null,\n                    \"show_price\": true,\n                    \"has_tax\": true,\n                    \"stock_items\": [\n                        {\n                            \"store\": {\n                                \"uid\": 346326890542861,\n                                \"translations\": [\n                                    {\n                                        \"title\": \"Warehouse - Nicosia Store\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"email\": \"\",\n                                \"visible\": true,\n                                \"pickup_allowed\": true,\n                                \"created_at\": \"13/02/2023 10:04:49\",\n                                \"updated_at\": \"24/08/2023 10:22:02\"\n                            },\n                            \"quantity\": 0,\n                            \"created_at\": \"20/09/2023 09:51:12\",\n                            \"updated_at\": \"20/09/2023 09:51:12\"\n                        },\n                        {\n                            \"store\": {\n                                \"uid\": 473251864538157,\n                                \"translations\": [\n                                    {\n                                        \"title\": \"Nicosia Store\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"email\": \"\",\n                                \"visible\": true,\n                                \"pickup_allowed\": true,\n                                \"created_at\": \"13/02/2023 10:05:10\",\n                                \"updated_at\": \"15/06/2023 12:02:12\"\n                            },\n                            \"quantity\": 0,\n                            \"created_at\": \"20/09/2023 09:51:13\",\n                            \"updated_at\": \"20/09/2023 09:51:13\"\n                        },\n                        {\n                            \"store\": {\n                                \"uid\": 444686109884420,\n                                \"translations\": [\n                                    {\n                                        \"title\": \"Limassol Store\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"email\": \"\",\n                                \"visible\": true,\n                                \"pickup_allowed\": true,\n                                \"created_at\": \"13/02/2023 10:05:26\",\n                                \"updated_at\": \"15/06/2023 12:02:12\"\n                            },\n                            \"quantity\": 33,\n                            \"created_at\": \"20/09/2023 09:51:13\",\n                            \"updated_at\": \"20/09/2023 09:51:13\"\n                        },\n                        {\n                            \"store\": {\n                                \"uid\": 512592570248121,\n                                \"translations\": [\n                                    {\n                                        \"title\": \"Pafos Store\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"email\": \"safdsfdaaaffffa\",\n                                \"visible\": true,\n                                \"pickup_allowed\": true,\n                                \"created_at\": \"13/02/2023 10:05:46\",\n                                \"updated_at\": \"30/08/2023 08:32:48\"\n                            },\n                            \"quantity\": 0,\n                            \"created_at\": \"20/09/2023 09:51:13\",\n                            \"updated_at\": \"20/09/2023 09:51:13\"\n                        },\n                        {\n                            \"store\": {\n                                \"uid\": 699304110431578,\n                                \"translations\": [\n                                    {\n                                        \"title\": \"Clearance Warehouse - Nicosia Store\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"email\": \"\",\n                                \"visible\": true,\n                                \"pickup_allowed\": true,\n                                \"created_at\": \"13/02/2023 10:06:18\",\n                                \"updated_at\": \"15/06/2023 12:02:12\"\n                            },\n                            \"quantity\": 0,\n                            \"created_at\": \"20/09/2023 09:51:13\",\n                            \"updated_at\": \"20/09/2023 09:51:13\"\n                        }\n                    ]\n                }\n            ],\n            \"measurements\": {\n                \"weight\": \"1.0\",\n                \"length\": \"0.0\",\n                \"width\": \"0.0\",\n                \"height\": \"0.0\"\n            },\n            \"order_status\": {\n                \"can_backorder\": false,\n                \"can_preorder\": false,\n                \"available_on\": null\n            },\n            \"images\": [\n                {\n                    \"id\": 12136,\n                    \"file_name\": \"18700332.jpg\",\n                    \"thumbnail\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/thumbnails/18700332_1693473159.jpg\",\n                    \"preview\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/previews/18700332_1693473159.jpg\",\n                    \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/lists/18700332_1693473159.jpg\",\n                    \"banner\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/banners/18700332_1693473159.jpg\"\n                }\n            ],\n            \"max_purchasable_quantity\": null,\n            \"max_product_quantity\": 14,\n            \"created_at\": \"31/08/2023 09:12:39\",\n            \"updated_at\": \"20/09/2023 11:47:03\",\n            \"display_total_compare_to_price\": \"€275.28\",\n            \"display_price\": \"€99.99\",\n            \"display_tax_price\": \"€24.00\",\n            \"display_total_price\": \"€123.99\",\n            \"on_sale\": true,\n            \"on_sale_percentage\": 54.95945945945946,\n            \"show_price\": true,\n            \"has_tax\": true,\n            \"stock_items\": [\n                {\n                    \"store\": {\n                        \"uid\": 346326890542861,\n                        \"translations\": [\n                            {\n                                \"title\": \"Warehouse - Nicosia Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:04:49\",\n                        \"updated_at\": \"24/08/2023 10:22:02\"\n                    },\n                    \"quantity\": 0,\n                    \"created_at\": \"31/08/2023 09:13:02\",\n                    \"updated_at\": \"31/08/2023 09:13:02\"\n                },\n                {\n                    \"store\": {\n                        \"uid\": 473251864538157,\n                        \"translations\": [\n                            {\n                                \"title\": \"Nicosia Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:05:10\",\n                        \"updated_at\": \"15/06/2023 12:02:12\"\n                    },\n                    \"quantity\": 0,\n                    \"created_at\": \"31/08/2023 09:13:02\",\n                    \"updated_at\": \"01/09/2023 08:32:41\"\n                },\n                {\n                    \"store\": {\n                        \"uid\": 444686109884420,\n                        \"translations\": [\n                            {\n                                \"title\": \"Limassol Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:05:26\",\n                        \"updated_at\": \"15/06/2023 12:02:12\"\n                    },\n                    \"quantity\": 33,\n                    \"created_at\": \"31/08/2023 09:13:02\",\n                    \"updated_at\": \"18/09/2023 12:08:14\"\n                },\n                {\n                    \"store\": {\n                        \"uid\": 512592570248121,\n                        \"translations\": [\n                            {\n                                \"title\": \"Pafos Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"safdsfdaaaffffa\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:05:46\",\n                        \"updated_at\": \"30/08/2023 08:32:48\"\n                    },\n                    \"quantity\": 0,\n                    \"created_at\": \"31/08/2023 09:13:02\",\n                    \"updated_at\": \"31/08/2023 09:13:02\"\n                },\n                {\n                    \"store\": {\n                        \"uid\": 699304110431578,\n                        \"translations\": [\n                            {\n                                \"title\": \"Clearance Warehouse - Nicosia Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:06:18\",\n                        \"updated_at\": \"15/06/2023 12:02:12\"\n                    },\n                    \"quantity\": 0,\n                    \"created_at\": \"31/08/2023 09:13:02\",\n                    \"updated_at\": \"31/08/2023 09:13:02\"\n                }\n            ],\n            \"taxes\": [\n                {\n                    \"uid\": 481258870904813,\n                    \"translations\": [\n                        {\n                            \"title\": \"Φ.Π.Α\",\n                            \"locale\": \"el\"\n                        },\n                        {\n                            \"title\": \"Default tax\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"is_default\": true,\n                    \"rate\": 0.24,\n                    \"applies_to\": \"subtotal\",\n                    \"included_in_price\": false,\n                    \"created_at\": \"13/10/2022 07:38:20\",\n                    \"updated_at\": \"07/09/2023 08:27:49\"\n                }\n            ],\n            \"prices\": [\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 99.99,\n                    \"compare_to_price\": 222.0\n                },\n                {\n                    \"price_list_title\": \"2. Retail Price no VAT\",\n                    \"price_list_api_uid\": 445643306463029,\n                    \"price\": 99.99,\n                    \"compare_to_price\": 222.0\n                },\n                {\n                    \"price_list_title\": \"3. Wholesale Price no VAT\",\n                    \"price_list_api_uid\": 633311263925896,\n                    \"price\": 170.0,\n                    \"compare_to_price\": 222.0\n                },\n                {\n                    \"price_list_title\": \"4. Dealer Price no VAT\",\n                    \"price_list_api_uid\": 924804050700710,\n                    \"price\": 99.99,\n                    \"compare_to_price\": 222.0\n                }\n            ]\n        },\n        \"custom_fields\": [\n            {\n                \"type\": \"text\",\n                \"key\": \"test_key\",\n                \"value\": \"test_value\"\n            }\n        ]\n    }\n}\n\n
\nReturns a product object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the product
type String The type of item
translations Array An array of product's translations. Every translation is an object with the following fields:  
- title  
- subtitle  
- slug  
- description  
- locale
sku String The sku of the product
compare_to_price Float The compare to price of the product
price Float The price of the product
published Boolean Whether the product is published or not
prototype_uid Bigint The ID of product's category
attributes Array An array of product's attributes. Every attribute is an object with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- prototype_attribute_uid  
- prototype_attribute_key  
- created_at  
- updated_at
meta_tags Object An object with informations about product's meta_tags:  
- translations - an array of meta tag's translations. Every translation is an object with following fields:  
- title  
- description  
- keywords  
- locale
option_types Array An array with product's option types. Every option type is an object with the following fields:  
- uid  
- filterable_key  
- input_type  
- preselect_default  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- options - an array of option type's options. Every option is an abject with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- price_operator  
- price_operand  
- price  
- default_price_value  
- default  
- created_at  
- updated_at  
- created_at  
- updated_at
variants Array An array of product's variants. Every variant is an object. For variant's fields see below
measurements Object An object with informations about product's measuments. It contains the following fields:  
- weight  
- length  
- width  
- height
order_status Object An object with informations about product's order status. It contains the following fields:  
- can_backorder  
- can_preorder  
- available_on
images Array An array of product's images. Every image is an object with the following fields:  
- id  
- file_name  
- thumbnail  
- preview  
- list_view  
- banner
max_purchasable_quantity Integer The maximum purchasable quantity of this product per order
max_product_quantity Integer The maximum purchasable quantity of products per order
created_at String The date that product was created
updated_at String The date that product was updated
display_total_compare_to_price String The total compare to price of product in display format
display_price String The price of product in display format
display_tax_price String The tax price of product in display format
display_total_price String The total price of product in display format
on_sale Boolean Whether the product is on sale or not
on_sale_percentage Float The percentage of discount of product
show_price Boolean Whether to show product's price or not
has_tax Boolean Whether the product has tax or not
stock_items Array An array of product's stock items. Every stock item is an object with the following fields:  
- store - an object with information about stock item's store. This object contains the following fields:  
- uid  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- email  
- visible  
- pickup_allowed  
- created_at  
- updated_at  
- quantity  
- created_at  
- updated_at
taxes Array An array of product's taxes. Every tax is an object with the following fields:  
- uid  
- translations - an array of tax's translations. Every translation is an object with following fields:  
- title  
- locale  
- is_default  
- rate  
- applies_to  
- included_in_price  
- created_at  
- updated_at
prices Array An array of product's price list prices. Every price is an object with the following fields:  
- price_list_title  
- price_list_api_uid  
- price  
- compare_to_price
\n
Variant has the following fields:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the variant
type String The type of item
translations Array An array of variant's translations. Every translation is an object with the following fields:  
- title  
- subtitle  
- slug  
- description  
- locale
sku String The sku of the variant
compare_to_price Float The compare to price of the variant
price Float The price of the variant
upc String The upc of the variant
weight String The weight of the variant
options Array An array with options of the variant. Every option is an object with the following fields:  
- option_uid  
- option_type_uid
option_types Array An array with option types of the variant. Every option type is an object with the following fields:  
- uid  
- filterable_key  
- input_type  
- preselect_default  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- options - an array of option type's options. Every option is an abject with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- price_operator  
- price_operand  
- price  
- default_price_value  
- default  
- created_at  
- updated_at  
- created_at  
- updated_at
images Array An array of variant's images. Every image is an object with the following fields:  
- id  
- file_name  
- thumbnail  
- preview  
- list_view  
- banner
max_purchasable_quantity Integer The maximum purchasable quantity of this variant per order
max_product_quantity Integer The maximum purchasable quantity of products per order
order_status Object An object with informations about variant's order status. It contains the following fields:  
- can_backorder  
- can_preorder  
- available_on
created_at String The date that variant was created
updated_at String The date that variant was updated
display_total_compare_to_price String The total compare to price of variant in display format
display_price String The price of variant in display format
display_tax_price String The tax price of variant in display format
display_total_price String The total price of variant in display format
on_sale Boolean Whether the variant is on sale or not
on_sale_percentage Float The percentage of discount of variant
show_price Boolean Whether to show variant's price or not
has_tax Boolean Whether the variant has tax or not
stock_items Array An array of variant's stock items. Every stock item is an object with the following fields:  
- store - an object with information about stock item's store. This object contains the following fields:  
- uid  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- email  
- visible  
- pickup_allowed  
- created_at  
- updated_at  
- quantity  
- created_at  
- updated_at
\n
Also returns a custom_fields object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
type String The type of value (\"text\" or \"html\" or \"json\")
key String The key of custom field
value String The value of custom field
\n
Errors
\nExample: Product not found
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"product_not_found\",\n        \"message\": \"Product with specified uid does not exist\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","products","product_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"126871f1-b890-4064-b5ad-c55e91fda635"},{"name":"Create Product","id":"1a6f32cc-df45-4834-a248-64dc1d3c35ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{   \n    \"product\": {\n        \"locale\": \"el\",\n        \"title\": \"EL-Product\", \n        \"slug\": \"el-product\",\n        \"description\": \"EL-Product-Description
\",\n        \"subtitle\": \"EL-Product-Subtitle
\",\n        \"sku\": \"00140371\",\n        \"price\": 40,\n        \"compare_to_price\": 10,\n        \"published\": true,\n        \"applied_tax_uid\": 155183482461123,\n        \"prototype_uid\": 345583482461114,\n        \"prototype_attributes\": [{\n            \"title\": \"EL-Attribute 1\",\n            \"prototype_attribute_uid\": 123433331312\n        },{\n            \"title\": \"EL-Attribute 2\",\n            \"prototype_attribute_uid\": 123433331311\n        }],\n        \"product_measurement\": {\n            \"weight\": \"1.5\",\n            \"length\": \"15.0\",\n            \"width\": \"15.0\",\n            \"height\": \"10.0\"\n        },\n        \"option_types\": [{\n            \"title\": \"EL-Option-Type 1\",\n            \"options\": [{\n                \"title\": \"EL-Option 1\", \n                \"price_operator\": 0, \n                \"price_operand\": 0, \n                \"price\": 12 \n            },{\n                \"title\": \"EL-Option 2\", \n                \"price_operator\": 0, \n                \"price_operand\": 0, \n                \"price\": 12 \n            }]},{\n            \"title\": \"EL-Option-Type 2\",\n            \"options\": [{\n                \"title\": \"EL-Option 1\", \n                \"price_operator\": 0, \n                \"price_operand\": 0, \n                \"price\": 12 \n            },{\n                \"title\": \"EL-Option 2\", \n                \"price_operator\": 0, \n                \"price_operand\": 0, \n                \"price\": 12 \n            }]\n        }],\n        \"stock_items\": [{\n            \"store_uid\": 155183482461601,\n            \"quantity\": 50\n        },{\n            \"store_uid\": 125183482461631,\n            \"quantity\": 20\n        }],\n        \"product_images\": [{\n            \"url\": \"https//example.com/image1.jpg\",\n            \"position\": 1\n        },{\n            \"url\": \"https//example.com/image2.jpg\",\n            \"position\": 2\n        }],\n        \"seo\": {\n            \"title\": \"EL-SEO\", \n            \"keywords\": \"EL-SEO-Keyword 1, EL-SEO-Keyword 2\", \n            \"description\": \"EL-SEO-description\"\n        },\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"custom-field-key-1\", \n                \"value\": \"custom-field-value-1\",\n                \"type\": \"text\"\n            },\n            \"custom_field2\": {\n                \"key\": \"custom-field-key-2\", \n                \"value\": \"custom-field-value-2\",\n                \"type\": \"html\"\n            }, \n            \"custom_field3\": {\n                \"key\": \"custom-field-key-3\", \n                \"value\": \"custom-field-value-3\",\n                \"type\": \"json\"\n            },\n            \"custom_field4\": {\n                \"key\": \"custom-field-key-4\", \n                \"value\": \"custom-field-value-4\",\n                \"type\": \"text\"\n            },\n            \"custom_field5\": {\n                \"key\": \"custom-field-key-5\", \n                \"value\": \"custom-field-value-5\",\n                \"type\": \"text\"\n            },\n            \"custom_field6\": {\n                \"key\": \"custom-field-key-6\", \n                \"value\": \"custom-field-value-6\",\n                \"type\": \"text\"\n            },\n            \"custom_field7\": {\n                \"key\": \"custom-field-key-7\", \n                \"value\": \"custom-field-value-7\",\n                \"type\": \"text\"\n            },\n            \"custom_field8\": {\n                \"key\": \"custom-field-key-8\", \n                \"value\": \"custom-field-value-8\",\n                \"type\": \"text\"\n            },\n            \"custom_field9\": {\n                \"key\": \"custom-field-key-9\", \n                \"value\": \"custom-field-value-9\",\n                \"type\": \"text\"\n            },\n            \"custom_field10\": {\n                \"key\": \"custom-field-key-10\", \n                \"value\": \"custom-field-value-10\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/products","description":"Creates a product
\nParameters
\n{   \"product\":{\n        \"locale\": \"en\",\n        \"title\": \"Test product\",\n        \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer rhoncus ac diam et euismod. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Cras at orci nunc. Donec euismod pharetra venenatis. Nulla maximus, dui nec rhoncus ornare, eros nulla rhoncus turpis, vitae scelerisque magna mi eu purus.\",\n        \"subtitle\": \"Nam magna lorem, vulputate vel semper scelerisque, elementum eu arcu.\",\n        \"sku\": \"01234567\",\n        \"price\": 50.5,\n        \"compare_to_price\": 110.0,\n        \"published\": true,\n        \"prototype_uid\": 438785098766320,\n        \"applied_tax_uid\": 481258870904813,\n        \"product_measurement\": {\n            \"weight\": 2.5,\n            \"length\": 14.0,\n            \"width\": 12.0,\n            \"height\": 10.0\n        },\n        \"prototype_attributes\": [\n            {\n                \"title\": \"1234512345123\",\n                \"prototype_attribute_uid\": 511657348593198\n            },\n            {\n                \"title\": \"Test Brand\",\n                \"prototype_attribute_uid\": 792147838615580\n            },\n            {\n                \"title\": \"Blue\",\n                \"prototype_attribute_uid\": 850013564166658\n            },\n            {\n                \"title\": \"No\",\n                \"prototype_attribute_uid\": 195658809681290\n            },\n            {\n                \"title\": \"Microtextured\",\n                \"prototype_attribute_uid\": 491806080342594\n            },\n            {\n                \"title\": \"20cm x 25cm\",\n                \"prototype_attribute_uid\": 199027907529441\n            }\n        ],\n        \"option_types\": [\n            {\n                \"title\": \"Test Option Type\",\n                \"options\": [\n                    {\n                        \"title\": \"option one\", \n                        \"price_operator\": 1, \n                        \"price_operand\": 1, \n                        \"price\": 10 \n                    },\n                    {\n                    \"title\": \"option two\", \n                    \"price_operator\": 1, \n                    \"price_operand\": 1, \n                    \"price\": 15 \n                    }\n                ]\n            }\n        ],\n        \"stock_items\": [\n            {\n                \"store_uid\": 346326890542861,\n                \"quantity\": 20\n            },\n            {\n                \"store_uid\": 473251864538157,\n                \"quantity\": 40\n            },\n            {\n                \"store_uid\": 444686109884420,\n                \"quantity\": 15\n            },\n            {\n                \"store_uid\": 512592570248121,\n                \"quantity\": 0\n            },\n            {\n                \"store_uid\": 699304110431578,\n                \"quantity\": 50\n            }\n        ],\n        \"product_images\": [\n            {\n                \"url\": \"https://unblast.com/wp-content/uploads/2019/08/Carton-Packaging-Box-Mockup-2.jpg\",\n                \"position\": 1\n            },\n            {\n                \"url\": \"https://dailymockup.com/wp-content/uploads/edd/2019/05/packaging-box-mockup-free.jpg\",\n                \"position\": 2\n            }\n        ],\n        \"seo\": {\n            \"title\": \"test title\",\n            \"keywords\": \"keyword_1, keyword_2\",\n            \"description\": \"test description\"\n        },\n        \"product_order_status\": {\n            \"can_backorder\": false,\n            \"can_preorder\": false, \n            \"available_on\": null\n        },\n        \"prices\": [\n            {\n                \"price_list_uid\": 941615867930108,\n                \"price\": 45.5,\n                \"compare_to_price\": 100\n            },\n            {\n                \"price_list_uid\": 941615867930108,\n                \"price\": 42,\n                \"compare_to_price\": 95\n            },\n            {\n                \"price_list_uid\": 941615867930108,\n                \"price\": 46,\n                \"compare_to_price\": 105\n            },\n            {\n                \"price_list_uid\": 941615867930108,\n                \"price\": 41,\n                \"compare_to_price\": 90\n            }\n        ],\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"test_key\",\n                \"value\": \"test_value\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}\n\n
\nWe send a product object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nRequired Field Type Description
Mandatory locale String The locale of the translation to be created
Mandatory title String The title of product
Optional slug String The slug of product
Optional description String The description of the product's translation
Optional subtitle String The subtitle of the product's translation
Optional sku String The sku of the product
Optional price Float The price of the product
Optional compare_to_price Float The compare to price of the product
Optional published Boolean Whether the product is published or not
Optional applied_tax_uid Bigint The ID of the applied tax of the product
Optional product_measurement Object An object with informations about product's measurement. It contains the following fields:  
- weight(Float) - in kg  
- length(Float) - in cm  
- width(Float) - in cm  
- height(Float) - in cm
Optional prototype_uid Bigint The ID of the category of the product
Optional prototype_attributes Array An array of product's category attributes. Every category attribute is an object with the following fields:  
- title(String)  
- prototype_attribute_uid(Bigint) - prototype attribute ID
Optional option_types Array An array of product's category attributes. Every category attribute is an object with the following fields:  
- title(String)  
- options(Array) - an array of products available options. Every option is an object that contains the following fields:  
- title(String)  
- price_operator(Integer) - must be 0(+) or 1(-)  
- price_operand(Integer) - must be 0(x starting price) or 1(% of starting price)  
- price(Float)
Optional stock_items Array An array of product's stock items. Every stock item is an object with the following fields:  
- store_uid(Bigint) - store ID  
- quantity(Integer)
Optional product_images Array An array of product's images. Every image is an object with the following fields:  
- url  
- position(Integer) - the display order of image
Optional seo Object An object with informations about product's seo. It contains the following fields:  
- title(String)  
- keywords(String)  
- description(String)
Optional product_order_status Object An object with informations about product's order status. It contains the following fields:  
- can_backorder(Boolean)  
- can_preorder(Boolean)  
- available_on(String) - must be a date in format DD-MM-YYYY hh::mm (e.g. \"19-10-2023 11:00\")
Optional prices Array An array of product's price list prices. Every price is an object with the following fields:  
- price_list_uid(Bigint) - the ID of price list  
- price(Float)  
- compare_to_price(Float)
Optional custom_fields Object An object with product's custom fields. It contains the following a field for every custom field to be added. Field name follows the pattern custom_field. Can add up to 10 custom fields. Every custom field contains the following fields:  
- key(String)  
- value(String)  
- type(String) - must be \"text\" or \"html\" or \"json\"
\n
Response
\n{\n    \"response\": {\n        \"product\": {\n            \"uid\": 171255899643487,\n            \"type\": \"product\",\n            \"translations\": [\n                {\n                    \"title\": \"Test product\",\n                    \"subtitle\": \"Nam magna lorem, vulputate vel semper scelerisque, elementum eu arcu.\",\n                    \"slug\": \"test-product\",\n                    \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer rhoncus ac diam et euismod. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Cras at orci nunc. Donec euismod pharetra venenatis. Nulla maximus, dui nec rhoncus ornare, eros nulla rhoncus turpis, vitae scelerisque magna mi eu purus.\",\n                    \"locale\": \"en\"\n                }\n            ],\n            \"sku\": \"01234567\",\n            \"compare_to_price\": 110.0,\n            \"price\": 62.62,\n            \"published\": true,\n            \"prototype_uid\": 438785098766320,\n            \"attributes\": [\n                {\n                    \"uid\": 213723296905979,\n                    \"filterable_key\": \"1234512345123\",\n                    \"translations\": [\n                        {\n                            \"title\": \"1234512345123\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 511657348593198,\n                    \"prototype_attribute_key\": \"UPC\",\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"21/09/2023 09:00:19\"\n                },\n                {\n                    \"uid\": 936680195614754,\n                    \"filterable_key\": \"test_brand\",\n                    \"translations\": [\n                        {\n                            \"title\": \"Test Brand\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 792147838615580,\n                    \"prototype_attribute_key\": \"Brand\",\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"21/09/2023 09:00:19\"\n                },\n                {\n                    \"uid\": 610813415070212,\n                    \"filterable_key\": \"blue\",\n                    \"translations\": [\n                        {\n                            \"title\": \"Blue\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 850013564166658,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"21/09/2023 09:00:19\"\n                },\n                {\n                    \"uid\": 230231242436689,\n                    \"filterable_key\": \"no\",\n                    \"translations\": [\n                        {\n                            \"title\": \"No\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 195658809681290,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"21/09/2023 09:00:19\"\n                },\n                {\n                    \"uid\": 350833511876953,\n                    \"filterable_key\": \"microtextured\",\n                    \"translations\": [\n                        {\n                            \"title\": \"Microtextured\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 491806080342594,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"21/09/2023 09:00:19\"\n                },\n                {\n                    \"uid\": 121609346910613,\n                    \"filterable_key\": \"20cm_x_25cm\",\n                    \"translations\": [\n                        {\n                            \"title\": \"20cm x 25cm\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 199027907529441,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"21/09/2023 09:00:19\"\n                }\n            ],\n            \"meta_tags\": {\n                \"translations\": [\n                    {\n                        \"title\": \"test title\",\n                        \"description\": \"test description\",\n                        \"keywords\": \"keyword_1, keyword_2\",\n                        \"locale\": \"en\"\n                    }\n                ],\n                \"og_images\": []\n            },\n            \"option_types\": [\n                {\n                    \"uid\": 764842755739604,\n                    \"filterable_key\": \"test_option_type\",\n                    \"input_type\": 0,\n                    \"preselect_default\": true,\n                    \"translations\": [\n                        {\n                            \"title\": \"Test Option Type\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"options\": [\n                        {\n                            \"uid\": 200387624273178,\n                            \"filterable_key\": \"option_one\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"option one\",\n                                    \"locale\": \"en\"\n                                }\n                            ],\n                            \"price_operator\": 1,\n                            \"price_operand\": 1,\n                            \"price\": 10.0,\n                            \"display_price_value\": \"-10.0%\",\n                            \"default\": true,\n                            \"created_at\": \"21/09/2023 09:00:19\",\n                            \"updated_at\": \"21/09/2023 09:00:19\"\n                        },\n                        {\n                            \"uid\": 882301226439411,\n                            \"filterable_key\": \"option_two\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"option two\",\n                                    \"locale\": \"en\"\n                                }\n                            ],\n                            \"price_operator\": 1,\n                            \"price_operand\": 1,\n                            \"price\": 15.0,\n                            \"display_price_value\": \"-15.0%\",\n                            \"default\": null,\n                            \"created_at\": \"21/09/2023 09:00:19\",\n                            \"updated_at\": \"21/09/2023 09:00:19\"\n                        }\n                    ],\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"21/09/2023 09:00:19\"\n                }\n            ],\n            \"variants\": [],\n            \"measurements\": {\n                \"weight\": \"2.5\",\n                \"length\": \"14.0\",\n                \"width\": \"12.0\",\n                \"height\": \"10.0\"\n            },\n            \"order_status\": {\n                \"can_backorder\": false,\n                \"can_preorder\": false,\n                \"available_on\": null\n            },\n            \"images\": [\n                {\n                    \"id\": 12156,\n                    \"file_name\": \"Carton-Packaging-Box-Mockup-2.jpg\",\n                    \"thumbnail\": \"https://storage.googleapis.com/myshop_1665646692/products/7a17ffee69c4cfb5d4610541e0e68f34e65fa170/thumbnails/carton-packaging-box-mockup-2_1695286819.jpg\",\n                    \"preview\": \"https://storage.googleapis.com/myshop_1665646692/products/7a17ffee69c4cfb5d4610541e0e68f34e65fa170/previews/carton-packaging-box-mockup-2_1695286819.jpg\",\n                    \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/7a17ffee69c4cfb5d4610541e0e68f34e65fa170/lists/carton-packaging-box-mockup-2_1695286819.jpg\",\n                    \"banner\": \"https://storage.googleapis.com/myshop_1665646692/products/7a17ffee69c4cfb5d4610541e0e68f34e65fa170/banners/carton-packaging-box-mockup-2_1695286819.jpg\"\n                },\n                {\n                    \"id\": 12160,\n                    \"file_name\": \"packaging-box-mockup-free.jpg\",\n                    \"thumbnail\": \"https://storage.googleapis.com/myshop_1665646692/products/7a17ffee69c4cfb5d4610541e0e68f34e65fa170/thumbnails/packaging-box-mockup-free_1695286832.jpg\",\n                    \"preview\": \"https://storage.googleapis.com/myshop_1665646692/products/7a17ffee69c4cfb5d4610541e0e68f34e65fa170/previews/packaging-box-mockup-free_1695286832.jpg\",\n                    \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/7a17ffee69c4cfb5d4610541e0e68f34e65fa170/lists/packaging-box-mockup-free_1695286832.jpg\",\n                    \"banner\": \"https://storage.googleapis.com/myshop_1665646692/products/7a17ffee69c4cfb5d4610541e0e68f34e65fa170/banners/packaging-box-mockup-free_1695286832.jpg\"\n                }\n            ],\n            \"max_purchasable_quantity\": null,\n            \"max_product_quantity\": 14,\n            \"created_at\": \"21/09/2023 09:00:19\",\n            \"updated_at\": \"21/09/2023 09:00:42\",\n            \"display_total_compare_to_price\": \"€136.40\",\n            \"display_price\": \"€50.50\",\n            \"display_tax_price\": \"€12.12\",\n            \"display_total_price\": \"€62.62\",\n            \"on_sale\": true,\n            \"on_sale_percentage\": 54.090909090909086,\n            \"show_price\": true,\n            \"has_tax\": true,\n            \"stock_items\": [\n                {\n                    \"store\": {\n                        \"uid\": 346326890542861,\n                        \"translations\": [\n                            {\n                                \"title\": \"Warehouse - Nicosia Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:04:49\",\n                        \"updated_at\": \"24/08/2023 10:22:02\"\n                    },\n                    \"quantity\": 20,\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"21/09/2023 09:00:19\"\n                },\n                {\n                    \"store\": {\n                        \"uid\": 473251864538157,\n                        \"translations\": [\n                            {\n                                \"title\": \"Nicosia Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:05:10\",\n                        \"updated_at\": \"15/06/2023 12:02:12\"\n                    },\n                    \"quantity\": 40,\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"21/09/2023 09:00:19\"\n                },\n                {\n                    \"store\": {\n                        \"uid\": 444686109884420,\n                        \"translations\": [\n                            {\n                                \"title\": \"Limassol Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:05:26\",\n                        \"updated_at\": \"15/06/2023 12:02:12\"\n                    },\n                    \"quantity\": 15,\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"21/09/2023 09:00:19\"\n                },\n                {\n                    \"store\": {\n                        \"uid\": 512592570248121,\n                        \"translations\": [\n                            {\n                                \"title\": \"Pafos Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"safdsfdaaaffffa\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:05:46\",\n                        \"updated_at\": \"30/08/2023 08:32:48\"\n                    },\n                    \"quantity\": 0,\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"21/09/2023 09:00:19\"\n                },\n                {\n                    \"store\": {\n                        \"uid\": 699304110431578,\n                        \"translations\": [\n                            {\n                                \"title\": \"Clearance Warehouse - Nicosia Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:06:18\",\n                        \"updated_at\": \"15/06/2023 12:02:12\"\n                    },\n                    \"quantity\": 50,\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"21/09/2023 09:00:19\"\n                }\n            ],\n            \"taxes\": [\n                {\n                    \"uid\": 481258870904813,\n                    \"translations\": [\n                        {\n                            \"title\": \"Φ.Π.Α\",\n                            \"locale\": \"el\"\n                        },\n                        {\n                            \"title\": \"Default tax\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"is_default\": true,\n                    \"rate\": 0.24,\n                    \"applies_to\": \"subtotal\",\n                    \"included_in_price\": false,\n                    \"created_at\": \"13/10/2022 07:38:20\",\n                    \"updated_at\": \"07/09/2023 08:27:49\"\n                }\n            ],\n            \"prices\": [\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 45.5,\n                    \"compare_to_price\": 100.0\n                },\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 42.0,\n                    \"compare_to_price\": 95.0\n                },\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 46.0,\n                    \"compare_to_price\": 105.0\n                },\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 41.0,\n                    \"compare_to_price\": 90.0\n                }\n            ]\n        },\n        \"custom_fields\": [\n            {\n                \"type\": \"text\",\n                \"key\": \"test_key\",\n                \"value\": \"test_value\"\n            }\n        ],\n        \"logs\": []\n    }\n}\n\n
\nReturns a new product with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the product
type String The type of item
translations Array An array of product's translations. Every translation is an object with the following fields:  
- title  
- subtitle  
- slug  
- description  
- locale
sku String The sku of the product
compare_to_price Float The compare to price of the product
price Float The price of the product
published Boolean Whether the product is published or not
prototype_uid Bigint The ID of product's category
attributes Array An array of product's attributes. Every attribute is an object with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- prototype_attribute_uid  
- prototype_attribute_key  
- created_at  
- updated_at
meta_tags Object An object with informations about product's meta_tags:  
- translations - an array of meta tag's translations. Every translation is an object with following fields:  
- title  
- description  
- keywords  
- locale
option_types Array An array with product's option types. Every option type is an object with the following fields:  
- uid  
- filterable_key  
- input_type  
- preselect_default  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- options - an array of option type's options. Every option is an abject with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- price_operator  
- price_operand  
- price  
- default_price_value  
- default  
- created_at  
- updated_at  
- created_at  
- updated_at
variants Array An array of product's variants. In this case it's empty.
measurements Object An object with informations about product's measuments. It contains the following fields:  
- weight  
- length  
- width  
- height
order_status Object An object with informations about product's order status. It contains the following fields:  
- can_backorder  
- can_preorder  
- available_on
images Array An array of product's images. Every image is an object with the following fields:  
- id  
- file_name  
- thumbnail  
- preview  
- list_view  
- banner
max_purchasable_quantity Integer The maximum purchasable quantity of this product per order
max_product_quantity Integer The maximum purchasable quantity of products per order
created_at String The date that product was created
updated_at String The date that product was updated
display_total_compare_to_price String The total compare to price of product in display format
display_price String The price of product in display format
display_tax_price String The tax price of product in display format
display_total_price String The total price of product in display format
on_sale Boolean Whether the product is on sale or not
on_sale_percentage Float The percentage of discount of product
show_price Boolean Whether to show product's price or not
has_tax Boolean Whether the product has tax or not
stock_items Array An array of product's stock items. Every stock item is an object with the following fields:  
- store - an object with information about stock item's store. This object contains the following fields:  
- uid  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- email  
- visible  
- pickup_allowed  
- created_at  
- updated_at  
- quantity  
- created_at  
- updated_at
taxes Array An array of product's taxes. Every tax is an object with the following fields:  
- uid  
- translations - an array of tax's translations. Every translation is an object with following fields:  
- title  
- locale  
- is_default  
- rate  
- applies_to  
- included_in_price  
- created_at  
- updated_at
prices Array An array of product's price list prices. Every price is an object with the following fields:  
- price_list_title  
- price_list_api_uid  
- price  
- compare_to_price
\n
Also returns a custom_fields object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
type String The type of value (\"text\" or \"html\" or \"json\")
key String The key of custom field
value String The value of custom field
\n
logs - An array of notes related to the request (e.g. [\"invalid prototype uid\"])
\nErrors
\nExample: title is blank
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"Error creating product\",\n        \"message\": \"Title can't be blank\"\n    }\n}\n\n
\nExample: price is not a number
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"Error creating product\",\n        \"message\": \"Price not a number.\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","products"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"1a6f32cc-df45-4834-a248-64dc1d3c35ad"},{"name":"Update Product","id":"707ea0a4-fe7c-46bb-ad74-7c70b4923f5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{   \n    \"product\": {\n        \"locale\": \"el\",\n        \"sku\": \"00140371\",\n        \"price\": 40,\n        \"compare_to_price\": 10,\n        \"published\": true,\n        \"applied_tax_uid\": 155183482461123,\n        \"prototype_uid\": 345583482461114,\n        \"product_attributes\": [{\n            \"title\": \"EL-Attribute 1\",\n            \"product_attribute_uid\": 123433331312\n        },{\n            \"title\": \"EL-Attribute 2\",\n            \"product_attribute_uid\": 123433331311\n        }],\n        \"product_measurement\": {\n            \"weight\": \"1.5\",\n            \"length\": \"15.0\",\n            \"width\": \"15.0\",\n            \"height\": \"10.0\"\n        },\n        \"stock_items\": [{\n            \"store_uid\": 155183482461601,\n            \"quantity\": 50\n        },{\n            \"store_uid\": 125183482461631,\n            \"quantity\": 20\n        }],\n        \"product_images\": [{\n            \"url\": \"https//example.com/image1.jpg\",\n            \"position\": 1\n        },{\n            \"url\": \"https//example.com/image2.jpg\",\n            \"position\": 2\n        }],\n        \"option_types\": [{\n            \"title\": \"EL-Option-Type 1\",\n            \"options\": [{\n                \"title\": \"EL-Option 1\", \n                \"price_operator\": 0, \n                \"price_operand\": 0, \n                \"price\": 12 \n            },{\n                \"title\": \"EL-Option 2\", \n                \"price_operator\": 0, \n                \"price_operand\": 0, \n                \"price\": 12 \n            }]},{\n            \"title\": \"EL-Option-Type 2\",\n            \"options\": [{\n                \"title\": \"EL-Option 1\", \n                \"price_operator\": 0, \n                \"price_operand\": 0, \n                \"price\": 12 \n            },{\n                \"title\": \"EL-Option 2\", \n                \"price_operator\": 0, \n                \"price_operand\": 0, \n                \"price\": 12 \n            }]\n        }],\n        \"seo\": {\n            \"title\": \"EL-SEO\", \n            \"keywords\": \"EL-SEO-Keyword 1, EL-SEO-Keyword 2\", \n            \"description\": \"EL-SEO-description\"\n        },\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"custom-field-key-1\", \n                \"value\": \"custom-field-value-1\",\n                \"type\": \"text\"\n            },\n            \"custom_field2\": {\n                \"key\": \"custom-field-key-2\", \n                \"value\": \"custom-field-value-2\",\n                \"type\": \"html\"\n            }, \n            \"custom_field3\": {\n                \"key\": \"custom-field-key-3\", \n                \"value\": \"custom-field-value-3\",\n                \"type\": \"json\"\n            },\n            \"custom_field4\": {\n                \"key\": \"custom-field-key-4\", \n                \"value\": \"custom-field-value-4\",\n                \"type\": \"text\"\n            },\n            \"custom_field5\": {\n                \"key\": \"custom-field-key-5\", \n                \"value\": \"custom-field-value-5\",\n                \"type\": \"text\"\n            },\n            \"custom_field6\": {\n                \"key\": \"custom-field-key-6\", \n                \"value\": \"custom-field-value-6\",\n                \"type\": \"text\"\n            },\n            \"custom_field7\": {\n                \"key\": \"custom-field-key-7\", \n                \"value\": \"custom-field-value-7\",\n                \"type\": \"text\"\n            },\n            \"custom_field8\": {\n                \"key\": \"custom-field-key-8\", \n                \"value\": \"custom-field-value-8\",\n                \"type\": \"text\"\n            },\n            \"custom_field9\": {\n                \"key\": \"custom-field-key-9\", \n                \"value\": \"custom-field-value-9\",\n                \"type\": \"text\"\n            },\n            \"custom_field10\": {\n                \"key\": \"custom-field-key-10\", \n                \"value\": \"custom-field-value-10\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/products/product_uid","description":"Updates a product
\nParameters
\nproduct_uid <**_**Bigint> -_ Indicates the id of the product to be updated.
\n{   \"product\":{\n        \"locale\": \"en\",\n        \"sku\": \"01234567\",\n        \"price\": 92.99,\n        \"compare_to_price\": 100.0,\n        \"published\": false,\n        \"prototype_uid\": 438785098766320,\n        \"applied_tax_uid\": 481258870904813,\n        \"product_measurement\": {\n            \"weight\": 0.55,\n            \"length\": 15.0,\n            \"width\": 13.0,\n            \"height\": 9.0\n        },\n        \"product_attributes\": [\n            {\n                \"title\": \"0123412341234\",\n                \"product_attribute_uid\": 213723296905979\n            },\n            {\n                \"title\": \"Test Brand One\",\n                \"product_attribute_uid\": 936680195614754\n            },\n            {\n                \"title\": \"Orange\",\n                \"product_attribute_uid\": 610813415070212\n            },\n            {\n                \"title\": \"Yes\",\n                \"product_attribute_uid\": 230231242436689\n            },\n            {\n                \"title\": \"Microtextured\",\n                \"product_attribute_uid\": 350833511876953\n            },\n            {\n                \"title\": \"22cm x 27cm\",\n                \"product_attribute_uid\": 121609346910613\n            }\n        ],\n        \"option_types\": [\n            {\n                \"title\": \"Test Option Type One\",\n                \"option_type_api_uid\": 764842755739604,\n                \"options\": [\n                    {\n                        \"title\": \"product option one\", \n                        \"price_operator\": 0, \n                        \"price_operand\": 1, \n                        \"price\": 15,\n                        \"option_api_uid\": 200387624273178\n                    },\n                    {\n                    \"title\": \"product option two\", \n                    \"price_operator\": 0, \n                    \"price_operand\": 1, \n                    \"price\": 20,\n                    \"option_api_uid\": 882301226439411\n                    }\n                ]\n            }\n        ],\n        \"stock_items\": [\n            {\n                \"store_uid\": 346326890542861,\n                \"quantity\": 11\n            },\n            {\n                \"store_uid\": 473251864538157,\n                \"quantity\": 40\n            },\n            {\n                \"store_uid\": 444686109884420,\n                \"quantity\": 15\n            },\n            {\n                \"store_uid\": 512592570248121,\n                \"quantity\": 0\n            },\n            {\n                \"store_uid\": 699304110431578,\n                \"quantity\": 50\n            }\n        ],\n        \"product_images\": [\n            {\n                \"url\": \"https://unblast.com/wp-content/uploads/2019/08/Carton-Packaging-Box-Mockup-2.jpg\",\n                \"position\": 2\n            },\n            {\n                \"url\": \"https://dailymockup.com/wp-content/uploads/edd/2019/05/packaging-box-mockup-free.jpg\",\n                \"position\": 1\n            }\n        ],\n        \"seo\": {\n            \"title\": \"test title one\",\n            \"keywords\": \"keyword_1, keyword_2\",\n            \"description\": \"test description\"\n        },\n        \"product_order_status\": {\n            \"can_backorder\": false,\n            \"can_preorder\": false, \n            \"available_on\": null\n        },\n        \"prices\": [\n            {\n                \"price_list_uid\": 941615867930108,\n                \"price\": 44.5,\n                \"compare_to_price\": 100\n            },\n            {\n                \"price_list_uid\": 941615867930108,\n                \"price\": 42,\n                \"compare_to_price\": 95\n            },\n            {\n                \"price_list_uid\": 941615867930108,\n                \"price\": 43,\n                \"compare_to_price\": 102\n            },\n            {\n                \"price_list_uid\": 941615867930108,\n                \"price\": 41,\n                \"compare_to_price\": 90\n            }\n        ],\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"new test key\",\n                \"value\": \"new test value\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}\n\n
\nWe send a product object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nRequired Field Type Description
Conditional locale String Must be provided if there are changes in product/category attributes, options or seo. The locale of the translations to be updated.
Optional sku String The sku of the product
Optional price Float The price of the product
Optional compare_to_price Float The compare to price of the product
Optional published Boolean Whether the product is published or not
Optional applied_tax_uid Bigint The ID of the applied tax of the product
Optional product_measurement Object An object with informations about product's measurement. It contains the following fields:  
- weight(Float) - in kg  
- length(Float) - in cm  
- width(Float) - in cm  
- height(Float) - in cm
Optional prototype_uid Bigint The ID of the category of the product
Conditional prototype_attributes Array Must be provided if the existed category of the product will be changed. An array of product's category attributes. Every category attribute is an object with the following fields:  
- title(String)  
- prototype_attribute_uid(Bigint) - prototype attribute ID
Conditional product_attributes Array Must be provided if the existed category of the product remains.  
An array of product's attributes. Every product attribute is an object with the following fields:  
- title(String)  
- product_attribute_uid(Bigint) - prototype attribute ID
Optional option_types Array An array of product's category attributes. Every category attribute is an object with the following fields:  
- title(String)  
- option_type_api_uid(Bigint) - the ID of the product option  
- options(Array) - an array of products available options. Every option is an object that contains the following fields:  
1. title(String)  
2. price_operator(Integer) - must be 0(+) or 1(-)  
3. price_operand(Integer) - must be 0(x starting price) or 1(% of starting price)  
4. price(Float)  
5. option_api_uid(Float) - the ID of the product option
Optional stock_items Array An array of product's stock items. Every stock item is an object with the following fields:  
- store_uid(Bigint) - store ID  
- quantity(Integer)
Optional product_images Array An array of product's images. Every image is an object with the following fields:  
- url  
- position(Integer) - the display order of image
Optional seo Object An object with informations about product's seo. It contains the following fields:  
- title(String)  
- keywords(String)  
- description(String)
Optional product_order_status Object An object with informations about product's order status. It contains the following fields:  
- can_backorder(Boolean)  
- can_preorder(Boolean)  
- available_on(String) - must be a date in format DD-MM-YYYY hh::mm (e.g. \"19-10-2023 11:00\")
Optional prices Array An array of product's price list prices. Every price is an object with the following fields:  
- price_list_uid(Bigint) - the ID of price list  
- price(Float)  
- compare_to_price(Float)
Optional custom_fields Object An object with product's custom fields. It contains the following a field for every custom field to be added. Field name follows the pattern custom_field. Can add up to 10 custom fields. Every custom field contains the following fields:  
- key(String)  
- value(String)  
- type(String) - must be \"text\" or \"html\" or \"json\"
\n
For every custom field parameter provided, which has key that do not exist in product's current custom fields, a new one is created. Elsewise the existed custom field gets updated.
\nResponse
\n{\n    \"response\": {\n        \"product\": {\n            \"uid\": 171255899643487,\n            \"type\": \"product\",\n            \"translations\": [\n                {\n                    \"title\": \"Test product\",\n                    \"subtitle\": \"Nam magna lorem, vulputate vel semper scelerisque, elementum eu arcu.\",\n                    \"slug\": \"test-product\",\n                    \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer rhoncus ac diam et euismod. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Cras at orci nunc. Donec euismod pharetra venenatis. Nulla maximus, dui nec rhoncus ornare, eros nulla rhoncus turpis, vitae scelerisque magna mi eu purus.\",\n                    \"locale\": \"en\"\n                },\n                {\n                    \"title\": \"update DE-Test Product\",\n                    \"subtitle\": \"updated DE-Product subtitle\",\n                    \"slug\": \"update-de-test-product\",\n                    \"description\": \"updated DE-Product description\",\n                    \"locale\": \"de\"\n                }\n            ],\n            \"sku\": \"01234567\",\n            \"compare_to_price\": 100.0,\n            \"price\": 92.99,\n            \"published\": false,\n            \"prototype_uid\": 438785098766320,\n            \"attributes\": [\n                {\n                    \"uid\": 213723296905979,\n                    \"filterable_key\": \"0123412341234\",\n                    \"translations\": [\n                        {\n                            \"title\": \"0123412341234\",\n                            \"locale\": \"en\"\n                        },\n                        {\n                            \"title\": \"0034512345123\",\n                            \"locale\": \"de\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 511657348593198,\n                    \"prototype_attribute_key\": \"UPC\",\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"25/09/2023 07:56:13\"\n                },\n                {\n                    \"uid\": 936680195614754,\n                    \"filterable_key\": \"test_brand_one\",\n                    \"translations\": [\n                        {\n                            \"title\": \"Test Brand One\",\n                            \"locale\": \"en\"\n                        },\n                        {\n                            \"title\": \"Test Brand DE\",\n                            \"locale\": \"de\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 792147838615580,\n                    \"prototype_attribute_key\": \"Brand\",\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"25/09/2023 07:56:13\"\n                },\n                {\n                    \"uid\": 610813415070212,\n                    \"filterable_key\": \"orange\",\n                    \"translations\": [\n                        {\n                            \"title\": \"Orange\",\n                            \"locale\": \"en\"\n                        },\n                        {\n                            \"title\": \"Blau\",\n                            \"locale\": \"de\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 850013564166658,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"25/09/2023 07:56:13\"\n                },\n                {\n                    \"uid\": 230231242436689,\n                    \"filterable_key\": \"yes\",\n                    \"translations\": [\n                        {\n                            \"title\": \"Yes\",\n                            \"locale\": \"en\"\n                        },\n                        {\n                            \"title\": \"Nein\",\n                            \"locale\": \"de\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 195658809681290,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"25/09/2023 07:56:13\"\n                },\n                {\n                    \"uid\": 350833511876953,\n                    \"filterable_key\": \"microtextured\",\n                    \"translations\": [\n                        {\n                            \"title\": \"Microtextured\",\n                            \"locale\": \"en\"\n                        },\n                        {\n                            \"title\": \"Mikrotexturiert\",\n                            \"locale\": \"de\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 491806080342594,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"21/09/2023 11:37:52\"\n                },\n                {\n                    \"uid\": 121609346910613,\n                    \"filterable_key\": \"22cm_x_27cm\",\n                    \"translations\": [\n                        {\n                            \"title\": \"22cm x 27cm\",\n                            \"locale\": \"en\"\n                        },\n                        {\n                            \"title\": \"19cm x 26cm\",\n                            \"locale\": \"de\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 199027907529441,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"25/09/2023 07:56:13\"\n                }\n            ],\n            \"meta_tags\": {\n                \"translations\": [\n                    {\n                        \"title\": \"test title one\",\n                        \"description\": \"test description\",\n                        \"keywords\": \"keyword_1, keyword_2\",\n                        \"locale\": \"en\"\n                    },\n                    {\n                        \"title\": \"DE-SEO\",\n                        \"description\": \"DE-SEO-description\",\n                        \"keywords\": \"DE-SEO-Keyword 1, DE-SEO-Keyword 2, DE-SEO-Keyword 3\",\n                        \"locale\": \"de\"\n                    }\n                ],\n                \"og_images\": []\n            },\n            \"option_types\": [\n                {\n                    \"uid\": 764842755739604,\n                    \"filterable_key\": \"test_option_type_one\",\n                    \"input_type\": 0,\n                    \"preselect_default\": true,\n                    \"translations\": [\n                        {\n                            \"title\": \"Test Option Type One\",\n                            \"locale\": \"en\"\n                        },\n                        {\n                            \"title\": \"Test Option Type DE\",\n                            \"locale\": \"de\"\n                        }\n                    ],\n                    \"options\": [\n                        {\n                            \"uid\": 200387624273178,\n                            \"filterable_key\": \"product_option_one\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"product option one\",\n                                    \"locale\": \"en\"\n                                },\n                                {\n                                    \"title\": \"updated option one de\",\n                                    \"locale\": \"de\"\n                                }\n                            ],\n                            \"price_operator\": 0,\n                            \"price_operand\": 1,\n                            \"price\": 15.0,\n                            \"display_price_value\": \"+15.0%\",\n                            \"default\": true,\n                            \"created_at\": \"21/09/2023 09:00:19\",\n                            \"updated_at\": \"25/09/2023 07:39:05\"\n                        },\n                        {\n                            \"uid\": 882301226439411,\n                            \"filterable_key\": \"product_option_two\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"product option two\",\n                                    \"locale\": \"en\"\n                                },\n                                {\n                                    \"title\": \"option two de\",\n                                    \"locale\": \"de\"\n                                }\n                            ],\n                            \"price_operator\": 0,\n                            \"price_operand\": 1,\n                            \"price\": 20.0,\n                            \"display_price_value\": \"+20.0%\",\n                            \"default\": false,\n                            \"created_at\": \"21/09/2023 09:00:19\",\n                            \"updated_at\": \"25/09/2023 07:39:05\"\n                        }\n                    ],\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"25/09/2023 07:39:05\"\n                },\n                {\n                    \"uid\": 192277111936672,\n                    \"filterable_key\": \"test_option_type_one\",\n                    \"input_type\": 0,\n                    \"preselect_default\": true,\n                    \"translations\": [\n                        {\n                            \"title\": \"Test Option Type One\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"options\": [\n                        {\n                            \"uid\": 489228434182043,\n                            \"filterable_key\": \"product_option_one\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"product option one\",\n                                    \"locale\": \"en\"\n                                }\n                            ],\n                            \"price_operator\": 0,\n                            \"price_operand\": 1,\n                            \"price\": 15.0,\n                            \"display_price_value\": \"+15.0%\",\n                            \"default\": true,\n                            \"created_at\": \"25/09/2023 08:07:09\",\n                            \"updated_at\": \"25/09/2023 08:07:09\"\n                        },\n                        {\n                            \"uid\": 68702696982854,\n                            \"filterable_key\": \"product_option_two\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"product option two\",\n                                    \"locale\": \"en\"\n                                }\n                            ],\n                            \"price_operator\": 0,\n                            \"price_operand\": 1,\n                            \"price\": 20.0,\n                            \"display_price_value\": \"+20.0%\",\n                            \"default\": null,\n                            \"created_at\": \"25/09/2023 08:07:09\",\n                            \"updated_at\": \"25/09/2023 08:07:09\"\n                        }\n                    ],\n                    \"created_at\": \"25/09/2023 08:07:09\",\n                    \"updated_at\": \"25/09/2023 08:07:09\"\n                },\n                {\n                    \"uid\": 890116662369394,\n                    \"filterable_key\": \"test_option_type_one\",\n                    \"input_type\": 0,\n                    \"preselect_default\": true,\n                    \"translations\": [\n                        {\n                            \"title\": \"Test Option Type One\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"options\": [\n                        {\n                            \"uid\": 488122632697425,\n                            \"filterable_key\": \"product_option_one\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"product option one\",\n                                    \"locale\": \"en\"\n                                }\n                            ],\n                            \"price_operator\": 0,\n                            \"price_operand\": 1,\n                            \"price\": 15.0,\n                            \"display_price_value\": \"+15.0%\",\n                            \"default\": true,\n                            \"created_at\": \"25/09/2023 08:18:28\",\n                            \"updated_at\": \"25/09/2023 08:18:28\"\n                        },\n                        {\n                            \"uid\": 458920803160252,\n                            \"filterable_key\": \"product_option_two\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"product option two\",\n                                    \"locale\": \"en\"\n                                }\n                            ],\n                            \"price_operator\": 0,\n                            \"price_operand\": 1,\n                            \"price\": 20.0,\n                            \"display_price_value\": \"+20.0%\",\n                            \"default\": null,\n                            \"created_at\": \"25/09/2023 08:18:28\",\n                            \"updated_at\": \"25/09/2023 08:18:28\"\n                        }\n                    ],\n                    \"created_at\": \"25/09/2023 08:18:28\",\n                    \"updated_at\": \"25/09/2023 08:18:28\"\n                },\n                {\n                    \"uid\": 600087895600277,\n                    \"filterable_key\": \"test_option_type_one\",\n                    \"input_type\": 0,\n                    \"preselect_default\": true,\n                    \"translations\": [\n                        {\n                            \"title\": \"Test Option Type One\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"options\": [\n                        {\n                            \"uid\": 984034936656161,\n                            \"filterable_key\": \"product_option_one\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"product option one\",\n                                    \"locale\": \"en\"\n                                }\n                            ],\n                            \"price_operator\": 0,\n                            \"price_operand\": 1,\n                            \"price\": 15.0,\n                            \"display_price_value\": \"+15.0%\",\n                            \"default\": true,\n                            \"created_at\": \"25/09/2023 08:18:49\",\n                            \"updated_at\": \"25/09/2023 08:18:49\"\n                        },\n                        {\n                            \"uid\": 229289305312128,\n                            \"filterable_key\": \"product_option_two\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"product option two\",\n                                    \"locale\": \"en\"\n                                }\n                            ],\n                            \"price_operator\": 0,\n                            \"price_operand\": 1,\n                            \"price\": 20.0,\n                            \"display_price_value\": \"+20.0%\",\n                            \"default\": null,\n                            \"created_at\": \"25/09/2023 08:18:49\",\n                            \"updated_at\": \"25/09/2023 08:18:49\"\n                        }\n                    ],\n                    \"created_at\": \"25/09/2023 08:18:49\",\n                    \"updated_at\": \"25/09/2023 08:18:49\"\n                },\n                {\n                    \"uid\": 172882470739839,\n                    \"filterable_key\": \"test_option_type_one\",\n                    \"input_type\": 0,\n                    \"preselect_default\": true,\n                    \"translations\": [\n                        {\n                            \"title\": \"Test Option Type One\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"options\": [\n                        {\n                            \"uid\": 140874783592695,\n                            \"filterable_key\": \"product_option_one\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"product option one\",\n                                    \"locale\": \"en\"\n                                }\n                            ],\n                            \"price_operator\": 0,\n                            \"price_operand\": 1,\n                            \"price\": 15.0,\n                            \"display_price_value\": \"+15.0%\",\n                            \"default\": true,\n                            \"created_at\": \"25/09/2023 08:36:35\",\n                            \"updated_at\": \"25/09/2023 08:36:36\"\n                        },\n                        {\n                            \"uid\": 359977308993414,\n                            \"filterable_key\": \"product_option_two\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"product option two\",\n                                    \"locale\": \"en\"\n                                }\n                            ],\n                            \"price_operator\": 0,\n                            \"price_operand\": 1,\n                            \"price\": 20.0,\n                            \"display_price_value\": \"+20.0%\",\n                            \"default\": null,\n                            \"created_at\": \"25/09/2023 08:36:36\",\n                            \"updated_at\": \"25/09/2023 08:36:36\"\n                        }\n                    ],\n                    \"created_at\": \"25/09/2023 08:36:35\",\n                    \"updated_at\": \"25/09/2023 08:36:36\"\n                },\n                {\n                    \"uid\": 205638801488500,\n                    \"filterable_key\": \"test_option_type_one\",\n                    \"input_type\": 0,\n                    \"preselect_default\": true,\n                    \"translations\": [\n                        {\n                            \"title\": \"Test Option Type One\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"options\": [\n                        {\n                            \"uid\": 641104802361055,\n                            \"filterable_key\": \"product_option_one\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"product option one\",\n                                    \"locale\": \"en\"\n                                }\n                            ],\n                            \"price_operator\": 0,\n                            \"price_operand\": 1,\n                            \"price\": 15.0,\n                            \"display_price_value\": \"+15.0%\",\n                            \"default\": true,\n                            \"created_at\": \"25/09/2023 08:37:09\",\n                            \"updated_at\": \"25/09/2023 08:37:09\"\n                        },\n                        {\n                            \"uid\": 775254629688336,\n                            \"filterable_key\": \"product_option_two\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"product option two\",\n                                    \"locale\": \"en\"\n                                }\n                            ],\n                            \"price_operator\": 0,\n                            \"price_operand\": 1,\n                            \"price\": 20.0,\n                            \"display_price_value\": \"+20.0%\",\n                            \"default\": null,\n                            \"created_at\": \"25/09/2023 08:37:09\",\n                            \"updated_at\": \"25/09/2023 08:37:09\"\n                        }\n                    ],\n                    \"created_at\": \"25/09/2023 08:37:09\",\n                    \"updated_at\": \"25/09/2023 08:37:09\"\n                }\n            ],\n            \"variants\": [],\n            \"measurements\": {\n                \"weight\": \"0.55\",\n                \"length\": \"15.0\",\n                \"width\": \"13.0\",\n                \"height\": \"9.0\"\n            },\n            \"order_status\": {\n                \"can_backorder\": false,\n                \"can_preorder\": false,\n                \"available_on\": null\n            },\n            \"images\": [\n                {\n                    \"id\": 12160,\n                    \"file_name\": \"packaging-box-mockup-free.jpg\",\n                    \"thumbnail\": \"https://storage.googleapis.com/myshop_1665646692/products/7a17ffee69c4cfb5d4610541e0e68f34e65fa170/thumbnails/packaging-box-mockup-free_1695286832.jpg\",\n                    \"preview\": \"https://storage.googleapis.com/myshop_1665646692/products/7a17ffee69c4cfb5d4610541e0e68f34e65fa170/previews/packaging-box-mockup-free_1695286832.jpg\",\n                    \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/7a17ffee69c4cfb5d4610541e0e68f34e65fa170/lists/packaging-box-mockup-free_1695286832.jpg\",\n                    \"banner\": \"https://storage.googleapis.com/myshop_1665646692/products/7a17ffee69c4cfb5d4610541e0e68f34e65fa170/banners/packaging-box-mockup-free_1695286832.jpg\"\n                },\n                {\n                    \"id\": 12156,\n                    \"file_name\": \"Carton-Packaging-Box-Mockup-2.jpg\",\n                    \"thumbnail\": \"https://storage.googleapis.com/myshop_1665646692/products/7a17ffee69c4cfb5d4610541e0e68f34e65fa170/thumbnails/carton-packaging-box-mockup-2_1695286819.jpg\",\n                    \"preview\": \"https://storage.googleapis.com/myshop_1665646692/products/7a17ffee69c4cfb5d4610541e0e68f34e65fa170/previews/carton-packaging-box-mockup-2_1695286819.jpg\",\n                    \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/7a17ffee69c4cfb5d4610541e0e68f34e65fa170/lists/carton-packaging-box-mockup-2_1695286819.jpg\",\n                    \"banner\": \"https://storage.googleapis.com/myshop_1665646692/products/7a17ffee69c4cfb5d4610541e0e68f34e65fa170/banners/carton-packaging-box-mockup-2_1695286819.jpg\"\n                }\n            ],\n            \"max_purchasable_quantity\": null,\n            \"max_product_quantity\": 14,\n            \"created_at\": \"21/09/2023 09:00:19\",\n            \"updated_at\": \"25/09/2023 08:37:09\",\n            \"display_total_compare_to_price\": \"€124.00\",\n            \"display_price\": \"€92.99\",\n            \"display_tax_price\": \"€22.32\",\n            \"display_total_price\": \"€115.31\",\n            \"total_price\": 115.31,\n            \"on_sale\": true,\n            \"on_sale_percentage\": 7.01,\n            \"show_price\": true,\n            \"has_tax\": true,\n            \"in_stock\": true,\n            \"total_stock\": 116,\n            \"stock_items\": [\n                {\n                    \"store\": {\n                        \"uid\": 346326890542861,\n                        \"translations\": [\n                            {\n                                \"title\": \"Warehouse - Nicosia Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:04:49\",\n                        \"updated_at\": \"24/08/2023 10:22:02\"\n                    },\n                    \"quantity\": 11,\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"25/09/2023 07:56:13\"\n                },\n                {\n                    \"store\": {\n                        \"uid\": 473251864538157,\n                        \"translations\": [\n                            {\n                                \"title\": \"Nicosia Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:05:10\",\n                        \"updated_at\": \"15/06/2023 12:02:12\"\n                    },\n                    \"quantity\": 40,\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"21/09/2023 09:00:19\"\n                },\n                {\n                    \"store\": {\n                        \"uid\": 444686109884420,\n                        \"translations\": [\n                            {\n                                \"title\": \"Limassol Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:05:26\",\n                        \"updated_at\": \"15/06/2023 12:02:12\"\n                    },\n                    \"quantity\": 15,\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"21/09/2023 09:00:19\"\n                },\n                {\n                    \"store\": {\n                        \"uid\": 512592570248121,\n                        \"translations\": [\n                            {\n                                \"title\": \"Pafos Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"safdsfdaaaffffa\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:05:46\",\n                        \"updated_at\": \"30/08/2023 08:32:48\"\n                    },\n                    \"quantity\": 0,\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"21/09/2023 09:00:19\"\n                },\n                {\n                    \"store\": {\n                        \"uid\": 699304110431578,\n                        \"translations\": [\n                            {\n                                \"title\": \"Clearance Warehouse - Nicosia Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:06:18\",\n                        \"updated_at\": \"15/06/2023 12:02:12\"\n                    },\n                    \"quantity\": 50,\n                    \"created_at\": \"21/09/2023 09:00:19\",\n                    \"updated_at\": \"21/09/2023 09:00:19\"\n                }\n            ],\n            \"taxes\": [\n                {\n                    \"uid\": 481258870904813,\n                    \"translations\": [\n                        {\n                            \"title\": \"Φ.Π.Α\",\n                            \"locale\": \"el\"\n                        },\n                        {\n                            \"title\": \"Default tax\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"is_default\": true,\n                    \"rate\": 0.24,\n                    \"applies_to\": \"subtotal\",\n                    \"included_in_price\": false,\n                    \"created_at\": \"13/10/2022 07:38:20\",\n                    \"updated_at\": \"07/09/2023 08:27:49\"\n                }\n            ],\n            \"prices\": [\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 41.0,\n                    \"compare_to_price\": 90.0\n                },\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 42.0,\n                    \"compare_to_price\": 95.0\n                },\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 46.0,\n                    \"compare_to_price\": 105.0\n                },\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 41.0,\n                    \"compare_to_price\": 90.0\n                }\n            ]\n        },\n        \"custom_fields\": [\n            {\n                \"type\": \"text\",\n                \"key\": \"test_key\",\n                \"value\": \"test_value\"\n            },\n            {\n                \"type\": \"text\",\n                \"key\": \"new test key\",\n                \"value\": \"new test value\"\n            }\n        ],\n        \"logs\": []\n    }\n}\n\n
\nReturns a product with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the product
type String The type of item
translations Array An array of product's translations. Every translation is an object with the following fields:  
- title  
- subtitle  
- slug  
- description  
- locale
sku String The sku of the product
compare_to_price Float The compare to price of the product
price Float The price of the product
published Boolean Whether the product is published or not
prototype_uid Bigint The ID of product's category
attributes Array An array of product's attributes. Every attribute is an object with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- prototype_attribute_uid  
- prototype_attribute_key  
- created_at  
- updated_at
meta_tags Object An object with informations about product's meta_tags:  
- translations - an array of meta tag's translations. Every translation is an object with following fields:  
- title  
- description  
- keywords  
- locale
option_types Array An array with product's option types. Every option type is an object with the following fields:  
- uid  
- filterable_key  
- input_type  
- preselect_default  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- options - an array of option type's options. Every option is an abject with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- price_operator  
- price_operand  
- price  
- default_price_value  
- default  
- created_at  
- updated_at  
- created_at  
- updated_at
variants Array An array of product's variants.
measurements Object An object with informations about product's measuments. It contains the following fields:  
- weight  
- length  
- width  
- height
order_status Object An object with informations about product's order status. It contains the following fields:  
- can_backorder  
- can_preorder  
- available_on
images Array An array of product's images. Every image is an object with the following fields:  
- id  
- file_name  
- thumbnail  
- preview  
- list_view  
- banner
max_purchasable_quantity Integer The maximum purchasable quantity of this product per order
max_product_quantity Integer The maximum purchasable quantity of products per order
created_at String The date that product was created
updated_at String The date that product was updated
display_total_compare_to_price String The total compare to price of product in display format
display_price String The price of product in display format
display_tax_price String The tax price of product in display format
display_total_price String The total price of product in display format
on_sale Boolean Whether the product is on sale or not
on_sale_percentage Float The percentage of discount of product
show_price Boolean Whether to show product's price or not
has_tax Boolean Whether the product has tax or not
stock_items Array An array of product's stock items. Every stock item is an object with the following fields:  
- store - an object with information about stock item's store. This object contains the following fields:  
- uid  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- email  
- visible  
- pickup_allowed  
- created_at  
- updated_at  
- quantity  
- created_at  
- updated_at
taxes Array An array of product's taxes. Every tax is an object with the following fields:  
- uid  
- translations - an array of tax's translations. Every translation is an object with following fields:  
- title  
- locale  
- is_default  
- rate  
- applies_to  
- included_in_price  
- created_at  
- updated_at
prices Array An array of product's price list prices. Every price is an object with the following fields:  
- price_list_title  
- price_list_api_uid  
- price  
- compare_to_price
\n
Also returns a custom_fields object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
type String The type of value (\"text\" or \"html\" or \"json\")
key String The key of custom field
value String The value of custom field
\n
logs - An array of notes related to the request (e.g. [\"invalid prototype uid\"])
\nErrors
\nExample: title is blank
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"product_not_found\",\n        \"message\": \"Product with specified uid does not exist\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","products","product_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"707ea0a4-fe7c-46bb-ad74-7c70b4923f5b"},{"name":"Delete Product","id":"c9eb1aff-9625-48f8-8097-6b7f38b01251","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/admapi/v1/products/product_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","products","product_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"c9eb1aff-9625-48f8-8097-6b7f38b01251"},{"name":"Add Translation","id":"ec218fc9-31e0-4fdc-9022-21276dbe2e7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{   \n    \"translation\": {\n        \"title\": \"DE-Product\", \n        \"slug\": \"de-category\", \n        \"subtitle\": \"DE-Product subtitle
\",\n        \"description\": \"DE-Product description
\",\n        \"attributes\": [\n            {\n                \"title\": \"DE-Attribute-1\",\n                \"uid\": 352419358000727\n            },\n            {\n                \"title\": \"DE-Attribute-2\",\n                \"uid\": 429172881178697\n            }\n        ],\n        \"seo\": {\n            \"title\": \"DE-SEO\", \n            \"keywords\": \"DE-SEO-Keyword 1, DE-SEO-Keyword 2\", \n            \"description\": \"DE-SEO-description\"\n        }\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/products/product_uid/translations/","description":"Creates a product translation
\nParameters
\nlocale <**_**String> -_ Indicates the locale of translation to be created.
product_uid <**_**Bigint> -_ The ID of product, for which the translation will be created.
\n{   \n    \"translation\": {\n        \"title\": \"DE-Test Product\",\n        \"subtitle\": \"DE-Product subtitle\",\n        \"description\": \"DE-Product description\",\n        \"attributes\": [\n            {\n                \"title\": \"1234512345123\",\n                \"uid\": 213723296905979\n            },\n            {\n                \"title\": \"DE Test Brand\",\n                \"uid\": 936680195614754\n            },\n            {\n                \"title\": \"Blau\",\n                \"uid\": 610813415070212\n            },\n            {\n                \"title\": \"Nein\",\n                \"uid\": 230231242436689\n            },\n            {\n                \"title\": \"Mikrotexturiert\",\n                \"uid\": 350833511876953\n            },\n            {\n                \"title\": \"20cm x 25cm\",\n                \"uid\": 121609346910613\n            }\n        ],\n        \"option_types\": [\n            {\n                \"title\": \"Test Option Type DE\", \n                \"uid\": 764842755739604,\n                \"options\": [\n                    {\n                        \"title\": \"option one de\", \n                        \"uid\": 200387624273178\n                    },\n                    {\n                        \"title\": \"option two de\", \n                        \"uid\": 882301226439411\n                    }\n                ]\n            }\n        ],\n        \"seo\": {\n            \"title\": \"DE-SEO\", \n            \"keywords\": \"DE-SEO-Keyword 1, DE-SEO-Keyword 2\", \n            \"description\": \"DE-SEO-description\"\n        }\n    }\n}\n\n
\nWe send a product object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nRequired Field Type Description
Mandatory title String The title of the product's translation
Optional slug String The slug of product
Optional subtitle String The subtitle of the product's translation
Optional description String The description of the product's translation
Optional attributes Array An array of product's attributes. Every product attribute is an object with the following fields:  
- title(String)  
- uid(Bigint) - product attribute ID
Optional option_types Array An array of product's option types. Every option type is an object with the following fields:  
- title(String)  
- uid(Bigint) - option type ID  
- options(Array) - an array of options. Every option is an object with the following fields:  
- title(String)  
- uid(Bigint) - option ID
Optional seo Object An object with informations about product's seo. It contains the following fields:  
- title(String)  
- keywords(String)  
- description(String)
\n
Response
\n{\n    \"response\": {\n        \"translation\": {\n            \"title\": \"DE-Test Product\",\n            \"subtitle\": \"DE-Product subtitle\",\n            \"slug\": \"de-test-product\",\n            \"description\": \"DE-Product description\",\n            \"locale\": \"de\"\n        },\n        \"attributes_translations\": [\n            {\n                \"title\": \"1234512345123\",\n                \"locale\": \"de\",\n                \"uid\": 213723296905979\n            },\n            {\n                \"title\": \"DE Test Brand\",\n                \"locale\": \"de\",\n                \"uid\": 936680195614754\n            },\n            {\n                \"title\": \"Blau\",\n                \"locale\": \"de\",\n                \"uid\": 610813415070212\n            },\n            {\n                \"title\": \"Nein\",\n                \"locale\": \"de\",\n                \"uid\": 230231242436689\n            },\n            {\n                \"title\": \"Mikrotexturiert\",\n                \"locale\": \"de\",\n                \"uid\": 350833511876953\n            },\n            {\n                \"title\": \"20cm x 25cm\",\n                \"locale\": \"de\",\n                \"uid\": 121609346910613\n            }\n        ],\n        \"option_types_translations\": [\n            {\n                \"title\": \"Test Option Type DE\",\n                \"locale\": \"de\",\n                \"uid\": 764842755739604,\n                \"options_translations\": [\n                    {\n                        \"title\": \"option one de\",\n                        \"locale\": \"de\",\n                        \"uid\": 200387624273178\n                    },\n                    {\n                        \"title\": \"option two de\",\n                        \"locale\": \"de\",\n                        \"uid\": 882301226439411\n                    }\n                ]\n            }\n        ]\n    }\n}\n\n
\nReturns a new translation with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The title of the created product translation
subtitle String The subtitle of the created product translation
slug String The slug of the created product translation
description String The description of the created product translation
locale String The locale of the created product translation
\n
Also returns an attributes_translations array with objects having the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The title of the created product attribute translation
locale String The locale of the created product attribute translation
uid Bigint The ID of the product attribute
\n
Also returns an option_types array with objects having the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The title of the created option type translation
locale String The locale of the created option type translation
uid String The ID of the option type
options_translations Array An array with created options translations. Every option translation is an object with the following fields:  
- title(String) - the title of the created option translation  
- locale(String) - the locale of the created option translation  
- uid(Bigint) - the ID of option
\n
Errors
\nExample: title is blank
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"Error creating translation\",\n        \"message\": \"Product title is empty\"\n    }\n}\n\n
\nExample: translation already exists
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"translation_already_exists\",\n        \"message\": \"Translation already exists\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","products","product_uid","translations",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"ec218fc9-31e0-4fdc-9022-21276dbe2e7d"},{"name":"Update Translation","id":"26133505-5538-4f92-a429-cf4f4456e48b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{   \n    \"translation\": {\n        \"title\": \"DE-Product\", \n        \"slug\": \"de-product\", \n        \"subtitle\": \"DE-Product subtitle
\",\n        \"description\": \"DE-Product description
\",\n        \"attributes\": [{\n            \"title\": \"DE-Attribute-1\",\n            \"uid\": 352419358000727\n        },{\n            \"title\": \"DE-Attribute-2\",\n            \"uid\": 429172881178697\n        }],\n        \"option_types\": [{\n            \"title\": \"option type one\",\n            \"uid\": 6979306177094242345,\n            \"options\": [{\n                \"title\": \"option one\",\n                \"uid\": 948859792361236\n            },{\n                \"title\": \"option two\",\n                \"uid\": 339878378491246\n            }]\n        },{\n            \"title\": \"option type one\",\n            \"uid\": 697930617709123,\n            \"options\": [{\n                \"title\": \"option one\",\n                \"uid\": 948859792366012\n            },{\n                \"title\": \"option two\",\n                \"uid\": 339878378495123\n            }]\n        }],\n        \"seo\":{\n            \"title\": \"DE-SEO-title\",\n            \"keywords\": \"DE-SEO-keyword1, DE-SEO-keyword2\", \n            \"description\": \"DE-SEO-description\"\n        }\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/products/product_uid/translations/","description":"Updates a product translation
\nParameters
\nlocale <**_**String> -_ Indicates the locale of translation to be updated.
product_uid <**_**Bigint> -_ The ID of product, for which the translation will be updated.
\n{   \n    \"translation\": {\n        \"title\": \"updated DE-Test Product\",\n        \"subtitle\": \"updated DE-Product subtitle\",\n        \"description\": \"updated DE-Product description\",\n        \"attributes\": [\n            {\n                \"title\": \"0034512345123\",\n                \"uid\": 213723296905979\n            },\n            {\n                \"title\": \"Test Brand DE\",\n                \"uid\": 936680195614754\n            },\n            {\n                \"title\": \"Blau\",\n                \"uid\": 610813415070212\n            },\n            {\n                \"title\": \"Nein\",\n                \"uid\": 230231242436689\n            },\n            {\n                \"title\": \"Mikrotexturiert\",\n                \"uid\": 350833511876953\n            },\n            {\n                \"title\": \"19cm x 26cm\",\n                \"uid\": 121609346910613\n            }\n        ],\n        \"option_types\": [\n            {\n                \"title\": \"Test Option Type DE\", \n                \"uid\": 764842755739604,\n                \"options\": [\n                    {\n                        \"title\": \"updated option one de\", \n                        \"uid\": 200387624273178\n                    },\n                    {\n                        \"title\": \"option two de\", \n                        \"uid\": 882301226439411\n                    }\n                ]\n            }\n        ],\n        \"seo\": {\n            \"title\": \"DE-SEO\", \n            \"keywords\": \"DE-SEO-Keyword 1, DE-SEO-Keyword 2, DE-SEO-Keyword 3\", \n            \"description\": \"DE-SEO-description\"\n        }\n    }\n}\n\n
\nWe send a product object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nRequired Field Type Description
Optional title String The title of the product's translation
Optional slug String The slug of product
Optional subtitle String The subtitle of the product's translation
Optional description String The description of the product's translation
Optional attributes Array An array of product's attributes. Every product attribute is an object with the following fields:  
- title(String)  
- uid(Bigint) - product attribute ID
Optional option_types Array An array of product's option types. Every option type is an object with the following fields:  
- title(String)  
- uid(Bigint) - option type ID  
- options(Array) - an array of options. Every option is an object with the following fields:  
- title(String)  
- uid(Bigint) - option ID
Optional seo Object An object with informations about product's seo. It contains the following fields:  
- title(String)  
- keywords(String)  
- description(String)
\n
Response
\n{\n    \"response\": {\n        \"translation\": {\n            \"title\": \"updated DE-Test Product\",\n            \"subtitle\": \"updated DE-Product subtitle\",\n            \"slug\": \"updated-de-test-product\",\n            \"description\": \"updated DE-Product description\",\n            \"locale\": \"de\"\n        },\n        \"attributes_translations\": [\n            {\n                \"title\": \"0034512345123\",\n                \"locale\": \"de\",\n                \"uid\": 213723296905979\n            },\n            {\n                \"title\": \"Test Brand DE\",\n                \"locale\": \"de\",\n                \"uid\": 936680195614754\n            },\n            {\n                \"title\": \"Blau\",\n                \"locale\": \"de\",\n                \"uid\": 610813415070212\n            },\n            {\n                \"title\": \"Nein\",\n                \"locale\": \"de\",\n                \"uid\": 230231242436689\n            },\n            {\n                \"title\": \"Mikrotexturiert\",\n                \"locale\": \"de\",\n                \"uid\": 350833511876953\n            },\n            {\n                \"title\": \"19cm x 26cm\",\n                \"locale\": \"de\",\n                \"uid\": 121609346910613\n            }\n        ],\n        \"option_type_translations\": [\n            {\n                \"title\": \"Test Option Type DE\",\n                \"locale\": \"de\",\n                \"uid\": 764842755739604,\n                \"option_translations\": [\n                    {\n                        \"title\": \"updated option one de\",\n                        \"locale\": \"de\",\n                        \"uid\": 200387624273178\n                    },\n                    {\n                        \"title\": \"option two de\",\n                        \"locale\": \"de\",\n                        \"uid\": 882301226439411\n                    }\n                ]\n            }\n        ]\n    }\n}\n\n
\nReturns a translation object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The title of the product translation
subtitle String The subtitle of the product translation
slug String The slug of the product translation
description String The description of the product translation
locale String The locale of the product translation
\n
Also returns an attributes_translations array with objects having the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The title of the product attribute translation
locale String The locale of the product attribute translation
uid Bigint The ID of the product attribute
\n
Also returns an option_types array with objects having the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The title of the option type translation
locale String The locale of the option type translation
uid String The ID of the option type
options_translations Array An array with options translations. Every option translation is an object with the following fields:  
- title(String) - the title of the option translation  
- locale(String) - the locale of the created option translation  
- uid(Bigint) - the ID of option
\n
Errors
\nExample: title is blank
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"Error updating translation\",\n        \"message\": \"Product title is empty\"\n    }\n}\n\n
\nExample: translation not found
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"translation_not_found\",\n        \"message\": \"Translation not found\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","products","product_uid","translations",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"26133505-5538-4f92-a429-cf4f4456e48b"},{"name":"Delete Translation","id":"aa5f97b1-4c3a-4d05-98ca-628e3940be0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/admapi/v1/products/product_uid/translations/","description":"Deletes an existing translation of a product.
\nParameters
\nproduct_uid - The ID of the product.
locale - The locale of the translation to be deleted.
\nResponse
\n{\n    \"response\": {\n        \"translation\": {\n            \"title\": \"Starfield Collector's Edition For Xbox Series X\",\n            \"subtitle\": \"\",\n            \"slug\": \"starfield-collectors-edition-for-xbox-series-x\",\n            \"description\": \"\",\n            \"locale\": \"en\"\n        },\n        \"attributes_translations\": [\n            {\n                \"title\": \"Bethesda\",\n                \"locale\": \"en\",\n                \"uid\": 539404257675281\n            },\n            {\n                \"title\": \"\",\n                \"locale\": \"en\",\n                \"uid\": 52551778438350\n            },\n            {\n                \"title\": \"\",\n                \"locale\": \"en\",\n                \"uid\": 709255984541221\n            },\n            {\n                \"title\": \"\",\n                \"locale\": \"en\",\n                \"uid\": 965823280502370\n            },\n            {\n                \"title\": \"\",\n                \"locale\": \"en\",\n                \"uid\": 961368379231464\n            },\n            {\n                \"title\": \"\",\n                \"locale\": \"en\",\n                \"uid\": 48602618395287\n            }\n        ],\n        \"meta_tag_translations\": {\n            \"id\": 2300,\n            \"title\": \"test title en\",\n            \"description\": \"test description en\",\n            \"keywords\": \"keyword_en_1, keyword_en_2\",\n            \"locale\": \"en\"\n        },\n        \"option_types_translations\": [\n            {\n                \"title\": \"test option type one eng\",\n                \"locale\": \"en\",\n                \"uid\": 334702311955931,\n                \"options_translations\": [\n                    {\n                        \"title\": \"test option one eng\",\n                        \"locale\": \"en\",\n                        \"uid\": 311792935687528\n                    },\n                    {\n                        \"title\": \"test option two eng\",\n                        \"locale\": \"en\",\n                        \"uid\": 520547302133366\n                    }\n                ]\n            },\n            {\n                \"title\": \"test option type eng\",\n                \"locale\": \"en\",\n                \"uid\": 384665074253195,\n                \"options_translations\": [\n                    {\n                        \"title\": \"test option 2-1 eng\",\n                        \"locale\": \"en\",\n                        \"uid\": 542472257760195\n                    },\n                    {\n                        \"title\": \"test option 2-2 eng\",\n                        \"locale\": \"en\",\n                        \"uid\": 672745872327628\n                    }\n                ]\n            }\n        ]\n    }\n}\n\n
\nReturns a response object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
translation Object An object with informations about deleted translation. It contains the following fields:  
  
- title  
- subtitle  
- slug  
- description  
- locale
attributes_translations Array An array of deleted product's attributes translations. Every attribute translation is an object with the following fields:  
  
- title  
- locale  
- uid
meta_tag_translations Object An object with informations about deleted product's meta_tags translations:  
  
- id  
- title  
- description  
- keywords  
- locale
option_types_translations Array An array with deleted product's option types translations. Every option type translation is an object with the following fields:  
  
- title  
- locale  
- uid  
- options_translations - an array of deleted option translations. Every option translation is an object with the following fields:  
  
- title  
- locale  
- uid
\n
Errors
\nExample: product not found
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"product_not_found\",\n        \"message\": \"Product with specified uid does not exist\"\n    }\n}\n\n
\nExample: translation not found
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"translation_not_found\",\n        \"message\": \"Translation not found\"\n    }\n}\n\n
\nExample: can't delete translation, if no other translation exists
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"one_translation_required\",\n        \"message\": \"Product has only one translation available, thus the translation can not be deleted\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","products","product_uid","translations",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"aa5f97b1-4c3a-4d05-98ca-628e3940be0f"},{"name":"List Products and Bundles","id":"a19faf34-708b-4379-af94-c48e0cf8d30e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/items?page=items_page&only_published=items_only_published&keyword=items_keyword&prototype_uid=items_prototype_uid","description":"Returns a list of products and bundles.
\nParameters
\npage <**_**int> -_ Indicates the page of category attributes to fetch. If not specified the first page is returned.
\nonly_published <**_**boolean> -_ Indicates whether to fetch unpublished items. If not specified unpublished items are returned too.
\nkeyword <**_**string> -_ Indicates a search term of products and bundles.
\nprototype_uid <**_**Bigint> -_ The ID of a category. If specified, products and bundles of only this category will be returned.
\nResponse
\n{\n    \"response\": {\n        \"items\": [\n            {\n                \"uid\": 66961353639720,\n                \"type\": \"product\",\n                \"translations\": [\n                    {\n                        \"title\": \"Starfield Collector's Edition For Xbox Series X\",\n                        \"subtitle\": \"\",\n                        \"slug\": \"starfield-collectors-edition-for-xbox-series-x\",\n                        \"description\": \"\",\n                        \"locale\": \"en\"\n                    },\n                    {\n                        \"title\": \"Starfield Collector's Edition For Xbox Series X\",\n                        \"subtitle\": \"\",\n                        \"slug\": \"starfield-collectors-edition-for-xbox-series-x-932342\",\n                        \"description\": \"\",\n                        \"locale\": \"el\"\n                    }\n                ],\n                \"sku\": \"18700332\",\n                \"compare_to_price\": 222.0,\n                \"price\": 123.99,\n                \"published\": true,\n                \"prototype_uid\": 508610039944329,\n                \"attributes\": [\n                    {\n                        \"uid\": 52551778438350,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 605218566287547,\n                        \"prototype_attribute_key\": \"UPC\",\n                        \"created_at\": \"31/08/2023 09:12:39\",\n                        \"updated_at\": \"31/08/2023 09:12:44\"\n                    },\n                    {\n                        \"uid\": 539404257675281,\n                        \"filterable_key\": \"bethesda\",\n                        \"translations\": [\n                            {\n                                \"title\": \"Bethesda\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"Bethesda\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 75427828319792,\n                        \"prototype_attribute_key\": \"Brand\",\n                        \"created_at\": \"31/08/2023 09:12:39\",\n                        \"updated_at\": \"31/08/2023 09:12:44\"\n                    },\n                    {\n                        \"uid\": 709255984541221,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 341868595651900,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"31/08/2023 09:12:39\",\n                        \"updated_at\": \"31/08/2023 09:12:44\"\n                    },\n                    {\n                        \"uid\": 965823280502370,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 925098014791791,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"31/08/2023 09:12:39\",\n                        \"updated_at\": \"31/08/2023 09:12:44\"\n                    },\n                    {\n                        \"uid\": 961368379231464,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 140055824201294,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"31/08/2023 09:12:39\",\n                        \"updated_at\": \"31/08/2023 09:12:44\"\n                    },\n                    {\n                        \"uid\": 48602618395287,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 216976544688651,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"31/08/2023 09:12:39\",\n                        \"updated_at\": \"31/08/2023 09:12:44\"\n                    }\n                ],\n                \"meta_tags\": {\n                    \"translations\": [],\n                    \"og_images\": []\n                },\n                \"option_types\": [],\n                \"variants\": [],\n                \"measurements\": {\n                    \"weight\": \"1.0\",\n                    \"length\": \"0.0\",\n                    \"width\": \"0.0\",\n                    \"height\": \"0.0\"\n                },\n                \"order_status\": {\n                    \"can_backorder\": false,\n                    \"can_preorder\": false,\n                    \"available_on\": null\n                },\n                \"images\": [\n                    {\n                        \"id\": 12136,\n                        \"file_name\": \"18700332.jpg\",\n                        \"thumbnail\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/thumbnails/18700332_1693473159.jpg\",\n                        \"preview\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/previews/18700332_1693473159.jpg\",\n                        \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/lists/18700332_1693473159.jpg\",\n                        \"banner\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/banners/18700332_1693473159.jpg\"\n                    }\n                ],\n                \"max_purchasable_quantity\": null,\n                \"max_product_quantity\": 14,\n                \"created_at\": \"31/08/2023 09:12:39\",\n                \"updated_at\": \"19/09/2023 12:08:47\",\n                \"display_total_compare_to_price\": \"€275.28\",\n                \"display_price\": \"€99.99\",\n                \"display_tax_price\": \"€24.00\",\n                \"display_total_price\": \"€123.99\",\n                \"on_sale\": true,\n                \"on_sale_percentage\": 54.95945945945946,\n                \"show_price\": true,\n                \"has_tax\": true,\n                \"stock_items\": [\n                    {\n                        \"store\": {\n                            \"uid\": 346326890542861,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Warehouse - Nicosia Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:04:49\",\n                            \"updated_at\": \"24/08/2023 10:22:02\"\n                        },\n                        \"quantity\": 0,\n                        \"created_at\": \"31/08/2023 09:13:02\",\n                        \"updated_at\": \"31/08/2023 09:13:02\"\n                    },\n                    {\n                        \"store\": {\n                            \"uid\": 473251864538157,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Nicosia Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:05:10\",\n                            \"updated_at\": \"15/06/2023 12:02:12\"\n                        },\n                        \"quantity\": 0,\n                        \"created_at\": \"31/08/2023 09:13:02\",\n                        \"updated_at\": \"01/09/2023 08:32:41\"\n                    },\n                    {\n                        \"store\": {\n                            \"uid\": 444686109884420,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Limassol Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:05:26\",\n                            \"updated_at\": \"15/06/2023 12:02:12\"\n                        },\n                        \"quantity\": 33,\n                        \"created_at\": \"31/08/2023 09:13:02\",\n                        \"updated_at\": \"18/09/2023 12:08:14\"\n                    },\n                    {\n                        \"store\": {\n                            \"uid\": 512592570248121,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Pafos Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"safdsfdaaaffffa\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:05:46\",\n                            \"updated_at\": \"30/08/2023 08:32:48\"\n                        },\n                        \"quantity\": 0,\n                        \"created_at\": \"31/08/2023 09:13:02\",\n                        \"updated_at\": \"31/08/2023 09:13:02\"\n                    },\n                    {\n                        \"store\": {\n                            \"uid\": 699304110431578,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Clearance Warehouse - Nicosia Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:06:18\",\n                            \"updated_at\": \"15/06/2023 12:02:12\"\n                        },\n                        \"quantity\": 0,\n                        \"created_at\": \"31/08/2023 09:13:02\",\n                        \"updated_at\": \"31/08/2023 09:13:02\"\n                    }\n                ],\n                \"taxes\": [\n                    {\n                        \"uid\": 481258870904813,\n                        \"translations\": [\n                            {\n                                \"title\": \"Φ.Π.Α\",\n                                \"locale\": \"el\"\n                            },\n                            {\n                                \"title\": \"Default tax\",\n                                \"locale\": \"en\"\n                            }\n                        ],\n                        \"is_default\": true,\n                        \"rate\": 0.24,\n                        \"applies_to\": \"subtotal\",\n                        \"included_in_price\": false,\n                        \"created_at\": \"13/10/2022 07:38:20\",\n                        \"updated_at\": \"07/09/2023 08:27:49\"\n                    }\n                ],\n                \"prices\": [\n                    {\n                        \"price_list_title\": \"1. Retail incl.VAT\",\n                        \"price_list_api_uid\": 941615867930108,\n                        \"price\": 99.99,\n                        \"compare_to_price\": 222.0\n                    },\n                    {\n                        \"price_list_title\": \"2. Retail Price no VAT\",\n                        \"price_list_api_uid\": 445643306463029,\n                        \"price\": 99.99,\n                        \"compare_to_price\": 222.0\n                    },\n                    {\n                        \"price_list_title\": \"3. Wholesale Price no VAT\",\n                        \"price_list_api_uid\": 633311263925896,\n                        \"price\": 170.0,\n                        \"compare_to_price\": 222.0\n                    },\n                    {\n                        \"price_list_title\": \"4. Dealer Price no VAT\",\n                        \"price_list_api_uid\": 924804050700710,\n                        \"price\": 99.99,\n                        \"compare_to_price\": 222.0\n                    }\n                ]\n            },\n            {\n                \"uid\": 350944728165206,\n                \"type\": \"product\",\n                \"translations\": [\n                    {\n                        \"title\": \"Starfield Premium Upgrade (Must have the base Game)\",\n                        \"subtitle\": \"\",\n                        \"slug\": \"starfield-premium-upgrade-must-have-the-base-game\",\n                        \"description\": \"\",\n                        \"locale\": \"en\"\n                    },\n                    {\n                        \"title\": \"Starfield Premium Upgrade (Must have the base Game)\",\n                        \"subtitle\": \"\",\n                        \"slug\": \"starfield-premium-upgrade-must-have-the-base-game-543369\",\n                        \"description\": \"\",\n                        \"locale\": \"el\"\n                    }\n                ],\n                \"sku\": \"18700334\",\n                \"compare_to_price\": 0.0,\n                \"price\": 112.84,\n                \"published\": true,\n                \"prototype_uid\": 508610039944329,\n                \"attributes\": [\n                    {\n                        \"uid\": 648161782088590,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 605218566287547,\n                        \"prototype_attribute_key\": \"UPC\",\n                        \"created_at\": \"31/08/2023 08:54:07\",\n                        \"updated_at\": \"31/08/2023 08:54:11\"\n                    },\n                    {\n                        \"uid\": 297416340279863,\n                        \"filterable_key\": \"bethesda\",\n                        \"translations\": [\n                            {\n                                \"title\": \"Bethesda\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"Bethesda\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 75427828319792,\n                        \"prototype_attribute_key\": \"Brand\",\n                        \"created_at\": \"31/08/2023 08:54:07\",\n                        \"updated_at\": \"31/08/2023 08:54:11\"\n                    },\n                    {\n                        \"uid\": 735225584162572,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 341868595651900,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"31/08/2023 08:54:07\",\n                        \"updated_at\": \"31/08/2023 08:54:11\"\n                    },\n                    {\n                        \"uid\": 768461164146261,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 925098014791791,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"31/08/2023 08:54:07\",\n                        \"updated_at\": \"31/08/2023 08:54:11\"\n                    },\n                    {\n                        \"uid\": 186595422646981,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 140055824201294,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"31/08/2023 08:54:07\",\n                        \"updated_at\": \"31/08/2023 08:54:11\"\n                    },\n                    {\n                        \"uid\": 372959999544453,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 216976544688651,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"31/08/2023 08:54:07\",\n                        \"updated_at\": \"31/08/2023 08:54:11\"\n                    }\n                ],\n                \"meta_tags\": {\n                    \"translations\": [],\n                    \"og_images\": []\n                },\n                \"option_types\": [],\n                \"variants\": [],\n                \"measurements\": {\n                    \"weight\": \"0.4\",\n                    \"length\": \"0.0\",\n                    \"width\": \"0.0\",\n                    \"height\": \"0.0\"\n                },\n                \"order_status\": {\n                    \"can_backorder\": false,\n                    \"can_preorder\": false,\n                    \"available_on\": null\n                },\n                \"images\": [\n                    {\n                        \"id\": 12132,\n                        \"file_name\": \"18700334.jpg\",\n                        \"thumbnail\": \"https://storage.googleapis.com/myshop_1665646692/products/b87b9052b4f8281854997acee8a51792ee53466c/thumbnails/18700334_1693472047.jpg\",\n                        \"preview\": \"https://storage.googleapis.com/myshop_1665646692/products/b87b9052b4f8281854997acee8a51792ee53466c/previews/18700334_1693472047.jpg\",\n                        \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/b87b9052b4f8281854997acee8a51792ee53466c/lists/18700334_1693472047.jpg\",\n                        \"banner\": \"https://storage.googleapis.com/myshop_1665646692/products/b87b9052b4f8281854997acee8a51792ee53466c/banners/18700334_1693472047.jpg\"\n                    }\n                ],\n                \"max_purchasable_quantity\": null,\n                \"max_product_quantity\": 14,\n                \"created_at\": \"31/08/2023 08:54:07\",\n                \"updated_at\": \"18/09/2023 12:07:45\",\n                \"display_total_compare_to_price\": \"€0.00\",\n                \"display_price\": \"€91.00\",\n                \"display_tax_price\": \"€21.84\",\n                \"display_total_price\": \"€112.84\",\n                \"on_sale\": false,\n                \"on_sale_percentage\": null,\n                \"show_price\": true,\n                \"has_tax\": true,\n                \"stock_items\": [\n                    {\n                        \"store\": {\n                            \"uid\": 346326890542861,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Warehouse - Nicosia Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:04:49\",\n                            \"updated_at\": \"24/08/2023 10:22:02\"\n                        },\n                        \"quantity\": 0,\n                        \"created_at\": \"31/08/2023 08:55:45\",\n                        \"updated_at\": \"18/09/2023 12:07:45\"\n                    },\n                    {\n                        \"store\": {\n                            \"uid\": 473251864538157,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Nicosia Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:05:10\",\n                            \"updated_at\": \"15/06/2023 12:02:12\"\n                        },\n                        \"quantity\": 22,\n                        \"created_at\": \"31/08/2023 08:55:45\",\n                        \"updated_at\": \"18/09/2023 12:07:45\"\n                    },\n                    {\n                        \"store\": {\n                            \"uid\": 444686109884420,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Limassol Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:05:26\",\n                            \"updated_at\": \"15/06/2023 12:02:12\"\n                        },\n                        \"quantity\": 0,\n                        \"created_at\": \"31/08/2023 08:55:45\",\n                        \"updated_at\": \"01/09/2023 08:05:45\"\n                    },\n                    {\n                        \"store\": {\n                            \"uid\": 512592570248121,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Pafos Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"safdsfdaaaffffa\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:05:46\",\n                            \"updated_at\": \"30/08/2023 08:32:48\"\n                        },\n                        \"quantity\": 0,\n                        \"created_at\": \"31/08/2023 08:55:45\",\n                        \"updated_at\": \"01/09/2023 08:05:45\"\n                    },\n                    {\n                        \"store\": {\n                            \"uid\": 699304110431578,\n                            \"translations\": [\n                                {\n                                    \"title\": \"Clearance Warehouse - Nicosia Store\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"email\": \"\",\n                            \"visible\": true,\n                            \"pickup_allowed\": true,\n                            \"created_at\": \"13/02/2023 10:06:18\",\n                            \"updated_at\": \"15/06/2023 12:02:12\"\n                        },\n                        \"quantity\": 0,\n                        \"created_at\": \"31/08/2023 08:55:45\",\n                        \"updated_at\": \"01/09/2023 08:05:45\"\n                    }\n                ],\n                \"taxes\": [\n                    {\n                        \"uid\": 481258870904813,\n                        \"translations\": [\n                            {\n                                \"title\": \"Φ.Π.Α\",\n                                \"locale\": \"el\"\n                            },\n                            {\n                                \"title\": \"Default tax\",\n                                \"locale\": \"en\"\n                            }\n                        ],\n                        \"is_default\": true,\n                        \"rate\": 0.24,\n                        \"applies_to\": \"subtotal\",\n                        \"included_in_price\": false,\n                        \"created_at\": \"13/10/2022 07:38:20\",\n                        \"updated_at\": \"07/09/2023 08:27:49\"\n                    }\n                ],\n                \"prices\": [\n                    {\n                        \"price_list_title\": \"1. Retail incl.VAT\",\n                        \"price_list_api_uid\": 941615867930108,\n                        \"price\": 70.0,\n                        \"compare_to_price\": 0.0\n                    },\n                    {\n                        \"price_list_title\": \"2. Retail Price no VAT\",\n                        \"price_list_api_uid\": 445643306463029,\n                        \"price\": 70.0,\n                        \"compare_to_price\": 0.0\n                    },\n                    {\n                        \"price_list_title\": \"3. Wholesale Price no VAT\",\n                        \"price_list_api_uid\": 633311263925896,\n                        \"price\": 20.0,\n                        \"compare_to_price\": 0.0\n                    },\n                    {\n                        \"price_list_title\": \"4. Dealer Price no VAT\",\n                        \"price_list_api_uid\": 924804050700710,\n                        \"price\": 70.0,\n                        \"compare_to_price\": 0.0\n                    }\n                ]\n            }\n        ],\n        \"page\": 1,\n        \"pages\": 1,\n        \"per_page\": 25,\n        \"total\": 2\n    }\n}\n\n
\nReturns a items object with the following attributes:
\nIf item is product:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the product
type String The type of item
translations Array An array of product's translations. Every translation is an object with the following fields:  
- title  
- subtitle  
- slug  
- description  
- locale
sku String The sku of the product
compare_to_price Float The compare to price of the product
price Float The price of the product
published Boolean Whether the product is published or not
prototype_uid Bigint The ID of product's category
attributes Array An array of product's attributes. Every attribute is an object with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- prototype_attribute_uid  
- prototype_attribute_key  
- created_at  
- updated_at
meta_tags Object An object with informations about product's meta_tags:  
- translations - an array of meta tag's translations. Every translation is an object with following fields:  
- title  
- description  
- keywords  
- locale
option_types Array An array with product's option types. Every option type is an object with the following fields:  
- uid  
- filterable_key  
- input_type  
- preselect_default  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- options - an array of option type's options. Every option is an abject with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- price_operator  
- price_operand  
- price  
- default_price_value  
- default  
- created_at  
- updated_at  
- created_at  
- updated_at
variants Array An array of product's variants. Every variant is an object. For variant's fields see below
measurements Object An object with informations about product's measuments. It contains the following fields:  
- weight  
- length  
- width  
- height
order_status Object An object with informations about product's order status. It contains the following fields:  
- can_backorder  
- can_preorder  
- available_on
images Array An array of product's images. Every image is an object with the following fields:  
- id  
- file_name  
- thumbnail  
- preview  
- list_view  
- banner
max_purchasable_quantity Integer The maximum purchasable quantity of this product per order
max_product_quantity Integer The maximum purchasable quantity of products per order
created_at String The date that product was created
updated_at String The date that product was updated
display_total_compare_to_price String The total compare to price of product in display format
display_price String The price of product in display format
display_tax_price String The tax price of product in display format
display_total_price String The total price of product in display format
on_sale Boolean Whether the product is on sale or not
on_sale_percentage Float The percentage of discount of product
show_price Boolean Whether to show product's price or not
has_tax Boolean Whether the product has tax or not
stock_items Array An array of product's stock items. Every stock item is an object with the following fields:  
- store - an object with information about stock item's store. This object contains the following fields:  
- uid  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- email  
- visible  
- pickup_allowed  
- created_at  
- updated_at  
- quantity  
- created_at  
- updated_at
taxes Array An array of product's taxes. Every tax is an object with the following fields:  
- uid  
- translations - an array of tax's translations. Every translation is an object with following fields:  
- title  
- locale  
- is_default  
- rate  
- applies_to  
- included_in_price  
- created_at  
- updated_at
prices Array An array of product's price list prices. Every price is an object with the following fields:  
- price_list_title  
- price_list_api_uid  
- price  
- compare_to_price
\n
Variant has the following fields:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the variant
type String The type of item
translations Array An array of variant's translations. Every translation is an object with the following fields:  
- title  
- subtitle  
- slug  
- description  
- locale
sku String The sku of the variant
compare_to_price Float The compare to price of the variant
price Float The price of the variant
upc String The upc of the variant
weight String The weight of the variant
options Array An array with options of the variant. Every option is an object with the following fields:  
- option_uid  
- option_type_uid
option_types Array An array with option types of the variant. Every option type is an object with the following fields:  
- uid  
- filterable_key  
- input_type  
- preselect_default  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- options - an array of option type's options. Every option is an abject with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- price_operator  
- price_operand  
- price  
- default_price_value  
- default  
- created_at  
- updated_at  
- created_at  
- updated_at
images Array An array of variant's images. Every image is an object with the following fields:  
- id  
- file_name  
- thumbnail  
- preview  
- list_view  
- banner
max_purchasable_quantity Integer The maximum purchasable quantity of this variant per order
max_product_quantity Integer The maximum purchasable quantity of products per order
order_status Object An object with informations about variant's order status. It contains the following fields:  
- can_backorder  
- can_preorder  
- available_on
created_at String The date that variant was created
updated_at String The date that variant was updated
display_total_compare_to_price String The total compare to price of variant in display format
display_price String The price of variant in display format
display_tax_price String The tax price of variant in display format
display_total_price String The total price of variant in display format
on_sale Boolean Whether the variant is on sale or not
on_sale_percentage Float The percentage of discount of variant
show_price Boolean Whether to show variant's price or not
has_tax Boolean Whether the variant has tax or not
stock_items Array An array of variant's stock items. Every stock item is an object with the following fields:  
- store - an object with information about stock item's store. This object contains the following fields:  
- uid  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- email  
- visible  
- pickup_allowed  
- created_at  
- updated_at  
- quantity  
- created_at  
- updated_at
\n
If item is bundle:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the bundle
type String The type of item
translations Array An array of bundle's translations. Every translation is an object with the following fields:  
- title  
- subtitle  
- slug  
- description  
- locale
sku String The sku of the bundle
compare_to_price Float The compare to price of the bundle
price Float The price of the bundle
published Boolean Whether the bundle is published or not
prototype_uid Bigint The ID of bundle's category
attributes Array An array of bundle's attributes. Every attribute is an object with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- prototype_attribute_uid  
- prototype_attribute_key  
- created_at  
- updated_at
meta_tags Object An object with informations about bundle's meta_tags:  
- translations - an array of meta tag's translations. Every translation is an object with following fields:  
- title  
- description  
- keywords  
- locale
measurements Object An object with informations about bundle's measuments. It contains the following fields:  
- weight  
- length  
- width  
- height
images Array An array of bundle's images. Every image is an object with the following fields:  
- id  
- file_name  
- thumbnail  
- preview  
- list_view  
- banner
max_purchasable_quantity Integer The maximum purchasable quantity of this bundle per order
created_at String The date that bundle was created
updated_at String The date that bundle was updated
display_total_compare_to_price String The total compare to price of bundle in display format
display_price String The price of bundle in display format
display_tax_price String The tax price of bundle in display format
display_total_price String The total price of bundle in display format
on_sale Boolean Whether the bundle is on sale or not
on_sale_percentage Float The percentage of discount of bundle
show_price Boolean Whether to show bundle's price or not
has_tax Boolean Whether the bundle has tax or not
taxes Array An array of bundle's taxes. Every tax is an object with the following fields:  
- uid  
- translations - an array of tax's translations. Every translation is an object with following fields:  
- title  
- locale  
- is_default  
- rate  
- applies_to  
- included_in_price  
- created_at  
- updated_at
prices Array An array of bundle's price list prices. Every price is an object with the following fields:  
- price_list_title  
- price_list_api_uid  
- price  
- compare_to_price
\n
items - <**_**List of Items>_ - The list of products and bundles.
page - Current page
pages - Total amount of pages
per_page - Items shown per page
total - Total items
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","items"],"host":[""],"query":[{"key":"page","value":"items_page"},{"key":"only_published","value":"items_only_published"},{"key":"keyword","value":"items_keyword"},{"key":"prototype_uid","value":"items_prototype_uid"}],"variable":[]}},"response":[],"_postman_id":"a19faf34-708b-4379-af94-c48e0cf8d30e"},{"name":"Adjust Product's Price","id":"c3a171c8-95f3-4970-8ce4-503922d68034","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/admapi/v1/products/product_uid/adjust_price","description":"Returns the adjusted price's for specific options or variant
\nParameters
\n{\n   \"selected_options_uids\": [311792935687528, 672745872327628] \n}\n\n
\nWe send an object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nRequired Field Type Description
Optional selected_options_uids Array An array with product option ids
\n
Response
\nIf provided options do not correspond to a variant, then a product object is returned.
\n{\n    \"response\": {\n        \"product\": {\n            \"display_total_compare_to_price\": \"€275.28\",\n            \"display_price\": \"€130.00\",\n            \"display_tax_price\": \"€31.20\",\n            \"display_total_price\": \"€161.20\",\n            \"on_sale\": true,\n            \"on_sale_percentage\": 41.44144144144144,\n            \"show_price\": true,\n            \"has_tax\": true,\n            \"price\": 161.2\n        }\n    }\n}\n\n
\nIf provided options correspond to a variant, then a variant object is returned.
\n{\n    \"response\": {\n        \"variant\": {\n            \"uid\": 277032461709847,\n            \"type\": \"variant\",\n            \"translations\": [\n                {\n                    \"title\": \"Starfield Collector's Edition For Xbox Series X\",\n                    \"subtitle\": \"\",\n                    \"slug\": \"starfield-collectors-edition-for-xbox-series-x\",\n                    \"description\": \"\",\n                    \"locale\": \"en\"\n                },\n                {\n                    \"title\": \"Starfield Collector's Edition For Xbox Series X\",\n                    \"subtitle\": \"\",\n                    \"slug\": \"starfield-collectors-edition-for-xbox-series-x-932342\",\n                    \"description\": \"\",\n                    \"locale\": \"el\"\n                }\n            ],\n            \"sku\": \"18700332\",\n            \"compare_to_price\": 0.0,\n            \"price\": 80.6,\n            \"upc\": \"\",\n            \"weight\": \"1.0\",\n            \"options\": [\n                {\n                    \"option_uid\": 311792935687528,\n                    \"option_type_uid\": 334702311955931\n                },\n                {\n                    \"option_uid\": 542472257760195,\n                    \"option_type_uid\": 384665074253195\n                }\n            ],\n            \"option_types\": [\n                {\n                    \"uid\": 334702311955931,\n                    \"filterable_key\": \"test_option_type_one\",\n                    \"input_type\": 0,\n                    \"preselect_default\": true,\n                    \"translations\": [\n                        {\n                            \"title\": \"test option type one\",\n                            \"locale\": \"el\"\n                        },\n                        {\n                            \"title\": \"test option type one eng\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"options\": [\n                        {\n                            \"uid\": 311792935687528,\n                            \"filterable_key\": \"test_option_one\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"test option one\",\n                                    \"locale\": \"el\"\n                                },\n                                {\n                                    \"title\": \"test option one eng\",\n                                    \"locale\": \"en\"\n                                }\n                            ],\n                            \"price_operator\": 0,\n                            \"price_operand\": 0,\n                            \"price\": 35.0,\n                            \"display_price_value\": \"+€35\",\n                            \"default\": true,\n                            \"created_at\": \"20/09/2023 09:05:28\",\n                            \"updated_at\": \"20/09/2023 13:30:23\"\n                        },\n                        {\n                            \"uid\": 520547302133366,\n                            \"filterable_key\": \"test_option_two\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"test option two\",\n                                    \"locale\": \"el\"\n                                },\n                                {\n                                    \"title\": \"test option two eng\",\n                                    \"locale\": \"en\"\n                                }\n                            ],\n                            \"price_operator\": 0,\n                            \"price_operand\": 0,\n                            \"price\": 11.0,\n                            \"display_price_value\": \"+€11\",\n                            \"default\": false,\n                            \"created_at\": \"20/09/2023 09:05:28\",\n                            \"updated_at\": \"20/09/2023 11:47:03\"\n                        }\n                    ],\n                    \"created_at\": \"20/09/2023 09:05:28\",\n                    \"updated_at\": \"20/09/2023 13:30:23\"\n                },\n                {\n                    \"uid\": 384665074253195,\n                    \"filterable_key\": \"test_option_type_2\",\n                    \"input_type\": 1,\n                    \"preselect_default\": true,\n                    \"translations\": [\n                        {\n                            \"title\": \"test option type 2\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"options\": [\n                        {\n                            \"uid\": 542472257760195,\n                            \"filterable_key\": \"test_option_2-1\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"test option 2-1\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"price_operator\": 0,\n                            \"price_operand\": 1,\n                            \"price\": 6.0,\n                            \"display_price_value\": \"+6.0%\",\n                            \"default\": true,\n                            \"created_at\": \"20/09/2023 13:03:04\",\n                            \"updated_at\": \"20/09/2023 13:30:35\"\n                        },\n                        {\n                            \"uid\": 672745872327628,\n                            \"filterable_key\": \"test_option_2-2\",\n                            \"translations\": [\n                                {\n                                    \"title\": \"test option 2-2\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"price_operator\": 1,\n                            \"price_operand\": 1,\n                            \"price\": 5.0,\n                            \"display_price_value\": \"-5.0%\",\n                            \"default\": false,\n                            \"created_at\": \"20/09/2023 13:03:04\",\n                            \"updated_at\": \"20/09/2023 13:03:04\"\n                        }\n                    ],\n                    \"created_at\": \"20/09/2023 13:03:04\",\n                    \"updated_at\": \"20/09/2023 13:30:35\"\n                }\n            ],\n            \"images\": [\n                {\n                    \"id\": 12136,\n                    \"file_name\": \"18700332.jpg\",\n                    \"thumbnail\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/thumbnails/18700332_1693473159.jpg\",\n                    \"preview\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/previews/18700332_1693473159.jpg\",\n                    \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/lists/18700332_1693473159.jpg\",\n                    \"banner\": \"https://storage.googleapis.com/myshop_1665646692/products/270808f6cc755472708054f68cc3e7949c0678fb/banners/18700332_1693473159.jpg\"\n                }\n            ],\n            \"max_purchasable_quantity\": null,\n            \"max_product_quantity\": 14,\n            \"order_status\": {\n                \"can_backorder\": true,\n                \"can_preorder\": false,\n                \"available_on\": null\n            },\n            \"created_at\": \"20/09/2023 09:51:12\",\n            \"updated_at\": \"20/09/2023 09:51:12\",\n            \"display_total_compare_to_price\": \"€0.00\",\n            \"display_price\": \"€65.00\",\n            \"display_tax_price\": \"€15.60\",\n            \"display_total_price\": \"€80.60\",\n            \"on_sale\": false,\n            \"on_sale_percentage\": null,\n            \"show_price\": true,\n            \"has_tax\": true,\n            \"stock_items\": [\n                {\n                    \"store\": {\n                        \"uid\": 346326890542861,\n                        \"translations\": [\n                            {\n                                \"title\": \"Warehouse - Nicosia Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:04:49\",\n                        \"updated_at\": \"24/08/2023 10:22:02\"\n                    },\n                    \"quantity\": 0,\n                    \"created_at\": \"20/09/2023 09:51:12\",\n                    \"updated_at\": \"20/09/2023 09:51:12\"\n                },\n                {\n                    \"store\": {\n                        \"uid\": 473251864538157,\n                        \"translations\": [\n                            {\n                                \"title\": \"Nicosia Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:05:10\",\n                        \"updated_at\": \"15/06/2023 12:02:12\"\n                    },\n                    \"quantity\": 0,\n                    \"created_at\": \"20/09/2023 09:51:13\",\n                    \"updated_at\": \"20/09/2023 09:51:13\"\n                },\n                {\n                    \"store\": {\n                        \"uid\": 444686109884420,\n                        \"translations\": [\n                            {\n                                \"title\": \"Limassol Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:05:26\",\n                        \"updated_at\": \"15/06/2023 12:02:12\"\n                    },\n                    \"quantity\": 33,\n                    \"created_at\": \"20/09/2023 09:51:13\",\n                    \"updated_at\": \"20/09/2023 09:51:13\"\n                },\n                {\n                    \"store\": {\n                        \"uid\": 512592570248121,\n                        \"translations\": [\n                            {\n                                \"title\": \"Pafos Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"safdsfdaaaffffa\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:05:46\",\n                        \"updated_at\": \"30/08/2023 08:32:48\"\n                    },\n                    \"quantity\": 0,\n                    \"created_at\": \"20/09/2023 09:51:13\",\n                    \"updated_at\": \"20/09/2023 09:51:13\"\n                },\n                {\n                    \"store\": {\n                        \"uid\": 699304110431578,\n                        \"translations\": [\n                            {\n                                \"title\": \"Clearance Warehouse - Nicosia Store\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"email\": \"\",\n                        \"visible\": true,\n                        \"pickup_allowed\": true,\n                        \"created_at\": \"13/02/2023 10:06:18\",\n                        \"updated_at\": \"15/06/2023 12:02:12\"\n                    },\n                    \"quantity\": 0,\n                    \"created_at\": \"20/09/2023 09:51:13\",\n                    \"updated_at\": \"20/09/2023 09:51:13\"\n                }\n            ]\n        }\n    }\n}\n\n
\nReturns a product object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
display_total_compare_to_price String The total compare to price of product in display format
display_price String The price of product in display format
display_tax_price String The tax price of product in display format
display_total_price String The total price of product in display format
on_sale Boolean Whether the product is on sale or not
on_sale_percentage Float The percentage of discount of product
show_price Boolean Whether to show product's price or not
has_tax Boolean Whether the product has tax or not
price Float The price of the product
\n
Returns a variant object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the variant
type String The type of item
translations Array An array of variant's translations. Every translation is an object with the following fields:  
- title  
- subtitle  
- slug  
- description  
- locale
sku String The sku of the variant
compare_to_price Float The compare to price of the variant
price Float The price of the variant
upc String The upc of the variant
weight String The weight of the variant
options Array An array with options of the variant. Every option is an object with the following fields:  
- option_uid  
- option_type_uid
option_types Array An array with option types of the variant. Every option type is an object with the following fields:  
- uid  
- filterable_key  
- input_type  
- preselect_default  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- options - an array of option type's options. Every option is an abject with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- price_operator  
- price_operand  
- price  
- default_price_value  
- default  
- created_at  
- updated_at  
- created_at  
- updated_at
images Array An array of variant's images. Every image is an object with the following fields:  
- id  
- file_name  
- thumbnail  
- preview  
- list_view  
- banner
max_purchasable_quantity Integer The maximum purchasable quantity of this variant per order
max_product_quantity Integer The maximum purchasable quantity of products per order
order_status Object An object with informations about variant's order status. It contains the following fields:  
- can_backorder  
- can_preorder  
- available_on
created_at String The date that variant was created
updated_at String The date that variant was updated
display_total_compare_to_price String The total compare to price of variant in display format
display_price String The price of variant in display format
display_tax_price String The tax price of variant in display format
display_total_price String The total price of variant in display format
on_sale Boolean Whether the variant is on sale or not
on_sale_percentage Float The percentage of discount of variant
show_price Boolean Whether to show variant's price or not
has_tax Boolean Whether the variant has tax or not
stock_items Array An array of variant's stock items. Every stock item is an object with the following fields:  
- store - an object with information about stock item's store. This object contains the following fields:  
- uid  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- email  
- visible  
- pickup_allowed  
- created_at  
- updated_at  
- quantity  
- created_at  
- updated_at
\n
Errors
\nExample: product not found
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"product_not_found\",\n        \"message\": \"Product with specified uid does not exist\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","products","product_uid","adjust_price"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"c3a171c8-95f3-4970-8ce4-503922d68034"}],"id":"1982d977-9fd7-4d11-a413-59f183d8a5ae","_postman_id":"1982d977-9fd7-4d11-a413-59f183d8a5ae","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}},{"name":"Bundle(s)","item":[{"name":"List Bundles","id":"5b98f626-a049-488e-8d34-ac3f75744281","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/bundles?page=1&keyword=bundle_keyword&prototype_uid=bundle_prototype_uid&only_published=bundle_only_published","description":"Returns a list of bundles.
\nParameters
\npage <**_**Integer> -_ Indicates the page of bundles to fetch. If not specified the first page is returned.
\nkeyword <**_**String> -_ Indicates a search term for bundles.
\nprototype_uid <**_**Bigint> -_ The ID of a category. If specified, bundles of only this category will be returned.
\nonly_published <**_**Boolean> -_ Indicates whether to fetch unpublished bundles. If not specified unpublished bundles are returned too.
\nResponse
\n{\n    \"response\": {\n        \"bundles\": [\n            {\n                \"uid\": 124190482339972,\n                \"type\": \"bundle\",\n                \"translations\": [\n                    {\n                        \"title\": \"test bundle one\",\n                        \"subtitle\": \"\",\n                        \"slug\": \"test-bundle-one\",\n                        \"description\": \"<p class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>test bundle one greek description</p>\",\n                        \"locale\": \"el\"\n                    },\n                    {\n                        \"title\": \"test bundle one\",\n                        \"subtitle\": \"\",\n                        \"slug\": \"test-bundle-one-99245\",\n                        \"description\": \"<p class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>test bundle one english description</p>\",\n                        \"locale\": \"en\"\n                    }\n                ],\n                \"sku\": \"00004321\",\n                \"compare_to_price\": 220.0,\n                \"price\": 217.0,\n                \"published\": true,\n                \"prototype_uid\": 508610039944329,\n                \"attributes\": [\n                    {\n                        \"uid\": 682018603007852,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 605218566287547,\n                        \"prototype_attribute_key\": \"UPC\",\n                        \"created_at\": \"24/09/2023 12:51:23\",\n                        \"updated_at\": \"24/09/2023 13:27:49\"\n                    },\n                    {\n                        \"uid\": 87057474238814,\n                        \"filterable_key\": \"test_brand\",\n                        \"translations\": [\n                            {\n                                \"title\": \"Test Brand\",\n                                \"locale\": \"el\"\n                            },\n                            {\n                                \"title\": \"Test Brand Eng\",\n                                \"locale\": \"en\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 75427828319792,\n                        \"prototype_attribute_key\": \"Brand\",\n                        \"created_at\": \"24/09/2023 12:51:23\",\n                        \"updated_at\": \"24/09/2023 13:27:49\"\n                    },\n                    {\n                        \"uid\": 357841117189526,\n                        \"filterable_key\": \"test_console\",\n                        \"translations\": [\n                            {\n                                \"title\": \"Test Console\",\n                                \"locale\": \"el\"\n                            },\n                            {\n                                \"title\": \"Test Console Eng\",\n                                \"locale\": \"en\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 341868595651900,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"24/09/2023 12:51:23\",\n                        \"updated_at\": \"24/09/2023 13:27:49\"\n                    },\n                    {\n                        \"uid\": 285640756867557,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 925098014791791,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"24/09/2023 12:51:23\",\n                        \"updated_at\": \"24/09/2023 13:27:49\"\n                    },\n                    {\n                        \"uid\": 916180335239882,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 140055824201294,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"24/09/2023 12:51:23\",\n                        \"updated_at\": \"24/09/2023 13:27:49\"\n                    },\n                    {\n                        \"uid\": 980111153929490,\n                        \"filterable_key\": null,\n                        \"translations\": [\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"el\"\n                            },\n                            {\n                                \"title\": \"\",\n                                \"locale\": \"en\"\n                            }\n                        ],\n                        \"prototype_attribute_uid\": 216976544688651,\n                        \"prototype_attribute_key\": null,\n                        \"created_at\": \"24/09/2023 12:51:23\",\n                        \"updated_at\": \"24/09/2023 13:27:49\"\n                    }\n                ],\n                \"meta_tags\": {\n                    \"translations\": [\n                        {\n                            \"title\": \"frerfefrerferf\",\n                            \"description\": \"\",\n                            \"keywords\": \"\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"og_images\": []\n                },\n                \"measurements\": {\n                    \"weight\": \"0.0\",\n                    \"length\": \"0.0\",\n                    \"width\": \"0.0\",\n                    \"height\": \"0.0\"\n                },\n                \"images\": [],\n                \"max_purchasable_quantity\": 3,\n                \"created_at\": \"31/08/2023 07:52:44\",\n                \"updated_at\": \"24/09/2023 13:32:11\",\n                \"display_total_compare_to_price\": \"€272.80\",\n                \"display_price\": \"€175.00\",\n                \"display_tax_price\": \"€42.00\",\n                \"display_total_price\": \"€217.00\",\n                \"on_sale\": true,\n                \"on_sale_percentage\": 20.454545454545457,\n                \"show_price\": true,\n                \"has_tax\": true,\n                \"in_stock\": true,\n                \"total_stock\": 22,\n                \"taxes\": [\n                    {\n                        \"uid\": 481258870904813,\n                        \"translations\": [\n                            {\n                                \"title\": \"Φ.Π.Α\",\n                                \"locale\": \"el\"\n                            },\n                            {\n                                \"title\": \"Default tax\",\n                                \"locale\": \"en\"\n                            }\n                        ],\n                        \"is_default\": true,\n                        \"rate\": 0.24,\n                        \"applies_to\": \"subtotal\",\n                        \"included_in_price\": false,\n                        \"created_at\": \"13/10/2022 07:38:20\",\n                        \"updated_at\": \"07/09/2023 08:27:49\"\n                    }\n                ],\n                \"prices\": [\n                    {\n                        \"price_list_title\": \"1. Retail incl.VAT\",\n                        \"price_list_api_uid\": 941615867930108,\n                        \"price\": 175.0,\n                        \"compare_to_price\": 220.0\n                    },\n                    {\n                        \"price_list_title\": \"2. Retail Price no VAT\",\n                        \"price_list_api_uid\": 445643306463029,\n                        \"price\": 175.0,\n                        \"compare_to_price\": 220.0\n                    },\n                    {\n                        \"price_list_title\": \"3. Wholesale Price no VAT\",\n                        \"price_list_api_uid\": 633311263925896,\n                        \"price\": 175.0,\n                        \"compare_to_price\": 220.0\n                    },\n                    {\n                        \"price_list_title\": \"4. Dealer Price no VAT\",\n                        \"price_list_api_uid\": 924804050700710,\n                        \"price\": 155.0,\n                        \"compare_to_price\": 205.0\n                    },\n                    {\n                        \"price_list_title\": \"1. Retail incl.VAT\",\n                        \"price_list_api_uid\": 941615867930108,\n                        \"price\": 0.0,\n                        \"compare_to_price\": 0.0\n                    },\n                    {\n                        \"price_list_title\": \"2. Retail Price no VAT\",\n                        \"price_list_api_uid\": 445643306463029,\n                        \"price\": 0.0,\n                        \"compare_to_price\": 0.0\n                    },\n                    {\n                        \"price_list_title\": \"3. Wholesale Price no VAT\",\n                        \"price_list_api_uid\": 633311263925896,\n                        \"price\": 0.0,\n                        \"compare_to_price\": 0.0\n                    },\n                    {\n                        \"price_list_title\": \"4. Dealer Price no VAT\",\n                        \"price_list_api_uid\": 924804050700710,\n                        \"price\": 0.0,\n                        \"compare_to_price\": 0.0\n                    }\n                ]\n            },\n            {\n                \"uid\": 669611420629592,\n                \"type\": \"bundle\",\n                \"translations\": [\n                    {\n                        \"title\": \"test bundle two\",\n                        \"subtitle\": \"\",\n                        \"slug\": \"test-bundle-two\",\n                        \"description\": \"\",\n                        \"locale\": \"el\"\n                    }\n                ],\n                \"sku\": \"00001234\",\n                \"compare_to_price\": 115.0,\n                \"price\": 107.0,\n                \"published\": true,\n                \"prototype_uid\": null,\n                \"attributes\": [],\n                \"meta_tags\": {\n                    \"translations\": [],\n                    \"og_images\": []\n                },\n                \"measurements\": {\n                    \"weight\": \"1.0\",\n                    \"length\": \"30.0\",\n                    \"width\": \"40.0\",\n                    \"height\": \"30.0\"\n                },\n                \"images\": [],\n                \"max_purchasable_quantity\": null,\n                \"created_at\": \"29/08/2023 12:21:02\",\n                \"updated_at\": \"24/09/2023 13:05:08\",\n                \"display_total_compare_to_price\": \"€123.05\",\n                \"display_price\": \"€100.00\",\n                \"display_tax_price\": \"€7.00\",\n                \"display_total_price\": \"€107.00\",\n                \"on_sale\": true,\n                \"on_sale_percentage\": 13.043478260869565,\n                \"show_price\": true,\n                \"has_tax\": true,\n                \"in_stock\": true,\n                \"total_stock\": 125,\n                \"taxes\": [\n                    {\n                        \"uid\": 398588775540894,\n                        \"translations\": [\n                            {\n                                \"title\": \"Μειωμένος φόρος\",\n                                \"locale\": \"el\"\n                            },\n                            {\n                                \"title\": \"Reduced tax\",\n                                \"locale\": \"en\"\n                            }\n                        ],\n                        \"is_default\": false,\n                        \"rate\": 0.07,\n                        \"applies_to\": \"subtotal\",\n                        \"included_in_price\": false,\n                        \"created_at\": \"25/10/2022 14:48:29\",\n                        \"updated_at\": \"30/08/2023 13:19:26\"\n                    }\n                ],\n                \"prices\": [\n                    {\n                        \"price_list_title\": \"1. Retail incl.VAT\",\n                        \"price_list_api_uid\": 941615867930108,\n                        \"price\": 100.0,\n                        \"compare_to_price\": 110.0\n                    },\n                    {\n                        \"price_list_title\": \"2. Retail Price no VAT\",\n                        \"price_list_api_uid\": 445643306463029,\n                        \"price\": 99.0,\n                        \"compare_to_price\": 105.0\n                    },\n                    {\n                        \"price_list_title\": \"3. Wholesale Price no VAT\",\n                        \"price_list_api_uid\": 633311263925896,\n                        \"price\": 95.0,\n                        \"compare_to_price\": 105.0\n                    },\n                    {\n                        \"price_list_title\": \"4. Dealer Price no VAT\",\n                        \"price_list_api_uid\": 924804050700710,\n                        \"price\": 92.0,\n                        \"compare_to_price\": 100.0\n                    }\n                ]\n            }\n        ],\n        \"page\": 1,\n        \"pages\": 1,\n        \"per_page\": 25,\n        \"total\": 2\n    }\n}\n\n
\nReturns a bundles object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the bundle
type String The type of item
translations Array An array of bundle's translations. Every translation is an object with the following fields:  
- title  
- subtitle  
- slug  
- description  
- locale
sku String The sku of the bundle
compare_to_price Float The compare to price of the bundle
price Float The price of the bundle
published Boolean Whether the bundle is published or not
prototype_uid Bigint The ID of bundle's category
attributes Array An array of bundle's attributes. Every attribute is an object with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- prototype_attribute_uid  
- prototype_attribute_key  
- created_at  
- updated_at
meta_tags Object An object with informations about bundle's meta_tags:  
- translations - an array of meta tag's translations. Every translation is an object with following fields:  
- title  
- description  
- keywords  
- locale
measurements Object An object with informations about bundle's measuments. It contains the following fields:  
- weight  
- length  
- width  
- height
images Array An array of bundle's images. Every image is an object with the following fields:  
- id  
- file_name  
- thumbnail  
- preview  
- list_view  
- banner
max_purchasable_quantity Integer The maximum purchasable quantity of this bundle per order
created_at String The date that bundle was created
updated_at String The date that bundle was updated
display_total_compare_to_price String The total compare to price of bundle in display format
display_price String The price of bundle in display format
display_tax_price String The tax price of bundle in display format
display_total_price String The total price of bundle in display format
on_sale Boolean Whether the bundle is on sale or not
on_sale_percentage Float The percentage of discount of bundle
show_price Boolean Whether to show bundle's price or not
has_tax Boolean Whether the bundle has tax or not
taxes Array An array of bundle's taxes. Every tax is an object with the following fields:  
- uid  
- translations - an array of tax's translations. Every translation is an object with following fields:  
- title  
- locale  
- is_default  
- rate  
- applies_to  
- included_in_price  
- created_at  
- updated_at
prices Array An array of bundle's price list prices. Every price is an object with the following fields:  
- price_list_title  
- price_list_api_uid  
- price  
- compare_to_price
\n
bundles - <**_**List of Bundles>_ - The list of bundles.
page - Current page
pages - Total amount of pages
per_page - Bundles shown per page
total - Total bundles
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","bundles"],"host":[""],"query":[{"key":"page","value":"1"},{"key":"keyword","value":"bundle_keyword"},{"key":"prototype_uid","value":"bundle_prototype_uid"},{"key":"only_published","value":"bundle_only_published"}],"variable":[]}},"response":[],"_postman_id":"5b98f626-a049-488e-8d34-ac3f75744281"},{"name":"Get Single Bundle","id":"a2f41644-8910-4e00-a7b5-1d9539a1fb00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/bundles/bundle_uid","description":"Returns a requested bundle.
\nParameters
\nbundle_uid <Bigint>: Indicates the id of the requested bundle.
\nResponse
\n{\n    \"response\": {\n        \"bundle\": {\n            \"uid\": 124190482339972,\n            \"type\": \"bundle\",\n            \"translations\": [\n                {\n                    \"title\": \"test bundle one\",\n                    \"subtitle\": \"\",\n                    \"slug\": \"test-bundle-one\",\n                    \"description\": \"<p class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>test bundle one greek description</p>\",\n                    \"locale\": \"el\"\n                },\n                {\n                    \"title\": \"test bundle one\",\n                    \"subtitle\": \"\",\n                    \"slug\": \"test-bundle-one-99245\",\n                    \"description\": \"<p class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>test bundle one english description</p>\",\n                    \"locale\": \"en\"\n                }\n            ],\n            \"sku\": \"00004321\",\n            \"compare_to_price\": 220.0,\n            \"price\": 217.0,\n            \"published\": true,\n            \"prototype_uid\": 508610039944329,\n            \"attributes\": [\n                {\n                    \"uid\": 682018603007852,\n                    \"filterable_key\": null,\n                    \"translations\": [\n                        {\n                            \"title\": \"\",\n                            \"locale\": \"el\"\n                        },\n                        {\n                            \"title\": \"\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 605218566287547,\n                    \"prototype_attribute_key\": \"UPC\",\n                    \"created_at\": \"24/09/2023 12:51:23\",\n                    \"updated_at\": \"24/09/2023 13:27:49\"\n                },\n                {\n                    \"uid\": 87057474238814,\n                    \"filterable_key\": \"test_brand\",\n                    \"translations\": [\n                        {\n                            \"title\": \"Test Brand\",\n                            \"locale\": \"el\"\n                        },\n                        {\n                            \"title\": \"Test Brand Eng\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 75427828319792,\n                    \"prototype_attribute_key\": \"Brand\",\n                    \"created_at\": \"24/09/2023 12:51:23\",\n                    \"updated_at\": \"24/09/2023 13:27:49\"\n                },\n                {\n                    \"uid\": 357841117189526,\n                    \"filterable_key\": \"test_console\",\n                    \"translations\": [\n                        {\n                            \"title\": \"Test Console\",\n                            \"locale\": \"el\"\n                        },\n                        {\n                            \"title\": \"Test Console Eng\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 341868595651900,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"24/09/2023 12:51:23\",\n                    \"updated_at\": \"24/09/2023 13:27:49\"\n                },\n                {\n                    \"uid\": 285640756867557,\n                    \"filterable_key\": null,\n                    \"translations\": [\n                        {\n                            \"title\": \"\",\n                            \"locale\": \"el\"\n                        },\n                        {\n                            \"title\": \"\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 925098014791791,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"24/09/2023 12:51:23\",\n                    \"updated_at\": \"24/09/2023 13:27:49\"\n                },\n                {\n                    \"uid\": 916180335239882,\n                    \"filterable_key\": null,\n                    \"translations\": [\n                        {\n                            \"title\": \"\",\n                            \"locale\": \"el\"\n                        },\n                        {\n                            \"title\": \"\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 140055824201294,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"24/09/2023 12:51:23\",\n                    \"updated_at\": \"24/09/2023 13:27:49\"\n                },\n                {\n                    \"uid\": 980111153929490,\n                    \"filterable_key\": null,\n                    \"translations\": [\n                        {\n                            \"title\": \"\",\n                            \"locale\": \"el\"\n                        },\n                        {\n                            \"title\": \"\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 216976544688651,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"24/09/2023 12:51:23\",\n                    \"updated_at\": \"24/09/2023 13:27:49\"\n                }\n            ],\n            \"meta_tags\": {\n                \"translations\": [\n                    {\n                        \"title\": \"frerfefrerferf\",\n                        \"description\": \"\",\n                        \"keywords\": \"\",\n                        \"locale\": \"el\"\n                    }\n                ],\n                \"og_images\": []\n            },\n            \"measurements\": {\n                \"weight\": \"0.0\",\n                \"length\": \"0.0\",\n                \"width\": \"0.0\",\n                \"height\": \"0.0\"\n            },\n            \"images\": [],\n            \"max_purchasable_quantity\": 3,\n            \"created_at\": \"31/08/2023 07:52:44\",\n            \"updated_at\": \"24/09/2023 13:32:11\",\n            \"bundle_items\": [\n                {\n                    \"type\": \"Shop::Product\",\n                    \"item_uid\": 523027160602323,\n                    \"quantity\": 2,\n                    \"position\": 1,\n                    \"itemable\": {\n                        \"uid\": 523027160602323,\n                        \"type\": \"product\",\n                        \"translations\": [\n                            {\n                                \"title\": \"Final Fantasy XVI Deluxe Edition For PS5\",\n                                \"subtitle\": \"\",\n                                \"slug\": \"final-fantasy-xvi-deluxe-edition-for-ps5\",\n                                \"description\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"Final Fantasy XVI Deluxe Edition For PS5\",\n                                \"subtitle\": \"\",\n                                \"slug\": \"final-fantasy-xvi-deluxe-edition-for-ps5-993026\",\n                                \"description\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"sku\": \"18700292\",\n                        \"compare_to_price\": 0.0,\n                        \"price\": 75.0,\n                        \"published\": true,\n                        \"prototype_uid\": 508610039944329,\n                        \"attributes\": [\n                            {\n                                \"uid\": 185728722992259,\n                                \"filterable_key\": \"5021290096943\",\n                                \"translations\": [\n                                    {\n                                        \"title\": \"5021290096943\",\n                                        \"locale\": \"en\"\n                                    },\n                                    {\n                                        \"title\": \"5021290096943\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"prototype_attribute_uid\": 605218566287547,\n                                \"prototype_attribute_key\": \"UPC\",\n                                \"created_at\": \"24/08/2023 09:38:42\",\n                                \"updated_at\": \"24/08/2023 09:38:46\"\n                            },\n                            {\n                                \"uid\": 202077171228475,\n                                \"filterable_key\": \"square_enix\",\n                                \"translations\": [\n                                    {\n                                        \"title\": \"Square Enix\",\n                                        \"locale\": \"en\"\n                                    },\n                                    {\n                                        \"title\": \"Square Enix\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"prototype_attribute_uid\": 75427828319792,\n                                \"prototype_attribute_key\": \"Brand\",\n                                \"created_at\": \"24/08/2023 09:38:42\",\n                                \"updated_at\": \"24/08/2023 09:38:46\"\n                            },\n                            {\n                                \"uid\": 960260010927478,\n                                \"filterable_key\": \"test_console\",\n                                \"translations\": [\n                                    {\n                                        \"title\": \"test console\",\n                                        \"locale\": \"en\"\n                                    },\n                                    {\n                                        \"title\": \"test console\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"prototype_attribute_uid\": 341868595651900,\n                                \"prototype_attribute_key\": null,\n                                \"created_at\": \"24/08/2023 09:38:42\",\n                                \"updated_at\": \"24/09/2023 12:23:12\"\n                            },\n                            {\n                                \"uid\": 774866302349538,\n                                \"filterable_key\": null,\n                                \"translations\": [\n                                    {\n                                        \"title\": \"\",\n                                        \"locale\": \"en\"\n                                    },\n                                    {\n                                        \"title\": \"\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"prototype_attribute_uid\": 925098014791791,\n                                \"prototype_attribute_key\": null,\n                                \"created_at\": \"24/08/2023 09:38:42\",\n                                \"updated_at\": \"24/09/2023 12:23:12\"\n                            },\n                            {\n                                \"uid\": 322689926315798,\n                                \"filterable_key\": null,\n                                \"translations\": [\n                                    {\n                                        \"title\": \"\",\n                                        \"locale\": \"en\"\n                                    },\n                                    {\n                                        \"title\": \"\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"prototype_attribute_uid\": 140055824201294,\n                                \"prototype_attribute_key\": null,\n                                \"created_at\": \"24/08/2023 09:38:42\",\n                                \"updated_at\": \"24/08/2023 09:38:46\"\n                            },\n                            {\n                                \"uid\": 228763496287028,\n                                \"filterable_key\": null,\n                                \"translations\": [\n                                    {\n                                        \"title\": \"\",\n                                        \"locale\": \"en\"\n                                    },\n                                    {\n                                        \"title\": \"\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"prototype_attribute_uid\": 216976544688651,\n                                \"prototype_attribute_key\": null,\n                                \"created_at\": \"24/08/2023 09:38:42\",\n                                \"updated_at\": \"24/08/2023 09:38:46\"\n                            }\n                        ],\n                        \"meta_tags\": {\n                            \"translations\": [],\n                            \"og_images\": []\n                        },\n                        \"option_types\": [],\n                        \"variants\": [],\n                        \"measurements\": {\n                            \"weight\": \"0.0\",\n                            \"length\": \"0.0\",\n                            \"width\": \"0.0\",\n                            \"height\": \"0.0\"\n                        },\n                        \"order_status\": {\n                            \"can_backorder\": false,\n                            \"can_preorder\": false,\n                            \"available_on\": null\n                        },\n                        \"images\": [\n                            {\n                                \"id\": 12124,\n                                \"file_name\": \"18700292.jpg\",\n                                \"thumbnail\": \"https://storage.googleapis.com/myshop_1665646692/products/206cbd8578f006554127ed15e2144b2d40c53687/thumbnails/18700292_1692869922.jpg\",\n                                \"preview\": \"https://storage.googleapis.com/myshop_1665646692/products/206cbd8578f006554127ed15e2144b2d40c53687/previews/18700292_1692869922.jpg\",\n                                \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/206cbd8578f006554127ed15e2144b2d40c53687/lists/18700292_1692869922.jpg\",\n                                \"banner\": \"https://storage.googleapis.com/myshop_1665646692/products/206cbd8578f006554127ed15e2144b2d40c53687/banners/18700292_1692869922.jpg\"\n                            }\n                        ],\n                        \"max_purchasable_quantity\": null,\n                        \"max_product_quantity\": 14,\n                        \"created_at\": \"24/08/2023 09:38:41\",\n                        \"updated_at\": \"24/09/2023 13:34:12\"\n                    }\n                },\n                {\n                    \"type\": \"product\",\n                    \"item_uid\": 350944728165206,\n                    \"item_sku\": \"18700334\",\n                    \"item_title\": \"Starfield Premium Upgrade (Must have the base Game)\",\n                    \"quantity\": 1,\n                    \"position\": 2,\n                    \"itemable\": {\n                        \"uid\": 350944728165206,\n                        \"type\": \"product\",\n                        \"translations\": [\n                            {\n                                \"title\": \"Starfield Premium Upgrade (Must have the base Game)\",\n                                \"subtitle\": \"\",\n                                \"slug\": \"starfield-premium-upgrade-must-have-the-base-game\",\n                                \"description\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"Starfield Premium Upgrade (Must have the base Game)\",\n                                \"subtitle\": \"\",\n                                \"slug\": \"starfield-premium-upgrade-must-have-the-base-game-543369\",\n                                \"description\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"sku\": \"18700334\",\n                        \"compare_to_price\": 0.0,\n                        \"price\": 91.0,\n                        \"published\": true,\n                        \"prototype_uid\": 508610039944329,\n                        \"attributes\": [\n                            {\n                                \"uid\": 648161782088590,\n                                \"filterable_key\": null,\n                                \"translations\": [\n                                    {\n                                        \"title\": \"\",\n                                        \"locale\": \"en\"\n                                    },\n                                    {\n                                        \"title\": \"\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"prototype_attribute_uid\": 605218566287547,\n                                \"prototype_attribute_key\": \"UPC\",\n                                \"created_at\": \"31/08/2023 08:54:07\",\n                                \"updated_at\": \"31/08/2023 08:54:11\"\n                            },\n                            {\n                                \"uid\": 297416340279863,\n                                \"filterable_key\": \"bethesda\",\n                                \"translations\": [\n                                    {\n                                        \"title\": \"Bethesda\",\n                                        \"locale\": \"en\"\n                                    },\n                                    {\n                                        \"title\": \"Bethesda\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"prototype_attribute_uid\": 75427828319792,\n                                \"prototype_attribute_key\": \"Brand\",\n                                \"created_at\": \"31/08/2023 08:54:07\",\n                                \"updated_at\": \"31/08/2023 08:54:11\"\n                            },\n                            {\n                                \"uid\": 735225584162572,\n                                \"filterable_key\": null,\n                                \"translations\": [\n                                    {\n                                        \"title\": \"\",\n                                        \"locale\": \"en\"\n                                    },\n                                    {\n                                        \"title\": \"\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"prototype_attribute_uid\": 341868595651900,\n                                \"prototype_attribute_key\": null,\n                                \"created_at\": \"31/08/2023 08:54:07\",\n                                \"updated_at\": \"31/08/2023 08:54:11\"\n                            },\n                            {\n                                \"uid\": 768461164146261,\n                                \"filterable_key\": null,\n                                \"translations\": [\n                                    {\n                                        \"title\": \"\",\n                                        \"locale\": \"en\"\n                                    },\n                                    {\n                                        \"title\": \"\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"prototype_attribute_uid\": 925098014791791,\n                                \"prototype_attribute_key\": null,\n                                \"created_at\": \"31/08/2023 08:54:07\",\n                                \"updated_at\": \"31/08/2023 08:54:11\"\n                            },\n                            {\n                                \"uid\": 186595422646981,\n                                \"filterable_key\": null,\n                                \"translations\": [\n                                    {\n                                        \"title\": \"\",\n                                        \"locale\": \"en\"\n                                    },\n                                    {\n                                        \"title\": \"\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"prototype_attribute_uid\": 140055824201294,\n                                \"prototype_attribute_key\": null,\n                                \"created_at\": \"31/08/2023 08:54:07\",\n                                \"updated_at\": \"31/08/2023 08:54:11\"\n                            },\n                            {\n                                \"uid\": 372959999544453,\n                                \"filterable_key\": null,\n                                \"translations\": [\n                                    {\n                                        \"title\": \"\",\n                                        \"locale\": \"en\"\n                                    },\n                                    {\n                                        \"title\": \"\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"prototype_attribute_uid\": 216976544688651,\n                                \"prototype_attribute_key\": null,\n                                \"created_at\": \"31/08/2023 08:54:07\",\n                                \"updated_at\": \"31/08/2023 08:54:11\"\n                            }\n                        ],\n                        \"meta_tags\": {\n                            \"translations\": [],\n                            \"og_images\": []\n                        },\n                        \"option_types\": [],\n                        \"variants\": [],\n                        \"measurements\": {\n                            \"weight\": \"0.4\",\n                            \"length\": \"0.0\",\n                            \"width\": \"0.0\",\n                            \"height\": \"0.0\"\n                        },\n                        \"order_status\": {\n                            \"can_backorder\": false,\n                            \"can_preorder\": false,\n                            \"available_on\": null\n                        },\n                        \"images\": [\n                            {\n                                \"id\": 12132,\n                                \"file_name\": \"18700334.jpg\",\n                                \"thumbnail\": \"https://storage.googleapis.com/myshop_1665646692/products/b87b9052b4f8281854997acee8a51792ee53466c/thumbnails/18700334_1693472047.jpg\",\n                                \"preview\": \"https://storage.googleapis.com/myshop_1665646692/products/b87b9052b4f8281854997acee8a51792ee53466c/previews/18700334_1693472047.jpg\",\n                                \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/b87b9052b4f8281854997acee8a51792ee53466c/lists/18700334_1693472047.jpg\",\n                                \"banner\": \"https://storage.googleapis.com/myshop_1665646692/products/b87b9052b4f8281854997acee8a51792ee53466c/banners/18700334_1693472047.jpg\"\n                            }\n                        ],\n                        \"max_purchasable_quantity\": null,\n                        \"max_product_quantity\": 14,\n                        \"created_at\": \"31/08/2023 08:54:07\",\n                        \"updated_at\": \"18/09/2023 12:07:45\"\n                    }\n                }\n            ],\n            \"display_total_compare_to_price\": \"€272.80\",\n            \"display_price\": \"€175.00\",\n            \"display_tax_price\": \"€42.00\",\n            \"display_total_price\": \"€217.00\",\n            \"on_sale\": true,\n            \"on_sale_percentage\": 20.454545454545457,\n            \"show_price\": true,\n            \"has_tax\": true,\n            \"in_stock\": true,\n            \"total_stock\": 22,\n            \"taxes\": [\n                {\n                    \"uid\": 481258870904813,\n                    \"translations\": [\n                        {\n                            \"title\": \"Φ.Π.Α\",\n                            \"locale\": \"el\"\n                        },\n                        {\n                            \"title\": \"Default tax\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"is_default\": true,\n                    \"rate\": 0.24,\n                    \"applies_to\": \"subtotal\",\n                    \"included_in_price\": false,\n                    \"created_at\": \"13/10/2022 07:38:20\",\n                    \"updated_at\": \"07/09/2023 08:27:49\"\n                }\n            ],\n            \"prices\": [\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 175.0,\n                    \"compare_to_price\": 220.0\n                },\n                {\n                    \"price_list_title\": \"2. Retail Price no VAT\",\n                    \"price_list_api_uid\": 445643306463029,\n                    \"price\": 175.0,\n                    \"compare_to_price\": 220.0\n                },\n                {\n                    \"price_list_title\": \"3. Wholesale Price no VAT\",\n                    \"price_list_api_uid\": 633311263925896,\n                    \"price\": 175.0,\n                    \"compare_to_price\": 220.0\n                },\n                {\n                    \"price_list_title\": \"4. Dealer Price no VAT\",\n                    \"price_list_api_uid\": 924804050700710,\n                    \"price\": 155.0,\n                    \"compare_to_price\": 205.0\n                },\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 0.0,\n                    \"compare_to_price\": 0.0\n                },\n                {\n                    \"price_list_title\": \"2. Retail Price no VAT\",\n                    \"price_list_api_uid\": 445643306463029,\n                    \"price\": 0.0,\n                    \"compare_to_price\": 0.0\n                },\n                {\n                    \"price_list_title\": \"3. Wholesale Price no VAT\",\n                    \"price_list_api_uid\": 633311263925896,\n                    \"price\": 0.0,\n                    \"compare_to_price\": 0.0\n                },\n                {\n                    \"price_list_title\": \"4. Dealer Price no VAT\",\n                    \"price_list_api_uid\": 924804050700710,\n                    \"price\": 0.0,\n                    \"compare_to_price\": 0.0\n                }\n            ]\n        },\n        \"custom_fields\": [\n            {\n                \"type\": \"text\",\n                \"key\": \"test key \",\n                \"value\": \"test value\"\n            }\n        ]\n    }\n}\n\n
\nReturns a bundle object wit h the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the bundle
type String The type of item
translations Array An array of bundle's translations. Every translation is an object with the following fields:  
- title  
- subtitle  
- slug  
- description  
- locale
sku String The sku of the bundle
compare_to_price Float The compare to price of the bundle
price Float The price of the bundle
published Boolean Whether the bundle is published or not
prototype_uid Bigint The ID of bundle's category
attributes Array An array of bundle's attributes. Every attribute is an object with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- prototype_attribute_uid  
- prototype_attribute_key  
- created_at  
- updated_at
bundle_items Array An array of included items of bundle. Every item is an object with the following fields:  
- type  
- item_uid  
- quantity  
- position
meta_tags Object An object with informations about bundle's meta_tags:  
- translations - an array of meta tag's translations. Every translation is an object with following fields:  
- title  
- description  
- keywords  
- locale
measurements Object An object with informations about bundle's measuments. It contains the following fields:  
- weight  
- length  
- width  
- height
images Array An array of bundle's images. Every image is an object with the following fields:  
- id  
- file_name  
- thumbnail  
- preview  
- list_view  
- banner
max_purchasable_quantity Integer The maximum purchasable quantity of this bundle per order
created_at String The date that bundle was created
updated_at String The date that bundle was updated
display_total_compare_to_price String The total compare to price of bundle in display format
display_price String The price of bundle in display format
display_tax_price String The tax price of bundle in display format
display_total_price String The total price of bundle in display format
on_sale Boolean Whether the bundle is on sale or not
on_sale_percentage Float The percentage of discount of bundle
show_price Boolean Whether to show bundle's price or not
has_tax Boolean Whether the bundle has tax or not
taxes Array An array of bundle's taxes. Every tax is an object with the following fields:  
- uid  
- translations - an array of tax's translations. Every translation is an object with following fields:  
- title  
- locale  
- is_default  
- rate  
- applies_to  
- included_in_price  
- created_at  
- updated_at
prices Array An array of bundle's price list prices. Every price is an object with the following fields:  
- price_list_title  
- price_list_api_uid  
- price  
- compare_to_price
\n
Also returns a custom_fields object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
type String The type of value (\"text\" or \"html\" or \"json\")
key String The key of custom field
value String The value of custom field
\n
Errors
\nExample: bundle not found
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"bundle_not_found\",\n        \"message\": \"Bundle with specified uid does not exist\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","bundles","bundle_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"a2f41644-8910-4e00-a7b5-1d9539a1fb00"},{"name":"Create Bundle","id":"b1daf888-83f4-45dd-a47d-e688cd96f828","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{   \n    \"bundle\": {\n        \"locale\": \"el\",\n        \"title\": \"EL-Bundle\", \n        \"slug\": \"el-bundle\",\n        \"description\": \"EL-Bundle-Description
\",\n        \"subtitle\": \"EL-Bundle-Subtitle
\",\n        \"sku\": \"00140371\",\n        \"price\": 40,\n        \"compare_to_price\": 10,\n        \"published\": true,\n        \"applied_tax_uid\": 155183482461123,\n        \"prototype_uid\": 345583482461114,\n        \"prototype_attributes\": [{\n            \"title\": \"EL-Attribute 1\",\n            \"prototype_attribute_uid\": 123433331312\n        },{\n            \"title\": \"EL-Attribute 2\",\n            \"prototype_attribute_uid\": 123433331311\n        }],\n        \"bundle_measurement\": {\n            \"weight\": \"1.5\",\n            \"length\": \"15.0\",\n            \"width\": \"15.0\",\n            \"height\": \"10.0\"\n        },\n        \"bundle_images\": [{\n            \"url\": \"https//example.com/image1.jpg\",\n            \"position\": 1\n        },{\n            \"url\": \"https//example.com/image2.jpg\",\n            \"position\": 2\n        }],\n        \"bundle_items\": [{\n            \"itemable_type\": \"product\",\n            \"itemable_uid\": 509921316903820,\n            \"position\": 1,\n            \"quantity\": 3\n        },{\n            \"itemable_type\": \"variant\",\n            \"itemable_uid\": 509921316903840,\n            \"position\": 2,\n            \"quantity\": 1\n        }],\n        \"seo\": {\n            \"title\": \"EL-SEO\", \n            \"keywords\": \"EL-SEO-Keyword 1, EL-SEO-Keyword 2\", \n            \"description\": \"EL-SEO-description\"\n        },\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"custom-field-key-1\", \n                \"value\": \"custom-field-value-1\",\n                \"type\": \"text\"\n            },\n            \"custom_field2\": {\n                \"key\": \"custom-field-key-2\", \n                \"value\": \"custom-field-value-2\",\n                \"type\": \"html\"\n            }, \n            \"custom_field3\": {\n                \"key\": \"custom-field-key-3\", \n                \"value\": \"custom-field-value-3\",\n                \"type\": \"json\"\n            },\n            \"custom_field4\": {\n                \"key\": \"custom-field-key-4\", \n                \"value\": \"custom-field-value-4\",\n                \"type\": \"text\"\n            },\n            \"custom_field5\": {\n                \"key\": \"custom-field-key-5\", \n                \"value\": \"custom-field-value-5\",\n                \"type\": \"text\"\n            },\n            \"custom_field6\": {\n                \"key\": \"custom-field-key-6\", \n                \"value\": \"custom-field-value-6\",\n                \"type\": \"text\"\n            },\n            \"custom_field7\": {\n                \"key\": \"custom-field-key-7\", \n                \"value\": \"custom-field-value-7\",\n                \"type\": \"text\"\n            },\n            \"custom_field8\": {\n                \"key\": \"custom-field-key-8\", \n                \"value\": \"custom-field-value-8\",\n                \"type\": \"text\"\n            },\n            \"custom_field9\": {\n                \"key\": \"custom-field-key-9\", \n                \"value\": \"custom-field-value-9\",\n                \"type\": \"text\"\n            },\n            \"custom_field10\": {\n                \"key\": \"custom-field-key-10\", \n                \"value\": \"custom-field-value-10\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/bundles","description":"Creates a bundle
\nParameters
\n{   \"bundle\":{\n        \"locale\": \"el\",\n        \"title\": \"test bundle\",\n        \"description\": \"test bundle description\",\n        \"subtitle\": \"test bundle subtitle\",\n        \"sku\": \"00012345\",\n        \"price\": 45.5,\n        \"compare_to_price\": 61.5,\n        \"published\": true,\n        \"prototype_uid\": 438785098766320,\n        \"applied_tax_uid\": 49306442105762,\n        \"bundle_measurement\": {\n            \"weight\": 2.5,\n            \"length\": 14.0,\n            \"width\": 12.0,\n            \"height\": 10.0\n        },\n        \"prototype_attributes\": [\n            {\n                \"title\": \"1234512345123\",\n                \"prototype_attribute_uid\": 511657348593198\n            },\n            {\n                \"title\": \"Test Brand\",\n                \"prototype_attribute_uid\": 792147838615580\n            },\n            {\n                \"title\": \"Blue\",\n                \"prototype_attribute_uid\": 850013564166658\n            },\n            {\n                \"title\": \"No\",\n                \"prototype_attribute_uid\": 195658809681290\n            },\n            {\n                \"title\": \"Microtextured\",\n                \"prototype_attribute_uid\": 491806080342594\n            },\n            {\n                \"title\": \"20cm x 25cm\",\n                \"prototype_attribute_uid\": 199027907529441\n            }\n        ],\n        \"bundle_images\": [\n            {\n                \"url\": \"https://unblast.com/wp-content/uploads/2019/08/Carton-Packaging-Box-Mockup-2.jpg\",\n                \"position\": 1\n            },\n            {\n                \"url\": \"https://dailymockup.com/wp-content/uploads/edd/2019/05/packaging-box-mockup-free.jpg\",\n                \"position\": 2\n            }\n        ],\n        \"bundle_items\": [\n            {\n                \"itemable_type\": \"product\",\n                \"itemable_uid\": 639770013061695,\n                \"position\": 1, \n                \"quantity\": 2\n            },\n            {\n                \"itemable_type\": \"variant\",\n                \"itemable_uid\": 590701494934057,\n                \"position\": 2, \n                \"quantity\": 1\n            }\n        ],\n        \"seo\": {\n            \"title\": \"test title\",\n            \"keywords\": \"keyword_1, keyword_2\",\n            \"description\": \"test description\"\n        },\n        \"prices\": [\n            {\n                \"price_list_uid\": 941615867930108,\n                \"price\": 45.5,\n                \"compare_to_price\": 61.5\n            },\n            {\n                \"price_list_uid\": 941615867930108,\n                \"price\": 42,\n                \"compare_to_price\": 60\n            },\n            {\n                \"price_list_uid\": 941615867930108,\n                \"price\": 40.5,\n                \"compare_to_price\": 58.5\n            },\n            {\n                \"price_list_uid\": 941615867930108,\n                \"price\": 39,\n                \"compare_to_price\": 55\n            }\n        ],\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"test_key\",\n                \"value\": \"test_value\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}\n\n
\nWe send a bundle object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nRequired Field Type Description
Mandatory locale String The locale of the translation to be created
Mandatory title String The title of bundle
Optional slug String The slug of bundle
Optional description String The description of the bundle's translation
Optional subtitle String The subtitle of the bundle's translation
Optional sku String The sku of the bundle
Optional price Float The price of the bundle
Optional compare_to_price Float The compare to price of the bundle
Optional published Boolean Whether the bundle is published or not. Bundles with less than two bundle items can't be published.
Optional applied_tax_uid Bigint The ID of the applied tax of the bundle
Optional bundle_measurement Object An object with informations about bundle's measurement. It contains the following fields:  
- weight(Float) - in kg  
- length(Float) - in cm  
- width(Float) - in cm  
- height(Float) - in cm
Optional prototype_uid Bigint The ID of the category of the bundle
Optional prototype_attributes Array An array of bundle's category attributes. Every category attribute is an object with the following fields:  
- title(String)  
- prototype_attribute_uid(Bigint) - prototype attribute ID
Optional bundle_images Array An array of bundle's images. Every image is an object with the following fields:  
- url(String)  
- position(Integer) - the display order of image
Optional bundle_items Array An array of bundle's included items. Every bundle item is an object with the following fields:  
- itemable_type(String) - the type of the item(\"product\" or \"variant\")  
- itemable_uid(Bigint) - the ID of the item  
- position(Integer) - the display order of the item  
- quantity(Integer) - the quantity of the item
Optional seo Object An object with informations about bundle's seo. It contains the following fields:  
- title(String)  
- keywords(String)  
- description(String)
Optional prices Array An array of bundle's price list prices. Every price is an object with the following fields:  
- price_list_uid(Bigint) - the ID of price list  
- price(Float)  
- compare_to_price(Float)
Optional custom_fields Object An object with bundle's custom fields. It contains the following a field for every custom field to be added. Field name follows the pattern custom_field. Can add up to 10 custom fields. Every custom field contains the following fields:  
- key(String)  
- value(String)  
- type(String) - must be \"text\" or \"html\" or \"json\"
\n
Response
\n{\n    \"response\": {\n        \"bundle\": {\n            \"uid\": 576103935999375,\n            \"type\": \"bundle\",\n            \"translations\": [\n                {\n                    \"title\": \"test bundle\",\n                    \"subtitle\": \"test bundle subtitle\",\n                    \"slug\": \"test-bundle\",\n                    \"description\": \"test bundle description\",\n                    \"locale\": \"el\"\n                }\n            ],\n            \"sku\": \"00012345\",\n            \"compare_to_price\": 61.5,\n            \"price\": 45.5,\n            \"published\": true,\n            \"prototype_uid\": 438785098766320,\n            \"attributes\": [\n                {\n                    \"uid\": 296039195783503,\n                    \"filterable_key\": \"1234512345123\",\n                    \"translations\": [\n                        {\n                            \"title\": \"1234512345123\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 511657348593198,\n                    \"prototype_attribute_key\": \"UPC\",\n                    \"created_at\": \"03/10/2023 09:44:17\",\n                    \"updated_at\": \"03/10/2023 09:44:17\"\n                },\n                {\n                    \"uid\": 804750963352873,\n                    \"filterable_key\": \"test_brand\",\n                    \"translations\": [\n                        {\n                            \"title\": \"Test Brand\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 792147838615580,\n                    \"prototype_attribute_key\": \"Brand\",\n                    \"created_at\": \"03/10/2023 09:44:17\",\n                    \"updated_at\": \"03/10/2023 09:44:17\"\n                },\n                {\n                    \"uid\": 863583260761864,\n                    \"filterable_key\": \"blue\",\n                    \"translations\": [\n                        {\n                            \"title\": \"Blue\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 850013564166658,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"03/10/2023 09:44:17\",\n                    \"updated_at\": \"03/10/2023 09:44:17\"\n                },\n                {\n                    \"uid\": 758029153747418,\n                    \"filterable_key\": \"no\",\n                    \"translations\": [\n                        {\n                            \"title\": \"No\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 195658809681290,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"03/10/2023 09:44:17\",\n                    \"updated_at\": \"03/10/2023 09:44:17\"\n                },\n                {\n                    \"uid\": 271268473311771,\n                    \"filterable_key\": \"microtextured\",\n                    \"translations\": [\n                        {\n                            \"title\": \"Microtextured\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 491806080342594,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"03/10/2023 09:44:17\",\n                    \"updated_at\": \"03/10/2023 09:44:17\"\n                },\n                {\n                    \"uid\": 900069450155147,\n                    \"filterable_key\": \"20cm_x_25cm\",\n                    \"translations\": [\n                        {\n                            \"title\": \"20cm x 25cm\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 199027907529441,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"03/10/2023 09:44:17\",\n                    \"updated_at\": \"03/10/2023 09:44:17\"\n                }\n            ],\n            \"meta_tags\": {\n                \"translations\": [\n                    {\n                        \"title\": \"test title\",\n                        \"description\": \"test description\",\n                        \"keywords\": \"keyword_1, keyword_2\",\n                        \"locale\": \"el\"\n                    }\n                ],\n                \"og_images\": []\n            },\n            \"measurements\": {\n                \"weight\": \"2.5\",\n                \"length\": \"14.0\",\n                \"width\": \"12.0\",\n                \"height\": \"10.0\"\n            },\n            \"images\": [\n                {\n                    \"uid\": 157351002432860,\n                    \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/576103935999375/lists/carton-packaging-box-mockup-2_1696326257.jpg\"\n                },\n                {\n                    \"uid\": 369469891631531,\n                    \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/576103935999375/lists/packaging-box-mockup-free_1696326264.jpg\"\n                }\n            ],\n            \"max_purchasable_quantity\": null,\n            \"created_at\": \"03/10/2023 09:44:17\",\n            \"updated_at\": \"03/10/2023 09:44:28\",\n            \"bundle_items\": [\n                {\n                    \"type\": \"product\",\n                    \"item_uid\": 639770013061695,\n                    \"quantity\": 2,\n                    \"position\": 1,\n                    \"itemable\": {\n                        \"uid\": 639770013061695,\n                        \"type\": \"product\",\n                        \"translations\": [\n                            {\n                                \"title\": \"test product\",\n                                \"subtitle\": \"\",\n                                \"slug\": \"test-product\",\n                                \"description\": \"\",\n                                \"locale\": \"el\"\n                            },\n                            {\n                                \"title\": \"test product\",\n                                \"subtitle\": \"\",\n                                \"slug\": \"test-product-37070\",\n                                \"description\": \"\",\n                                \"locale\": \"en\"\n                            }\n                        ],\n                        \"sku\": \"00005678\",\n                        \"compare_to_price\": 31.0,\n                        \"price\": 20.0,\n                        \"published\": false,\n                        \"prototype_uid\": null,\n                        \"attributes\": [],\n                        \"meta_tags\": {\n                            \"translations\": [\n                                {\n                                    \"title\": \"test product\",\n                                    \"description\": \"\",\n                                    \"keywords\": \"\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"og_images\": []\n                        },\n                        \"option_types\": [],\n                        \"variants\": [],\n                        \"measurements\": {\n                            \"weight\": \"0.0\",\n                            \"length\": \"0.0\",\n                            \"width\": \"0.0\",\n                            \"height\": \"0.0\"\n                        },\n                        \"order_status\": null,\n                        \"images\": [],\n                        \"max_purchasable_quantity\": null,\n                        \"max_product_quantity\": 14,\n                        \"created_at\": \"03/10/2023 09:41:18\",\n                        \"updated_at\": \"03/10/2023 09:42:16\"\n                    }\n                },\n                {\n                    \"type\": \"variant\",\n                    \"item_uid\": 590701494934057,\n                    \"quantity\": 1,\n                    \"position\": 2,\n                    \"itemable\": {\n                        \"uid\": 590701494934057,\n                        \"type\": \"variant\",\n                        \"translations\": [\n                            {\n                                \"title\": \"Logitech M190 Wireless Mouse\",\n                                \"subtitle\": \"\",\n                                \"slug\": \"logitech-m190-wireless-mouse-771199\",\n                                \"description\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"Logitech M190 Wireless Mouse\",\n                                \"subtitle\": \"\",\n                                \"slug\": \"logitech-m190-wireless-mouse-168547\",\n                                \"description\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"sku\": \"13500737\",\n                        \"compare_to_price\": 30.0,\n                        \"price\": 17.0,\n                        \"upc\": \"5099206091825\",\n                        \"weight\": \"0.0\",\n                        \"options\": [\n                            {\n                                \"option_uid\": 279253698179152,\n                                \"option_type_uid\": 546256194908277\n                            },\n                            {\n                                \"option_uid\": 83739605579190,\n                                \"option_type_uid\": 245750398187715\n                            }\n                        ],\n                        \"option_types\": [\n                            {\n                                \"uid\": 546256194908277,\n                                \"filterable_key\": \"test_option_type_1\",\n                                \"input_type\": 1,\n                                \"preselect_default\": true,\n                                \"translations\": [\n                                    {\n                                        \"title\": \"test option type 1\",\n                                        \"locale\": \"el\"\n                                    },\n                                    {\n                                        \"title\": \"test option type 1\",\n                                        \"locale\": \"en\"\n                                    }\n                                ],\n                                \"options\": [\n                                    {\n                                        \"uid\": 279253698179152,\n                                        \"filterable_key\": \"test_option_11\",\n                                        \"translations\": [\n                                            {\n                                                \"title\": \"test option 11\",\n                                                \"locale\": \"el\"\n                                            },\n                                            {\n                                                \"title\": \"test option 11\",\n                                                \"locale\": \"en\"\n                                            }\n                                        ],\n                                        \"price_operator\": 0,\n                                        \"price_operand\": 0,\n                                        \"price\": 0.0,\n                                        \"display_price_value\": null,\n                                        \"default\": true,\n                                        \"created_at\": \"03/10/2023 09:29:40\",\n                                        \"updated_at\": \"03/10/2023 09:36:29\"\n                                    },\n                                    {\n                                        \"uid\": 980983570752194,\n                                        \"filterable_key\": \"test_option_12\",\n                                        \"translations\": [\n                                            {\n                                                \"title\": \"test option 12\",\n                                                \"locale\": \"el\"\n                                            },\n                                            {\n                                                \"title\": \"test option 12\",\n                                                \"locale\": \"en\"\n                                            }\n                                        ],\n                                        \"price_operator\": 0,\n                                        \"price_operand\": 0,\n                                        \"price\": 1.0,\n                                        \"display_price_value\": \"+€1\",\n                                        \"default\": false,\n                                        \"created_at\": \"03/10/2023 09:29:40\",\n                                        \"updated_at\": \"03/10/2023 09:36:29\"\n                                    }\n                                ],\n                                \"created_at\": \"03/10/2023 09:29:40\",\n                                \"updated_at\": \"03/10/2023 09:36:29\"\n                            },\n                            {\n                                \"uid\": 245750398187715,\n                                \"filterable_key\": \"test_option_type_2\",\n                                \"input_type\": 3,\n                                \"preselect_default\": true,\n                                \"translations\": [\n                                    {\n                                        \"title\": \"test option type 2\",\n                                        \"locale\": \"en\"\n                                    },\n                                    {\n                                        \"title\": \"test option type 2\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"options\": [\n                                    {\n                                        \"uid\": 83739605579190,\n                                        \"filterable_key\": \"test_option_21\",\n                                        \"translations\": [\n                                            {\n                                                \"title\": \"test option 21\",\n                                                \"locale\": \"en\"\n                                            },\n                                            {\n                                                \"title\": \"test option 21\",\n                                                \"locale\": \"el\"\n                                            }\n                                        ],\n                                        \"price_operator\": 0,\n                                        \"price_operand\": 1,\n                                        \"price\": 2.0,\n                                        \"display_price_value\": \"+2.0%\",\n                                        \"default\": true,\n                                        \"created_at\": \"03/10/2023 09:32:16\",\n                                        \"updated_at\": \"03/10/2023 09:36:51\"\n                                    },\n                                    {\n                                        \"uid\": 31765377719412,\n                                        \"filterable_key\": \"test_option_22\",\n                                        \"translations\": [\n                                            {\n                                                \"title\": \"test option 22\",\n                                                \"locale\": \"en\"\n                                            },\n                                            {\n                                                \"title\": \"test option 22\",\n                                                \"locale\": \"el\"\n                                            }\n                                        ],\n                                        \"price_operator\": 0,\n                                        \"price_operand\": 1,\n                                        \"price\": 5.0,\n                                        \"display_price_value\": \"+5.0%\",\n                                        \"default\": false,\n                                        \"created_at\": \"03/10/2023 09:32:16\",\n                                        \"updated_at\": \"03/10/2023 09:36:51\"\n                                    }\n                                ],\n                                \"created_at\": \"03/10/2023 09:32:16\",\n                                \"updated_at\": \"03/10/2023 09:36:51\"\n                            }\n                        ],\n                        \"images\": [\n                            {\n                                \"uid\": 374409513608977,\n                                \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/f08d44fb5df24f94f0e17511406bb47bf768c540/lists/13500737_1690287383.jpg\"\n                            }\n                        ],\n                        \"max_purchasable_quantity\": 4,\n                        \"max_product_quantity\": 14,\n                        \"order_status\": {\n                            \"can_backorder\": false,\n                            \"can_preorder\": false,\n                            \"available_on\": null\n                        },\n                        \"created_at\": \"03/10/2023 09:38:12\",\n                        \"updated_at\": \"03/10/2023 09:38:27\"\n                    }\n                }\n            ],\n            \"display_total_compare_to_price\": \"€61.50\",\n            \"display_price\": \"€45.50\",\n            \"display_tax_price\": \"€10.50\",\n            \"display_total_price\": \"€45.50\",\n            \"total_price\": 45.5,\n            \"on_sale\": true,\n            \"on_sale_percentage\": 26.01626016260163,\n            \"show_price\": true,\n            \"has_tax\": true,\n            \"in_stock\": true,\n            \"total_stock\": 25,\n            \"taxes\": [\n                {\n                    \"uid\": 49306442105762,\n                    \"translations\": [\n                        {\n                            \"title\": \"rgtrgswrgw tax\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"is_default\": false,\n                    \"rate\": 0.3,\n                    \"applies_to\": \"subtotal\",\n                    \"included_in_price\": true,\n                    \"created_at\": \"01/08/2023 08:46:10\",\n                    \"updated_at\": \"01/08/2023 08:46:10\"\n                }\n            ],\n            \"prices\": [\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 45.5,\n                    \"compare_to_price\": 61.5\n                },\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 42.0,\n                    \"compare_to_price\": 60.0\n                },\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 40.5,\n                    \"compare_to_price\": 58.5\n                },\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 39.0,\n                    \"compare_to_price\": 55.0\n                }\n            ]\n        },\n        \"custom_fields\": [\n            {\n                \"type\": \"text\",\n                \"key\": \"test_key\",\n                \"value\": \"test_value\"\n            }\n        ],\n        \"logs\": []\n    }\n}\n\n
\nReturns a new bundle with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the bundle
type String The type of item
translations Array An array of bundle's translations. Every translation is an object with the following fields:  
- title  
- subtitle  
- slug  
- description  
- locale
sku String The sku of the bundle
compare_to_price Float The compare to price of the bundle
price Float The price of the bundle
published Boolean Whether the bundle is published or not
prototype_uid Bigint The ID of bundle's category
attributes Array An array of bundle's attributes. Every attribute is an object with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- prototype_attribute_uid  
- prototype_attribute_key  
- created_at  
- updated_at
meta_tags Object An object with informations about bundle's meta_tags:  
- translations - an array of meta tag's translations. Every translation is an object with following fields:  
- title  
- description  
- keywords  
- locale
measurements Object An object with informations about bundle's measuments. It contains the following fields:  
- weight  
- length  
- width  
- height
images Array An array of bundle's images. Every image is an object with the following fields:  
- id  
- file_name  
- thumbnail  
- preview  
- list_view  
- banner
max_purchasable_quantity Integer The maximum purchasable quantity of this bundle per order
created_at String The date that bundle was created
updated_at String The date that bundle was updated
bundle_items Array An array of included items of bundle. Every item is an object with the following fields:  
- type  
- item_uid  
- quantity  
- position  
- itemable - an object with information about the included item. The content of this object depends of the type of the item. See below for more details.
display_total_compare_to_price String The total compare to price of bundle in display format
display_price String The price of bundle in display format
display_tax_price String The tax price of bundle in display format
display_total_price String The total price of bundle in display format
on_sale Boolean Whether the bundle is on sale or not
on_sale_percentage Float The percentage of discount of bundle
show_price Boolean Whether to show bundle's price or not
has_tax Boolean Whether the bundle has tax or not
in_stock Boolean Whether the bundle is in stock or not
total_stock Integer The total stock of the bundle. It is computed from stock of the bundle items
taxes Array An array of bundle's taxes. Every tax is an object with the following fields:  
- uid  
- translations - an array of tax's translations. Every translation is an object with following fields:  
- title  
- locale  
- is_default  
- rate  
- applies_to  
- included_in_price  
- created_at  
- updated_at
prices Array An array of bundle's price list prices. Every price is an object with the following fields:  
- price_list_title  
- price_list_api_uid  
- price  
- compare_to_price
\n
If bundle item is a product then itemable has the following fields:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the product
type String The type of item
translations Array An array of product's translations. Every translation is an object with the following fields:  
- title  
- subtitle  
- slug  
- description  
- locale
sku String The sku of the product
compare_to_price Float The compare to price of the product
price Float The price of the product
published Boolean Whether the product is published or not
prototype_uid Bigint The ID of product's category
attributes Array An array of product's attributes. Every attribute is an object with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- prototype_attribute_uid  
- prototype_attribute_key  
- created_at  
- updated_at
meta_tags Object An object with informations about product's meta_tags:  
- translations - an array of meta tag's translations. Every translation is an object with following fields:  
- title  
- description  
- keywords  
- locale
option_types Array An array with product's option types. Every option type is an object with the following fields:  
- uid  
- filterable_key  
- input_type  
- preselect_default  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- options - an array of option type's options. Every option is an abject with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- price_operator  
- price_operand  
- price  
- default_price_value  
- default  
- created_at  
- updated_at  
- created_at  
- updated_at
variants Array An array of product's variants. Every variant is an object. For variant's fields see below
measurements Object An object with informations about product's measuments. It contains the following fields:  
- weight  
- length  
- width  
- height
order_status Object An object with informations about product's order status. It contains the following fields:  
- can_backorder  
- can_preorder  
- available_on
images Array An array of product's images. Every image is an object with the following fields:  
- id  
- file_name  
- thumbnail  
- preview  
- list_view  
- banner
max_purchasable_quantity Integer The maximum purchasable quantity of this product per order
max_product_quantity Integer The maximum purchasable quantity of products per order
created_at String The date that product was created
updated_at String The date that product was updated
\n
If bundle item is a variant then itemable has the following fields:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the variant
type String The type of item
translations Array An array of variant's translations. Every translation is an object with the following fields:  
- title  
- subtitle  
- slug  
- description  
- locale
sku String The sku of the variant
compare_to_price Float The compare to price of the variant
price Float The price of the variant
upc String The upc of the variant
weight String The weight of the variant
options Array An array with options of the variant. Every option is an object with the following fields:  
- option_uid  
- option_type_uid
option_types Array An array with option types of the variant. Every option type is an object with the following fields:  
- uid  
- filterable_key  
- input_type  
- preselect_default  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- options - an array of option type's options. Every option is an abject with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- price_operator  
- price_operand  
- price  
- default_price_value  
- default  
- created_at  
- updated_at  
- created_at  
- updated_at
images Array An array of variant's images. Every image is an object with the following fields:  
- id  
- file_name  
- thumbnail  
- preview  
- list_view  
- banner
max_purchasable_quantity Integer The maximum purchasable quantity of this variant per order
max_product_quantity Integer The maximum purchasable quantity of products per order
order_status Object An object with informations about variant's order status. It contains the following fields:  
- can_backorder  
- can_preorder  
- available_on
created_at String The date that variant was created
updated_at String The date that variant was updated
\n
Also returns a custom_fields object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
type String The type of value (\"text\" or \"html\" or \"json\")
key String The key of custom field
value String The value of custom field
\n
logs - An array of notes related to the request (e.g. [\"invalid prototype uid\"])
\nErrors
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","bundles"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"b1daf888-83f4-45dd-a47d-e688cd96f828"},{"name":"Update Bundle","id":"1794059a-57d0-47d7-99d7-e99c95d80d17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{   \n    \"bundle\": {\n        \"locale\": \"el\",\n        \"title\": \"EL-Bundle\", \n        \"slug\": \"el-bundle\",\n        \"description\": \"EL-Bundle-Description
\",\n        \"subtitle\": \"EL-Bundle-Subtitle
\",\n        \"sku\": \"00140371\",\n        \"price\": 40,\n        \"compare_to_price\": 10,\n        \"published\": true,\n        \"applied_tax_uid\": 155183482461123,\n        \"prototype_uid\": 345583482461114,\n        \"bundle_attributes\": [{\n            \"title\": \"EL-Attribute 1\",\n            \"bundle_attribute_uid\": 123433331312\n        },{\n            \"title\": \"EL-Attribute 2\",\n            \"bundle_attribute_uid\": 123433331311\n        }],\n        \"bundle_measurement\": {\n            \"weight\": \"1.5\",\n            \"length\": \"15.0\",\n            \"width\": \"15.0\",\n            \"height\": \"10.0\"\n        },\n        \"bundle_images\": [{\n            \"url\": \"https//example.com/image1.jpg\",\n            \"position\": 1\n        },{\n            \"url\": \"https//example.com/image2.jpg\",\n            \"position\": 2\n        }],\n        \"bundle_items\": [{\n            \"itemable_type\": \"product\",\n            \"itemable_uid\": 509921316903820,\n            \"position\": 1,\n            \"quantity\": 3\n        },{\n            \"itemable_type\": \"variant\",\n            \"itemable_uid\": 509921316903840,\n            \"position\": 2,\n            \"quantity\": 1\n        }],\n        \"seo\": {\n            \"title\": \"EL-SEO\", \n            \"keywords\": \"EL-SEO-Keyword 1, EL-SEO-Keyword 2\", \n            \"description\": \"EL-SEO-description\"\n        },\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"custom-field-key-1\", \n                \"value\": \"custom-field-value-1\",\n                \"type\": \"text\"\n            },\n            \"custom_field2\": {\n                \"key\": \"custom-field-key-2\", \n                \"value\": \"custom-field-value-2\",\n                \"type\": \"html\"\n            }, \n            \"custom_field3\": {\n                \"key\": \"custom-field-key-3\", \n                \"value\": \"custom-field-value-3\",\n                \"type\": \"json\"\n            },\n            \"custom_field4\": {\n                \"key\": \"custom-field-key-4\", \n                \"value\": \"custom-field-value-4\",\n                \"type\": \"text\"\n            },\n            \"custom_field5\": {\n                \"key\": \"custom-field-key-5\", \n                \"value\": \"custom-field-value-5\",\n                \"type\": \"text\"\n            },\n            \"custom_field6\": {\n                \"key\": \"custom-field-key-6\", \n                \"value\": \"custom-field-value-6\",\n                \"type\": \"text\"\n            },\n            \"custom_field7\": {\n                \"key\": \"custom-field-key-7\", \n                \"value\": \"custom-field-value-7\",\n                \"type\": \"text\"\n            },\n            \"custom_field8\": {\n                \"key\": \"custom-field-key-8\", \n                \"value\": \"custom-field-value-8\",\n                \"type\": \"text\"\n            },\n            \"custom_field9\": {\n                \"key\": \"custom-field-key-9\", \n                \"value\": \"custom-field-value-9\",\n                \"type\": \"text\"\n            },\n            \"custom_field10\": {\n                \"key\": \"custom-field-key-10\", \n                \"value\": \"custom-field-value-10\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/bundles/bundle_uid","description":"Updates a bundle
\nParameters
\nbundle_uid (Bigint) - Indicates the id of the bundle to be updated.
\n{   \"bundle\":{\n        \"locale\": \"el\",\n        \"sku\": \"00012345\",\n        \"price\": 43.5,\n        \"compare_to_price\": 57.8,\n        \"published\": true,\n        \"prototype_uid\": 4387850987663201,\n        \"applied_tax_uid\": 481258870904813,\n        \"bundle_measurement\": {\n            \"weight\": 2.4,\n            \"length\": 12.0,\n            \"width\": 11.0,\n            \"height\": 11.2\n        },\n        \"bundle_attributes\": [\n            {\n                \"title\": \"1234512345123\",\n                \"prototype_attribute_uid\": 296039195783503\n            },\n            {\n                \"title\": \"Test Brand Two\",\n                \"prototype_attribute_uid\": 804750963352873\n            },\n            {\n                \"title\": \"Orange\",\n                \"prototype_attribute_uid\": 863583260761864\n            },\n            {\n                \"title\": \"Yes\",\n                \"prototype_attribute_uid\": 758029153747418\n            },\n            {\n                \"title\": \"Microtextured\",\n                \"prototype_attribute_uid\": 271268473311771\n            },\n            {\n                \"title\": \"22cm x 26cm\",\n                \"prototype_attribute_uid\": 900069450155147\n            }\n        ],\n        \"bundle_images\": [\n            {\n                \"url\": \"https://unblast.com/wp-content/uploads/2019/08/Carton-Packaging-Box-Mockup-2.jpg\",\n                \"position\": 1\n            }\n        ],\n        \"bundle_items\": [\n            {\n                \"itemable_type\": \"product\",\n                \"itemable_uid\": 639770013061695,\n                \"position\": 2, \n                \"quantity\": 3\n            },\n            {\n                \"itemable_type\": \"variant\",\n                \"itemable_uid\": 590701494934057,\n                \"position\": 1, \n                \"quantity\": 2\n            }\n        ],\n        \"seo\": {\n            \"title\": \"updated test title\",\n            \"keywords\": \"keyword_1, keyword_2, keyword_3\",\n            \"description\": \"updated test description\"\n        },\n        \"prices\": [\n            {\n                \"price_list_uid\": 941615867930108,\n                \"price\": 42.5,\n                \"compare_to_price\": 57.5\n            },\n            {\n                \"price_list_uid\": 941615867930108,\n                \"price\": 42,\n                \"compare_to_price\": 60\n            },\n            {\n                \"price_list_uid\": 941615867930108,\n                \"price\": 40.5,\n                \"compare_to_price\": 54.5\n            },\n            {\n                \"price_list_uid\": 941615867930108,\n                \"price\": 39,\n                \"compare_to_price\": 54\n            }\n        ],\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"new_test_key\",\n                \"value\": \"test_value\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}\n\n
\nWe send a bundle object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nRequired Field Type Description
Conditional locale String Must be provided if there are changes in bundle/category attributes, options or seo. The locale of the translations to be updated.
Optional sku String The sku of the bundle
Optional price Float The price of the bundle
Optional compare_to_price Float The compare to price of the bundle
Optional published Boolean Whether the bundle is published or not
Optional applied_tax_uid Bigint The ID of the applied tax of the bundle
Optional bundle_measurement Object An object with informations about bundle's measurement. It contains the following fields:  
- weight(Float) - in kg  
- length(Float) - in cm  
- width(Float) - in cm  
- height(Float) - in cm
Optional prototype_uid Bigint The ID of the category of the bundle
Conditional prototype_attributes Array Must be provided if the existed category of the bundle will be changed. An array of bundle's category attributes. Every category attribute is an object with the following fields:  
- title(String)  
- prototype_attribute_uid(Bigint) - prototype attribute ID
Conditional bundle_attributes Array Must be provided if the existed category of the bundle remains.  
An array of bundle's attributes. Every bundle attribute is an object with the following fields:  
- title(String)  
- bundle_attribute_uid(Bigint) - prototype attribute ID
Optional bundle_images Array An array of bundle's images. Every image is an object with the following fields:  
- url  
- position(Integer) - the display order of image
Optional seo Object An object with informations about bundle's seo. It contains the following fields:  
- title(String)  
- keywords(String)  
- description(String)
Optional prices Array An array of bundle's price list prices. Every price is an object with the following fields:  
- price_list_uid(Bigint) - the ID of price list  
- price(Float)  
- compare_to_price(Float)
Optional custom_fields Object An object with bundle's custom fields. It contains the following a field for every custom field to be added. Field name follows the pattern custom_field. Can add up to 10 custom fields. Every custom field contains the following fields:  
- key(String)  
- value(String)  
- type(String) - must be \"text\" or \"html\" or \"json\"
\n
For every custom field parameter provided, which has key that do not exist in bundle's current custom fields, a new one is created. Elsewise the existed custom field gets updated.
\nResponse
\n{\n    \"response\": {\n        \"bundle\": {\n            \"uid\": 576103935999375,\n            \"type\": \"bundle\",\n            \"translations\": [\n                {\n                    \"title\": \"test bundle\",\n                    \"subtitle\": \"test bundle subtitle\",\n                    \"slug\": \"test-bundle\",\n                    \"description\": \"test bundle description\",\n                    \"locale\": \"el\"\n                }\n            ],\n            \"sku\": \"00012345\",\n            \"compare_to_price\": 57.8,\n            \"price\": 43.5,\n            \"published\": true,\n            \"prototype_uid\": 438785098766320,\n            \"attributes\": [\n                {\n                    \"uid\": 296039195783503,\n                    \"filterable_key\": \"1234512345123\",\n                    \"translations\": [\n                        {\n                            \"title\": \"1234512345123\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 511657348593198,\n                    \"prototype_attribute_key\": \"UPC\",\n                    \"created_at\": \"03/10/2023 09:44:17\",\n                    \"updated_at\": \"03/10/2023 09:44:17\"\n                },\n                {\n                    \"uid\": 804750963352873,\n                    \"filterable_key\": \"test_brand\",\n                    \"translations\": [\n                        {\n                            \"title\": \"Test Brand\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 792147838615580,\n                    \"prototype_attribute_key\": \"Brand\",\n                    \"created_at\": \"03/10/2023 09:44:17\",\n                    \"updated_at\": \"03/10/2023 09:44:17\"\n                },\n                {\n                    \"uid\": 863583260761864,\n                    \"filterable_key\": \"blue\",\n                    \"translations\": [\n                        {\n                            \"title\": \"Blue\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 850013564166658,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"03/10/2023 09:44:17\",\n                    \"updated_at\": \"03/10/2023 09:44:17\"\n                },\n                {\n                    \"uid\": 758029153747418,\n                    \"filterable_key\": \"no\",\n                    \"translations\": [\n                        {\n                            \"title\": \"No\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 195658809681290,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"03/10/2023 09:44:17\",\n                    \"updated_at\": \"03/10/2023 09:44:17\"\n                },\n                {\n                    \"uid\": 271268473311771,\n                    \"filterable_key\": \"microtextured\",\n                    \"translations\": [\n                        {\n                            \"title\": \"Microtextured\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 491806080342594,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"03/10/2023 09:44:17\",\n                    \"updated_at\": \"03/10/2023 09:44:17\"\n                },\n                {\n                    \"uid\": 900069450155147,\n                    \"filterable_key\": \"20cm_x_25cm\",\n                    \"translations\": [\n                        {\n                            \"title\": \"20cm x 25cm\",\n                            \"locale\": \"el\"\n                        }\n                    ],\n                    \"prototype_attribute_uid\": 199027907529441,\n                    \"prototype_attribute_key\": null,\n                    \"created_at\": \"03/10/2023 09:44:17\",\n                    \"updated_at\": \"03/10/2023 09:44:17\"\n                }\n            ],\n            \"meta_tags\": {\n                \"translations\": [\n                    {\n                        \"title\": \"updated test title\",\n                        \"description\": \"updated test description\",\n                        \"keywords\": \"keyword_1, keyword_2, keyword_3\",\n                        \"locale\": \"el\"\n                    }\n                ],\n                \"og_images\": []\n            },\n            \"measurements\": {\n                \"weight\": \"2.4\",\n                \"length\": \"12.0\",\n                \"width\": \"11.0\",\n                \"height\": \"11.2\"\n            },\n            \"images\": [\n                {\n                    \"uid\": 157351002432860,\n                    \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/576103935999375/lists/carton-packaging-box-mockup-2_1696326257.jpg\"\n                },\n                {\n                    \"uid\": 369469891631531,\n                    \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/576103935999375/lists/packaging-box-mockup-free_1696326264.jpg\"\n                }\n            ],\n            \"max_purchasable_quantity\": null,\n            \"created_at\": \"03/10/2023 09:44:17\",\n            \"updated_at\": \"03/10/2023 11:18:04\",\n            \"bundle_items\": [\n                {\n                    \"type\": \"product\",\n                    \"item_uid\": 639770013061695,\n                    \"quantity\": 3,\n                    \"position\": 2,\n                    \"itemable\": {\n                        \"uid\": 639770013061695,\n                        \"type\": \"product\",\n                        \"translations\": [\n                            {\n                                \"title\": \"test product\",\n                                \"subtitle\": \"\",\n                                \"slug\": \"test-product\",\n                                \"description\": \"\",\n                                \"locale\": \"el\"\n                            },\n                            {\n                                \"title\": \"test product\",\n                                \"subtitle\": \"\",\n                                \"slug\": \"test-product-37070\",\n                                \"description\": \"\",\n                                \"locale\": \"en\"\n                            }\n                        ],\n                        \"sku\": \"00005678\",\n                        \"compare_to_price\": 31.0,\n                        \"price\": 20.0,\n                        \"published\": false,\n                        \"prototype_uid\": null,\n                        \"attributes\": [],\n                        \"meta_tags\": {\n                            \"translations\": [\n                                {\n                                    \"title\": \"test product\",\n                                    \"description\": \"\",\n                                    \"keywords\": \"\",\n                                    \"locale\": \"el\"\n                                }\n                            ],\n                            \"og_images\": []\n                        },\n                        \"option_types\": [],\n                        \"variants\": [],\n                        \"measurements\": {\n                            \"weight\": \"0.0\",\n                            \"length\": \"0.0\",\n                            \"width\": \"0.0\",\n                            \"height\": \"0.0\"\n                        },\n                        \"order_status\": null,\n                        \"images\": [],\n                        \"max_purchasable_quantity\": null,\n                        \"max_product_quantity\": 14,\n                        \"created_at\": \"03/10/2023 09:41:18\",\n                        \"updated_at\": \"03/10/2023 09:42:16\"\n                    }\n                },\n                {\n                    \"type\": \"variant\",\n                    \"item_uid\": 590701494934057,\n                    \"quantity\": 2,\n                    \"position\": 1,\n                    \"itemable\": {\n                        \"uid\": 590701494934057,\n                        \"type\": \"variant\",\n                        \"translations\": [\n                            {\n                                \"title\": \"Logitech M190 Wireless Mouse\",\n                                \"subtitle\": \"\",\n                                \"slug\": \"logitech-m190-wireless-mouse-771199\",\n                                \"description\": \"\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"Logitech M190 Wireless Mouse\",\n                                \"subtitle\": \"\",\n                                \"slug\": \"logitech-m190-wireless-mouse-168547\",\n                                \"description\": \"\",\n                                \"locale\": \"el\"\n                            }\n                        ],\n                        \"sku\": \"13500737\",\n                        \"compare_to_price\": 30.0,\n                        \"price\": 17.0,\n                        \"upc\": \"5099206091825\",\n                        \"weight\": \"0.0\",\n                        \"options\": [\n                            {\n                                \"option_uid\": 279253698179152,\n                                \"option_type_uid\": 546256194908277\n                            },\n                            {\n                                \"option_uid\": 83739605579190,\n                                \"option_type_uid\": 245750398187715\n                            }\n                        ],\n                        \"option_types\": [\n                            {\n                                \"uid\": 546256194908277,\n                                \"filterable_key\": \"test_option_type_1\",\n                                \"input_type\": 1,\n                                \"preselect_default\": true,\n                                \"translations\": [\n                                    {\n                                        \"title\": \"test option type 1\",\n                                        \"locale\": \"el\"\n                                    },\n                                    {\n                                        \"title\": \"test option type 1\",\n                                        \"locale\": \"en\"\n                                    }\n                                ],\n                                \"options\": [\n                                    {\n                                        \"uid\": 279253698179152,\n                                        \"filterable_key\": \"test_option_11\",\n                                        \"translations\": [\n                                            {\n                                                \"title\": \"test option 11\",\n                                                \"locale\": \"el\"\n                                            },\n                                            {\n                                                \"title\": \"test option 11\",\n                                                \"locale\": \"en\"\n                                            }\n                                        ],\n                                        \"price_operator\": 0,\n                                        \"price_operand\": 0,\n                                        \"price\": 0.0,\n                                        \"display_price_value\": null,\n                                        \"default\": true,\n                                        \"created_at\": \"03/10/2023 09:29:40\",\n                                        \"updated_at\": \"03/10/2023 09:36:29\"\n                                    },\n                                    {\n                                        \"uid\": 980983570752194,\n                                        \"filterable_key\": \"test_option_12\",\n                                        \"translations\": [\n                                            {\n                                                \"title\": \"test option 12\",\n                                                \"locale\": \"el\"\n                                            },\n                                            {\n                                                \"title\": \"test option 12\",\n                                                \"locale\": \"en\"\n                                            }\n                                        ],\n                                        \"price_operator\": 0,\n                                        \"price_operand\": 0,\n                                        \"price\": 1.0,\n                                        \"display_price_value\": \"+€1\",\n                                        \"default\": false,\n                                        \"created_at\": \"03/10/2023 09:29:40\",\n                                        \"updated_at\": \"03/10/2023 09:36:29\"\n                                    }\n                                ],\n                                \"created_at\": \"03/10/2023 09:29:40\",\n                                \"updated_at\": \"03/10/2023 09:36:29\"\n                            },\n                            {\n                                \"uid\": 245750398187715,\n                                \"filterable_key\": \"test_option_type_2\",\n                                \"input_type\": 3,\n                                \"preselect_default\": true,\n                                \"translations\": [\n                                    {\n                                        \"title\": \"test option type 2\",\n                                        \"locale\": \"en\"\n                                    },\n                                    {\n                                        \"title\": \"test option type 2\",\n                                        \"locale\": \"el\"\n                                    }\n                                ],\n                                \"options\": [\n                                    {\n                                        \"uid\": 83739605579190,\n                                        \"filterable_key\": \"test_option_21\",\n                                        \"translations\": [\n                                            {\n                                                \"title\": \"test option 21\",\n                                                \"locale\": \"en\"\n                                            },\n                                            {\n                                                \"title\": \"test option 21\",\n                                                \"locale\": \"el\"\n                                            }\n                                        ],\n                                        \"price_operator\": 0,\n                                        \"price_operand\": 1,\n                                        \"price\": 2.0,\n                                        \"display_price_value\": \"+2.0%\",\n                                        \"default\": true,\n                                        \"created_at\": \"03/10/2023 09:32:16\",\n                                        \"updated_at\": \"03/10/2023 09:36:51\"\n                                    },\n                                    {\n                                        \"uid\": 31765377719412,\n                                        \"filterable_key\": \"test_option_22\",\n                                        \"translations\": [\n                                            {\n                                                \"title\": \"test option 22\",\n                                                \"locale\": \"en\"\n                                            },\n                                            {\n                                                \"title\": \"test option 22\",\n                                                \"locale\": \"el\"\n                                            }\n                                        ],\n                                        \"price_operator\": 0,\n                                        \"price_operand\": 1,\n                                        \"price\": 5.0,\n                                        \"display_price_value\": \"+5.0%\",\n                                        \"default\": false,\n                                        \"created_at\": \"03/10/2023 09:32:16\",\n                                        \"updated_at\": \"03/10/2023 09:36:51\"\n                                    }\n                                ],\n                                \"created_at\": \"03/10/2023 09:32:16\",\n                                \"updated_at\": \"03/10/2023 09:36:51\"\n                            }\n                        ],\n                        \"images\": [\n                            {\n                                \"uid\": 374409513608977,\n                                \"list_view\": \"https://storage.googleapis.com/myshop_1665646692/products/f08d44fb5df24f94f0e17511406bb47bf768c540/lists/13500737_1690287383.jpg\"\n                            }\n                        ],\n                        \"max_purchasable_quantity\": 4,\n                        \"max_product_quantity\": 14,\n                        \"order_status\": {\n                            \"can_backorder\": false,\n                            \"can_preorder\": false,\n                            \"available_on\": null\n                        },\n                        \"created_at\": \"03/10/2023 09:38:12\",\n                        \"updated_at\": \"03/10/2023 09:38:27\"\n                    }\n                }\n            ],\n            \"display_total_compare_to_price\": \"€71.67\",\n            \"display_price\": \"€43.50\",\n            \"display_tax_price\": \"€10.44\",\n            \"display_total_price\": \"€53.94\",\n            \"total_price\": 53.94,\n            \"on_sale\": true,\n            \"on_sale_percentage\": 24.74048442906574,\n            \"show_price\": true,\n            \"has_tax\": true,\n            \"in_stock\": true,\n            \"total_stock\": 12,\n            \"taxes\": [\n                {\n                    \"uid\": 481258870904813,\n                    \"translations\": [\n                        {\n                            \"title\": \"Φ.Π.Α\",\n                            \"locale\": \"el\"\n                        },\n                        {\n                            \"title\": \"Default tax\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"is_default\": true,\n                    \"rate\": 0.24,\n                    \"applies_to\": \"subtotal\",\n                    \"included_in_price\": false,\n                    \"created_at\": \"13/10/2022 07:38:20\",\n                    \"updated_at\": \"07/09/2023 08:27:49\"\n                }\n            ],\n            \"prices\": [\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 39.0,\n                    \"compare_to_price\": 54.0\n                },\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 42.0,\n                    \"compare_to_price\": 60.0\n                },\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 40.5,\n                    \"compare_to_price\": 58.5\n                },\n                {\n                    \"price_list_title\": \"1. Retail incl.VAT\",\n                    \"price_list_api_uid\": 941615867930108,\n                    \"price\": 39.0,\n                    \"compare_to_price\": 55.0\n                }\n            ]\n        },\n        \"custom_fields\": [\n            {\n                \"type\": \"text\",\n                \"key\": \"test_key\",\n                \"value\": \"test_value\"\n            },\n            {\n                \"type\": \"text\",\n                \"key\": \"new_test_key\",\n                \"value\": \"test_value\"\n            }\n        ],\n        \"logs\": [\n            \"invalid prototype uid\"\n        ]\n    }\n}\n\n
\nReturns a bundle with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the bundle
type String The type of item
translations Array An array of bundle's translations. Every translation is an object with the following fields:  
- title  
- subtitle  
- slug  
- description  
- locale
sku String The sku of the bundle
compare_to_price Float The compare to price of the bundle
price Float The price of the bundle
published Boolean Whether the bundle is published or not
prototype_uid Bigint The ID of bundle's category
attributes Array An array of bundle's attributes. Every attribute is an object with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- prototype_attribute_uid  
- prototype_attribute_key  
- created_at  
- updated_at
meta_tags Object An object with informations about bundle's meta_tags:  
- translations - an array of meta tag's translations. Every translation is an object with following fields:  
- title  
- description  
- keywords  
- locale
measurements Object An object with informations about bundle's measuments. It contains the following fields:  
- weight  
- length  
- width  
- height
images Array An array of bundle's images. Every image is an object with the following fields:  
- id  
- file_name  
- thumbnail  
- preview  
- list_view  
- banner
max_purchasable_quantity Integer The maximum purchasable quantity of this bundle per order
created_at String The date that bundle was created
updated_at String The date that bundle was updated
bundle_items Array An array of included items of bundle. Every item is an object with the following fields:  
- type  
- item_uid  
- quantity  
- position  
- itemable - an object with information about the included item. The content of this object depends of the type of the item. See below for more details.
display_total_compare_to_price String The total compare to price of bundle in display format
display_price String The price of bundle in display format
display_tax_price String The tax price of bundle in display format
display_total_price String The total price of bundle in display format
on_sale Boolean Whether the bundle is on sale or not
on_sale_percentage Float The percentage of discount of bundle
show_price Boolean Whether to show bundle's price or not
has_tax Boolean Whether the bundle has tax or not
in_stock Boolean Whether the bundle is in stock or not
total_stock Integer The total stock of the bundle. It is computed from stock of the bundle items
taxes Array An array of bundle's taxes. Every tax is an object with the following fields:  
- uid  
- translations - an array of tax's translations. Every translation is an object with following fields:  
- title  
- locale  
- is_default  
- rate  
- applies_to  
- included_in_price  
- created_at  
- updated_at
prices Array An array of bundle's price list prices. Every price is an object with the following fields:  
- price_list_title  
- price_list_api_uid  
- price  
- compare_to_price
\n
If bundle item is a product then itemable has the following fields:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the product
type String The type of item
translations Array An array of product's translations. Every translation is an object with the following fields:  
- title  
- subtitle  
- slug  
- description  
- locale
sku String The sku of the product
compare_to_price Float The compare to price of the product
price Float The price of the product
published Boolean Whether the product is published or not
prototype_uid Bigint The ID of product's category
attributes Array An array of product's attributes. Every attribute is an object with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- prototype_attribute_uid  
- prototype_attribute_key  
- created_at  
- updated_at
meta_tags Object An object with informations about product's meta_tags:  
- translations - an array of meta tag's translations. Every translation is an object with following fields:  
- title  
- description  
- keywords  
- locale
option_types Array An array with product's option types. Every option type is an object with the following fields:  
- uid  
- filterable_key  
- input_type  
- preselect_default  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- options - an array of option type's options. Every option is an abject with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- price_operator  
- price_operand  
- price  
- default_price_value  
- default  
- created_at  
- updated_at  
- created_at  
- updated_at
variants Array An array of product's variants. Every variant is an object. For variant's fields see below
measurements Object An object with informations about product's measuments. It contains the following fields:  
- weight  
- length  
- width  
- height
order_status Object An object with informations about product's order status. It contains the following fields:  
- can_backorder  
- can_preorder  
- available_on
images Array An array of product's images. Every image is an object with the following fields:  
- id  
- file_name  
- thumbnail  
- preview  
- list_view  
- banner
max_purchasable_quantity Integer The maximum purchasable quantity of this product per order
max_product_quantity Integer The maximum purchasable quantity of products per order
created_at String The date that product was created
updated_at String The date that product was updated
\n
If bundle item is a variant then itemable has the following fields:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the variant
type String The type of item
translations Array An array of variant's translations. Every translation is an object with the following fields:  
- title  
- subtitle  
- slug  
- description  
- locale
sku String The sku of the variant
compare_to_price Float The compare to price of the variant
price Float The price of the variant
upc String The upc of the variant
weight String The weight of the variant
options Array An array with options of the variant. Every option is an object with the following fields:  
- option_uid  
- option_type_uid
option_types Array An array with option types of the variant. Every option type is an object with the following fields:  
- uid  
- filterable_key  
- input_type  
- preselect_default  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- options - an array of option type's options. Every option is an abject with the following fields:  
- uid  
- filterable_key  
- translations - an array of attribute's translations. Every translation is an object with following fields:  
- title  
- locale  
- price_operator  
- price_operand  
- price  
- default_price_value  
- default  
- created_at  
- updated_at  
- created_at  
- updated_at
images Array An array of variant's images. Every image is an object with the following fields:  
- id  
- file_name  
- thumbnail  
- preview  
- list_view  
- banner
max_purchasable_quantity Integer The maximum purchasable quantity of this variant per order
max_product_quantity Integer The maximum purchasable quantity of products per order
order_status Object An object with informations about variant's order status. It contains the following fields:  
- can_backorder  
- can_preorder  
- available_on
created_at String The date that variant was created
updated_at String The date that variant was updated
\n
Also returns a custom_fields object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
type String The type of value (\"text\" or \"html\" or \"json\")
key String The key of custom field
value String The value of custom field
\n
logs - An array of notes related to the request (e.g. [\"invalid prototype uid\"])
\nErrors
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","bundles","bundle_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"1794059a-57d0-47d7-99d7-e99c95d80d17"},{"name":"Delete Bundle","id":"62cb19ad-38e7-4182-9d1e-6d33b33f72b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/admapi/v1/bundles/bundle_uid","description":"Deletes an existing bundle.
\nParameters
\nbundle_uid - The ID of the product.
\nErrors
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","bundles","bundle_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"62cb19ad-38e7-4182-9d1e-6d33b33f72b5"},{"name":"Add Translation","id":"f35626e5-4b7f-47c8-a10a-ddc979474207","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{   \n    \"translation\": {\n        \"title\": \"DE-Bundle\", \n        \"slug\": \"de-category\", \n        \"subtitle\": \"DE-Bundle subtitle
\",\n        \"description\": \"DE-Bundle description
\",\n        \"attributes\": [\n            {\n                \"title\": \"DE-Attribute-1\",\n                \"uid\": 352419358000727\n            },\n            {\n                \"title\": \"DE-Attribute-2\",\n                \"uid\": 429172881178697\n            }\n        ],\n        \"seo\": {\n            \"title\": \"DE-SEO\", \n            \"keywords\": \"DE-SEO-Keyword 1, DE-SEO-Keyword 2\", \n            \"description\": \"DE-SEO-description\"\n        }\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/bundles/bundle_uid/translations/","description":"Creates a bundle translation
\nParameters
\nlocale <**_**String> -_ Indicates the locale of translation to be created.
bundle_uid <**_**Bigint> -_ The ID of bundle, for which the translation will be created.
\n{   \n    \"translation\": {\n        \"title\": \"EN-Test Bundle\",\n        \"subtitle\": \"EN-Bundle subtitle\",\n        \"description\": \"EN-Bundle description\",\n        \"attributes\": [\n            {\n                \"title\": \"1234512345123\",\n                \"uid\": 296039195783503\n            },\n            {\n                \"title\": \"EN Test Brand\",\n                \"uid\": 804750963352873\n            },\n            {\n                \"title\": \"Blue\",\n                \"uid\": 863583260761864\n            },\n            {\n                \"title\": \"No\",\n                \"uid\": 758029153747418\n            },\n            {\n                \"title\": \"Micro-textured\",\n                \"uid\": 271268473311771\n            },\n            {\n                \"title\": \"20cm x 25cm\",\n                \"uid\": 900069450155147\n            }\n        ],\n        \"seo\": {\n            \"title\": \"EN-SEO\", \n            \"keywords\": \"EN-SEO-Keyword 1, EN-SEO-Keyword 2\", \n            \"description\": \"EN-SEO-description\"\n        }\n    }\n}\n\n
\nWe send a product object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nRequired Field Type Description
Mandatory title String The title of the product's translation
Optional slug String The slug of product
Optional subtitle String The subtitle of the product's translation
Optional description String The description of the product's translation
Optional attributes Array An array of product's attributes. Every product attribute is an object with the following fields:  
- title(String)  
- uid(Bigint) - product attribute ID
Optional seo Object An object with informations about product's seo. It contains the following fields:  
- title(String)  
- keywords(String)  
- description(String)
\n
Response
\n{\n    \"response\": {\n        \"translation\": {\n            \"title\": \"EN-Test Bundle\",\n            \"subtitle\": \"EN-Bundle subtitle\",\n            \"slug\": \"en-test-bundle\",\n            \"description\": \"EN-Bundle description\",\n            \"locale\": \"en\"\n        },\n        \"attributes_translations\": [\n            {\n                \"title\": \"1234512345123\",\n                \"locale\": \"en\",\n                \"uid\": 296039195783503\n            },\n            {\n                \"title\": \"EN Test Brand\",\n                \"locale\": \"en\",\n                \"uid\": 804750963352873\n            },\n            {\n                \"title\": \"Blue\",\n                \"locale\": \"en\",\n                \"uid\": 863583260761864\n            },\n            {\n                \"title\": \"No\",\n                \"locale\": \"en\",\n                \"uid\": 758029153747418\n            },\n            {\n                \"title\": \"Micro-textured\",\n                \"locale\": \"en\",\n                \"uid\": 271268473311771\n            },\n            {\n                \"title\": \"20cm x 25cm\",\n                \"locale\": \"en\",\n                \"uid\": 900069450155147\n            }\n        ]\n    }\n}\n\n
\nReturns a new translation with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The title of the created product translation
subtitle String The subtitle of the created product translation
slug String The slug of the created product translation
description String The description of the created product translation
locale String The locale of the created product translation
\n
Also returns an attributes_translations array with objects having the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The title of the created product attribute translation
locale String The locale of the created product attribute translation
uid Bigint The ID of the product attribute
\n
Errors
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","bundles","bundle_uid","translations",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"f35626e5-4b7f-47c8-a10a-ddc979474207"},{"name":"Update Translation","id":"6e5a99ed-af80-4051-94d4-e42052dc0605","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{   \n    \"translation\": {\n        \"title\": \"DE-Bundle\", \n        \"slug\": \"de-bundle\", \n        \"subtitle\": \"DE-Bundle subtitle
\",\n        \"description\": \"DE-Bundle description
\",\n        \"attributes\": [{\n            \"title\": \"DE-Attribute-1\",\n            \"uid\": 352419358000727\n        },{\n            \"title\": \"DE-Attribute-2\",\n            \"uid\": 429172881178697\n        }],\n        \"seo\": {\n            \"title\": \"DE-SEO\", \n            \"keywords\": \"DE-SEO-Keyword 1, DE-SEO-Keyword 2\", \n            \"description\": \"DE-SEO-description\"\n        }\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/bundles/bundle_uid/translations/","description":"Updates a bundle translation
\nParameters
\nlocale <**_**String> -_ Indicates the locale of translation to be updated.
bundle_uid <**_**Bigint> -_ The ID of bundle, for which the translation will be updated.
\n{   \n    \"translation\": {\n        \"title\": \"update en-Test Bundle\",\n        \"subtitle\": \"updated en-Bundle subtitle\",\n        \"description\": \"updated en-Bundle description\",\n        \"attributes\": [\n            {\n                \"title\": \"0034512345123\",\n                \"uid\": 296039195783503\n            },\n            {\n                \"title\": \"Test Brand en\",\n                \"uid\": 804750963352873\n            },\n            {\n                \"title\": \"Test attribute translation value\",\n                \"uid\": 863583260761864\n            }\n        ],\n        \"seo\": {\n            \"title\": \"en-SEO\", \n            \"keywords\": \"en-SEO-Keyword 1, en-SEO-Keyword 2, en-SEO-Keyword 3\", \n            \"description\": \"en-SEO-description\"\n        }\n    }\n}\n\n
\nWe send a product object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nRequired Field Type Description
Optional title String The title of the bundle's translation
Optional slug String The slug of bundle
Optional subtitle String The subtitle of the bundle's translation
Optional description String The description of the bundle's translation
Optional attributes Array An array of bundle's attributes. Every bundle attribute is an object with the following fields:  
- title(String)  
- uid(Bigint) - bundle attribute ID
Optional seo Object An object with informations about bundle's seo. It contains the following fields:  
- title(String)  
- keywords(String)  
- description(String)
\n
Response
\n{\n    \"response\": {\n        \"translation\": {\n            \"title\": \"update en-Test Product\",\n            \"subtitle\": \"updated en-Product subtitle\",\n            \"slug\": \"en-test-bundle\",\n            \"description\": \"updated en-Product description\",\n            \"locale\": \"en\"\n        },\n        \"attributes_translations\": [\n            {\n                \"title\": \"0034512345123\",\n                \"locale\": \"en\",\n                \"uid\": 296039195783503\n            },\n            {\n                \"title\": \"Test Brand en\",\n                \"locale\": \"en\",\n                \"uid\": 804750963352873\n            },\n            {\n                \"title\": \"Test attribute translation value\",\n                \"locale\": \"en\",\n                \"uid\": 863583260761864\n            }\n        ]\n    }\n}\n\n
\nReturns a translation object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The title of the bundle translation
subtitle String The subtitle of the bundle translation
slug String The slug of the bundle translation
description String The description of the bundle translation
locale String The locale of the bundle translation
\n
Also returns an attributes_translations array with updated bundle attributes, consisted of objects having the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The title of the bundle attribute translation
locale String The locale of the bundle attribute translation
uid Bigint The ID of the bundle attribute
\n
Errors
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","bundles","bundle_uid","translations",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"6e5a99ed-af80-4051-94d4-e42052dc0605"},{"name":"Delete Translation","id":"8093cec7-32dd-45fd-8d52-807018c1ec09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/admapi/v1/bundles/bundle_uid/translations/","description":"Deletes an existing translation of a bundle.
\nParameters
\nbundle_uid - The ID of the bundle.
locale - The locale of the translation to be deleted.
\nResponse
\n{\n    \"response\": {\n        \"translation\": {\n            \"title\": \"update en-Test Bundle\",\n            \"subtitle\": \"updated en-Bundle subtitle\",\n            \"slug\": \"en-test-bundle\",\n            \"description\": \"updated en-Bundle description\",\n            \"locale\": \"en\"\n        },\n        \"attributes_translations\": [\n            {\n                \"title\": \"0034512345123\",\n                \"locale\": \"en\",\n                \"uid\": 296039195783503\n            },\n            {\n                \"title\": \"Test Brand en\",\n                \"locale\": \"en\",\n                \"uid\": 804750963352873\n            },\n            {\n                \"title\": \"Test attribute translation value\",\n                \"locale\": \"en\",\n                \"uid\": 863583260761864\n            },\n            {\n                \"title\": \"No\",\n                \"locale\": \"en\",\n                \"uid\": 758029153747418\n            },\n            {\n                \"title\": \"Micro-textured\",\n                \"locale\": \"en\",\n                \"uid\": 271268473311771\n            },\n            {\n                \"title\": \"20cm x 25cm\",\n                \"locale\": \"en\",\n                \"uid\": 900069450155147\n            }\n        ],\n        \"meta_tag_translations\": {\n            \"id\": 2318,\n            \"title\": \"en-SEO\",\n            \"description\": \"en-SEO-description\",\n            \"keywords\": \"en-SEO-Keyword 1, en-SEO-Keyword 2, en-SEO-Keyword 3\",\n            \"locale\": \"en\"\n        }\n    }\n}\n\n
\nReturns a response object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
translation Object An object with informations about deleted translation. It contains the following fields:  
  
- title  
- subtitle  
- slug  
- description  
- locale
attributes_translations Array An array of deleted bundle's attributes translations. Every attribute translation is an object with the following fields:  
  
- title  
- locale  
- uid
meta_tag_translations Object An object with informations about deleted bundle's meta_tags translations:  
  
- id  
- title  
- description  
- keywords  
- locale
\n
Errors
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","bundles","bundle_uid","translations",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"8093cec7-32dd-45fd-8d52-807018c1ec09"}],"id":"b206800d-838f-4d3e-8f52-ff7f29207b4b","_postman_id":"b206800d-838f-4d3e-8f52-ff7f29207b4b","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}},{"name":"Category","item":[{"name":"List Categories","id":"e241fab6-1d6e-4eff-be90-4c33539d6500","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/prototypes?page=1","description":"Returns the list of categories available to the store.
\nParameters
\npage <**_**int> -_ Indicates the page of categories to fetch. If not specified the first page is returned.
\nResponse
\n{\n    \"response\": {\n        \"prototypes\": [\n            {\n                \"uid\": 400082000216718,\n                \"translations\": [\n                    {\n                        \"title\": \"EN-Category 1\",\n                        \"slug\": \"en-category-1\",\n                        \"locale\": \"en\"\n                    },\n                    {\n                        \"title\": \"DE-Category-1\",\n                        \"slug\": \"de-category-1\",\n                        \"locale\": \"de\"\n                    }\n                ],\n                \"prototype_attributes\": [\n                    {\n                        \"uid\": 100560964141712,\n                        \"visible\": true,\n                        \"position\": 0,\n                        \"translations\": [\n                            {\n                                \"title\": \"EN-Attribute 1\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"DE-Attribute 1\",\n                                \"locale\": \"de\"\n                            }\n                        ],\n                        \"created_at\": \"12/07/2022 08:43:52\",\n                        \"updated_at\": \"12/07/2022 11:32:41\"\n                    },\n                    {\n                        \"uid\": 577728188702055,\n                        \"visible\": true,\n                        \"position\": 1,\n                        \"translations\": [\n                            {\n                                \"title\": \"EN-UPC\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"DE-UPC\",\n                                \"locale\": \"de\"\n                            }\n                        ],\n                        \"created_at\": \"12/07/2022 08:43:52\",\n                        \"updated_at\": \"12/07/2022 11:32:41\"\n                    },\n                    {\n                        \"uid\": 345363927173550,\n                        \"visible\": false,\n                        \"position\": 2,\n                        \"translations\": [\n                            {\n                                \"title\": \"EN-Attribute 2\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"DE-Attribute 2\",\n                                \"locale\": \"de\"\n                            }\n                        ],\n                        \"created_at\": \"12/07/2022 08:43:52\",\n                        \"updated_at\": \"12/07/2022 11:32:41\"\n                    },\n                    {\n                        \"uid\": 178060053093683,\n                        \"visible\": true,\n                        \"position\": 3,\n                        \"translations\": [\n                            {\n                                \"title\": \"EN-Brand\",\n                                \"locale\": \"en\"\n                            },\n                            {\n                                \"title\": \"DE-Brand\",\n                                \"locale\": \"de\"\n                            }\n                        ],\n                        \"created_at\": \"12/07/2022 08:43:52\",\n                        \"updated_at\": \"12/07/2022 11:32:41\"\n                    }\n                ],\n                \"created_at\": \"12/07/2022 08:43:52\",\n                \"updated_at\": \"12/07/2022 11:32:51\"\n            },\n            {\n                \"uid\": 453475310005162,\n                \"translations\": [\n                    {\n                        \"title\": \"EN-Category 2\",\n                        \"slug\": \"en-category-2\",\n                        \"locale\": \"en\"\n                    }\n                ],\n                \"prototype_attributes\": [\n                    {\n                        \"uid\": 935766474141101,\n                        \"visible\": true,\n                        \"position\": 1,\n                        \"translations\": [\n                            {\n                                \"title\": \"UPC\",\n                                \"locale\": \"en\"\n                            }\n                        ],\n                        \"created_at\": \"04/06/2021 12:01:11\",\n                        \"updated_at\": \"13/09/2022 08:56:03\"\n                    },\n                    {\n                        \"uid\": 594407509084581,\n                        \"visible\": true,\n                        \"position\": 2,\n                        \"translations\": [\n                            {\n                                \"title\": \"Brand\",\n                                \"locale\": \"en\"\n                            }\n                        ],\n                        \"created_at\": \"04/06/2021 12:01:11\",\n                        \"updated_at\": \"13/09/2022 08:56:03\"\n                    }\n                ],\n                \"created_at\": \"04/06/2021 12:01:11\",\n                \"updated_at\": \"13/09/2022 08:56:03\"\n            }\n        ],\n        \"page\": 1,\n        \"pages\": 1,\n        \"per_page\": 25,\n        \"total\": 2\n    }\n}\n\n
\nprototypes <**_**List of Category>_ - The list of available categories.
page - Current page
pages - Total amount of pages
per_page - Items shown per page
total - Total items
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes"],"host":[""],"query":[{"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"e241fab6-1d6e-4eff-be90-4c33539d6500"},{"name":"Get Single Category","id":"5b8ae153-8364-4073-a22e-f92f515e162f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/prototypes/prototype_uid","description":"Returns the specified category.
\nParameters
\nprototype_uid - The ID of the category to be retrieved.
\nResponse
\n{\n    \"response\": {\n        \"prototype\": {\n            \"uid\": 400082000216718,\n            \"translations\": [\n                {\n                    \"title\": \"EN-Category 1\",\n                    \"slug\": \"en-category-1\",\n                    \"locale\": \"en\"\n                },\n                {\n                    \"title\": \"DE-Category 1\",\n                    \"slug\": \"de-category-1\",\n                    \"locale\": \"de\"\n                }\n            ],\n            \"prototype_attributes\": [\n                {\n                    \"uid\": 100560964141712,\n                    \"visible\": true,\n                    \"position\": 0,\n                    \"translations\": [\n                        {\n                            \"title\": \"EN-Attribute 1\",\n                            \"locale\": \"en\"\n                        },\n                        {\n                            \"title\": \"DE-Attribute 1\",\n                            \"locale\": \"de\"\n                        }\n                    ],\n                    \"created_at\": \"12/07/2022 08:43:52\",\n                    \"updated_at\": \"12/07/2022 11:32:41\"\n                },\n                {\n                    \"uid\": 577728188702055,\n                    \"visible\": true,\n                    \"position\": 1,\n                    \"translations\": [\n                        {\n                            \"title\": \"EN-UPC\",\n                            \"locale\": \"en\"\n                        },\n                        {\n                            \"title\": \"DE-UPC\",\n                            \"locale\": \"de\"\n                        }\n                    ],\n                    \"created_at\": \"12/07/2022 08:43:52\",\n                    \"updated_at\": \"12/07/2022 11:32:41\"\n                },\n                {\n                    \"uid\": 345363927173550,\n                    \"visible\": false,\n                    \"position\": 2,\n                    \"translations\": [\n                        {\n                            \"title\": \"EN-Attribute 2\",\n                            \"locale\": \"en\"\n                        },\n                        {\n                            \"title\": \"DE-Attribute 2\",\n                            \"locale\": \"de\"\n                        }\n                    ],\n                    \"created_at\": \"12/07/2022 08:43:52\",\n                    \"updated_at\": \"12/07/2022 11:32:41\"\n                },\n                {\n                    \"uid\": 178060053093683,\n                    \"visible\": true,\n                    \"position\": 3,\n                    \"translations\": [\n                        {\n                            \"title\": \"EN-Brand\",\n                            \"locale\": \"en\"\n                        },\n                        {\n                            \"title\": \"DE-Brand\",\n                            \"locale\": \"de\"\n                        }\n                    ],\n                    \"created_at\": \"12/07/2022 08:43:52\",\n                    \"updated_at\": \"12/07/2022 11:32:41\"\n                }\n            ],\n            \"created_at\": \"12/07/2022 08:43:52\",\n            \"updated_at\": \"12/07/2022 11:32:51\"\n        }\n    }\n}\n\n
\nReturns a category object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the category requested
translations Array An array of all the category's or category attribute's translations
title String The title of the translation
slug String The slug of of the translation
locale String The locale of the translation
prototype_attributes Array An array of all the category's attributes
visible Boolean Whether or not the attribute is visible
position Int The position of the attribute
created_at DateTime When the category was created.
updated_at DateTime When the category was last updated.
\n
Errors
\nExample: not found
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"prototype_not_found\",\n        \"message\": \"Prototype with specified uid does not exist\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes","prototype_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"5b8ae153-8364-4073-a22e-f92f515e162f"},{"name":"Create Category","id":"85272421-02ae-4699-9620-0efb0fdfbdf3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"prototype\": {\n        \"locale\": \"en\",\n        \"title\": \"EN-Category\",\n        \"slug\": \"en-category\",\n        \"prototype_attributes\": [\n            {\n                \"title\": \"EN-Attribute 1\",\n                \"visible\": true\n            },\n            {\n                \"title\": \"EN-Attribute 2\",\n                \"visible\": false\n            }\n        ],\n        \"enable_attribute_groups\": false,\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"custom-field-key-1\", \n                \"value\": \"custom-field-value-1\",\n                \"type\": \"text\"\n            },\n            \"custom_field2\": {\n                \"key\": \"custom-field-key-2\", \n                \"value\": \"custom-field-value-2\",\n                \"type\": \"html\"\n            }, \n            \"custom_field3\": {\n                \"key\": \"custom-field-key-3\", \n                \"value\": \"custom-field-value-3\",\n                \"type\": \"json\"\n            },\n            \"custom_field4\": {\n                \"key\": \"custom-field-key-4\", \n                \"value\": \"custom-field-value-4\",\n                \"type\": \"text\"\n            },\n            \"custom_field5\": {\n                \"key\": \"custom-field-key-5\", \n                \"value\": \"custom-field-value-5\",\n                \"type\": \"text\"\n            },\n            \"custom_field6\": {\n                \"key\": \"custom-field-key-6\", \n                \"value\": \"custom-field-value-6\",\n                \"type\": \"text\"\n            },\n            \"custom_field7\": {\n                \"key\": \"custom-field-key-7\", \n                \"value\": \"custom-field-value-7\",\n                \"type\": \"text\"\n            },\n            \"custom_field8\": {\n                \"key\": \"custom-field-key-8\", \n                \"value\": \"custom-field-value-8\",\n                \"type\": \"text\"\n            },\n            \"custom_field9\": {\n                \"key\": \"custom-field-key-9\", \n                \"value\": \"custom-field-value-9\",\n                \"type\": \"text\"\n            },\n            \"custom_field10\": {\n                \"key\": \"custom-field-key-10\", \n                \"value\": \"custom-field-value-10\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/prototypes","description":"Creates a category
\nThe attributes \"UPC\" and \"Brand\" get created automatically
A custom field value can be of type \"html\", \"text\" or \"json\"
\nParameters
\n{\n    \"prototype\": {\n        \"locale\": \"en\",\n        \"title\": \"EN-Category\",\n        \"slug\": \"en-category\",\n        \"prototype_attributes\": [\n            {\n                \"title\": \"EN-Attribute 1\",\n                \"visible\": true\n            },\n            {\n                \"title\": \"EN-Attribute 2\",\n                \"visible\": false\n            }\n        ]\n    }\n}\n\n
\nWe send a category object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
locale String The locale of the translation
title String The title of the translation
slug String The slug of the translation (if not specified then it's generated based on the title)
prototype_attributes Array An array of the category's attributes
visible Boolean Whether the attribute is visible
enable_attribute_groups Boolean Whether the category has attribute_groups
custom_fields Array An array of the category's custom fields
key String Key of the custom field
value String Value of the custom field
type String What type is the value of custom field
\n
Response
\n{\n    \"response\": {\n        \"prototype\": {\n            \"uid\": 102426527134609,\n            \"translations\": [\n                {\n                    \"title\": \"EN-Category\",\n                    \"slug\": \"en-category\",\n                    \"locale\": \"en\"\n                }\n            ],\n            \"prototype_attributes\": [\n                {\n                    \"uid\": 674510182934383,\n                    \"visible\": true,\n                    \"position\": 0,\n                    \"translations\": [\n                        {\n                            \"title\": \"UPC\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"created_at\": \"30/09/2022 13:13:13\",\n                    \"updated_at\": \"30/09/2022 13:13:13\"\n                },\n                {\n                    \"uid\": 285540296155073,\n                    \"visible\": true,\n                    \"position\": 1,\n                    \"translations\": [\n                        {\n                            \"title\": \"Brand\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"created_at\": \"30/09/2022 13:13:13\",\n                    \"updated_at\": \"30/09/2022 13:13:13\"\n                },\n                {\n                    \"uid\": 542614229038935,\n                    \"visible\": true,\n                    \"position\": 0,\n                    \"translations\": [\n                        {\n                            \"title\": \"EN-Attribute 1\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"created_at\": \"30/09/2022 13:13:13\",\n                    \"updated_at\": \"30/09/2022 13:13:13\"\n                },\n                {\n                    \"uid\": 702417418621073,\n                    \"visible\": false,\n                    \"position\": 1,\n                    \"translations\": [\n                        {\n                            \"title\": \"EN-Attribute 2\",\n                            \"locale\": \"en\"\n                        }\n                    ],\n                    \"created_at\": \"30/09/2022 13:13:13\",\n                    \"updated_at\": \"30/09/2022 13:13:13\"\n                }\n            ],\n            \"created_at\": \"30/09/2022 13:13:13\",\n            \"updated_at\": \"30/09/2022 13:13:13\"\n        }\n    }\n}\n\n
\nReturns a new category object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the category requested
translations Array An array of all the category's or category attribute's translations
title String The title of the translation
slug String The slug of of the translation
locale String The locale of the translation
prototype_attributes Array An array of all the category's attributes
visible Boolean Whether or not the attribute is visible
position Int The position of the attribute
created_at DateTime When the category was created.
updated_at DateTime When the category was last updated.
\n
Errors
\nExample: title is blank
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"Error creating prototype\",\n        \"message\": \"Title The title cannot be blank\"\n    }\n}\n\n
\nExample: missing locale
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"Error creating prototype\",\n        \"message\": \"Translations locale Locale cannot be blank\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"85272421-02ae-4699-9620-0efb0fdfbdf3"},{"name":"Create Category(with groups)","id":"3bf6819b-31f2-414c-8aa1-ba0f972ea45b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"prototype\": {\n        \"locale\": \"en\",\n        \"title\": \"EN-Category\",\n        \"slug\": \"en-category\",\n        \"enable_attribute_groups\": true,\n        \"prototype_attribute_groups\": [\n            {\n                \"title\": \"EN-Category-Attribute-Group 1\",\n                \"prototype_attributes\": [\n                    {\n                        \"title\": \"EN-Attribute 1\",\n                        \"visible\": true\n                    },\n                    {\n                        \"title\": \"EN-Attribute 2\",\n                        \"visible\": false\n                    }\n                ]\n            },\n            {\n                \"title\": \"EN-Category-Attribute-Group 2\",\n                \"prototype_attributes\": [\n                    {\n                        \"title\": \"EN-Attribute 3\",\n                        \"visible\": true\n                    },\n                    {\n                        \"title\": \"EN-Attribute 4\",\n                        \"visible\": false\n                    }\n                ]\n            }\n        ],\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"custom-field-key-1\", \n                \"value\": \"custom-field-value-1\",\n                \"type\": \"text\"\n            },\n            \"custom_field2\": {\n                \"key\": \"custom-field-key-2\", \n                \"value\": \"custom-field-value-2\",\n                \"type\": \"html\"\n            }, \n            \"custom_field3\": {\n                \"key\": \"custom-field-key-3\", \n                \"value\": \"custom-field-value-3\",\n                \"type\": \"json\"\n            },\n            \"custom_field4\": {\n                \"key\": \"custom-field-key-4\", \n                \"value\": \"custom-field-value-4\",\n                \"type\": \"text\"\n            },\n            \"custom_field5\": {\n                \"key\": \"custom-field-key-5\", \n                \"value\": \"custom-field-value-5\",\n                \"type\": \"text\"\n            },\n            \"custom_field6\": {\n                \"key\": \"custom-field-key-6\", \n                \"value\": \"custom-field-value-6\",\n                \"type\": \"text\"\n            },\n            \"custom_field7\": {\n                \"key\": \"custom-field-key-7\", \n                \"value\": \"custom-field-value-7\",\n                \"type\": \"text\"\n            },\n            \"custom_field8\": {\n                \"key\": \"custom-field-key-8\", \n                \"value\": \"custom-field-value-8\",\n                \"type\": \"text\"\n            },\n            \"custom_field9\": {\n                \"key\": \"custom-field-key-9\", \n                \"value\": \"custom-field-value-9\",\n                \"type\": \"text\"\n            },\n            \"custom_field10\": {\n                \"key\": \"custom-field-key-10\", \n                \"value\": \"custom-field-value-10\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/prototypes","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"3bf6819b-31f2-414c-8aa1-ba0f972ea45b"},{"name":"Update Category","id":"5d3bfc39-b640-4793-a2c5-c2b27a5a227d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n    \"prototype\": {\n        \"locale\": \"en\",\n        \"title\": \"EN-Category\",\n        \"slug\": \"en-category\",\n        \"prototype_attributes\": [\n            {\n                \"title\": \"updated-EN-Attribute 1\",\n                \"visible\": false,\n                \"api_uid\": 180141210820652\n            },\n            {\n                \"title\": \"new-EN-Attribute\",\n                \"visible\": false\n            }\n        ],\n        \"enable_attribute_groups\": false,\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"custom-field-key-1\", \n                \"value\": \"custom-field-value-1\",\n                \"type\": \"text\"\n            },\n            \"custom_field2\": {\n                \"key\": \"custom-field-key-2\", \n                \"value\": \"custom-field-value-2\",\n                \"type\": \"html\"\n            }, \n            \"custom_field3\": {\n                \"key\": \"custom-field-key-3\", \n                \"value\": \"custom-field-value-3\",\n                \"type\": \"json\"\n            },\n            \"custom_field4\": {\n                \"key\": \"custom-field-key-4\", \n                \"value\": \"custom-field-value-4\",\n                \"type\": \"text\"\n            },\n            \"custom_field5\": {\n                \"key\": \"custom-field-key-5\", \n                \"value\": \"custom-field-value-5\",\n                \"type\": \"text\"\n            },\n            \"custom_field6\": {\n                \"key\": \"custom-field-key-6\", \n                \"value\": \"custom-field-value-6\",\n                \"type\": \"text\"\n            },\n            \"custom_field7\": {\n                \"key\": \"custom-field-key-7\", \n                \"value\": \"custom-field-value-7\",\n                \"type\": \"text\"\n            },\n            \"custom_field8\": {\n                \"key\": \"custom-field-key-8\", \n                \"value\": \"custom-field-value-8\",\n                \"type\": \"text\"\n            },\n            \"custom_field9\": {\n                \"key\": \"custom-field-key-9\", \n                \"value\": \"custom-field-value-9\",\n                \"type\": \"text\"\n            },\n            \"custom_field10\": {\n                \"key\": \"custom-field-key-10\", \n                \"value\": \"custom-field-value-10\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/prototypes/prototype_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes","prototype_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"5d3bfc39-b640-4793-a2c5-c2b27a5a227d"},{"name":"Update Category(with groups)","id":"843a927e-6069-412e-9c6a-c372120e6116","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n    \"prototype\": {\n        \"locale\": \"en\",\n        \"title\": \"EN-Category\",\n        \"slug\": \"en-category\",\n        \"enable_attribute_groups\": true,\n        \"prototype_attribute_groups\": [\n            {\n                \"title\": \"EN-Category-Attribute-Group 1\",\n                \"api_uid\": 171493185208451,\n                \"prototype_attributes\": [\n                    {\n                        \"title\": \"EN-Attribute 1\",\n                        \"visible\": false,\n                        \"api_uid\": 972493555208351\n                    },\n                    {\n                        \"title\": \"EN-Attribute 2\",\n                        \"visible\": false,\n                        \"api_uid\": 972493873508351\n                    }\n                ]\n            },\n            {\n                \"title\": \"EN-Category-Attribute-Group 2\",\n                \"prototype_attributes\": [\n                    {\n                        \"title\": \"new-EN-Attribute 3\",\n                        \"visible\": true\n                    }\n                ]\n            }\n        ],\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"custom-field-key-1\", \n                \"value\": \"custom-field-value-1\",\n                \"type\": \"text\"\n            },\n            \"custom_field2\": {\n                \"key\": \"custom-field-key-2\", \n                \"value\": \"custom-field-value-2\",\n                \"type\": \"html\"\n            }, \n            \"custom_field3\": {\n                \"key\": \"custom-field-key-3\", \n                \"value\": \"custom-field-value-3\",\n                \"type\": \"json\"\n            },\n            \"custom_field4\": {\n                \"key\": \"custom-field-key-4\", \n                \"value\": \"custom-field-value-4\",\n                \"type\": \"text\"\n            },\n            \"custom_field5\": {\n                \"key\": \"custom-field-key-5\", \n                \"value\": \"custom-field-value-5\",\n                \"type\": \"text\"\n            },\n            \"custom_field6\": {\n                \"key\": \"custom-field-key-6\", \n                \"value\": \"custom-field-value-6\",\n                \"type\": \"text\"\n            },\n            \"custom_field7\": {\n                \"key\": \"custom-field-key-7\", \n                \"value\": \"custom-field-value-7\",\n                \"type\": \"text\"\n            },\n            \"custom_field8\": {\n                \"key\": \"custom-field-key-8\", \n                \"value\": \"custom-field-value-8\",\n                \"type\": \"text\"\n            },\n            \"custom_field9\": {\n                \"key\": \"custom-field-key-9\", \n                \"value\": \"custom-field-value-9\",\n                \"type\": \"text\"\n            },\n            \"custom_field10\": {\n                \"key\": \"custom-field-key-10\", \n                \"value\": \"custom-field-value-10\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/prototypes/prototype_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes","prototype_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"843a927e-6069-412e-9c6a-c372120e6116"},{"name":"Delete Category","id":"c1bb1f52-9ada-4046-a6a8-6a78ce1f3469","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/admapi/v1/prototypes/prototype_uid","description":"Destroys a category.
\nParameters
\nprototype_uid <**_**Bigint**_**> - The ID of the category to be deleted.
\nResponse
\n{\n    \"response\": {\n        \"prototype\": {\n            \"uid\": 415171999987195,\n            \"translations\": [],\n            \"prototype_attributes\": [],\n            \"created_at\": \"30/09/2022 13:20:31\",\n            \"updated_at\": \"30/09/2022 13:30:39\"\n        }\n    }\n}\n\n
\nReturns the deleted category object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the category created
translations Array An array of all the category's translations
prototype_attributes Array An array of the category's attributes
created_at DateTime When the category was created.
updated_at DateTime When the category was last updated.
\n
Errors
\nExample: Category not found
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"prototype_not_found\",\n        \"message\": \"Prototype with specified uid does not exist\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes","prototype_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"c1bb1f52-9ada-4046-a6a8-6a78ce1f3469"},{"name":"Add Translation","id":"30e7b132-6c91-4819-9e46-d399fa85313a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"translation\": {\n        \"title\": \"DE-Category\",\n        \"slug\": \"de-category\",\n        \"prototype_attributes\": [\n            {\n                \"title\": \"DE-Attribute 1\",\n                \"prototype_attribute_uid\": 352419358000727\n            },\n            {\n                \"title\": \"DE-Attribute 2\",\n                \"prototype_attribute_uid\": 429172881178697\n            },\n            {\n                \"title\": \"DE-UPC\",\n                \"prototype_attribute_uid\": 159547786442424\n            },\n            {\n                \"title\": \"DE-Brand\",\n                \"prototype_attribute_uid\": 974581977787337\n            }\n        ],\n        \"prototype_attribute_groups\": [\n            {\n                \"title\": \"DE-Category-Attribute-Group 1\",\n                \"prototype_attribute_group_uid\": 171493185208451\n            },\n            {\n                \"title\": \"DE-Category-Attribute-Group 2\",\n                \"prototype_attribute_group_uid\": 535166248796058\n            }\n        ]\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/prototypes/prototype_uid/translations/","description":"Creates a new translation for the specified category.
\nParameters
\nprototype_uid - The ID of the category.
locale - The locale for which the translation is about.
\nRequest Body
\n{\n    \"translation\": {\n        \"title\": \"DE-Category\",\n        \"slug\": \"de-category\",\n        \"prototype_attributes\": [\n            {\n                \"title\": \"DE-Attribute 1\",\n                \"prototype_attribute_uid\": 100560964141712\n            },\n            {\n                \"title\": \"DE-UPC\",\n                \"prototype_attribute_uid\": 577728188702055\n            },\n            {\n                \"title\": \"DE-Attribute 2\",\n                \"prototype_attribute_uid\": 345363927173550\n            },\n            {\n                \"title\": \"DE-Brand\",\n                \"prototype_attribute_uid\": 178060053093683\n            }\n        ]\n    }\n}\n\n
\nWe need a translation object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The title for the specified locale
slug String The slug of the category for the specified locale (if not specified then it's generated based on the title)
prototype_attributes Array An array with the translations for all the category attributes
prototype_attribute_uid Bigint The ID of the specified attribute (all attributes must be included for the translation to be created)
\n
Response
\n{\n    \"response\": {\n        \"prototype_translation\": {\n            \"title\": \"DE-Category\",\n            \"slug\": \"de-category\",\n            \"locale\": \"de\"\n        },\n        \"prototype_attribute_translations\": [\n            {\n                \"title\": \"DE-Attribute 1\",\n                \"locale\": \"de\"\n            },\n            {\n                \"title\": \"DE-Attribute 2\",\n                \"locale\": \"de\"\n            },\n            {\n                \"title\": \"DE-UPC\",\n                \"locale\": \"de\"\n            },\n            {\n                \"title\": \"DE-Brand\",\n                \"locale\": \"de\"\n            }\n        ]\n    }\n}\n\n
\nReturns a newly created translation object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
prototype_translation Object The translation object of the category
title String The title of the translation
slug String The slug of the category's translation
locale String The locale of the translation
prototype_attribute_translations Array An array with the created translation for each attribute
\n
Errors
\nExample: locale not supported
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"unavailable_locale\",\n        \"message\": \"This locale is not supported\"\n    }\n}\n\n
\nExample: locale already exists
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"translation_already_exists\",\n        \"message\": \"Translation already exists\"\n    }\n}\n\n
\nExample: missing or invalid attribute
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"missing_or_invalid_prototype_attribute\",\n        \"message\": \"Missing or invalid Category Attribute\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes","prototype_uid","translations",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"30e7b132-6c91-4819-9e46-d399fa85313a"},{"name":"Update Translation","id":"5cacf6e2-abd3-4bc1-8651-423442f8d6b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n    \"translation\": {\n        \"title\": \"EN-Category 1\",\n        \"slug\": \"en-category-1\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/prototypes/prototype_uid/translations/","description":"Updates an existing translation for the specified category. To create a new translation see \"Add translation\" section
\nParameters
\nprototype_uid - The ID of the category.
locale - The locale for which the translation is about.
\nRequest Body
\n{\n    \"translation\": {\n        \"title\": \"EN-Category 1\",\n        \"slug\": \"en-category-1\"\n    }\n}\n\n
\nWe need a translation object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The title of the category for the specified locale
slug String The slug of the category for the specified locale (if not specified then it's generated based on the title)
\n
Response
\n{\n    \"response\": {\n        \"translation\": {\n            \"title\": \"EN-Category 1\",\n            \"slug\": \"en-category-1\",\n            \"locale\": \"en\"\n        }\n    }\n}\n\n
\nReturns a translation object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The title of the translation
slug String The slug of the translation
locale String The locale of the translation
\n
Errors
\nExample: locale not found
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"translation_not_found\",\n        \"message\": \"Translation not found\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes","prototype_uid","translations",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"5cacf6e2-abd3-4bc1-8651-423442f8d6b5"},{"name":"Delete Translation","id":"45e7968d-99d5-4827-acb5-d8d5190d7abe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/admapi/v1/prototypes/prototype_uid/translations/","description":"Deletes an existing translation for the specified category.
\nParameters
\nprototype_uid - The ID of the category.
locale - The locale for which the translation is about.
\nResponse
\n{\n    \"response\": \"Translation deleted successfully\"\n}\n\n
\nErrors
\nExample: locale not found
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"translation_not_found\",\n        \"message\": \"Translation not found\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes","prototype_uid","translations",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"45e7968d-99d5-4827-acb5-d8d5190d7abe"}],"id":"d77c80d9-c15a-4f98-9317-3f8c0f451784","_postman_id":"d77c80d9-c15a-4f98-9317-3f8c0f451784","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}},{"name":"Category Attribute Group(s)","item":[{"name":"Create Category Attribute Group","id":"9e20f6b8-d869-4b60-8e06-850292ab0588","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"prototype_attribute_group\": {\n        \"visible\": true,\n        \"position\": 0,\n        \"prototype_attributes\": [607121932173827, 759454193776076],\n        \"translations_attributes\": [\n            {\n            \"locale\": \"el\",\n            \"title\": \"EL-Prototype-Attribute-Group\"\n            },\n            {\n            \"locale\": \"en\", \n            \"title\": \"EN-Prototype-Attribute-Group\"\n            }\n        ],\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"custom-field-key-1\", \n                \"value\": \"custom-field-value-1\",\n                \"type\": \"text\"\n            },\n            \"custom_field2\": {\n                \"key\": \"custom-field-key-2\", \n                \"value\": \"custom-field-value-2\",\n                \"type\": \"html\"\n            }, \n            \"custom_field3\": {\n                \"key\": \"custom-field-key-3\", \n                \"value\": \"custom-field-value-3\",\n                \"type\": \"json\"\n            },\n            \"custom_field4\": {\n                \"key\": \"custom-field-key-4\", \n                \"value\": \"custom-field-value-4\",\n                \"type\": \"text\"\n            },\n            \"custom_field5\": {\n                \"key\": \"custom-field-key-5\", \n                \"value\": \"custom-field-value-5\",\n                \"type\": \"text\"\n            },\n            \"custom_field6\": {\n                \"key\": \"custom-field-key-6\", \n                \"value\": \"custom-field-value-6\",\n                \"type\": \"text\"\n            },\n            \"custom_field7\": {\n                \"key\": \"custom-field-key-7\", \n                \"value\": \"custom-field-value-7\",\n                \"type\": \"text\"\n            },\n            \"custom_field8\": {\n                \"key\": \"custom-field-key-8\", \n                \"value\": \"custom-field-value-8\",\n                \"type\": \"text\"\n            },\n            \"custom_field9\": {\n                \"key\": \"custom-field-key-9\", \n                \"value\": \"custom-field-value-9\",\n                \"type\": \"text\"\n            },\n            \"custom_field10\": {\n                \"key\": \"custom-field-key-10\", \n                \"value\": \"custom-field-value-10\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/prototypes/prototype_uid/prototype_attribute_groups","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes","prototype_uid","prototype_attribute_groups"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"9e20f6b8-d869-4b60-8e06-850292ab0588"},{"name":"Update Category Attribute Group","id":"67062460-28aa-4956-bb40-286b670ab6e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n    \"prototype_attribute_group\": {\n        \"visible\": true,\n        \"position\": 0,\n        \"prototype_attributes\": [607121932173827, 759454193776076],\n        \"translations_attributes\": [\n            {\n            \"locale\": \"el\",\n            \"title\": \"EL-Prototype-Attribute-Group\"\n            },\n            {\n            \"locale\": \"en\", \n            \"title\": \"EN-Prototype-Attribute-Group\"\n            }\n        ],\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"custom-field-key-1\", \n                \"value\": \"custom-field-value-1\",\n                \"type\": \"text\"\n            },\n            \"custom_field2\": {\n                \"key\": \"custom-field-key-2\", \n                \"value\": \"custom-field-value-2\",\n                \"type\": \"html\"\n            }, \n            \"custom_field3\": {\n                \"key\": \"custom-field-key-3\", \n                \"value\": \"custom-field-value-3\",\n                \"type\": \"json\"\n            },\n            \"custom_field4\": {\n                \"key\": \"custom-field-key-4\", \n                \"value\": \"custom-field-value-4\",\n                \"type\": \"text\"\n            },\n            \"custom_field5\": {\n                \"key\": \"custom-field-key-5\", \n                \"value\": \"custom-field-value-5\",\n                \"type\": \"text\"\n            },\n            \"custom_field6\": {\n                \"key\": \"custom-field-key-6\", \n                \"value\": \"custom-field-value-6\",\n                \"type\": \"text\"\n            },\n            \"custom_field7\": {\n                \"key\": \"custom-field-key-7\", \n                \"value\": \"custom-field-value-7\",\n                \"type\": \"text\"\n            },\n            \"custom_field8\": {\n                \"key\": \"custom-field-key-8\", \n                \"value\": \"custom-field-value-8\",\n                \"type\": \"text\"\n            },\n            \"custom_field9\": {\n                \"key\": \"custom-field-key-9\", \n                \"value\": \"custom-field-value-9\",\n                \"type\": \"text\"\n            },\n            \"custom_field10\": {\n                \"key\": \"custom-field-key-10\", \n                \"value\": \"custom-field-value-10\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/prototypes/prototype_uid/prototype_attribute_groups/prototype_attribute_group_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes","prototype_uid","prototype_attribute_groups","prototype_attribute_group_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"67062460-28aa-4956-bb40-286b670ab6e6"},{"name":"Delete Category Attribute Group","id":"7bf6871c-c200-432b-8aaf-de5f09615894","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/admapi/v1/prototypes/prototype_uid/prototype_attribute_groups/prototype_attribute_group_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes","prototype_uid","prototype_attribute_groups","prototype_attribute_group_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"7bf6871c-c200-432b-8aaf-de5f09615894"},{"name":"Update Translation","id":"340947cb-f108-41cb-af50-2d91f107fa01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n    \"translation\": {\n        \"title\": \"DE-Category-Attribute-Group\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/prototypes/prototype_uid/prototype_attribute_groups/prototype_attribute_group_uid/translations/","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes","prototype_uid","prototype_attribute_groups","prototype_attribute_group_uid","translations",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"340947cb-f108-41cb-af50-2d91f107fa01"}],"id":"b16f06b0-4c61-4fe0-8a83-880af1e5b06a","_postman_id":"b16f06b0-4c61-4fe0-8a83-880af1e5b06a","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}},{"name":"Category Attribute(s)","item":[{"name":"Get Single Category Attribute","id":"d8905325-11d7-4180-8a40-b7e3a32ba46f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/prototypes/prototype_uid/prototype_attributes/prototype_attribute_uid","description":"Returns the specified category attribute.
\nParameters
\nprototype_uid - The ID of the category to be retrieved that has the attribute.
\nprototype_attribute_uid - The ID of the category attribute to be retrieved.
\nResponse
\n{\n    \"response\": {\n        \"prototype_attribute\": {\n            \"uid\": 352419358000727,\n            \"visible\": true,\n            \"position\": 0,\n            \"translations\": [\n                {\n                    \"title\": \"EN-Attribute 1\",\n                    \"locale\": \"en\"\n                }\n            ],\n            \"created_at\": \"30/09/2022 13:10:15\",\n            \"updated_at\": \"30/09/2022 14:27:12\"\n        }\n    }\n}\n\n
\nReturns a category attribute object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the category attribute requested
visible Boolean Whether or not the category attribute is visible
position Int The position of the category attribute
translations Array An array of all the translations
title String The title of the translation
locale String The locale of the translation
created_at DateTime When the category attribute was created
updated_at DateTime When the category attribute was last updated
\n
Errors
\nExample: not found
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"prototype_attribute_not_found\",\n        \"message\": \"Prototype attribute with specified uid does not exist\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes","prototype_uid","prototype_attributes","prototype_attribute_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"d8905325-11d7-4180-8a40-b7e3a32ba46f"},{"name":"List Category Attributes","id":"bd369b62-a82a-4f48-96c4-889983e46cfc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/prototypes/prototype_uid/prototype_attributes","description":"Returns the list of category attributes of a specific category.
\nParameters
\npage <**_**int> -_ Indicates the page of category attributes to fetch. If not specified the first page is returned.
\nResponse
\n{\n    \"response\": {\n        \"prototype_attributes\": [\n            {\n                \"uid\": 352419358000727,\n                \"visible\": true,\n                \"position\": 0,\n                \"translations\": [\n                    {\n                        \"title\": \"EN-Attribute 1\",\n                        \"locale\": \"en\"\n                    }\n                ],\n                \"created_at\": \"30/09/2022 13:10:15\",\n                \"updated_at\": \"30/09/2022 14:27:12\"\n            },\n            {\n                \"uid\": 429172881178697,\n                \"visible\": false,\n                \"position\": 1,\n                \"translations\": [\n                    {\n                        \"title\": \"EN-Attribute 2\",\n                        \"locale\": \"en\"\n                    }\n                ],\n                \"created_at\": \"30/09/2022 13:10:15\",\n                \"updated_at\": \"30/09/2022 14:27:12\"\n            },\n            {\n                \"uid\": 159547786442424,\n                \"visible\": true,\n                \"position\": 2,\n                \"translations\": [\n                    {\n                        \"title\": \"UPC\",\n                        \"locale\": \"en\"\n                    }\n                ],\n                \"created_at\": \"30/09/2022 13:10:15\",\n                \"updated_at\": \"30/09/2022 14:27:12\"\n            },\n            {\n                \"uid\": 974581977787337,\n                \"visible\": true,\n                \"position\": 3,\n                \"translations\": [\n                    {\n                        \"title\": \"Brand\",\n                        \"locale\": \"en\"\n                    }\n                ],\n                \"created_at\": \"30/09/2022 13:10:15\",\n                \"updated_at\": \"30/09/2022 14:27:12\"\n            }\n        ],\n        \"page\": 1,\n        \"pages\": 1,\n        \"per_page\": 25,\n        \"total\": 4\n    }\n}\n\n
\nprototype_attributes - <**_**List of Category Attributes>_ - The list of available category attributes.
page - Current page
pages - Total amount of pages
per_page - Items shown per page
total - Total items
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes","prototype_uid","prototype_attributes"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"bd369b62-a82a-4f48-96c4-889983e46cfc"},{"name":"Create Category Attribute","id":"909b816b-7006-4e77-bb35-fe739267c00d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"prototype_attribute\": {\n        \"visible\": true,\n        \"prototype_attribute_group_api_uid\": 263628499080780, \n        \"is_webshort\": true,\n        \"translations_attributes\": [\n            {\n                \"locale\": \"en\",\n                \"title\": \"EN-Category Attribute 1\"\n            },\n            {\n                \"locale\": \"de\",\n                \"title\": \"DE-Category Attribute 1\"\n            }\n        ],\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"custom-field-key-1\", \n                \"value\": \"custom-field-value-1\",\n                \"type\": \"text\"\n            },\n            \"custom_field2\": {\n                \"key\": \"custom-field-key-2\", \n                \"value\": \"custom-field-value-2\",\n                \"type\": \"html\"\n            }, \n            \"custom_field3\": {\n                \"key\": \"custom-field-key-3\", \n                \"value\": \"custom-field-value-3\",\n                \"type\": \"json\"\n            },\n            \"custom_field4\": {\n                \"key\": \"custom-field-key-4\", \n                \"value\": \"custom-field-value-4\",\n                \"type\": \"text\"\n            },\n            \"custom_field5\": {\n                \"key\": \"custom-field-key-5\", \n                \"value\": \"custom-field-value-5\",\n                \"type\": \"text\"\n            },\n            \"custom_field6\": {\n                \"key\": \"custom-field-key-6\", \n                \"value\": \"custom-field-value-6\",\n                \"type\": \"text\"\n            },\n            \"custom_field7\": {\n                \"key\": \"custom-field-key-7\", \n                \"value\": \"custom-field-value-7\",\n                \"type\": \"text\"\n            },\n            \"custom_field8\": {\n                \"key\": \"custom-field-key-8\", \n                \"value\": \"custom-field-value-8\",\n                \"type\": \"text\"\n            },\n            \"custom_field9\": {\n                \"key\": \"custom-field-key-9\", \n                \"value\": \"custom-field-value-9\",\n                \"type\": \"text\"\n            },\n            \"custom_field10\": {\n                \"key\": \"custom-field-key-10\", \n                \"value\": \"custom-field-value-10\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/prototypes/prototype_uid/prototype_attributes","description":"Creates a category attribute
\nAll category available locales must be present
\nParameters
\n{\n    \"prototype_attribute\": {\n        \"visible\": true,\n        \"translations_attributes\": [\n            {\n                \"locale\": \"en\",\n                \"title\": \"EN-Category Attribute 1\"\n            },\n            {\n                \"locale\": \"de\",\n                \"title\": \"DE-Category Attribute 1\"\n            }\n        ]\n    }\n}\n\n
\nWe send a category object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
visible Boolean Whether or not the attribute is visible
translations_attributes Array An array with all the category attribute translations
locale String The locale of the translation
title String The title of the translation
\n
Response
\n{\n    \"response\": {\n        \"prototype_attribute\": {\n            \"uid\": 709083629280582,\n            \"visible\": true,\n            \"position\": 4,\n            \"translations\": [\n                {\n                    \"title\": \"EN-Category Attribute 1\",\n                    \"locale\": \"en\"\n                },\n                {\n                    \"title\": \"DE-Category Attribute 1\",\n                    \"locale\": \"de\"\n                }\n            ],\n            \"created_at\": \"30/09/2022 15:00:34\",\n            \"updated_at\": \"30/09/2022 15:00:34\"\n        }\n    }\n}\n\n
\nReturns a new category object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the category attribute
visible Boolean Whether or not the attribute is visible
position Int The position of the attribute
translations Array An array of all the category attribute's translations
title String The title of the translation
locale String The locale of the translation
created_at DateTime When the category attribute was created
updated_at DateTime When the category attribute was last updated
\n
Errors
\nExample: title is blank
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"Error creating prototype attribute\",\n        \"message\": \"Title Title cannot be blank\"\n    }\n}\n\n
\nExample: missing category available locale
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"invalid_translation_locales\",\n        \"message\": \"Category attribute should have all locale translations that its Category has\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes","prototype_uid","prototype_attributes"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"909b816b-7006-4e77-bb35-fe739267c00d"},{"name":"Update Category Attribute","id":"7c746479-e89e-4313-a07a-bf862c581dab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n    \"prototype_attribute\": {\n        \"visible\": false,\n        \"prototype_attribute_group_api_uid\": 263628499080780, \n        \"is_webshort\": false,\n        \"translations_attributes\": [\n            {\n                \"locale\": \"en\",\n                \"title\": \"EN-Category Attribute 1\"\n            }\n        ],\n        \"custom_fields\": {\n            \"custom_field1\": {\n                \"key\": \"custom-field-key-1\", \n                \"value\": \"custom-field-value-1\",\n                \"type\": \"text\"\n            },\n            \"custom_field2\": {\n                \"key\": \"custom-field-key-2\", \n                \"value\": \"custom-field-value-2\",\n                \"type\": \"html\"\n            }, \n            \"custom_field3\": {\n                \"key\": \"custom-field-key-3\", \n                \"value\": \"custom-field-value-3\",\n                \"type\": \"json\"\n            },\n            \"custom_field4\": {\n                \"key\": \"custom-field-key-4\", \n                \"value\": \"custom-field-value-4\",\n                \"type\": \"text\"\n            },\n            \"custom_field5\": {\n                \"key\": \"custom-field-key-5\", \n                \"value\": \"custom-field-value-5\",\n                \"type\": \"text\"\n            },\n            \"custom_field6\": {\n                \"key\": \"custom-field-key-6\", \n                \"value\": \"custom-field-value-6\",\n                \"type\": \"text\"\n            },\n            \"custom_field7\": {\n                \"key\": \"custom-field-key-7\", \n                \"value\": \"custom-field-value-7\",\n                \"type\": \"text\"\n            },\n            \"custom_field8\": {\n                \"key\": \"custom-field-key-8\", \n                \"value\": \"custom-field-value-8\",\n                \"type\": \"text\"\n            },\n            \"custom_field9\": {\n                \"key\": \"custom-field-key-9\", \n                \"value\": \"custom-field-value-9\",\n                \"type\": \"text\"\n            },\n            \"custom_field10\": {\n                \"key\": \"custom-field-key-10\", \n                \"value\": \"custom-field-value-10\",\n                \"type\": \"text\"\n            }\n        }\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/prototypes/prototype_uid/prototype_attributes/prototype_attribute_uid","description":"Updates a specified category attribute.
\nParameters
\nprototype_uid - The ID of the category that has the attribute.
\nprototype_attribute_uid - The ID of the category attribute to be updated.
\nRequest Body
\n{\n    \"prototype_attribute\": {\n        \"visible\": false,\n        \"translations_attributes\": [\n            {\n                \"locale\": \"en\",\n                \"title\": \"EN-Category Attribute 1\"\n            }\n        ]\n    }\n}\n\n
\nWe need an object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
visible Boolean Whether or not the attribute is visible
translations_attributes Array An array with the translations that will be updated
locale String The locale of the translation
title String The title of the translation
\n
Response
\n{\n    \"response\": {\n        \"prototype_attribute\": {\n            \"uid\": 352419358000727,\n            \"visible\": false,\n            \"position\": 0,\n            \"translations\": [\n                {\n                    \"title\": \"EN-Category Attribute 1\",\n                    \"locale\": \"en\"\n                },\n                {\n                    \"title\": \"DE-Category Attribute 1\",\n                    \"locale\": \"de\"\n                }\n            ],\n            \"created_at\": \"30/09/2022 13:10:15\",\n            \"updated_at\": \"30/09/2022 15:16:01\"\n        }\n    }\n}\n\n
\nReturns a translation object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the category attribute
visible Boolean Whether or not the attribute is visible
position Int The position of the attribute
translations Array An array of all the category attribute's translations
title String The title of the translation
locale String The locale of the translation
created_at DateTime When the category attribute was created
updated_at DateTime When the category attribute was last updated
\n
Errors
\nExample: invalid locale
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"invalid_locale\",\n        \"message\": \"One or more locales are not supported by the Category\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes","prototype_uid","prototype_attributes","prototype_attribute_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"7c746479-e89e-4313-a07a-bf862c581dab"},{"name":"Delete Category Attribute","id":"600d4ef6-2c62-4590-8157-610e386f3685","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/admapi/v1/prototypes/prototype_uid/prototype_attributes/prototype_attribute_uid","description":"Deletes an existing category attribute.
\nParameters
\nprototype_uid - The ID of the category.
prototype_attribute_uid - The ID of the category attribute to be deleted.
\nResponse
\n{\n    \"response\": \"Category Attribute deleted successfully\"\n}\n\n
\nErrors
\nExample: category attribute not found
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"prototype_attribute_not_found\",\n        \"message\": \"Prototype attribute with specified uid does not exist\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","prototypes","prototype_uid","prototype_attributes","prototype_attribute_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"600d4ef6-2c62-4590-8157-610e386f3685"}],"id":"4a828409-3a14-47be-acde-a8c824bae803","_postman_id":"4a828409-3a14-47be-acde-a8c824bae803","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}},{"name":"Taxe(s)","item":[{"name":"List Taxes","id":"d22b281a-39bf-4ee1-a3e6-67cf5b00923e","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/admapi/v1/taxes?page=1","description":"Returns the list of taxes available to the store. First result in the array is always the default tax which is immutable.
\nParameters
\npage <*int> -* Indicates the page of taxes to fetch. If not specified the first page is returned.
\nResponse
\n{\n    \"response\": {\n        \"taxes\": [\n            {\n                \"uid\": 480527211475204,\n                \"title\": \"Tax\",\n                \"is_default\": true,\n                \"rate\": 0.0,\n                \"applies_to\": 0,\n                \"included_in_price\": false,\n                \"created_at\": \"16/05/2022 13:54:05\",\n                \"updated_at\": \"18/05/2022 13:09:26\"\n            },\n            {\n                \"uid\": 185113879518452,\n                \"title\": \"VAT\",\n                \"is_default\": false,\n                \"rate\": 0.24,\n                \"applies_to\": 0,\n                \"included_in_price\": false,\n                \"created_at\": \"17/05/2022 13:28:25\",\n                \"updated_at\": \"18/05/2022 13:09:26\"\n            }\n        ],\n        \"page\": 1,\n        \"pages\": 1,\n        \"per_page\": 25,\n        \"total\": 2\n    }\n}\n\n
\ntaxes <*List of Tax>* - The list of available taxes.
page - Current page
pages - Total amount of pages
per_page - Items shown per page
total - Total items
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","taxes"],"host":[""],"query":[{"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"d22b281a-39bf-4ee1-a3e6-67cf5b00923e"},{"name":"Get Single Tax","id":"06afc647-2834-463a-ada3-805a9f0964bf","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/admapi/v1/taxes/","description":"Returns the specified tax.
\nParameters
\ntaxid - The ID of the tax to be retrieved.
\nResponse
\n{\n    \"response\": {\n        \"tax\": {\n            \"uid\": 277228082213362,\n            \"title\": \"API Tax 2\",\n            \"is_default\": false,\n            \"rate\": 0.28,\n            \"applies_to\": 0,\n            \"included_in_price\": false,\n            \"created_at\": \"18/05/2022 14:24:27\",\n            \"updated_at\": \"18/05/2022 14:30:58\",\n            \"translations\": [\n                {\n                    \"title\": \"API Tax 2\",\n                    \"locale\": \"en\"\n                }\n            ]\n        }\n    }\n}\n\n
\nReturns a tax object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the tax requested
title String The name of the tax
is_default Boolean Whether or not the tax requested is the default tax
rate Decimal The rate of the tax in float with 2 digits precision. For example we set 0.28 for 28% taxes.
applies_to Int Specifies where the tax rate will be applied:*  
0 - Subtotal  
1 - Subtotal and Shipping.*
included_in_price Boolean Whether or not the tax is included in the product's base price.
created_at DateTime When the tax was created.
updated_at DateTime When the tax was last updated.
\n
Errors
\nExample: not found
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"tax_not_found\",\n        \"message\": \"Tax with specified uid does not exist\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","taxes",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"06afc647-2834-463a-ada3-805a9f0964bf"},{"name":"Create Tax","id":"e490623c-4dea-4709-b10c-1f0954e50821","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"tax\": {\n        \"title\": \"API Tax 4\",\n        \"rate\": 0.35,\n        \"included_in_price\": true,\n        \"applies_to\": 0,\n        \"locale\": \"en\"\n    }\n}"},"url":"/admapi/v1/taxes","description":"Creates a tax.
\nParameters
\n{\n    \"tax\": {\n        \"title\": \"API Tax 4\",\n        \"rate\": 0.35,\n        \"included_in_price\": true,\n        \"applies_to\": 0,\n        \"locale\": \"en\"\n    }\n}\n\n
\nWe send a tax object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The name of the new tax
rate Decimal The rate of the tax in float with 2 digits precision. For example we set 0.28 for 28% taxes.
included_in_price Boolean Whether or not the tax is included in the product's base price.
applies_to Int Specifies where the tax rate will be applied:  
0 - Subtotal  
1 - Subtotal and Shipping.
locale String (Mandatory) The locale of the translatable title.
\n
Response
\n{\n    \"response\": {\n        \"tax\": {\n            \"uid\": 646726532028248,\n            \"title\": \"API Tax 4\",\n            \"is_default\": false,\n            \"rate\": 0.35,\n            \"applies_to\": 0,\n            \"included_in_price\": true,\n            \"created_at\": \"24/05/2022 09:43:16\",\n            \"updated_at\": \"24/05/2022 09:43:16\",\n            \"translations\": [\n                {\n                    \"title\": \"API Tax 4\",\n                    \"locale\": \"en\"\n                }\n            ]\n        }\n    }\n}\n\n
\nReturns a new tax object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the tax created
title String The name of the tax
is_default Boolean Whether or not the tax requested is the default tax
rate Decimal The rate of the tax in float with 2 digits precision. For example we set 0.28 for 28% taxes.
applies_to Int Specifies where the tax rate will be applied:  
0 - Subtotal  
1 - Subtotal and Shipping.
included_in_price Boolean Whether or not the tax is included in the product's base price.
created_at DateTime When the tax was created.
updated_at DateTime When the tax was last updated.
translations Array An array containing the tax translations.
\n
Errors
\nExample: name is blank
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"Error creating tax\",\n        \"message\": \"Name The name cannot be blank.\"\n    }\n}\n\n
\nExample: invalid rate
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"Error creating tax\",\n        \"message\": \"Rate (decimal) Rate has to be between 0 and 1.\"\n    }\n}\n\n
\nExample: missing locale
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"missing_locale\",\n        \"message\": \"You need to specify a locale for the tax\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","taxes"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"e490623c-4dea-4709-b10c-1f0954e50821"},{"name":"Update Tax","id":"ab21abb9-a74d-45e7-b993-34f4dc0038ca","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"tax\": {\n    \"rate\": 0.35\n  }\n}"},"url":"/admapi/v1/taxes/","description":"Updates an existing tax.
\nParameters
\ntaxid - The ID of the tax to be updated.
\n{\n    \"tax\": {\n        \"rate\": 0.35\n    }\n}\n\n
\nWe send a tax object with any of the following attributes to be updated:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
rate Decimal The rate of the tax in float with 2 digits precision. For example we set 0.28 for 28% taxes.
included_in_price Boolean Whether or not the tax is included in the product's base price.
applies_to Int Specifies where the tax rate will be applied:  
0 - Subtotal  
1 - Subtotal and Shipping.
\n
Note: To update the title of the tax see the sections \"Add translation\" & \"Update translation\"
\nResponse
\n{\n    \"response\": {\n        \"tax\": {\n            \"uid\": 646726532028248,\n            \"title\": \"API Tax 4\",\n            \"is_default\": false,\n            \"rate\": 0.35,\n            \"applies_to\": 0,\n            \"included_in_price\": true,\n            \"created_at\": \"24/05/2022 09:43:16\",\n            \"updated_at\": \"24/05/2022 09:53:38\",\n            \"translations\": [\n               {\n                   \"title\": \"API Tax 4\",\n                   \"locale\": \"en\"\n               }\n            ]\n        }\n    }\n}\n\n
\nReturns a new tax object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
taxid Bigint The ID of the tax created
name String The name of the tax
is_default Boolean Whether or not the tax requested is the default tax
rate Decimal The rate of the tax in float with 2 digits precision. For example we set 0.28 for 28% taxes.
applies_to Int Specifies where the tax rate will be applied:  
0 - Subtotal  
1 - Subtotal and Shipping.
included_in_price Boolean Whether or not the tax is included in the product's base price.
created_at DateTime When the tax was created.
updated_at DateTime When the tax was last updated.
\n
Errors
\nExample: Tax not found
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"tax_not_found\",\n        \"message\": \"Tax with specified uid does not exist\"\n    }\n}\n\n
\nExample: invalid rate
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"Error updating tax\",\n        \"message\": \"Rate (decimal) Rate has to be between 0 and 1.\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","taxes",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"ab21abb9-a74d-45e7-b993-34f4dc0038ca"},{"name":"Delete Tax","id":"fcff68dd-d3ab-4e67-9b84-752b4adeb33e","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"/admapi/v1/taxes/","description":"Destroys a tax.
\nParameters
\ntaxid <*Bigint*> - The ID of the tax to be deleted.
\nResponse
\n{\n    \"response\": {\n        \"tax\": {\n            \"uid\": 646726532028248,\n            \"title\": \"New API Tax 4\",\n            \"is_default\": false,\n            \"rate\": 0.35,\n            \"applies_to\": 0,\n            \"included_in_price\": true,\n            \"created_at\": \"24/05/2022 09:43:16\",\n            \"updated_at\": \"24/05/2022 09:53:38\"\n        }\n    }\n}\n\n
\nReturns the deleted tax object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the tax created
title String The name of the tax
is_default Boolean Whether or not the tax requested is the default tax
rate Decimal The rate of the tax in float with 2 digits precision. For example we set 0.28 for 28% taxes.
applies_to Int Specifies where the tax rate will be applied:  
0 - Subtotal  
1 - Subtotal and Shipping.
included_in_price Boolean Whether or not the tax is included in the product's base price.
created_at DateTime When the tax was created.
updated_at DateTime When the tax was last updated.
\n
Errors
\nExample: Tax not found
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"tax_not_found\",\n        \"message\": \"Tax with specified uid does not exist\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","taxes",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"fcff68dd-d3ab-4e67-9b84-752b4adeb33e"},{"name":"Add translation","id":"6b399374-d267-4b7d-884c-23f47b4c5678","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"translation\": {\n        \"title\": \"API Tax 2 Francais\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/taxes//translations/","description":"Creates a new translation for the specified tax.
\nParameters
\ntaxid - The ID of the tax.
locale - The locale for which the translation is about.
\nRequest Body
\n{\n    \"translation\": {\n        \"title\": \"API Tax 2 Francais\"\n    }\n}\n\n
\nWe need a translation object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The name of the tax for the specified locale.
\n
Response
\n{\n    \"response\": {\n        \"translation\": {\n            \"title\": \"API Tax 2 Francais\",\n            \"locale\": \"fr\"\n        }\n    }\n}\n\n
\nReturns a newly created translation object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The name of the tax.
locale String The locale of the translation.
\n
Errors
\nExample: locale not supported
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"unavailable_locale\",\n        \"message\": \"This locale is not supported\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","taxes","","translations",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"6b399374-d267-4b7d-884c-23f47b4c5678"},{"name":"Update translation","id":"1c3f6be6-1dbe-48d7-8349-963c7f63c95b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n    \"translation\": {\n        \"title\": \"API Tax 2 Fr\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/taxes//translations/","description":"Updates an existing translation for the specified tax. To create a new translation see \"Add translation\" section
\nParameters
\ntaxid - The ID of the tax.
locale - The locale for which the translation is about.
\nRequest Body
\n{\n    \"translation\": {\n        \"title\": \"API Tax 2 Fr\"\n    }\n}\n\n
\nWe need a translation object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The name of the tax for the specified locale.
\n
Response
\n{\n    \"response\": {\n        \"translation\": {\n            \"title\": \"API Tax 2 Fr\",\n            \"locale\": \"fr\"\n        }\n    }\n}\n\n
\nReturns a translation object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The name of the tax.
locale String The locale of the translation.
\n
Errors
\nExample: locale not supported
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"unavailable_locale\",\n        \"message\": \"This locale is not supported\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","taxes","","translations",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"1c3f6be6-1dbe-48d7-8349-963c7f63c95b"},{"name":"Delete translation","id":"b05ea6f8-2942-4e56-936d-30ce7bdffa85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/taxes//translations/","description":"Deletes an existing translation for the specified tax.
\nParameters
\ntaxid - The ID of the tax.
locale - The locale for which the translation is about.
\nResponse
\n{\n    \"response\": \"Translation deleted successfully\"\n}\n\n
\nErrors
\nExample: locale not found
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"locale_not_found\",\n        \"message\": \"The tax does not have a translation for this locale\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","taxes","","translations",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"b05ea6f8-2942-4e56-936d-30ce7bdffa85"}],"id":"157cea7f-c8d9-49a7-a272-0883d0ef24cd","description":"The platform offers the option to have multiple taxes based on the tax category of your products. Your store always has a default tax available and this is shown and edited from the main taxes screen of your admin panel.
\n","_postman_id":"157cea7f-c8d9-49a7-a272-0883d0ef24cd","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}},{"name":"Store Location(s)","item":[{"name":"List Stores","id":"9279550e-ecd4-4fa3-bd32-a5f91c772625","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/stores?page=1","description":"Returns the list of stores. First result in the array is the main store.
\nParameters
\npage - Indicates the page of stores to fetch. If not specified the first page is returned
\nResponse
\n{\n    \"response\": {\n        \"stores\": [\n            {\n                \"uid\": 635156939194632,\n                \"title\": \"API Store\",\n                \"email\": \"test@test.com\",\n                \"active\": true,\n                \"translations\": [\n                    {\n                        \"title\": \"API Store\",\n                        \"locale\": \"en\"\n                    },\n                    {\n                        \"title\": \"API Store French\",\n                        \"locale\": \"fr\"\n                    }\n                ],\n                \"created_at\": \"11/07/2022 14:54:35\",\n                \"updated_at\": \"12/07/2022 09:09:03\"\n            }\n        ],\n        \"page\": 1,\n        \"pages\": 1,\n        \"per_page\": 25,\n        \"total\": 1\n    }\n}\n\n
\nstores - The list of available stores
page - Current page
pages - Total amount of pages
per_page - Items shown per page
total - Total items
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","stores"],"host":[""],"query":[{"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"9279550e-ecd4-4fa3-bd32-a5f91c772625"},{"name":"Get Single Store","id":"4063b852-c837-4ca2-9f62-02d306179217","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/stores/","description":"Returns the specified store.
\nParameters
\nstoreid - The ID of the store to be retrieved.
\nResponse
\n{\n    \"response\": {\n        \"store\": {\n            \"uid\": 183771300737153,\n            \"title\": \"API Store\",\n            \"email\": \"test@reactiveapi.com\",\n            \"active\": true,\n            \"translations\": [\n                {\n                    \"title\": \"API Store\",\n                    \"locale\": \"en\"\n                }\n            ],\n            \"created_at\": \"16/05/2022 13:54:05\",\n            \"updated_at\": \"24/05/2022 10:31:17\"\n        }\n    }\n}\n\n
\nReturns a store object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the store requested.
title String The name of the store.
email String The email address of the store.
active Boolean Whether or not the store is active.
translations Array An array containing the store translations.
created_at DateTime When the store was created.
updated_at DateTime When the store was last updated.
\n
Errors
\nExample: not found
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"store_not_found\",\n        \"message\": \"Store with specified uid does not exist\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","stores",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"4063b852-c837-4ca2-9f62-02d306179217"},{"name":"Create Store","id":"95731175-d16f-4358-9601-3eb4dcf331b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"store\": {\n    \"title\": \"API Store 2\",\n    \"email\": \"test@reactiveapi.com\",\n    \"active\": true,\n    \"locale\": \"en\"\n  }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/stores","description":"Creates a store.
\nParameters
\n{\n    \"store\": {\n        \"title\": \"API Store 2\",\n        \"email\": \"test@reactiveapi.com\",\n        \"active\": true,\n        \"locale\": \"en\"\n    }\n}\n\n
\nWe send a store object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The name of the store.
email String (Optional) The email address of the store.
active Boolean (Optional) Whether or not the store is active.
locale String (Mandatory) The locale of the translatable title
\n
Response
\n{\n    \"response\": {\n        \"store\": {\n            \"uid\": 964162355872397,\n            \"title\": \"API Store 2\",\n            \"email\": \"test@reactiveapi.com\",\n            \"active\": true,\n            \"translations\": [\n                { \n                    \"title\": \"API Store 2\",\n                    \"locale\": \"en\" \n                }  \n            ],\n            \"created_at\": \"24/05/2022 13:54:05\",\n            \"updated_at\": \"24/05/2022 13:54:05\"\n        }\n    }\n}\n\n
\nReturns a newly created store object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the store requested.
title String The name of the store.
email String The email address of the store.
active Boolean Whether or not the store is active.
translations Array An array containing the store translations.
created_at DateTime When the store was created.
updated_at DateTime When the store was last updated.
\n
Errors
\nExample: maximum limit reached
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"Error creating store\",\n        \"message\": \"You have reached the maximum limit for stores. Please upgrade your package.\"\n    }\n}\n\n
\nExample: presentation is blank
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"Error creating store\",\n        \"message\": \"Presentation The presentation cannot be blank.\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","stores"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"95731175-d16f-4358-9601-3eb4dcf331b2"},{"name":"Update Store","id":"39599f61-f45d-4301-b692-07c9e1b9ae19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n  \"store\": {\n    \"active\": false\n  }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/stores/","description":"Updates the specified store.
\nParameters
\nstoreid - The ID of the store to be updated.
\n{\n    \"store\": {\n        \"active\": false\n    }\n}\n\n
\nWe send a store object with any of the following attributes to be updated:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
email String The email address of the store.
active Boolean Whether or not the store is active.
\n
Note: To update the title of the store see the sections \"Add translation\" & \"Update translation\"
\nResponse
\n{\n    \"response\": {\n        \"store\": {\n            \"uid\": 964162355872397,\n            \"title\": \"Edited API Store 2\",\n            \"email\": \"test@reactiveapi.com\",\n            \"active\": true,\n            \"translations\": [\n                {\n                  \"title\": \"API Store 2\",\n                  \"locale\": \"en\"\n                }\n            ],\n            \"created_at\": \"24/05/2022 13:54:05\",\n            \"updated_at\": \"24/05/2022 14:31:17\"\n        }\n    }\n}\n\n
\nReturns a newly created store object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
uid Bigint The ID of the store requested.
title String The name of the store.
email String The email address of the store.
active Boolean Whether or not the store is active.
translations Array An array containing the translations of the specified store.
created_at DateTime When the store was created.
updated_at DateTime When the store was last updated.
\n
Errors
\nExample: not found
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"store_not_found\",\n        \"message\": \"Store with specified uid does not exist\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","stores",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"39599f61-f45d-4301-b692-07c9e1b9ae19"},{"name":"Add translation","id":"cc236698-0b4f-4470-9e47-ae94fdc679c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"translation\": {\n        \"title\": \"API Store 2 Francais\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/stores//translations/","description":"Creates a new translation for the specified store.
\nParameters
\nstoreid - The ID of the store.
locale - The locale for which the translation is about.
\nRequest Body
\n{\n    \"translation\": {\n        \"title\": \"API Store 2 Francais\"\n    }\n}\n\n
\nWe need a translation object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The name of the store for this locale.
\n
Response
\n{\n    \"response\": {\n        \"translation\": {\n            \"title\": \"API Store 2 Francais\",\n            \"locale\": \"fr\"\n        }\n    }\n}\n\n
\nReturns a newly created translation object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The name of the store.
locale String The locale of the translation.
\n
Errors
\nExample: locale not supported
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"unavailable_locale\",\n        \"message\": \"This locale is not supported\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","stores","","translations",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"cc236698-0b4f-4470-9e47-ae94fdc679c5"},{"name":"Update translation","id":"5ab9341f-adef-4a16-b59e-085ab9303e18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n    \"translation\": {\n        \"title\": \"API Store 2 Fr\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/stores//translations/","description":"Updates an existing translation for the specified store. To create a new translation see \"Add translation\" section
\nParameters
\nstoreid - The ID of the store.
locale - The locale for which the translation is about.
\nRequest Body
\n{\n    \"translation\": {\n        \"title\": \"API Store 2 Fr\"\n    }\n}\n\n
\nWe need a translation object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The name of the store for this locale.
\n
Response
\n{\n    \"response\": {\n        \"translation\": {\n            \"title\": \"API Store 2 Fr\",\n            \"locale\": \"fr\"\n        }\n    }\n}\n\n
\nReturns a newly created translation object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
title String The name of the store.
locale String The locale of the translation.
\n
Errors
\nExample: locale not supported
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"unavailable_locale\",\n        \"message\": \"This locale is not supported\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","stores","","translations",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"5ab9341f-adef-4a16-b59e-085ab9303e18"},{"name":"Delete translation","id":"e7cabb83-db2b-4662-abfc-611ee361a968","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/admapi/v1/stores//translations/","description":"Deletes an existing translation for the specified store.
\nParameters
\nstoreid - The ID of the store.
locale - The locale for which the translation is about.
\nResponse
\n{\n    \"response\": \"Translation deleted successfully\"\n}\n\n
\nErrors
\nExample: locale not found
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"locale_not_found\",\n        \"message\": \"The store does not have a translation for this locale\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","stores","","translations",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"e7cabb83-db2b-4662-abfc-611ee361a968"}],"id":"eda9b124-fdf2-4ba7-b2ba-abdbb15d3606","description":"The platform offers the option to have multiple store locations. You always have a main store available and all stores are shown and edited from the main stores screen of your admin panel.
\n","_postman_id":"eda9b124-fdf2-4ba7-b2ba-abdbb15d3606","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}},{"name":"Order(s)","item":[{"name":"Shipment(s)","item":[{"name":"List Shipments","id":"ca6ce1da-145a-42ab-9880-4605f33d420f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/orders/order_uid/shipments","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","orders","order_uid","shipments"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"ca6ce1da-145a-42ab-9880-4605f33d420f"},{"name":"Get Single Shipment","id":"805a472d-ffc9-4b8f-9b1f-e7d1af2c363e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/orders/order_uid/shipments/shipment_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","orders","order_uid","shipments","shipment_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"805a472d-ffc9-4b8f-9b1f-e7d1af2c363e"},{"name":"Create Shipment","id":"b33466ca-754f-4966-953f-7fa6566cae1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/admapi/v1/orders/order_uid/shipments","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","orders","order_uid","shipments"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"b33466ca-754f-4966-953f-7fa6566cae1e"},{"name":"Update Shipment","id":"b29c1eba-0bb0-4ad2-9b3d-d878320b2f59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"/admapi/v1/orders/order_uid/shipments/shipment_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","orders","order_uid","shipments","shipment_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"b29c1eba-0bb0-4ad2-9b3d-d878320b2f59"},{"name":"Delete Shipment","id":"0f25d125-f639-476a-82a2-e2dcfc192663","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/admapi/v1/orders/order_uid/shipments/shipment_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","orders","order_uid","shipments","shipment_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"0f25d125-f639-476a-82a2-e2dcfc192663"}],"id":"01fd6751-4fbe-45a5-a8c6-7458e5659083","_postman_id":"01fd6751-4fbe-45a5-a8c6-7458e5659083","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}},{"name":"Line Item(s)","item":[{"name":"Update Line Item","id":"fbf56d95-976b-4e78-95d0-264da462f857","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"/admapi/v1/orders/order_uid/line_items/line_item_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","orders","order_uid","line_items","line_item_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"fbf56d95-976b-4e78-95d0-264da462f857"},{"name":"Delete Line Item","id":"449036fa-c258-49b6-a0c6-a0199e28d7e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/admapi/v1/orders/order_uid/line_items/line_item_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","orders","order_uid","line_items","line_item_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"449036fa-c258-49b6-a0c6-a0199e28d7e2"}],"id":"dc04c90d-6e69-43fb-a14d-54bbd4221f57","_postman_id":"dc04c90d-6e69-43fb-a14d-54bbd4221f57","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}},{"name":"List Orders","id":"dc4bd2d1-d0ac-4094-9c6f-837df9c46109","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/orders?fetch_completed=orders_fetch_completed&fetch_incomplete=orders_fetch_incomplete&fetch_cancelled=orders_fetch_cancelled","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","orders"],"host":[""],"query":[{"key":"fetch_completed","value":"orders_fetch_completed"},{"key":"fetch_incomplete","value":"orders_fetch_incomplete"},{"key":"fetch_cancelled","value":"orders_fetch_cancelled"}],"variable":[]}},"response":[],"_postman_id":"dc4bd2d1-d0ac-4094-9c6f-837df9c46109"},{"name":"Get Single Order","id":"5e38af29-204b-459c-a2af-211adb2a3ee6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/orders/order_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","orders","order_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"5e38af29-204b-459c-a2af-211adb2a3ee6"},{"name":"Populate Order","id":"3b2d1edf-fce8-427f-8e3e-194cc17245f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/admapi/v1/orders/populate","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","orders","populate"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"3b2d1edf-fce8-427f-8e3e-194cc17245f5"},{"name":"Update Order","id":"191326ab-1e62-4a58-97d9-f0ee2b7204cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"/admapi/v1/orders/order_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","orders","order_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"191326ab-1e62-4a58-97d9-f0ee2b7204cb"},{"name":"Finalize Order","id":"9eac8f33-c50b-4f90-a48e-56b165b88e2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/admapi/v1/orders/order_uid/finalize","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","orders","order_uid","finalize"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"9eac8f33-c50b-4f90-a48e-56b165b88e2f"},{"name":"Delete Order","id":"58fbdecf-4f4f-4cd5-ad1f-bc057aa6eabf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/admapi/v1/orders/order_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","orders","order_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"58fbdecf-4f4f-4cd5-ad1f-bc057aa6eabf"},{"name":"List Order's Shipping Methods","id":"4fd206be-b0be-4235-86fc-e9a025005438","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/orders/order_uid/shipping_methods","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","orders","order_uid","shipping_methods"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"4fd206be-b0be-4235-86fc-e9a025005438"},{"name":"List Order's Payment Methods","id":"c6ddd7fe-2b8b-401d-8730-9fdf163fdde3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/orders/order_uid/payment_methods","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","orders","order_uid","payment_methods"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"c6ddd7fe-2b8b-401d-8730-9fdf163fdde3"}],"id":"9acbf8a3-1433-47c8-9955-167d98b2d675","_postman_id":"9acbf8a3-1433-47c8-9955-167d98b2d675","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}},{"name":"Countries","item":[{"name":"List Countries","id":"eb44f62c-97d9-4d06-8c6d-64a9ef5bf448","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/countries","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","countries"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"eb44f62c-97d9-4d06-8c6d-64a9ef5bf448"}],"id":"ea9e2e40-f6f6-4cdf-8184-f9d5fb87f2a2","_postman_id":"ea9e2e40-f6f6-4cdf-8184-f9d5fb87f2a2","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}},{"name":"User(s)","item":[{"name":"Get Single User","id":"5cbded7f-2004-488d-b92e-1180bec2171f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/users/user_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","users","user_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"5cbded7f-2004-488d-b92e-1180bec2171f"},{"name":"Create User","id":"f2bc7130-0f0b-4e68-8de1-6460b6e88b63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{api_url}}/admapi/v1/users","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","users"],"host":["{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f2bc7130-0f0b-4e68-8de1-6460b6e88b63"},{"name":"Update User","id":"1b1e7f83-aa45-493f-90bc-62d2fa5952f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"/admapi/v1/users/user_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","users","user_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"1b1e7f83-aa45-493f-90bc-62d2fa5952f7"},{"name":"Search Users","id":"22537448-cee4-4734-9b54-a7bad92515e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admapi/v1/users/search?value=user_keyword","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","users","search"],"host":[""],"query":[{"key":"value","value":"user_keyword"}],"variable":[]}},"response":[],"_postman_id":"22537448-cee4-4734-9b54-a7bad92515e0"},{"name":"Create Company and User","id":"66c1d66b-3af1-4b2d-81f3-7df18a736911","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/admapi/v1/users/create_company_and_user","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","users","create_company_and_user"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"66c1d66b-3af1-4b2d-81f3-7df18a736911"}],"id":"985f32e3-e51b-4d97-b668-aea72705a1c0","_postman_id":"985f32e3-e51b-4d97-b668-aea72705a1c0","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}},{"name":"Companies","item":[{"name":"Create Company","id":"3b3f09dc-6f66-4002-b45d-5b70ed10ac57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/admapi/v1/companies","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","companies"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"3b3f09dc-6f66-4002-b45d-5b70ed10ac57"},{"name":"Update Company","id":"224f64a1-47e8-4120-b7e1-4265ed59bf02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"/admapi/v1/companies/company_uid","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","companies","company_uid"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"224f64a1-47e8-4120-b7e1-4265ed59bf02"},{"name":"Create Users","id":"7fd5afe7-514b-4446-b401-f2c25c7a3995","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/admapi/v1/companies/company_uid/users","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v1","companies","company_uid","users"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"7fd5afe7-514b-4446-b401-f2c25c7a3995"}],"id":"83bbe5ce-f922-416b-989c-9ba66d85d5a6","_postman_id":"83bbe5ce-f922-416b-989c-9ba66d85d5a6","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}}],"id":"3e82a710-018e-428a-99ce-300878bc7f75","description":"Reactive makes it easy to manage your website's content through our API endpoints. We currently support the basic entities update via our API. Those are
\n\nProducts
\nBundles
\nOrders (coming soon)
\nCategories
\nCategory Attribute Groups
\nCategory Attributes
\nTaxes
\nStore Locations
\nCustomers (coming soon)
\n
\nMore will follow over time making almost everything accessible via the API.
\n","_postman_id":"3e82a710-018e-428a-99ce-300878bc7f75","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}},{"name":"Ordering endpoints","item":[{"name":"Taxe(s)","item":[{"name":"List Taxes","id":"584ec991-96e2-47c0-98f3-d65aa3a096bc","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/api/v1/taxes?page=1","description":"Returns the list of taxes available to the store. First result in the array is always the default tax which is immutable.
\nParameters
\npage <*int> -* Indicates the page of taxes to fetch. If not specified the first page is returned.
\nResponse
\n{\n    \"response\": {\n        \"taxes\": [\n            {\n                \"taxid\": 480527211475204,\n                \"name\": \"Tax\",\n                \"is_default\": true,\n                \"rate\": 0.0,\n                \"applies_to\": 0,\n                \"included_in_price\": false,\n                \"created_at\": \"16/05/2022 13:54:05\",\n                \"updated_at\": \"18/05/2022 13:09:26\"\n            },\n            {\n                \"taxid\": 185113879518452,\n                \"name\": \"VAT\",\n                \"is_default\": false,\n                \"rate\": 0.24,\n                \"applies_to\": 0,\n                \"included_in_price\": false,\n                \"created_at\": \"17/05/2022 13:28:25\",\n                \"updated_at\": \"18/05/2022 13:09:26\"\n            }\n        ]\n    }\n}\n\n
\ntaxes <*List of Tax>* - The list of available taxes.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","taxes"],"host":[""],"query":[{"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"584ec991-96e2-47c0-98f3-d65aa3a096bc"},{"name":"Get Single Tax","id":"730c23c3-b90e-41df-a2fe-b7ffda58c879","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/api/v1/taxes/","description":"Returns the specified tax.
\nParameters
\ntaxid - The ID of the tax to be retrieved.
\nResponse
\n{\n    \"response\": {\n        \"tax\": {\n            \"taxid\": 277228082213362,\n            \"name\": \"API Tax 2\",\n            \"is_default\": false,\n            \"rate\": 0.28,\n            \"applies_to\": 0,\n            \"included_in_price\": false,\n            \"created_at\": \"18/05/2022 14:24:27\",\n            \"updated_at\": \"18/05/2022 14:30:58\"\n        }\n    }\n}\n\n
\nReturns a tax object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
taxid Bigint The ID of the tax requested
name String The name of the tax
is_default Boolean Whether or not the tax requested is the default tax
rate Decimal The rate of the tax in float with 2 digits precision. For example we set 0.28 for 28% taxes.
applies_to Int Specifies where the tax rate will be applied:*  
0 - Subtotal  
1 - Subtotal and Shipping.*
included_in_price Boolean Whether or not the tax is included in the product's base price.
created_at DateTime When the tax was created.
updated_at DateTime When the tax was last updated.
\n
Errors
\nExample: not found
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"tax_not_found\",\n        \"message\": \"Tax with specified uid does not exist\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","taxes",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"730c23c3-b90e-41df-a2fe-b7ffda58c879"},{"name":"Create Tax","id":"912446f5-7a97-46bf-8356-a44621e4894a","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"tax\": {\n        \"name\": \"API Tax 4\",\n        \"rate\": 0.35,\n        \"included_in_price\": true,\n        \"applies_to\": 0\n    }\n}"},"url":"/api/v1/taxes","description":"Creates a tax.
\nParameters
\n{\n    \"tax\": {\n        \"name\": \"API Tax 4\",\n        \"rate\": 0.35,\n        \"included_in_price\": true,\n        \"applies_to\": 0\n    }\n}\n\n
\nWe send a tax object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
name String The name of the new tax
rate Decimal The rate of the tax in float with 2 digits precision. For example we set 0.28 for 28% taxes.
included_in_price Boolean Whether or not the tax is included in the product's base price.
applies_to Int Specifies where the tax rate will be applied:  
0 - Subtotal  
1 - Subtotal and Shipping.
\n
Response
\n{\n    \"response\": {\n        \"tax\": {\n            \"taxid\": 646726532028248,\n            \"name\": \"API Tax 4\",\n            \"is_default\": false,\n            \"rate\": 0.35,\n            \"applies_to\": 0,\n            \"included_in_price\": true,\n            \"created_at\": \"24/05/2022 09:43:16\",\n            \"updated_at\": \"24/05/2022 09:43:16\"\n        }\n    }\n}\n\n
\nReturns a new tax object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
taxid Bigint The ID of the tax created
name String The name of the tax
is_default Boolean Whether or not the tax requested is the default tax
rate Decimal The rate of the tax in float with 2 digits precision. For example we set 0.28 for 28% taxes.
applies_to Int Specifies where the tax rate will be applied:  
0 - Subtotal  
1 - Subtotal and Shipping.
included_in_price Boolean Whether or not the tax is included in the product's base price.
created_at DateTime When the tax was created.
updated_at DateTime When the tax was last updated.
\n
Errors
\nExample: name is blank
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"Error creating tax\",\n        \"message\": \"Name The name cannot be blank.\"\n    }\n}\n\n
\nExample: invalid rate
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"Error creating tax\",\n        \"message\": \"Rate (decimal) Rate has to be between 0 and 1.\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","taxes"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"912446f5-7a97-46bf-8356-a44621e4894a"},{"name":"Update Tax","id":"961f2928-f87b-432e-bdf4-266705fb1a50","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"tax\": {\n        \"name\": \"API Tax 1\"\n    }\n}"},"url":"/api/v1/taxes/","description":"Creates a tax.
\nParameters
\ntaxid - The ID of the tax to be updated.
\n{\n    \"tax\": {\n        \"name\": \"New API Tax 4\"\n    }\n}\n\n
\nWe send a tax object with any of the following attributes to be updated:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
name String The name of the tax
rate Decimal The rate of the tax in float with 2 digits precision. For example we set 0.28 for 28% taxes.
included_in_price Boolean Whether or not the tax is included in the product's base price.
applies_to Int Specifies where the tax rate will be applied:  
0 - Subtotal  
1 - Subtotal and Shipping.
\n
Response
\n{\n    \"response\": {\n        \"tax\": {\n            \"taxid\": 646726532028248,\n            \"name\": \"New API Tax 4\",\n            \"is_default\": false,\n            \"rate\": 0.35,\n            \"applies_to\": 0,\n            \"included_in_price\": true,\n            \"created_at\": \"24/05/2022 09:43:16\",\n            \"updated_at\": \"24/05/2022 09:53:38\"\n        }\n    }\n}\n\n
\nReturns a new tax object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
taxid Bigint The ID of the tax created
name String The name of the tax
is_default Boolean Whether or not the tax requested is the default tax
rate Decimal The rate of the tax in float with 2 digits precision. For example we set 0.28 for 28% taxes.
applies_to Int Specifies where the tax rate will be applied:  
0 - Subtotal  
1 - Subtotal and Shipping.
included_in_price Boolean Whether or not the tax is included in the product's base price.
created_at DateTime When the tax was created.
updated_at DateTime When the tax was last updated.
\n
Errors
\nExample: Tax not found
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"tax_not_found\",\n        \"message\": \"Tax with specified uid does not exist\"\n    }\n}\n\n
\nExample: name is blank
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"Error updating tax\",\n        \"message\": \"Name The name cannot be blank.\"\n    }\n}\n\n
\nExample: invalid rate
\n{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"Error updating tax\",\n        \"message\": \"Rate (decimal) Rate has to be between 0 and 1.\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","taxes",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"961f2928-f87b-432e-bdf4-266705fb1a50"},{"name":"Delete Tax","id":"debc1b2c-5182-427b-b588-24d2028ca4d0","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"/api/v1/taxes/","description":"Destroys a tax.
\nParameters
\ntaxid <*Bigint*> - The ID of the tax to be deleted.
\nResponse
\n{\n    \"response\": {\n        \"tax\": {\n            \"taxid\": 646726532028248,\n            \"name\": \"New API Tax 4\",\n            \"is_default\": false,\n            \"rate\": 0.35,\n            \"applies_to\": 0,\n            \"included_in_price\": true,\n            \"created_at\": \"24/05/2022 09:43:16\",\n            \"updated_at\": \"24/05/2022 09:53:38\"\n        }\n    }\n}\n\n
\nReturns the deleted tax object with the following attributes:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nField Type Description
taxid Bigint The ID of the tax created
name String The name of the tax
is_default Boolean Whether or not the tax requested is the default tax
rate Decimal The rate of the tax in float with 2 digits precision. For example we set 0.28 for 28% taxes.
applies_to Int Specifies where the tax rate will be applied:  
0 - Subtotal  
1 - Subtotal and Shipping.
included_in_price Boolean Whether or not the tax is included in the product's base price.
created_at DateTime When the tax was created.
updated_at DateTime When the tax was last updated.
\n
Errors
\nExample: Tax not found
\n{\n    \"error\": {\n        \"code\": 404,\n        \"status\": \"tax_not_found\",\n        \"message\": \"Tax with specified uid does not exist\"\n    }\n}\n\n
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","taxes",""],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"debc1b2c-5182-427b-b588-24d2028ca4d0"}],"id":"8554bcb6-cd7d-4fa4-a1c5-ee2a947ea4c2","description":"The platform offers the option to have multiple taxes based on the tax category of your products. Your store always has a default tax available and this is shown and edited from the main taxes screen of your admin panel.
\n","_postman_id":"8554bcb6-cd7d-4fa4-a1c5-ee2a947ea4c2","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}}],"id":"518686f3-0973-455d-991b-87c6d274f419","_postman_id":"518686f3-0973-455d-991b-87c6d274f419","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}},{"name":"Cash Register endpoints","item":[{"name":"Create","id":"299ee729-a61c-4426-b906-38f82ba152c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n   \"line_items\":[\n      {\n         \"unit_price\":1.61,\n         \"unit_tax\":0.39,\n         \"quantity\":1,\n         \"custom_tax\":0.24,\n         \"title\":null,\n         \"mydata_classification_category\":\"category1_2\",\n         \"vat_exemption_category\":null\n      },\n      {\n         \"unit_price\":0.06,\n         \"unit_tax\":0.01,\n         \"quantity\":1,\n         \"custom_tax\":0.24,\n         \"title\":\"Περιβαλλοντικό τέλος & πλαστικής σακούλας\",\n         \"mydata_classification_category\":\"category1_95\",\n         \"origin_type\":\"fee\",\n         \"origin_key\":\"environmental_fee\"\n      }\n   ],\n   \"created_by\":{\n      \"type\":\"employee\",\n      \"uid\":531969783066759\n   },\n   \"total_price\":2.07,\n   \"locale\":\"el\",\n   \"internal_notes\":\"This is a note\",\n   \"platform_origin\":\"android\",\n   \"payment_method\":\"cash\",\n   \"tips\":\"\",\n   \"installments\":\"0\",\n   \"document_type\":\"receipt\",\n   \"document_specified_type\":\"products\",\n   \"store_uid\":\"652657706192564\"\n}"},"url":"/admapi/v2/cash_register_transactions","description":"Create a Transaction
\nCreates a Transaction.
\nAfter the transaction has been created call complete to finalize the Transaction.
\nParameters
\n
\ntotal_price decimal *Required
\nThe total price of the transaction
\n
\nlocale string *Required
\nThe current language of the application
\n
\ninternal_notes string
\nAdditional notes for the transaction. Usually used for invoicing purposes
\n
\nplatform_origin nullable enum
\nIndicates the platform from which the transaction was made
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nPossible enum values
android  
Any Android device
ios  
Any iOS device
pax  
Any PAX POS terminal
pos_terminal  
Any POS terminal
api  
Created using API request
web  
Created from the web platform
admin  
Created from the administrator panel
\n
\npayment_method enum *Required
\nThe payment method of the transaction
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nPossible enum values
cash  
Pay with cash
possible  
Pay by card using the Worldline POSsible payment application
EurobankSmartPos  
pay by card using the Worldline SmartPOS payment application
web_banking  
Pay by bank transfer
on_credit  
Mark transaction to be paid in a later date
\n
\ntips string
\nThe tip amount of the transaction as a float point string
\n
\ninstallments string
\nThe number of installments for the transaction
\n
\nstore_uid string
\nThe unique identifier of the store currently logged in to
\n
\ndocument_type string *Required
\nAlong with the document_specified_type field indicates the document code sent to the invoicing provider
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nPossible values
receipt  
Used for B2C transactions
invoice  
Used for B2B transactions
\n
\ndocument_specified_type string *Required
\nAlong with the document_type field indicates the document code sent to the invoicing provider
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nPossible values
products  
Retail transactions of goods
services  
Provision of services
\n
\nline_items array of objects *Required
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nChild attributes
line_items.unit_price decimal *Required  
The unit net amount of the item
line_items.unit_tax decimal *Required  
The unit vat amount of the item
line_items.quantity integer *Required  
The quantity of the item
line_items.custom_tax decimal *Required  
The tax rate of the item
line_items.title string  
A user-friendly title of the item
line_items.mydata_classification_category string *Required  
The classification category of revenues as stated in the myData platform. Used for invoicing purposes
line_items.origin_type string  
Used for invoicing purposes  
Possible values:  
fee: Invoicing special fee
line_items.origin_key string  
Used for invoicing purposes  
Possible values:  
environmental_fee  
recycling_fee  
plastic_fee
\n
\ncreated_by object
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nChild attributes
created_by.type string  
The type of the transaction creator entity. Possible values: employee, administrator
created_by.uid bigint  
The unique identifier of the transaction creator entity.
\n
Responses
\n
\n200 OK
\ntransaction Transaction object
\nThe newly created transaction object
\n
\npaymentUid bigint
\nThe uid of the pending payment created alongside the transaction
\n
\npaymentToken nullable string
\nA unique alphanumeric token describing the payment created. Used only for the EurobankSmartPos payment method
\n
\nsignature nullable object
\nUsed for invoicing purposes and only with payment methods EurobankSmartPos and possible for compliance with AADE regulations for POS payments
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nChild attributes
signature.uid bigint  
A unique identifier of the signature object
signature.uuid bigint  
A unique identifier of the signature object created by the invoicing provider
signature.signature string  
The hex representation of the encrypted transaction data to be signed
signature.data string  
The transaction data to be signed
signature.timestamp string  
The time the signature has been created in TIMESTAMP format
signature.provider_id string  
The unique identifier of the invoicing provider in the AADE registry
\n
401 Unauthorized
\nHTTP/1.1 401 Unauthorized
\n
\n422 Unprocessable Entity
\ncode string
\nA distinctive error code
\n
\nmessage string
\nA user-friendly error message
\n
\nstatus integer
\nThe status code of the request
\n
\n500 An internal error occured
\nHTTP/1.1 500 Internal Server Error
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v2","cash_register_transactions"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"503cac7a-c729-43c9-bcc1-db2d2d64189d","name":"Create","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n   \"line_items\":[\n      {\n         \"unit_price\":1.61,\n         \"unit_tax\":0.39,\n         \"quantity\":1,\n         \"custom_tax\":0.24,\n         \"title\":null,\n         \"mydata_classification_category\":\"category1_2\",\n         \"vat_exemption_category\":null\n      },\n      {\n         \"unit_price\":0.06,\n         \"unit_tax\":0.01,\n         \"quantity\":1,\n         \"custom_tax\":0.24,\n         \"title\":\"Περιβαλλοντικό τέλος & πλαστικής σακούλας\",\n         \"mydata_classification_category\":\"category1_95\",\n         \"origin_type\":\"fee\",\n         \"origin_key\":\"environmental_fee\"\n      }\n   ],\n   \"created_by\":{\n      \"type\":\"employee\",\n      \"uid\":531969783066759\n   },\n   \"total_price\":2.07,\n   \"locale\":\"el\",\n   \"internal_notes\":\"This is a note\",\n   \"platform_origin\":\"android\",\n   \"payment_method\":\"cash\",\n   \"tips\":\"\",\n   \"installments\":\"0\",\n   \"document_type\":\"receipt\",\n   \"document_specified_type\":\"products\",\n   \"store_uid\":\"652657706192564\"\n}"},"url":"/admapi/v2/cash_register_transactions"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Cache-Control","value":"no-store, must-revalidate, private, max-age=0"},{"key":"X-Request-Id","value":"53193abf-3448-4f70-ab92-5b1287be9865"},{"key":"X-Runtime","value":"1.555462"},{"key":"Server-Timing","value":"sql.active_record;dur=403.30, instantiation.active_record;dur=154.07, start_processing.action_controller;dur=0.08, cache_read.active_support;dur=14.23, cache_fetch_hit.active_support;dur=0.01, unpermitted_parameters.action_controller;dur=0.01, start_transaction.active_record;dur=0.01, transaction.active_record;dur=436.29, cache_generate.active_support;dur=9.69, cache_write.active_support;dur=0.92, render.active_model_serializers;dur=0.27, process_action.action_controller;dur=1511.93"},{"key":"X-MiniProfiler-Original-Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-MiniProfiler-Ids","value":"yzlqf2xgv7nzb84foquk,dnlcyumdgkb9gwp7lg1s,s6uskz3sjo8yyelqrs3k,idqfmgml0pncrld99fs7,j1g8qam7gv7q7xtcps9b,snzwy74s0bpnp5w9lt8k,maksrm4i99ihwmsvrcxw,5xuc7x9jhgd5oquz5awp,9cmzwdp03d5oku1zt0bn,g1hlmwb7x7ftad04a0wf,7we28tkmf3l9h1w9bfgu,vq71pxn3nlqm5j9p2o6w,1ch3f7zmjcwvl2bwqydi,u8kbs1but5dqtmb68tst,8j4u9jtxnvc2vsc3yhfn,y0izh7ytjfjpnj8dceq6,ijpgjuk25c1p2ekccd9o,w9ohm84ou4pz11ur5du4,pt6zptsfncr2ull1cwrg,3423lwhuomm3tf5rq9h6"},{"key":"Set-Cookie","value":"__profilin=p%3Dt; path=/; HttpOnly; SameSite=Lax"},{"key":"Vary","value":"Origin,Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n    \"response\": {\n        \"transaction\": {\n            \"uid\": 242384340845042,\n            \"number\": \"C62653954275\",\n            \"created_at\": \"22/12/2025 17:06\",\n            \"internal_notes\": \"This is a note\",\n            \"total\": 2.07,\n            \"display_total\": \"€2.07\",\n            \"subtotal\": 1.67,\n            \"display_subtotal\": \"€1.67\",\n            \"vat_total\": 0.4,\n            \"display_vat_total\": \"€0.40\",\n            \"updated_at\": \"22/12/2025 17:06\",\n            \"type\": \"cash_register_transaction\",\n            \"created_by\": \"John Smith\",\n            \"status\": \"checkout\",\n            \"prev_status\": null,\n            \"platform_origin\": \"android\",\n            \"display_preauth_total\": null,\n            \"display_vat_total_without_adjustments_tax\": \"€0.40\",\n            \"display_subtotal_with_extra_costs\": \"€1.67\",\n            \"payments\": [\n                {\n                    \"uid\": 76095438692441,\n                    \"amount\": \"€2.07\",\n                    \"amount_value\": 2.07,\n                    \"payment_method\": \"ReactiveCore::PosCash\",\n                    \"payment_method_title\": \"POS Cash\",\n                    \"transaction_code\": null,\n                    \"response_code\": null,\n                    \"created_at\": \"22/12/2025 17:06\",\n                    \"state\": \"pending\",\n                    \"entity_origin\": null,\n                    \"invoicing_key\": \"cash\",\n                    \"created_at_unformatted\": \"2025-12-22T15:06:28.000Z\"\n                }\n            ],\n            \"line_items\": [\n                {\n                    \"uid\": 546006941057059,\n                    \"transaction_uid\": 242384340845042,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.39\",\n                    \"display_total\": \"€2\",\n                    \"total\": 2,\n                    \"tax\": 0.39,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Good(s)\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                },\n                {\n                    \"uid\": 936170392713449,\n                    \"transaction_uid\": 242384340845042,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.01\",\n                    \"display_total\": \"€0.07\",\n                    \"total\": 0.07,\n                    \"tax\": 0.01,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Περιβαλλοντικό τέλος & πλαστικής σακούλας\",\n                    \"mydata_classification_category\": \"category1_95\",\n                    \"vat_exemption_category\": null\n                }\n            ]\n        },\n        \"paymentUid\": 76095438692441,\n        \"paymentToken\": null,\n        \"signature\": null\n    }\n}"}],"_postman_id":"299ee729-a61c-4426-b906-38f82ba152c2"},{"name":"Complete","id":"e67221c8-3b50-4765-bb15-4944afff64cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n   \"entity_uid\": 242384340845042,\n   \"payment_method\": \"cash\",\n   \"locale\": \"el\",\n   \"store_uid\": \"652657706192564\"\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v2/cash_register_transactions/{{transaction_uid}}/complete","description":"Finalize a Transaction
\nFinalizes a Transaction, after the payment has been made, either as completed or failed. After completion call issue tax document to issue the relative tax document for the transaction if invoicing integration is enabled.
\nParameters
\n
\nentity_uid bigint *Required
\nThe unique identifier of the transaction
\n
\npayment_method enum *Required
\nThe payment method of the transaction. Needs to be the same as the payment method used on the create endpoint.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nPossible enum values
cash  
Pay with cash
possible  
Pay by card using the Worldline POSsible payment application
EurobankSmartPos  
pay by card using the Worldline SmartPOS payment application
web_banking  
Pay by bank transfer
on_credit  
Mark transaction to be paid in a later date
\n
\nlocale string
\nThe current language of the application
\n
\nstore_uid string
\nThe unique identifier of the store currently logged in to
\n
\npayment_token string
\nAn alphanumeric unique identifier of the payment. Used only with EurobankSmartPos payment method
\n
\napplication_intent_result integer
\nThe application result code of the deeplink payment activity. Used only with EurobankSmartPos payment method
\n
\nsuccess boolean
\nIndicates if the payment process was successful. Used only with possible payment method
\n
\ndata JSON string
\nThe actual data of the payment as returned from the payment provider application. Used only with possible payment method and in case of a successful payment
\n
\nerror_log string
\nThe error code and message as returned from the payment provider application. Used only with possible payment method and in case of a failed payment
\nResponses
\n
\n200 OK
\ntransaction Transaction object
\nThe finalized transaction object
\n
\n401 Unauthorized
\nHTTP/1.1 401 Unauthorized
\n
\n422 Unprocessable Entity
\ncode string
\nA distinctive error code
\n
\nmessage string
\nA user-friendly error message
\n
\nstatus integer
\nThe status code of the request
\n
\n500 An internal error occured
\nHTTP/1.1 500 Internal Server Error
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v2","cash_register_transactions","{{transaction_uid}}","complete"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"3b1bcb4e-3784-403d-9b38-b1b198d86f5e","name":"Complete with Cash payment","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n   \"entity_uid\": 242384340845042,\n   \"payment_method\": \"cash\",\n   \"locale\": \"el\",\n   \"store_uid\": \"652657706192564\"\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v2/cash_register_transactions/{{transaction_uid}}/complete"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Cache-Control","value":"no-store, must-revalidate, private, max-age=0"},{"key":"X-Request-Id","value":"a7f5e83e-540f-4c15-a54f-ceb37a13802b"},{"key":"X-Runtime","value":"1.043578"},{"key":"Server-Timing","value":"sql.active_record;dur=327.39, instantiation.active_record;dur=22.02, start_processing.action_controller;dur=1.95, cache_read.active_support;dur=10.30, cache_fetch_hit.active_support;dur=0.00, start_transaction.active_record;dur=0.01, transaction.active_record;dur=124.16, cache_generate.active_support;dur=16.37, cache_write.active_support;dur=0.48, render.active_model_serializers;dur=0.64, process_action.action_controller;dur=754.32"},{"key":"X-MiniProfiler-Original-Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-MiniProfiler-Ids","value":"1stxth76wf3mjnwdvfzj,yzlqf2xgv7nzb84foquk,dnlcyumdgkb9gwp7lg1s,s6uskz3sjo8yyelqrs3k,idqfmgml0pncrld99fs7,j1g8qam7gv7q7xtcps9b,snzwy74s0bpnp5w9lt8k,maksrm4i99ihwmsvrcxw,5xuc7x9jhgd5oquz5awp,9cmzwdp03d5oku1zt0bn,g1hlmwb7x7ftad04a0wf,7we28tkmf3l9h1w9bfgu,vq71pxn3nlqm5j9p2o6w,1ch3f7zmjcwvl2bwqydi,u8kbs1but5dqtmb68tst,8j4u9jtxnvc2vsc3yhfn,y0izh7ytjfjpnj8dceq6,ijpgjuk25c1p2ekccd9o,w9ohm84ou4pz11ur5du4,pt6zptsfncr2ull1cwrg"},{"key":"Set-Cookie","value":"__profilin=p%3Dt; path=/; HttpOnly; SameSite=Lax"},{"key":"Vary","value":"Origin,Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n    \"response\": {\n        \"transaction\": {\n            \"uid\": 242384340845042,\n            \"number\": \"C62653954275\",\n            \"created_at\": \"22/12/2025 17:06\",\n            \"internal_notes\": \"This is a note\",\n            \"total\": 2.07,\n            \"display_total\": \"€2.07\",\n            \"subtotal\": 1.67,\n            \"display_subtotal\": \"€1.67\",\n            \"vat_total\": 0.4,\n            \"display_vat_total\": \"€0.40\",\n            \"updated_at\": \"22/12/2025 18:13\",\n            \"type\": \"cash_register_transaction\",\n            \"created_by\": \"John Smith\",\n            \"status\": \"completed\",\n            \"prev_status\": null,\n            \"platform_origin\": \"android\",\n            \"display_preauth_total\": null,\n            \"display_vat_total_without_adjustments_tax\": \"€0.40\",\n            \"display_subtotal_with_extra_costs\": \"€1.67\",\n            \"payments\": [\n                {\n                    \"uid\": 76095438692441,\n                    \"amount\": \"€2.07\",\n                    \"amount_value\": 2.07,\n                    \"payment_method\": \"ReactiveCore::PosCash\",\n                    \"payment_method_title\": \"POS Cash\",\n                    \"transaction_code\": null,\n                    \"response_code\": null,\n                    \"created_at\": \"22/12/2025 17:06\",\n                    \"state\": \"completed\",\n                    \"entity_origin\": null,\n                    \"invoicing_key\": \"cash\",\n                    \"created_at_unformatted\": \"2025-12-22T15:06:28.000Z\"\n                }\n            ],\n            \"line_items\": [\n                {\n                    \"uid\": 546006941057059,\n                    \"transaction_uid\": 242384340845042,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.39\",\n                    \"display_total\": \"€2\",\n                    \"total\": 2,\n                    \"tax\": 0.39,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Είδος\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                },\n                {\n                    \"uid\": 936170392713449,\n                    \"transaction_uid\": 242384340845042,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.01\",\n                    \"display_total\": \"€0.07\",\n                    \"total\": 0.07,\n                    \"tax\": 0.01,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Περιβαλλοντικό τέλος & πλαστικής σακούλας\",\n                    \"mydata_classification_category\": \"category1_95\",\n                    \"vat_exemption_category\": null\n                }\n            ]\n        }\n    }\n}"},{"id":"e9d537ef-f7c2-40dc-9645-801432a4f39c","name":"Complete with POSsible payment","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"entity_uid\": 38138366214518,\n    \"success\": true,\n    \"data\": \"{\\\"operation\\\":\\\"SALE\\\",\\\"version\\\":1,\\\"requestId\\\":\\\"353019440028696\\\",\\\"terminalSN\\\":\\\"1851386854\\\",\\\"result\\\":\\\"000\\\",\\\"resultDescription\\\":\\\"Approved\\\",\\\"data\\\":{\\\"uuid\\\":\\\"002383967377214147601007053\\\",\\\"createdTime\\\":1768901888,\\\"cardData\\\":{\\\"captureType\\\":\\\"CONTACTLESS\\\",\\\"bin\\\":\\\"467459\\\",\\\"aid\\\":\\\"A0000000031010\\\",\\\"type\\\":\\\"VISA\\\",\\\"receiptCardType\\\":\\\"Visa Debit\\\",\\\"holderName\\\":\\\"\\\",\\\"maskedPan\\\":\\\"4674 59** **** 5678\\\",\\\"expDate\\\":\\\"2912\\\"},\\\"transactionData\\\":{\\\"type\\\":\\\"SALE\\\",\\\"finalCode\\\":\\\"PP1\\\",\\\"amount\\\":500,\\\"tip\\\":0,\\\"totalAmount\\\":500,\\\"installments\\\":0,\\\"batchNo\\\":7,\\\"sequenceNo\\\":53,\\\"referenceNo\\\":\\\"007053\\\",\\\"authorizationCode\\\":\\\"320257\\\",\\\"bankId\\\":\\\"017\\\",\\\"cryptogram\\\":\\\"0C581782370B3843\\\",\\\"isReconciled\\\":false,\\\"reconciledTime\\\":0,\\\"isCancelled\\\":false,\\\"isRefunded\\\":false,\\\"loyaltyData\\\":{}},\\\"merchantData\\\":{\\\"mid\\\":\\\"0023839673\\\",\\\"tid\\\":\\\"77214147\\\",\\\"name\\\":\\\"merchant Test.\\\",\\\"address\\\":\\\"Mesogeion 44-46 N.psyxiko\\\",\\\"city\\\":\\\"HRAKLEION\\\",\\\"postCode\\\":\\\"14121\\\",\\\"country\\\":\\\"\\\",\\\"phone\\\":\\\"2106100670\\\"},\\\"applicationData\\\":{\\\"appVersion\\\":\\\"8.6.1\\\"},\\\"aade\\\":{\\\"acquirerId\\\":\\\"103\\\",\\\"batchNo\\\":7,\\\"sequenceNo\\\":53,\\\"approvalCode\\\":\\\"320257\\\",\\\"transactionId\\\":\\\"tr2;103;000007;000053;320257\\\",\\\"provider\\\":{\\\"id\\\":6,\\\"dataToSign\\\":\\\"C8189C6F135582F992C743F165169644EB5D6C98;;20260120113751;403;97;500;500;77214147\\\",\\\"signature\\\":\\\"MEQCIF73fBMSfAjkHuX3rQLz4ot85srNghzVqTJbSTTXTsa9AiAl3YObAQK8wOUn225nsePHwFd1fZRC8Kbgzlba4vZmpQ==\\\"}}}}\",\n    \"payment_method\": \"possible\",\n    \"locale\": \"el\",\n    \"store_uid\": \"652657706192564\"\n}","options":{"raw":{"language":"json"}}},"url":"/admapi/v2/cash_register_transactions/{{transaction_uid}}/complete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Cache-Control","value":"no-store, must-revalidate, private, max-age=0"},{"key":"X-Request-Id","value":"a7f5e83e-540f-4c15-a54f-ceb37a13802b"},{"key":"X-Runtime","value":"1.043578"},{"key":"Server-Timing","value":"sql.active_record;dur=327.39, instantiation.active_record;dur=22.02, start_processing.action_controller;dur=1.95, cache_read.active_support;dur=10.30, cache_fetch_hit.active_support;dur=0.00, start_transaction.active_record;dur=0.01, transaction.active_record;dur=124.16, cache_generate.active_support;dur=16.37, cache_write.active_support;dur=0.48, render.active_model_serializers;dur=0.64, process_action.action_controller;dur=754.32"},{"key":"X-MiniProfiler-Original-Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-MiniProfiler-Ids","value":"1stxth76wf3mjnwdvfzj,yzlqf2xgv7nzb84foquk,dnlcyumdgkb9gwp7lg1s,s6uskz3sjo8yyelqrs3k,idqfmgml0pncrld99fs7,j1g8qam7gv7q7xtcps9b,snzwy74s0bpnp5w9lt8k,maksrm4i99ihwmsvrcxw,5xuc7x9jhgd5oquz5awp,9cmzwdp03d5oku1zt0bn,g1hlmwb7x7ftad04a0wf,7we28tkmf3l9h1w9bfgu,vq71pxn3nlqm5j9p2o6w,1ch3f7zmjcwvl2bwqydi,u8kbs1but5dqtmb68tst,8j4u9jtxnvc2vsc3yhfn,y0izh7ytjfjpnj8dceq6,ijpgjuk25c1p2ekccd9o,w9ohm84ou4pz11ur5du4,pt6zptsfncr2ull1cwrg"},{"key":"Set-Cookie","value":"__profilin=p%3Dt; path=/; HttpOnly; SameSite=Lax"},{"key":"Vary","value":"Origin,Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n    \"response\": {\n        \"transaction\": {\n            \"uid\": 38138366214518,\n            \"number\": \"C05728198241\",\n            \"created_at\": \"20/01/2026 11:37\",\n            \"internal_notes\": null,\n            \"total\": 5,\n            \"display_total\": \"€5\",\n            \"subtotal\": 4.03,\n            \"display_subtotal\": \"€4.03\",\n            \"vat_total\": 0.97,\n            \"display_vat_total\": \"€0.97\",\n            \"updated_at\": \"20/01/2026 11:38\",\n            \"type\": \"cash_register_transaction\",\n            \"created_by\": \"John Smith\",\n            \"status\": \"completed\",\n            \"prev_status\": null,\n            \"platform_origin\": \"pax\",\n            \"display_preauth_total\": null,\n            \"display_vat_total_without_adjustments_tax\": \"€0.97\",\n            \"display_subtotal_with_extra_costs\": \"€4.03\",\n            \"payments\": [\n                {\n                    \"uid\": 353019440028696,\n                    \"amount\": \"€5\",\n                    \"amount_value\": 5,\n                    \"payment_method\": \"ReactiveCore::Possible\",\n                    \"payment_method_title\": \"Cardlink POSsible\",\n                    \"transaction_code\": \"002383967377214147601007053\",\n                    \"response_code\": null,\n                    \"created_at\": \"20/01/2026 09:37\",\n                    \"state\": \"completed\",\n                    \"entity_origin\": null,\n                    \"invoicing_key\": \"card\",\n                    \"rrn\": \"007053\",\n                    \"terminal_id\": \"77214147\",\n                    \"card_issuer\": \"VISA\",\n                    \"card_mask\": \"4674 59** **** 5678\",\n                    \"bank_id\": \"017\",\n                    \"installments\": 0,\n                    \"created_at_unformatted\": \"2026-01-20T09:37:52.000Z\"\n                }\n            ],\n            \"line_items\": [\n                {\n                    \"uid\": 618174143870628,\n                    \"transaction_uid\": 38138366214518,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.97\",\n                    \"display_total\": \"€5\",\n                    \"total\": 5,\n                    \"tax\": 0.97,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Είδος\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                }\n            ]\n        }\n    }\n}"}],"_postman_id":"e67221c8-3b50-4765-bb15-4944afff64cc"},{"name":"Issue Tax Document","id":"4bb3cbc0-6bab-41ef-96ab-34753efba7d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n   \"entity_uid\": 438191741392179,\n   \"entity_type\": \"ReactiveCore::CashRegisterTransaction\",\n   \"document_type\": \"invoice\",\n   \"locale\": \"el\",\n   \"counterpart_data\": {\n      \"company_name\": \"Test Company\",\n      \"vat\": \"7070770\",\n      \"street\": \"Test\",\n      \"street_number\": \"15\",\n      \"city\": \"Test\",\n      \"postal_code\": \"14444\",\n      \"phone\": \"2109999999\",\n      \"country\": \"GR\"\n   },\n   \"document_specified_type\": \"services\"\n}\n"},"url":"/admapi/v2/entity_invoices","description":"Issue an Invoice
\nIssues an Invoice for the transaction. Sends transaction data to the invoicing provider which issues the relative tax document to the AADE platform.
\nParameters
\n
\nentity_uid bigint *Required
\nThe unique identifier of the transaction
\n
\nentity_type string *Required
\nThe object type of the transaction
\nPossible values:
\nReactiveCore::CashRegisterTransaction
\n
\ndocument_type string *Required
\nAlong with the document_specified_type field indicates the document code sent to the invoicing provider
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nPossible values
receipt  
Used for B2C transactions
invoice  
Used for B2B transactions
\n
\ndocument_specified_type string *Required
\nAlong with the document_type field indicates the document code sent to the invoicing provider
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nPossible values
products  
Retail transactions of goods
services  
Provision of services
\n
\nlocale string
\nThe current language of the application
\n
\ncounterpart_data object
\nContains the required information for the counterpart side of the transaction. Required when document_type is invoice
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nChild attributes
counterpart_data.company_name string *Required  
The registered company name of the counterpart
counterpart_data.vat string *Required  
The VAT number of the counterpart's company
counterpart_data.street string *Required  
The counterpart's address' street
counterpart_data.street_number string *Required  
The counterpart's address' street number
counterpart_data.city string *Required  
The counterpart's address' city
counterpart_data.postal_code string *Required  
The counterpart's address' postal code
counterpart_data.phone string *Required  
The counterpart's phone number
counterpart_data.country string *Required  
The alpha2_code of the counterpart's country
\n
Responses
\n
\n200 OK
\ninvoice Invoice object
\nThe issued invoice object
\n
\nerrors nullable string
\nError messages returned from the invoicing provider
\n
\n401 Unauthorized
\nHTTP/1.1 401 Unauthorized
\n
\n422 Unprocessable Entity
\ncode string
\nA distinctive error code
\n
\nmessage string
\nA user-friendly error message
\n
\nstatus integer
\nThe status code of the request
\n
\n500 An internal error occured
\nHTTP/1.1 500 Internal Server Error
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}},"urlObject":{"path":["admapi","v2","entity_invoices"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"478e048f-da39-45bd-84fc-de60b7279c72","name":"Receipt","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n   \"entity_uid\": 242384340845042,\n   \"entity_type\": \"ReactiveCore::CashRegisterTransaction\",\n   \"document_type\": \"receipt\",\n   \"locale\": \"el\",\n   \"document_specified_type\": \"products\"\n}\n"},"url":"/admapi/v2/entity_invoices"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-bullet-footer-text","value":"[\"user: root  AVOID eager loading detected    ReactiveCore::CashRegisterTransactionLineItem => [:cash_register_transaction]\\n  Remove from your query: .includes([:cash_register_transaction])\"]"},{"key":"X-bullet-console-text","value":"[\"user: root\\nAVOID eager loading detected\\n  ReactiveCore::CashRegisterTransactionLineItem => [:cash_register_transaction]\\n  Remove from your query: .includes([:cash_register_transaction])\\nCall stack\\n\\n\"]"},{"key":"Cache-Control","value":"no-store, must-revalidate, private, max-age=0"},{"key":"X-Request-Id","value":"e974e609-3906-4d57-a432-5ef1f5970aee"},{"key":"X-Runtime","value":"3.643517"},{"key":"Server-Timing","value":"sql.active_record;dur=870.64, instantiation.active_record;dur=445.31, start_processing.action_controller;dur=0.63, cache_read.active_support;dur=48.54, cache_fetch_hit.active_support;dur=0.01, start_transaction.active_record;dur=0.02, enqueue.active_job;dur=32.11, transaction.active_record;dur=1345.78, render.active_model_serializers;dur=0.32, process_action.action_controller;dur=3357.63"},{"key":"X-MiniProfiler-Original-Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-MiniProfiler-Ids","value":"t8g2ku7ekpqeu80tb0us,n0bc2h8y35tyiv58iw4d,d09irxpnev3buad3ttdh,m6svnz4jazmtbbtvz5pe,lgvz751f7x40z2uc42fx,egq57h8r9wkp62hkvrkj,5t6t553bdsiu7qgk1o9y,c0j4utcaaeq1svq7bvv8,mczevpdsuwa5ejfwvmto,548j1qjus8yevm1ul0b1,9w812dkhzvm07tt7u6xi,pxos828hluacrlxfsq2f,rnnsoal2w6ct0mk81ihq,t7do6v1hfin5pvgdpb1z,gz2qyciyr8fk5nk42nfh,8rvxwczjw3ijre1o7cqi,ugo3ttk8fivlxg2c0g9,2nxu7o3o3vl3l7n49vmv,kyrdf9lxbin579ko8her,7pu40qyzxri2i4o2fdmf"},{"key":"Set-Cookie","value":"__profilin=p%3Dt; path=/; HttpOnly; SameSite=Lax"},{"key":"Vary","value":"Origin,Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n    \"response\": {\n        \"invoice\": {\n            \"id\": 1649,\n            \"apiUid\": 636651734383774,\n            \"uid\": \"52BEE19CEA19111E9F8E70987D878B7E92762A56\",\n            \"mark\": \"400001958428741\",\n            \"number\": 1086,\n            \"authenticationCode\": \"E59F46C4FA5F5B35B2D8832228FDD48FC7E80D0D\",\n            \"iviewUrl\": \"https://sandbox.iview.gr/EL801169211-207-52BEE19CEA19111E9F8E70987D878B7E92762A56\",\n            \"hasError\": false,\n            \"errorCode\": null,\n            \"issueDate\": \"2025-12-23T10:23:38.000Z\",\n            \"items\": [\n                {\n                    \"uid\": 546006941057059,\n                    \"transaction_uid\": 242384340845042,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.39\",\n                    \"display_total\": \"€2\",\n                    \"total\": 2,\n                    \"tax\": 0.39,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Good(s)\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                },\n                {\n                    \"uid\": 936170392713449,\n                    \"transaction_uid\": 242384340845042,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.01\",\n                    \"display_total\": \"€0.07\",\n                    \"total\": 0.07,\n                    \"tax\": 0.01,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Περιβαλλοντικό τέλος & πλαστικής σακούλας\",\n                    \"mydata_classification_category\": \"category1_95\",\n                    \"vat_exemption_category\": null\n                }\n            ],\n            \"invoiceType\": \"receipt\",\n            \"cancelled\": false,\n            \"counterpartData\": null,\n            \"netTotal\": \"€1.67\",\n            \"vatTotal\": \"€0.40\",\n            \"total\": \"€2.07\",\n            \"documentType\": \"products\",\n            \"documentForm\": \"basic\"\n        },\n        \"errors\": null\n    }\n}"},{"id":"9ffd20db-642f-49aa-a3d1-992056497b07","name":"Transmission failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n   \"entity_uid\": 438191741392179,\n   \"entity_type\": \"ReactiveCore::CashRegisterTransaction\",\n   \"document_type\": \"invoice\",\n   \"locale\": \"el\",\n   \"counterpart_data\": {\n      \"company_name\": \"Test Company\",\n      \"vat\": \"7070770\",\n      \"street\": \"Test\",\n      \"street_number\": \"15\",\n      \"city\": \"Test\",\n      \"postal_code\": \"14444\",\n      \"phone\": \"2109999999\",\n      \"country\": \"GR\"\n   },\n   \"document_specified_type\": \"services\"\n}\n"},"url":"/admapi/v2/entity_invoices"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":null,"header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Cache-Control","value":"no-cache"},{"key":"X-Request-Id","value":"9d80e46b-7202-43f5-be19-a324c2d156e0"},{"key":"X-Runtime","value":"0.764038"},{"key":"Server-Timing","value":"sql.active_record;dur=284.75, instantiation.active_record;dur=11.40, start_processing.action_controller;dur=0.16, cache_read.active_support;dur=15.21, cache_fetch_hit.active_support;dur=0.01, render.active_model_serializers;dur=0.11, process_action.action_controller;dur=441.60"},{"key":"Set-Cookie","value":"__profilin=p%3Dt; path=/; HttpOnly; SameSite=Lax"},{"key":"Vary","value":"Origin,Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"transmission_failure\",\n        \"message\": \"\"\n    }\n}"}],"_postman_id":"4bb3cbc0-6bab-41ef-96ab-34753efba7d8"}],"id":"854b58ec-b49d-4307-85ef-34bc5b9eafa6","description":"The Transaction Object
\nA Transaction represents the entity of a complete interaction between your merchant store and the client
\n{\n   \"uid\":250520004452016,\n   \"number\":\"C46232817621\",\n   \"created_at\":\"15/12/2025 15:17\",\n   \"internal_notes\":null,\n   \"total\":200.0,\n   \"display_total\":\"€200\",\n   \"subtotal\":161.29,\n   \"display_subtotal\":\"€161.29\",\n   \"vat_total\":38.71,\n   \"display_vat_total\":\"€38.71\",\n   \"updated_at\":\"15/12/2025 15:17\",\n   \"type\":\"cash_register_transaction\",\n   \"created_by\":\"Test Employee\",\n   \"status\":\"completed\",\n   \"prev_status\":null,\n   \"platform_origin\":\"pax\",\n   \"display_preauth_total\":null,\n   \"display_vat_total_without_adjustments_tax\":\"€38.71\",\n   \"display_subtotal_with_extra_costs\":\"€161.29\",\n   \"payments\":[\n      {\n         \"uid\":662326075769565,\n         \"amount\":\"€200\",\n         \"amount_value\":200.0,\n         \"payment_method\":\"ReactiveCore::Possible\",\n         \"payment_method_title\":\"Cardlink POSsible\",\n         \"transaction_code\":\"002383967377700006512032006\",\n         \"response_code\":null,\n         \"created_at\":\"15/12/2025 15:17\",\n         \"state\":\"completed\",\n         \"entity_origin\":null,\n         \"invoicing_key\":\"card\",\n         \"rrn\":null,\n         \"terminal_id\":null,\n         \"card_issuer\":null,\n         \"card_mask\":null,\n         \"bank_id\":null,\n         \"installments\":null,\n         \"created_at_unformatted\":\"2025-12-15T13:17:28.000Z\"\n      }\n   ],\n   \"line_items\":[\n      {\n         \"uid\":557183743503232,\n         \"transaction_uid\":250520004452016,\n         \"quantity\":1,\n         \"display_tax\":\"€38.71\",\n         \"display_total\":\"€200\",\n         \"total\":200.0,\n         \"tax\":38.71,\n         \"tax_rate\":\"0.24\",\n         \"custom_tax\":\"0.24\",\n         \"type\":\"cash_register_transaction_line_item\",\n         \"title\":\"Good(s)\",\n         \"mydata_classification_category\":\"category1_2\",\n         \"vat_exemption_category\":null\n      }\n   ]\n}\n\n
\nAttributes
\n
\nuid number
\nUnique identifier for the object
\n
\nnumber string
\nA unique for the object 12-digit alphanumeric that starts with the prefix C
\n
\ncreated_at string
\nThe date and time the object was created
\n
\ninternal_notes nullable string
\nAn arbitrary string attached to the object. Often useful for adding extra notes for the invoicing provider
\n
\ntotal decimal
\nThe total amount of the transaction
\n
\ndisplay_total string
\nThe total amount of the transaction prefixed with the transaction currency symbol for display purposes
\n
\nsubtotal decimal
\nThe net amount of the transaction
\n
\ndisplay_subtotal string
\nThe net amount of the transaction prefixed with the transaction currency symbol for display purposes
\n
\nvat_total decimal
\nThe vat amount of the transaction
\n
\ndisplay_vat_total string
\nThe vat amount of the transaction prefixed with the transaction currency symbol for display purposes
\n
\nupdated_at nullable string
\nThe date and time the object was last updated
\n
\ntype string
\nThe type of the object. Represents an underscore version of the object name
\n
\ncreated_by nullable string
\nThe employee name that created the transaction
\n
\nstatus enum
\nIndicates in what status the transaction currently is
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nPossible enum values
checkout  
Use checkout when the transaction is initially created and before a payment is made
completed  
Use completed when the transaction payment has been successfully settled
failed  
Use failed when the transaction payment fails for any reason
cancelled  
Use cancelled when the previously completed transaction payment has been refunded
authorized  
Use authorized when the transaction amount has been preauthorized for future capture
on_credit  
Use on_credit when the transaction shall be settled in a later stage
\n
\nprev_status nullable enum
\nIndicates a status that was previously applied to the transaction and needs to be remembered, i.e for an authorized transaction that gets captured and eventually gets marked as completed, we keep authorized as the prev_status value to indicate that this was a preauth transaction
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nPossible enum values
authorized
on_credit
\n
\nplatform_origin nullable enum
\nIndicates the platform from which the transaction was made
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nPossible enum values
android  
Any Android device
ios  
Any iOS device
pax  
Any PAX POS terminal
pos_terminal  
Any POS terminal
api  
Created using API request
web  
Created from the website
admin  
Created from the administrator panel
\n
\ndisplay_preauth_total nullable string
\nThe preauthorized amount of the transaction prefixed with the transaction currency symbol for display purposes. Populated only when the transaction has status or prev_status of authorized
\n
\ndisplay_vat_total_without_adjustments_tax nullable string
\nThe vat amount of the transaction, without any adjustments or discounts, prefixed with the transaction currency symbol for display purposes
\n
\ndisplay_subtotal_with_extra_costs string
\nThe net amount of the transaction, including any extra cost that may apply, prefixed with the transaction currency symbol for display purposes
\n
\npayments array of objects
\nThe payments associated with this transaction
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nChild attributes
payments.uid bigint  
Unique identifier for the object
payments.amount string  
The total amount of the payment prefixed with the transaction currency symbol for display purposes
payments.amount_value decimal  
The total amount of the payment
payments.payment_method string  
The payment method of the payment
payments.payment_method_title string  
A user-friendly description for the payment method
payments.transaction_code nullable string  
The transaction ID of the payment generated from the POS terminal handling the charge, if any and if the payment has been completed successfully
payments.response_code nullable string  
A string respresenting a possible extra description of the result of the payment handling. Usually populated on a payment that has failed
payments.created_at string  
The date and time the object was created
payments.state enum  
Indicates the state in which the payment currently is  
Possible values:  
processing: The payment is currently being processed by the payment provider  
pending: The payment flow has started and a response from the processing terminal is expected  
authorized: The payment amount has been preauthorized for future capture  
completed: The payment flow was completed successfully and the payment has been settled  
failed: The payment flow was unsuccessful or interrupted  
refunded: The payment amount has been returned to the customer successfully
payments.entity_origin nullable string  
Indicates the application flow from where the payment has been initiated
payments.invoicing_key string  
A key representation of the payment's payment method used for invoicing purposes
payments.rrn nullable string  
A unique identifier assigned from the processing POS terminal
payments.terminal_id nullable string  
The unique identifier of the processing POS terminal
payments.card_issuer nullable string  
The issuer of the card in case of a card payment
payments.card_mask nullable string  
The pan mask of the card hidden with asterisks in case of a card payment
payments.bank_id nullable string  
The unique identifier of the card's bank in case of a card payment
payments.installments nullable string  
The number of installments for the payment
payments.created_at_unformatted string  
The date and time the object was created in ISO-8601 format
\n
\nline_items array of objects
\nThe items that are included in the transaction
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nChild attributes
line_items.uid bigint  
The unique identifier of the line item
line_items.transaction_uid bigint  
The unique identifier of the transaction the line item belongs to
line_items.quantity integer  
The quantity of the item
line_items.display_tax string  
The vat amount of the item prefixed with the transaction's currency for display purposes
line_items.display_total string  
The total amount of the item prefixed with the transaction's currency for display purposes
line_items.total decimal  
The total amount of the item
line_items.tax decimal  
The vat amount of the item
line_items.tax_rate string  
The tax rate of the item
line_items.custom_tax string  
The tax rate of the item
line_items.type string  
The type of the item
line_items.title string  
The user-friendly name of the item
line_items.mydata_classification_category string  
The classification category of revenues as stated in the myData platform. Used for invoicing purposes
line_items.vat_exemption_category nullable string  
The vat exemption category of the item as stated in the myData platform. Used for invoicing purposes
\n
The Invoice object
\nAn Invoice represents the tax document issued to the invoicing provider for a specific Transaction
\n{\n   \"id\":1649,\n   \"apiUid\":636651734383774,\n   \"uid\":\"52BEE19CEA19111E9F8E70987D878B7E92762A56\",\n   \"mark\":\"400001958428741\",\n   \"number\":1086,\n   \"authenticationCode\":\"E59F46C4FA5F5B35B2D8832228FDD48FC7E80D0D\",\n   \"iviewUrl\":\"https://sandbox.iview.gr/EL801169211-207-52BEE19CEA19111E9F8E70987D878B7E92762A56\",\n   \"hasError\":false,\n   \"errorCode\":null,\n   \"issueDate\":\"2025-12-23T10:23:38.000Z\",\n   \"items\":[\n      {\n         \"uid\":546006941057059,\n         \"transaction_uid\":242384340845042,\n         \"quantity\":1,\n         \"display_tax\":\"€0.39\",\n         \"display_total\":\"€2\",\n         \"total\":2.0,\n         \"tax\":0.39,\n         \"tax_rate\":\"0.24\",\n         \"custom_tax\":\"0.24\",\n         \"type\":\"cash_register_transaction_line_item\",\n         \"title\":\"Good(s)\",\n         \"mydata_classification_category\":\"category1_2\",\n         \"vat_exemption_category\":null\n      },\n      {\n         \"uid\":936170392713449,\n         \"transaction_uid\":242384340845042,\n         \"quantity\":1,\n         \"display_tax\":\"€0.01\",\n         \"display_total\":\"€0.07\",\n         \"total\":0.07,\n         \"tax\":0.01,\n         \"tax_rate\":\"0.24\",\n         \"custom_tax\":\"0.24\",\n         \"type\":\"cash_register_transaction_line_item\",\n         \"title\":\"Περιβαλλοντικό τέλος & πλαστικής σακούλας\",\n         \"mydata_classification_category\":\"category1_95\",\n         \"vat_exemption_category\":null\n      }\n   ],\n   \"invoiceType\":\"receipt\",\n   \"cancelled\":false,\n   \"counterpartData\":null,\n   \"netTotal\":\"€1.67\",\n   \"vatTotal\":\"€0.40\",\n   \"total\":\"€2.07\",\n   \"documentType\":\"products\",\n   \"documentForm\":\"basic\"\n}\n\n
\nAttributes
\n
\nid integer
\nThe unique identifier of the invoice
\n
\napiUid bigint
\nA random unique identifier of the invoice
\n
\nuid string
\nA random unique identifier of the invoice assigned by the invoicing provider
\n
\nmark string
\nA unique alphanumeric associated with the invoice assigned by the invoicing provider
\n
\nnumber integer
\nThe sequential number of the invoice
\n
\nauthenticationCode string
\nA unique alphanumeric associated with the invoice assigned by the invoicing provider
\n
\niviewUrl string
\nThe url of the invoice on the invoicing provider's platform
\n
\nhasError boolean
\nIndicates whether the invoice has been issued successfully
\n
\nerrorCode integer
\nThe error code returned from the invoicing provider in case the invoice fails to be issued
\n
\nissueDate string
\nThe date and time the invoice was issued in ISO-8601 format
\n
\ninvoiceType enum
\nAlong with the documentType field indicates the document code sent to the invoicing provider
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nPossible enum values
receipt  
Used for B2C transactions
invoice  
Used for B2B transactions
local_tax_receipt  
Used for local taxes in case of B2C hotel bookings
local_tax_invoice  
Used for local taxes in case of B2B hotel bookings
credit_receipt  
Used for refunded B2C transactions
credit_invoice  
Used for refunded B2B transactions
credit_invoice_rel  
Used for refunded B2B transactions with a relative invoice
preauth_receipt  
Used for preauthorized B2C transactions
preauth_invoice  
Used for preauthorized B2B transactions
\n
\ncancelled boolean
\nIndicates whether the transaction this document refers to has been cancelled and a relative credit document has been issued
\n
\nnetTotal string
\nThe net amount of the invoice prefixed with the transaction currency symbol for display purposes
\n
\nvatTotal string
\nThe vat amount of the invoice prefixed with the transaction currency symbol for display purposes
\n
\ntotal string
\nThe total amount of the invoice prefixed with the transaction currency symbol for display purposes
\n
\ndocumentType enum
\nAlong with the invoiceType field indicates the document code sent to the invoicing provider
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nPossible enum values
products  
The document refers to retail transactions of goods
services  
The document refers to provision of services
\n
\ndocumentForm string
\nUsed to specify on_credit invoices
\nPossible values:
\n\nbasic: Normal settled invoice
\n
\non_credit: On credit invoice to be settled in the future
\n
\n
\n
\nitems array of objects
\nThe items that are included in this invoice
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nChild attributes
items.uid bigint  
The unique identifier of the item
items.transaction_uid bigint  
The unique identifier of the transaction the item belongs to
items.quantity integer  
The quantity of the item
items.display_tax string  
The vat amount of the item prefixed with the transaction currency symbol for display purposes
items.display_total string  
The total amount of the item prefixed with the transaction currency symbol for display purposes
items.total decimal  
The total amount of the item
items.tax decimal  
The vat amount of the item
items.tax_rate string  
The tax rate of the item as a fraction of 1
items.custom_tax string  
The tax rate of the item as a fraction of 1
items.type string  
The type of the item. Usually is the underscore representation of the object's class
items.title string  
A user-friendly title for the item
items.mydata_classification_category string  
The classification category of revenues as stated in the myData platform. Used for invoicing purposes
items.vat_exemption_category nullable string  
The vat exemption category of the item as stated in the myData platform. Used for invoicing purposes
\n
\ncounterpartData nullable object
\nThe attributes of the counterpart side in case of B2B transactions
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nChild attributes
counterpartData.company_name string *Required  
The registered company name of the counterpart
counterpartData.vat string *Required  
The VAT number of the counterpart's company
counterpartData.street string *Required  
The counterpart's address' street
counterpartData.street_number string *Required  
The counterpart's address' street number
counterpartData.city string *Required  
The counterpart's address' city
counterpartData.postal_code string *Required  
The counterpart's address' postal code
counterpartData.phone string *Required  
The counterpart's phone number
counterpartData.country string *Required  
The alpha2_code of the counterpart's country
\n
","_postman_id":"854b58ec-b49d-4307-85ef-34bc5b9eafa6","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","id":"fef0cbc8-6b7e-4edc-91d6-3457c7b9af5b","name":"API Documentation","type":"collection"}}},{"name":"Unattended endpoints","item":[{"name":"Issue token","id":"af899595-edd6-4329-8f83-6b8f93991b9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"","type":"text","uuid":"1082afb1-9c03-478d-afbf-3ea219c498b2"},{"key":"client_secret","value":"","type":"text","uuid":"c0367549-514f-4677-a99f-ccdc086a9d6b"},{"key":"grant_type","value":"client_credentials","type":"text","uuid":"872679ec-9e0e-4070-a3f2-3fd189104256"}]},"url":"/unattended_api/oauth/token","urlObject":{"path":["unattended_api","oauth","token"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"b41cf4a8-2ac5-4a63-b81e-e79034ce102e","name":"Issue token","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"","type":"text","uuid":"1082afb1-9c03-478d-afbf-3ea219c498b2"},{"key":"client_secret","value":"","type":"text","uuid":"c0367549-514f-4677-a99f-ccdc086a9d6b"},{"key":"grant_type","value":"client_credentials","type":"text","uuid":"872679ec-9e0e-4070-a3f2-3fd189104256"}]},"url":"/unattended_api/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n    \"access_token\": \"kIeMWMH9xeNThKKnGkfRiAp0J_Xd1yEEJZiCzw9yHh8\",\n    \"token_type\": \"Bearer\",\n    \"expires_in\": 7200,\n    \"scope\": \"read write\",\n    \"created_at\": 1769462129\n}"}],"_postman_id":"af899595-edd6-4329-8f83-6b8f93991b9d"},{"name":"Create","id":"9e0ea2d1-8e84-49f9-a07a-8357fe2d4500","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/unattended_api/v1/cash_register_transactions","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"e5c3cd1c-b468-4793-a1a2-32b6d5cd7020","id":"e5c3cd1c-b468-4793-a1a2-32b6d5cd7020","name":"Unattended endpoints","type":"folder"}},"urlObject":{"path":["unattended_api","v1","cash_register_transactions"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"c2ea090f-3124-47b4-9692-3979ca44d28f","name":"Create with cash","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n   \"tenant_uid\": 408704986590812,\n   \"line_items\":[\n      {\n         \"unit_price\":1.61,\n         \"unit_tax\":0.39,\n         \"quantity\":1,\n         \"tax_rate\":0.24,\n         \"title\":null,\n         \"mydata_classification_category\":\"category1_2\"\n      },\n      {\n         \"unit_price\":0.06,\n         \"unit_tax\":0.01,\n         \"quantity\":1,\n         \"tax_rate\":0.24,\n         \"title\":null,\n         \"mydata_classification_category\":\"category1_2\"\n      }\n   ],\n   \"terminal_id\": \"77700006\",\n   \"total_price\":2.07,\n   \"locale\":\"el\",\n   \"payment_method\":\"cash\",\n   \"document_type\":\"receipt\",\n   \"document_specified_type\":\"products\",\n   \"store_uid\":\"652657706192564\"\n}","options":{"raw":{"language":"json"}}},"url":"/unattended_api/v1/cash_register_transactions"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"response\": {\n        \"transaction\": {\n            \"uid\": 150500944813654,\n            \"number\": \"C76202874815\",\n            \"created_at\": \"23/01/2026 16:19\",\n            \"internal_notes\": null,\n            \"total\": 2.07,\n            \"display_total\": \"€2.07\",\n            \"subtotal\": 1.67,\n            \"display_subtotal\": \"€1.67\",\n            \"vat_total\": 0.4,\n            \"display_vat_total\": \"€0.40\",\n            \"updated_at\": \"23/01/2026 16:19\",\n            \"type\": \"cash_register_transaction\",\n            \"created_by\": \"77700006\",\n            \"status\": \"checkout\",\n            \"prev_status\": null,\n            \"platform_origin\": null,\n            \"display_preauth_total\": null,\n            \"display_vat_total_without_adjustments_tax\": \"€0.40\",\n            \"display_subtotal_with_extra_costs\": \"€1.67\",\n            \"payments\": [\n                {\n                    \"uid\": 909468982250858,\n                    \"amount\": \"€2.07\",\n                    \"amount_value\": 2.07,\n                    \"payment_method\": \"ReactiveCore::PosCash\",\n                    \"payment_method_title\": \"POS Cash\",\n                    \"transaction_code\": null,\n                    \"response_code\": null,\n                    \"created_at\": \"23/01/2026 16:19\",\n                    \"state\": \"pending\",\n                    \"entity_origin\": null,\n                    \"invoicing_key\": \"cash\",\n                    \"created_at_unformatted\": \"2026-01-23T14:19:43.000Z\"\n                }\n            ],\n            \"line_items\": [\n                {\n                    \"uid\": 10423516371557,\n                    \"transaction_uid\": 150500944813654,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.39\",\n                    \"display_total\": \"€2\",\n                    \"total\": 2,\n                    \"tax\": 0.39,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Good(s)\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                },\n                {\n                    \"uid\": 830371686422863,\n                    \"transaction_uid\": 150500944813654,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.01\",\n                    \"display_total\": \"€0.07\",\n                    \"total\": 0.07,\n                    \"tax\": 0.01,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Good(s)\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                }\n            ]\n        },\n        \"paymentUid\": 909468982250858,\n        \"paymentToken\": null,\n        \"signature\": null\n    }\n}"},{"id":"114722c2-3860-4013-a7d8-28999421fcc5","name":"Create with POSsible","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n   \"tenant_uid\": 408704986590812,\n   \"line_items\":[\n      {\n         \"unit_price\":1.61,\n         \"unit_tax\":0.39,\n         \"quantity\":1,\n         \"tax_rate\":0.24,\n         \"title\":null,\n         \"mydata_classification_category\":\"category1_2\"\n      },\n      {\n         \"unit_price\":0.06,\n         \"unit_tax\":0.01,\n         \"quantity\":1,\n         \"tax_rate\":0.24,\n         \"title\":null,\n         \"mydata_classification_category\":\"category1_2\"\n      }\n   ],\n   \"terminal_id\": \"77700006\",\n   \"total_price\":2.07,\n   \"locale\":\"el\",\n   \"payment_method\":\"possible\",\n   \"document_type\":\"receipt\",\n   \"document_specified_type\":\"products\",\n   \"store_uid\":\"652657706192564\"\n}","options":{"raw":{"language":"json"}}},"url":"/unattended_api/v1/cash_register_transactions"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"response\": {\n        \"transaction\": {\n            \"uid\": 745962178242837,\n            \"number\": \"C09247904711\",\n            \"created_at\": \"23/01/2026 16:46\",\n            \"internal_notes\": null,\n            \"total\": 2.07,\n            \"display_total\": \"€2.07\",\n            \"subtotal\": 1.67,\n            \"display_subtotal\": \"€1.67\",\n            \"vat_total\": 0.4,\n            \"display_vat_total\": \"€0.40\",\n            \"updated_at\": \"23/01/2026 16:46\",\n            \"type\": \"cash_register_transaction\",\n            \"created_by\": \"77700006\",\n            \"status\": \"checkout\",\n            \"prev_status\": null,\n            \"platform_origin\": null,\n            \"display_preauth_total\": null,\n            \"display_vat_total_without_adjustments_tax\": \"€0.40\",\n            \"display_subtotal_with_extra_costs\": \"€1.67\",\n            \"payments\": [\n                {\n                    \"uid\": 882370667094267,\n                    \"amount\": \"€2.07\",\n                    \"amount_value\": 2.07,\n                    \"payment_method\": \"ReactiveCore::Possible\",\n                    \"payment_method_title\": \"Cardlink POSsible\",\n                    \"transaction_code\": null,\n                    \"response_code\": null,\n                    \"created_at\": \"23/01/2026 16:46\",\n                    \"state\": \"pending\",\n                    \"entity_origin\": null,\n                    \"invoicing_key\": \"card\",\n                    \"created_at_unformatted\": \"2026-01-23T14:46:38.000Z\"\n                }\n            ],\n            \"line_items\": [\n                {\n                    \"uid\": 662303737871229,\n                    \"transaction_uid\": 745962178242837,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.39\",\n                    \"display_total\": \"€2\",\n                    \"total\": 2,\n                    \"tax\": 0.39,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Good(s)\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                },\n                {\n                    \"uid\": 266770220596808,\n                    \"transaction_uid\": 745962178242837,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.01\",\n                    \"display_total\": \"€0.07\",\n                    \"total\": 0.07,\n                    \"tax\": 0.01,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Good(s)\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                }\n            ]\n        },\n        \"paymentUid\": 882370667094267,\n        \"paymentToken\": null,\n        \"signature\": {\n            \"uid\": 275450676692230,\n            \"uuid\": \"DFD376028BA94742E4E414538786ACA16CBE874F\",\n            \"signature\": \"MEUCIQCiEYEosjAbmS6yGB9EyuxaJ3e38BOTMRlTBtjYl8PQBQIgBImjYG6wZsu0UTH1Nw6OKSfmL21VXa14nX3OGQ/9w3Q=\",\n            \"data\": \"DFD376028BA94742E4E414538786ACA16CBE874F;;20260123164638;167;40;207;207;77700006\",\n            \"timestamp\": \"20260123164638\",\n            \"ordering\": false,\n            \"provider_id\": \"6\"\n        }\n    }\n}"}],"_postman_id":"9e0ea2d1-8e84-49f9-a07a-8357fe2d4500"},{"name":"Complete","id":"0a6213c1-c862-4693-b8ca-0202061069af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/unattended_api/v1/cash_register_transactions/{{transaction_uid}}/complete","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"e5c3cd1c-b468-4793-a1a2-32b6d5cd7020","id":"e5c3cd1c-b468-4793-a1a2-32b6d5cd7020","name":"Unattended endpoints","type":"folder"}},"urlObject":{"path":["unattended_api","v1","cash_register_transactions","{{transaction_uid}}","complete"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"d85448e7-77a2-415c-ac64-ad85b9e784a6","name":"Complete with cash","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"tenant_uid\": 408704986590812,\n    \"payment_method\": \"cash\",\n    \"locale\": \"el\",\n    \"store_uid\": \"652657706192564\",\n    \"document_type\": \"receipt\",\n    \"document_specified_type\": \"products\"\n}","options":{"raw":{"language":"json"}}},"url":"/unattended_api/v1/cash_register_transactions/150500944813654/complete"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"response\": {\n        \"transaction\": {\n            \"uid\": 150500944813654,\n            \"number\": \"C76202874815\",\n            \"created_at\": \"23/01/2026 16:19\",\n            \"internal_notes\": null,\n            \"total\": 2.07,\n            \"display_total\": \"€2.07\",\n            \"subtotal\": 1.67,\n            \"display_subtotal\": \"€1.67\",\n            \"vat_total\": 0.4,\n            \"display_vat_total\": \"€0.40\",\n            \"updated_at\": \"23/01/2026 16:40\",\n            \"type\": \"cash_register_transaction\",\n            \"created_by\": \"77700006\",\n            \"status\": \"completed\",\n            \"prev_status\": null,\n            \"platform_origin\": null,\n            \"display_preauth_total\": null,\n            \"display_vat_total_without_adjustments_tax\": \"€0.40\",\n            \"display_subtotal_with_extra_costs\": \"€1.67\",\n            \"payments\": [\n                {\n                    \"uid\": 909468982250858,\n                    \"amount\": \"€2.07\",\n                    \"amount_value\": 2.07,\n                    \"payment_method\": \"ReactiveCore::PosCash\",\n                    \"payment_method_title\": \"POS Cash\",\n                    \"transaction_code\": null,\n                    \"response_code\": null,\n                    \"created_at\": \"23/01/2026 16:19\",\n                    \"state\": \"completed\",\n                    \"entity_origin\": null,\n                    \"invoicing_key\": \"cash\",\n                    \"created_at_unformatted\": \"2026-01-23T14:19:43.000Z\"\n                }\n            ],\n            \"line_items\": [\n                {\n                    \"uid\": 10423516371557,\n                    \"transaction_uid\": 150500944813654,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.39\",\n                    \"display_total\": \"€2\",\n                    \"total\": 2,\n                    \"tax\": 0.39,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Είδος\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                },\n                {\n                    \"uid\": 830371686422863,\n                    \"transaction_uid\": 150500944813654,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.01\",\n                    \"display_total\": \"€0.07\",\n                    \"total\": 0.07,\n                    \"tax\": 0.01,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Είδος\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                }\n            ]\n        },\n        \"invoice\": {\n            \"id\": 1660,\n            \"apiUid\": 917814641449450,\n            \"uid\": \"3E988AC5CF0EE86B3E962E575B9BB29EF747BFF8\",\n            \"mark\": \"400001959290126\",\n            \"number\": 1094,\n            \"authenticationCode\": \"191EE2B9005699DFD08BC5F63E3B8A23F585AEF2\",\n            \"iviewUrl\": \"https://sandbox.iview.gr/EL801169211-207-3E988AC5CF0EE86B3E962E575B9BB29EF747BFF8\",\n            \"hasError\": false,\n            \"errorCode\": null,\n            \"issueDate\": \"2026-01-23T14:40:52.000Z\",\n            \"items\": [\n                {\n                    \"uid\": 10423516371557,\n                    \"transaction_uid\": 150500944813654,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.39\",\n                    \"display_total\": \"€2\",\n                    \"total\": 2,\n                    \"tax\": 0.39,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Είδος\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                },\n                {\n                    \"uid\": 830371686422863,\n                    \"transaction_uid\": 150500944813654,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.01\",\n                    \"display_total\": \"€0.07\",\n                    \"total\": 0.07,\n                    \"tax\": 0.01,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Είδος\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                }\n            ],\n            \"invoiceType\": \"receipt\",\n            \"cancelled\": false,\n            \"counterpartData\": null,\n            \"netTotal\": \"€1.67\",\n            \"vatTotal\": \"€0.40\",\n            \"total\": \"€2.07\",\n            \"documentType\": \"products\",\n            \"documentForm\": \"basic\"\n        }\n    }\n}"},{"id":"c14447da-a045-4fd2-912b-2ed2d5da8e3f","name":"Complete with POSsible","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"tenant_uid\": 408704986590812,\n    \"payment_method\": \"possible\",\n    \"locale\": \"el\",\n    \"store_uid\": \"652657706192564\",\n    \"document_type\": \"receipt\",\n    \"document_specified_type\": \"products\",\n    \"success\": true,\n    \"data\": \"{\\\"operation\\\":\\\"SALE\\\",\\\"version\\\":1,\\\"requestId\\\":\\\"353019440028696\\\",\\\"terminalSN\\\":\\\"1851386854\\\",\\\"result\\\":\\\"000\\\",\\\"resultDescription\\\":\\\"Approved\\\",\\\"data\\\":{\\\"uuid\\\":\\\"002383967377214147601007053\\\",\\\"createdTime\\\":1768901888,\\\"cardData\\\":{\\\"captureType\\\":\\\"CONTACTLESS\\\",\\\"bin\\\":\\\"467459\\\",\\\"aid\\\":\\\"A0000000031010\\\",\\\"type\\\":\\\"VISA\\\",\\\"receiptCardType\\\":\\\"Visa Debit\\\",\\\"holderName\\\":\\\"\\\",\\\"maskedPan\\\":\\\"4674 59** **** 5678\\\",\\\"expDate\\\":\\\"2912\\\"},\\\"transactionData\\\":{\\\"type\\\":\\\"SALE\\\",\\\"finalCode\\\":\\\"PP1\\\",\\\"amount\\\":500,\\\"tip\\\":0,\\\"totalAmount\\\":500,\\\"installments\\\":0,\\\"batchNo\\\":7,\\\"sequenceNo\\\":53,\\\"referenceNo\\\":\\\"007053\\\",\\\"authorizationCode\\\":\\\"320257\\\",\\\"bankId\\\":\\\"017\\\",\\\"cryptogram\\\":\\\"0C581782370B3843\\\",\\\"isReconciled\\\":false,\\\"reconciledTime\\\":0,\\\"isCancelled\\\":false,\\\"isRefunded\\\":false,\\\"loyaltyData\\\":{}},\\\"merchantData\\\":{\\\"mid\\\":\\\"0023839673\\\",\\\"tid\\\":\\\"77214147\\\",\\\"name\\\":\\\"merchant Test.\\\",\\\"address\\\":\\\"Mesogeion 44-46 N.psyxiko\\\",\\\"city\\\":\\\"HRAKLEION\\\",\\\"postCode\\\":\\\"14121\\\",\\\"country\\\":\\\"\\\",\\\"phone\\\":\\\"2106100670\\\"},\\\"applicationData\\\":{\\\"appVersion\\\":\\\"8.6.1\\\"},\\\"aade\\\":{\\\"acquirerId\\\":\\\"103\\\",\\\"batchNo\\\":7,\\\"sequenceNo\\\":53,\\\"approvalCode\\\":\\\"320257\\\",\\\"transactionId\\\":\\\"tr2;103;000007;000053;320257\\\",\\\"provider\\\":{\\\"id\\\":6,\\\"dataToSign\\\":\\\"C8189C6F135582F992C743F165169644EB5D6C98;;20260120113751;403;97;500;500;77214147\\\",\\\"signature\\\":\\\"MEQCIF73fBMSfAjkHuX3rQLz4ot85srNghzVqTJbSTTXTsa9AiAl3YObAQK8wOUn225nsePHwFd1fZRC8Kbgzlba4vZmpQ==\\\"}}}}\"\n}","options":{"raw":{"language":"json"}}},"url":"/unattended_api/v1/cash_register_transactions/745962178242837/complete"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"response\": {\n        \"transaction\": {\n            \"uid\": 745962178242837,\n            \"number\": \"C09247904711\",\n            \"created_at\": \"23/01/2026 16:46\",\n            \"internal_notes\": null,\n            \"total\": 2.07,\n            \"display_total\": \"€2.07\",\n            \"subtotal\": 1.67,\n            \"display_subtotal\": \"€1.67\",\n            \"vat_total\": 0.4,\n            \"display_vat_total\": \"€0.40\",\n            \"updated_at\": \"23/01/2026 16:49\",\n            \"type\": \"cash_register_transaction\",\n            \"created_by\": \"77700006\",\n            \"status\": \"completed\",\n            \"prev_status\": null,\n            \"platform_origin\": null,\n            \"display_preauth_total\": null,\n            \"display_vat_total_without_adjustments_tax\": \"€0.40\",\n            \"display_subtotal_with_extra_costs\": \"€1.67\",\n            \"payments\": [\n                {\n                    \"uid\": 882370667094267,\n                    \"amount\": \"€2.07\",\n                    \"amount_value\": 2.07,\n                    \"payment_method\": \"ReactiveCore::Possible\",\n                    \"payment_method_title\": \"Cardlink POSsible\",\n                    \"transaction_code\": \"002383967377214147601007053\",\n                    \"response_code\": null,\n                    \"created_at\": \"23/01/2026 16:46\",\n                    \"state\": \"completed\",\n                    \"entity_origin\": null,\n                    \"invoicing_key\": \"card\",\n                    \"rrn\": \"007053\",\n                    \"terminal_id\": \"77214147\",\n                    \"card_issuer\": \"VISA\",\n                    \"card_mask\": \"4674 59** **** 5678\",\n                    \"bank_id\": \"017\",\n                    \"installments\": 0,\n                    \"created_at_unformatted\": \"2026-01-23T14:46:38.000Z\"\n                }\n            ],\n            \"line_items\": [\n                {\n                    \"uid\": 662303737871229,\n                    \"transaction_uid\": 745962178242837,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.39\",\n                    \"display_total\": \"€2\",\n                    \"total\": 2,\n                    \"tax\": 0.39,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Είδος\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                },\n                {\n                    \"uid\": 266770220596808,\n                    \"transaction_uid\": 745962178242837,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.01\",\n                    \"display_total\": \"€0.07\",\n                    \"total\": 0.07,\n                    \"tax\": 0.01,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Είδος\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                }\n            ]\n        },\n        \"invoice\": {\n            \"id\": 1661,\n            \"apiUid\": 200032620718201,\n            \"uid\": \"F2D5639D245E95171CEA3FDD1B9C0B029AB8F48E\",\n            \"mark\": \"400001959290564\",\n            \"number\": 1095,\n            \"authenticationCode\": \"283D1B3F128901288976808BDB099CB748572FB9\",\n            \"iviewUrl\": \"https://sandbox.iview.gr/EL801169211-207-F2D5639D245E95171CEA3FDD1B9C0B029AB8F48E\",\n            \"hasError\": false,\n            \"errorCode\": null,\n            \"issueDate\": \"2026-01-23T14:49:32.000Z\",\n            \"items\": [\n                {\n                    \"uid\": 662303737871229,\n                    \"transaction_uid\": 745962178242837,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.39\",\n                    \"display_total\": \"€2\",\n                    \"total\": 2,\n                    \"tax\": 0.39,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Είδος\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                },\n                {\n                    \"uid\": 266770220596808,\n                    \"transaction_uid\": 745962178242837,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.01\",\n                    \"display_total\": \"€0.07\",\n                    \"total\": 0.07,\n                    \"tax\": 0.01,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Είδος\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                }\n            ],\n            \"invoiceType\": \"receipt\",\n            \"cancelled\": false,\n            \"counterpartData\": null,\n            \"netTotal\": \"€1.67\",\n            \"vatTotal\": \"€0.40\",\n            \"total\": \"€2.07\",\n            \"documentType\": \"products\",\n            \"documentForm\": \"basic\"\n        }\n    }\n}"},{"id":"6fad07fa-1db8-48cb-b53a-d5a9011375f4","name":"Failed with POSsible","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"tenant_uid\": 408704986590812,\n    \"payment_method\": \"possible\",\n    \"locale\": \"el\",\n    \"store_uid\": \"652657706192564\",\n    \"document_type\": \"receipt\",\n    \"document_specified_type\": \"products\",\n    \"success\": false,\n    \"error_log\": \"(30005) User Exit Action\"\n}","options":{"raw":{"language":"json"}}},"url":"/unattended_api/v1/cash_register_transactions/620261130557302/complete"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"transaction_failed\",\n        \"message\": \"\"\n    }\n}"},{"id":"8886eae3-2070-48f3-9908-504324ce7b8f","name":"Failed with cash","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"tenant_uid\": 408704986590812,\n    \"payment_method\": \"cash\",\n    \"locale\": \"el\",\n    \"store_uid\": \"652657706192564\",\n    \"document_type\": \"receipt\",\n    \"document_specified_type\": \"products\",\n    \"success\": false\n}","options":{"raw":{"language":"json"}}},"url":"/unattended_api/v1/cash_register_transactions/780080946222364/complete"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":null,"header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Cache-Control","value":"no-cache"},{"key":"X-Request-Id","value":"af96b5af-7b89-4e84-ab90-2775b14dfb91"},{"key":"X-Runtime","value":"0.505822"},{"key":"Server-Timing","value":"sql.active_record;dur=98.51, start_processing.action_controller;dur=0.08, instantiation.active_record;dur=2.39, cache_read.active_support;dur=0.94, cache_fetch_hit.active_support;dur=0.01, start_transaction.active_record;dur=0.02, transaction.active_record;dur=105.53, render.active_model_serializers;dur=0.08, process_action.action_controller;dur=477.62"},{"key":"Set-Cookie","value":"__profilin=p%3Dt; path=/; HttpOnly; SameSite=Lax"},{"key":"Vary","value":"Origin,Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": {\n        \"code\": 422,\n        \"status\": \"transaction_failed\",\n        \"message\": \"\"\n    }\n}"}],"_postman_id":"0a6213c1-c862-4693-b8ca-0202061069af"},{"name":"Invoice status","id":"b54543af-efb2-4335-ad12-5378e65d9345","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/unattended_api/v1/cash_register_transactions/{{transaction_uid}}/invoices/{{invoice_uid}}?tenant_uid=408704986590812","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"e5c3cd1c-b468-4793-a1a2-32b6d5cd7020","id":"e5c3cd1c-b468-4793-a1a2-32b6d5cd7020","name":"Unattended endpoints","type":"folder"}},"urlObject":{"path":["unattended_api","v1","cash_register_transactions","{{transaction_uid}}","invoices","{{invoice_uid}}"],"host":[""],"query":[{"key":"tenant_uid","value":"408704986590812"}],"variable":[]}},"response":[{"id":"e6ab6ff6-5b06-41a3-a719-e5b4d3abee56","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/unattended_api/v1/cash_register_transactions/{{transaction_uid}}/invoices/{{invoice_uid}}?tenant_uid=408704986590812","host":[""],"path":["unattended_api","v1","cash_register_transactions","{{transaction_uid}}","invoices","{{invoice_uid}}"],"query":[{"key":"tenant_uid","value":"408704986590812"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Cache-Control","value":"no-store, must-revalidate, private, max-age=0"},{"key":"X-Request-Id","value":"956ac0f7-97b7-4996-a101-ce8d1cf667bb"},{"key":"X-Runtime","value":"0.135588"},{"key":"Server-Timing","value":"sql.active_record;dur=14.52, start_processing.action_controller;dur=0.13, instantiation.active_record;dur=43.48, render.active_model_serializers;dur=0.18, process_action.action_controller;dur=96.84"},{"key":"X-MiniProfiler-Original-Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-MiniProfiler-Ids","value":"5mh6cedvfng2iwzw2pe4,92tn04pqgldbcgd7f7kf,xmxsvyvov92oaaq5ocb7,qgzh7jiohregbnfrpns5,qr5ki923rfvs1ixhtihz,gulifpet4zd4r2e9744a,dcu6qay23l5uhwle1a1s,a8i8sym4onflj9mkkeps,k1y7qv4ojye2x2wionet,1ubxy0yo6wy09lqpp0bw,5wc4i6e4nue9dm5sktl,bgp3bhfbwt84hyeatr9z,4i3wsfxz7x7pmuul1v6k,uuribtacp1tciu9xyc6i,m2tybzwg5bec73qildu8,q5slnz8o3x2090g29tad,vbu6wqvmx126n64kab7,rtonh682tsx2rzducpa5,vr3oogrubwbn6llw4dra,vfoxetkvambd30n915jc"},{"key":"Set-Cookie","value":"__profilin=p%3Dt; path=/; HttpOnly; SameSite=Lax"},{"key":"Vary","value":"Origin,Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n    \"response\": {\n        \"issued\": true\n    }\n}"}],"_postman_id":"b54543af-efb2-4335-ad12-5378e65d9345"},{"name":"Invoices","id":"06b59668-cd26-4c1f-aba4-af65bb581170","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/unattended_api/v1/cash_register_transactions/{{transaction_uid}}/invoices?tenant_uid=408704986590812","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"e5c3cd1c-b468-4793-a1a2-32b6d5cd7020","id":"e5c3cd1c-b468-4793-a1a2-32b6d5cd7020","name":"Unattended endpoints","type":"folder"}},"urlObject":{"path":["unattended_api","v1","cash_register_transactions","{{transaction_uid}}","invoices"],"host":[""],"query":[{"key":"tenant_uid","value":"408704986590812"}],"variable":[]}},"response":[{"id":"fc8c812b-26bf-441d-97e7-58b45f09266d","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/unattended_api/v1/cash_register_transactions/{{transaction_uid}}/invoices?tenant_uid=408704986590812","host":[""],"path":["unattended_api","v1","cash_register_transactions","{{transaction_uid}}","invoices"],"query":[{"key":"tenant_uid","value":"408704986590812"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"X-bullet-footer-text","value":"[\"user: root  USE eager loading detected    ReactiveCore::EntityInvoice => [:slips]\\n  Add to your query: .includes([:slips])\",\"user: root  USE eager loading detected    ReactiveCore::EntityInvoice => [:entity_invoice]\\n  Add to your query: .includes([:entity_invoice])\"]"},{"key":"X-bullet-console-text","value":"[\"user: root\\nUSE eager loading detected\\n  ReactiveCore::EntityInvoice => [:slips]\\n  Add to your query: .includes([:slips])\\nCall stack\\n\\n\",\"user: root\\nUSE eager loading detected\\n  ReactiveCore::EntityInvoice => [:entity_invoice]\\n  Add to your query: .includes([:entity_invoice])\\nCall stack\\n\\n\"]"},{"key":"Cache-Control","value":"no-store, must-revalidate, private, max-age=0"},{"key":"X-Request-Id","value":"a8e1f2f4-8a10-4232-b671-2d9b28d67250"},{"key":"X-Runtime","value":"1.674723"},{"key":"Server-Timing","value":"sql.active_record;dur=253.96, start_processing.action_controller;dur=1.71, instantiation.active_record;dur=31.13, cache_read.active_support;dur=12.00, render.active_model_serializers;dur=1.41, process_action.action_controller;dur=840.70"},{"key":"X-MiniProfiler-Original-Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-MiniProfiler-Ids","value":"aiovpucbadjqvchkskbl,cf4w6nl25vtit9nbnjan,o4pv7shrbdjof7ex7gv1,pw5sgof1053s9jz6lmoi,2g6urc0mhcoaog77zwp7,wqp4dbkywjoewvkmyf5o,8h5o7593uoliqm9s9sel,dglxntt0u66ls4fabmmg,wklhhawkrvlpgsx3282k"},{"key":"Set-Cookie","value":"__profilin=p%3Dt; path=/; HttpOnly; SameSite=Lax"},{"key":"Vary","value":"Origin,Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n    \"response\": {\n        \"invoice\": {\n            \"id\": 1660,\n            \"apiUid\": 917814641449450,\n            \"uid\": \"3E988AC5CF0EE86B3E962E575B9BB29EF747BFF8\",\n            \"mark\": \"400001959290126\",\n            \"number\": 1094,\n            \"authenticationCode\": \"191EE2B9005699DFD08BC5F63E3B8A23F585AEF2\",\n            \"iviewUrl\": \"https://sandbox.iview.gr/EL801169211-207-3E988AC5CF0EE86B3E962E575B9BB29EF747BFF8\",\n            \"hasError\": false,\n            \"errorCode\": null,\n            \"issueDate\": \"2026-01-23T14:40:52.000Z\",\n            \"items\": [\n                {\n                    \"uid\": 10423516371557,\n                    \"transaction_uid\": 150500944813654,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.39\",\n                    \"display_total\": \"€2\",\n                    \"total\": 2,\n                    \"tax\": 0.39,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Good(s)\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                },\n                {\n                    \"uid\": 830371686422863,\n                    \"transaction_uid\": 150500944813654,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.01\",\n                    \"display_total\": \"€0.07\",\n                    \"total\": 0.07,\n                    \"tax\": 0.01,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Good(s)\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                }\n            ],\n            \"invoiceType\": \"receipt\",\n            \"cancelled\": false,\n            \"counterpartData\": null,\n            \"netTotal\": \"€1.67\",\n            \"vatTotal\": \"€0.40\",\n            \"total\": \"€2.07\",\n            \"documentType\": \"products\",\n            \"documentForm\": \"basic\"\n        }\n    }\n}"}],"_postman_id":"06b59668-cd26-4c1f-aba4-af65bb581170"},{"name":"Cancel check","id":"9c9f8341-f1c5-4948-9c54-b3ded2247f79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/unattended_api/v1/cash_register_transactions/{{transaction_uid}}/cancel_check","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"e5c3cd1c-b468-4793-a1a2-32b6d5cd7020","id":"e5c3cd1c-b468-4793-a1a2-32b6d5cd7020","name":"Unattended endpoints","type":"folder"}},"urlObject":{"path":["unattended_api","v1","cash_register_transactions","{{transaction_uid}}","cancel_check"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"3231b9e8-331c-42b1-8029-0a9ad755a292","name":"Cancel check cash","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"payment_method\": \"cash\",\n    \"locale\": \"el\",\n    \"terminal_id\": \"77214147\",\n    \"store_uid\": \"652657706192564\",\n    \"tenant_uid\": 408704986590812\n}","options":{"raw":{"language":"json"}}},"url":"/unattended_api/v1/cash_register_transactions/937169381569082/cancel_check"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n    \"response\": {\n        \"transaction\": {\n            \"uid\": 937169381569082,\n            \"number\": \"C99394021667\",\n            \"created_at\": \"31/03/2026 17:21\",\n            \"internal_notes\": null,\n            \"total\": 2.07,\n            \"display_total\": \"€2.07\",\n            \"subtotal\": 1.67,\n            \"display_subtotal\": \"€1.67\",\n            \"vat_total\": 0.4,\n            \"display_vat_total\": \"€0.40\",\n            \"updated_at\": \"31/03/2026 17:45\",\n            \"type\": \"cash_register_transaction\",\n            \"created_by\": \"77700006\",\n            \"status\": \"cancelled\",\n            \"prev_status\": null,\n            \"platform_origin\": null,\n            \"display_preauth_total\": null,\n            \"display_vat_total_without_adjustments_tax\": \"€0.40\",\n            \"display_subtotal_with_extra_costs\": \"€1.67\",\n            \"payments\": [\n                {\n                    \"uid\": 22177160126105,\n                    \"amount\": \"€2.07\",\n                    \"amount_value\": 2.07,\n                    \"payment_method\": \"ReactiveCore::PosCash\",\n                    \"payment_method_title\": \"POS Cash\",\n                    \"transaction_code\": null,\n                    \"response_code\": null,\n                    \"created_at\": \"31/03/2026 17:21\",\n                    \"state\": \"completed\",\n                    \"entity_origin\": null,\n                    \"invoicing_key\": \"cash\",\n                    \"created_at_unformatted\": \"2026-03-31T14:21:24.000Z\"\n                },\n                {\n                    \"uid\": 531351900612284,\n                    \"amount\": \"€2.07\",\n                    \"amount_value\": 2.07,\n                    \"payment_method\": \"ReactiveCore::PosCash\",\n                    \"payment_method_title\": \"POS Cash\",\n                    \"transaction_code\": null,\n                    \"response_code\": null,\n                    \"created_at\": \"31/03/2026 17:24\",\n                    \"state\": \"refunded\",\n                    \"entity_origin\": null,\n                    \"invoicing_key\": \"cash\",\n                    \"created_at_unformatted\": \"2026-03-31T14:24:31.000Z\"\n                },\n                {\n                    \"uid\": 625983134568952,\n                    \"amount\": \"€2.07\",\n                    \"amount_value\": 2.07,\n                    \"payment_method\": \"ReactiveCore::PosCash\",\n                    \"payment_method_title\": \"POS Cash\",\n                    \"transaction_code\": null,\n                    \"response_code\": null,\n                    \"created_at\": \"31/03/2026 17:45\",\n                    \"state\": \"pending\",\n                    \"entity_origin\": null,\n                    \"invoicing_key\": \"cash\",\n                    \"created_at_unformatted\": \"2026-03-31T14:45:08.000Z\"\n                }\n            ],\n            \"line_items\": [\n                {\n                    \"uid\": 238711182149251,\n                    \"transaction_uid\": 937169381569082,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.39\",\n                    \"display_total\": \"€2\",\n                    \"total\": 2,\n                    \"tax\": 0.39,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Good(s)\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                },\n                {\n                    \"uid\": 24302919088921,\n                    \"transaction_uid\": 937169381569082,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.01\",\n                    \"display_total\": \"€0.07\",\n                    \"total\": 0.07,\n                    \"tax\": 0.01,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Good(s)\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                }\n            ]\n        },\n        \"paymentUid\": 625983134568952,\n        \"paymentToken\": null,\n        \"signature\": null\n    }\n}"}],"_postman_id":"9c9f8341-f1c5-4948-9c54-b3ded2247f79"},{"name":"Cancel","id":"92bf369d-adf2-4d9a-af7c-5edb0c4ee301","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/unattended_api/v1/cash_register_transactions/{{transaction_uid}}/cancel","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"e5c3cd1c-b468-4793-a1a2-32b6d5cd7020","id":"e5c3cd1c-b468-4793-a1a2-32b6d5cd7020","name":"Unattended endpoints","type":"folder"}},"urlObject":{"path":["unattended_api","v1","cash_register_transactions","{{transaction_uid}}","cancel"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"27b5051a-87ee-4aa5-add8-688a6ea19c5b","name":"Cancel","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"payment_method\": \"cash\",\n    \"locale\": \"el\",\n    \"terminal_id\": \"77214147\",\n    \"store_uid\": \"652657706192564\",\n    \"tenant_uid\": 408704986590812,\n    \"success\": true\n}","options":{"raw":{"language":"json"}}},"url":"/unattended_api/v1/cash_register_transactions/937169381569082/cancel"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n    \"response\": {\n        \"transaction\": {\n            \"uid\": 937169381569082,\n            \"number\": \"C99394021667\",\n            \"created_at\": \"31/03/2026 17:21\",\n            \"internal_notes\": null,\n            \"total\": 2.07,\n            \"display_total\": \"€2.07\",\n            \"subtotal\": 1.67,\n            \"display_subtotal\": \"€1.67\",\n            \"vat_total\": 0.4,\n            \"display_vat_total\": \"€0.40\",\n            \"updated_at\": \"31/03/2026 17:26\",\n            \"type\": \"cash_register_transaction\",\n            \"created_by\": \"77700006\",\n            \"status\": \"cancelled\",\n            \"prev_status\": null,\n            \"platform_origin\": null,\n            \"display_preauth_total\": null,\n            \"display_vat_total_without_adjustments_tax\": \"€0.40\",\n            \"display_subtotal_with_extra_costs\": \"€1.67\",\n            \"payments\": [\n                {\n                    \"uid\": 22177160126105,\n                    \"amount\": \"€2.07\",\n                    \"amount_value\": 2.07,\n                    \"payment_method\": \"ReactiveCore::PosCash\",\n                    \"payment_method_title\": \"POS Cash\",\n                    \"transaction_code\": null,\n                    \"response_code\": null,\n                    \"created_at\": \"31/03/2026 17:21\",\n                    \"state\": \"completed\",\n                    \"entity_origin\": null,\n                    \"invoicing_key\": \"cash\",\n                    \"created_at_unformatted\": \"2026-03-31T14:21:24.000Z\"\n                },\n                {\n                    \"uid\": 531351900612284,\n                    \"amount\": \"€2.07\",\n                    \"amount_value\": 2.07,\n                    \"payment_method\": \"ReactiveCore::PosCash\",\n                    \"payment_method_title\": \"POS Cash\",\n                    \"transaction_code\": null,\n                    \"response_code\": null,\n                    \"created_at\": \"31/03/2026 17:24\",\n                    \"state\": \"refunded\",\n                    \"entity_origin\": null,\n                    \"invoicing_key\": \"cash\",\n                    \"created_at_unformatted\": \"2026-03-31T14:24:31.000Z\"\n                }\n            ],\n            \"line_items\": [\n                {\n                    \"uid\": 238711182149251,\n                    \"transaction_uid\": 937169381569082,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.39\",\n                    \"display_total\": \"€2\",\n                    \"total\": 2,\n                    \"tax\": 0.39,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Good(s)\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                },\n                {\n                    \"uid\": 24302919088921,\n                    \"transaction_uid\": 937169381569082,\n                    \"quantity\": 1,\n                    \"display_tax\": \"€0.01\",\n                    \"display_total\": \"€0.07\",\n                    \"total\": 0.07,\n                    \"tax\": 0.01,\n                    \"tax_rate\": \"0.24\",\n                    \"custom_tax\": \"0.24\",\n                    \"type\": \"cash_register_transaction_line_item\",\n                    \"title\": \"Good(s)\",\n                    \"mydata_classification_category\": \"category1_2\",\n                    \"vat_exemption_category\": null\n                }\n            ]\n        },\n        \"invoices\": [\n            {\n                \"id\": 1665,\n                \"apiUid\": 519936925051435,\n                \"uid\": \"61614B4F72C041062CFD43045CAD561875E77F89\",\n                \"mark\": \"400001961081987\",\n                \"number\": 141,\n                \"authenticationCode\": \"A8D7307F4F410BCD58838F034D0E63331BFECCAA\",\n                \"iviewUrl\": \"https://sandbox.iview.gr/EL801169211-207-61614B4F72C041062CFD43045CAD561875E77F89\",\n                \"hasError\": false,\n                \"errorCode\": null,\n                \"issueDate\": \"2026-03-31T14:26:14.000Z\",\n                \"items\": [\n                    {\n                        \"uid\": 238711182149251,\n                        \"transaction_uid\": 937169381569082,\n                        \"quantity\": 1,\n                        \"display_tax\": \"€0.39\",\n                        \"display_total\": \"€2\",\n                        \"total\": 2,\n                        \"tax\": 0.39,\n                        \"tax_rate\": \"0.24\",\n                        \"custom_tax\": \"0.24\",\n                        \"type\": \"cash_register_transaction_line_item\",\n                        \"title\": \"Good(s)\",\n                        \"mydata_classification_category\": \"category1_2\",\n                        \"vat_exemption_category\": null\n                    },\n                    {\n                        \"uid\": 24302919088921,\n                        \"transaction_uid\": 937169381569082,\n                        \"quantity\": 1,\n                        \"display_tax\": \"€0.01\",\n                        \"display_total\": \"€0.07\",\n                        \"total\": 0.07,\n                        \"tax\": 0.01,\n                        \"tax_rate\": \"0.24\",\n                        \"custom_tax\": \"0.24\",\n                        \"type\": \"cash_register_transaction_line_item\",\n                        \"title\": \"Good(s)\",\n                        \"mydata_classification_category\": \"category1_2\",\n                        \"vat_exemption_category\": null\n                    }\n                ],\n                \"invoiceType\": \"credit_receipt\",\n                \"cancelled\": false,\n                \"counterpartData\": null,\n                \"netTotal\": \"€1.67\",\n                \"vatTotal\": \"€0.40\",\n                \"total\": \"€2.07\",\n                \"documentType\": null,\n                \"documentForm\": null\n            }\n        ]\n    }\n}"}],"_postman_id":"92bf369d-adf2-4d9a-af7c-5edb0c4ee301"}],"id":"e5c3cd1c-b468-4793-a1a2-32b6d5cd7020","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"84230cdf-7458-4203-b5b8-7756cf6e84cd","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"c27e7e5a-f247-4280-a202-ca1679f9dadc","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"e5c3cd1c-b468-4793-a1a2-32b6d5cd7020","description":""}],"auth":{"type":"oauth2","oauth2":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"710694fc-9c8d-4b5c-8143-70669eff8c70","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"0ee0df6a-83c9-44bf-adbb-a60c11a24efe","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"api_url","value":""},{"key":"client_id","value":""},{"key":"client_secret","value":""},{"key":"code","value":""},{"key":"redirect_uri","value":""},{"key":"access_token","value":""},{"key":"taxid","value":""},{"key":"tax_page","value":"1"},{"key":"storeid","value":""},{"key":"refresh_token","value":""},{"key":"prototype_page","value":"1"},{"key":"prototype_uid","value":"prototype_uid"},{"key":"locale","value":""},{"key":"prototype_attribute_uid","value":"prototype_attribute_uid"},{"key":"prototype_attribute_page","value":"1"},{"key":"product_uid","value":"product_uid"},{"key":"product_page","value":"1"},{"key":"bundle_page","value":"1"},{"key":"bundle_uid","value":"bundle_uid"},{"key":"prototype_attribute_group_uid","value":"prototype_attribute_group_uid"},{"key":"variant_uid","value":"variant_uid"},{"key":"variant_page","value":"1"},{"key":"order_uid","value":"order_uid"},{"key":"shipment_uid","value":"shipment_uid"},{"key":"line_item_uid","value":"line_item_uid"},{"key":"items_page","value":"items_page"},{"key":"items_only_published","value":"items_only_published"},{"key":"items_keyword","value":"items_keyword"},{"key":"product_keyword","value":"product_keyword"},{"key":"product_prototype_uid","value":"product_prototype_uid"},{"key":"product_only_published","value":"product_only_published"},{"key":"bundle_keyword","value":"bundle_keyword"},{"key":"bundle_prototype_uid","value":"bundle_prototype_uid"},{"key":"bundle_only_published","value":"bundle_only_published"},{"key":"items_prototype_uid","value":"items_prototype_uid"},{"key":"user_keyword","value":"user_keyword"},{"key":"user_uid","value":"user_uid"},{"key":"company_uid","value":"company_uid"},{"key":"orders_fetch_completed","value":"orders_fetch_completed"},{"key":"orders_fetch_incomplete","value":"orders_fetch_incomplete"},{"key":"orders_fetch_cancelled","value":"orders_fetch_cancelled"}]}
Field	Type	Description
sku	String	The sku of the variant
price	Float	The price of the variant
compare_to_price	Float	The compare to price of the variant
weight	Float	The weight of the variant(kg)
max_purchasable_quantity	Integer	Maximum purchasable quantity of variant per order
product_api_uid	Bigint	Api uid of product that variant is based on
variant_order_status	Object	An object with variant's order status parameters
can_backorder	Boolean	Whether the variant can be ordered regardless of its available stock
can_preorder	Boolean	Whether the variant can be ordered before it comes to stock
available_on	String	The date that variant will be available
options	Array	An array of product option's api uids that define the variant
variant_image_url	String	The url of variant's image
prices	Array	An array of variant's price list prices
price_list_uid	Bigint	Price list's api uid
stock_items	Array	An array of variant's stock items
store_uid	Bigint	Api uid of stock item's store
quantity	Integer	Quantity of variant in the store
custom_fields	Array	An array of the category's custom fields
key	String	Key of the custom field
value	String	Value of the custom field
type	String	What type is the value of custom field
Field	Type	Description
uid	Bigint	The ID of the variant
sku	String	The sku of the variant
compare_to_price	Float	The compare to price of variant
price	Float	The price of the variant
upc	String	The UPC of the variant
weight	Float	The weight of the variant(kg)
options	Array	An array of variant's options
option_uid	Bigint	The ID of product option
option_type_uid	Bigint	The ID of product option type
images	Array	An array of variant's images
id	Int	The ID of variant image
file_name	String	Name of variant's image file
thumbnail	String	URL of variant's thumbnail image
preview	String	URL of variant's preview image
list_view	String	URL of variant's list view image
banner	String	URL of variant's banner image
stock_items	Array	URL of variant's banner image
store_uid	Bigint	URL of variant's banner image
quantity	Int	URL of variant's banner image
created_at	DateTime	When the item was created.
updated_at	DateTime	When the item was last updated.
Field	Type	Description
uid	Bigint	The ID of the product
type	String	The type of item
translations	Array	An array of product's translations. Every translation is an object with the following fields: - title - subtitle - slug - description - locale
sku	String	The sku of the product
compare_to_price	Float	The compare to price of the product
price	Float	The price of the product
published	Boolean	Whether the product is published or not
prototype_uid	Bigint	The ID of product's category
attributes	Array	An array of product's attributes. Every attribute is an object with the following fields: - uid - filterable_key - translations - an array of attribute's translations. Every translation is an object with following fields: - title - locale - prototype_attribute_uid - prototype_attribute_key - created_at - updated_at
meta_tags	Object	An object with informations about product's meta_tags: - translations - an array of meta tag's translations. Every translation is an object with following fields: - title - description - keywords - locale
option_types	Array	An array with product's option types. Every option type is an object with the following fields: - uid - filterable_key - input_type - preselect_default - translations - an array of attribute's translations. Every translation is an object with following fields: - title - locale - options - an array of option type's options. Every option is an abject with the following fields: - uid - filterable_key - translations - an array of attribute's translations. Every translation is an object with following fields: - title - locale - price_operator - price_operand - price - default_price_value - default - created_at - updated_at - created_at - updated_at
variants	Array	An array of product's variants. Every variant is an object. For variant's fields see below
measurements	Object	An object with informations about product's measuments. It contains the following fields: - weight - length - width - height
order_status	Object	An object with informations about product's order status. It contains the following fields: - can_backorder - can_preorder - available_on
images	Array	An array of product's images. Every image is an object with the following fields: - id - file_name - thumbnail - preview - list_view - banner
max_purchasable_quantity	Integer	The maximum purchasable quantity of this product per order
max_product_quantity	Integer	The maximum purchasable quantity of products per order
created_at	String	The date that product was created
updated_at	String	The date that product was updated
display_total_compare_to_price	String	The total compare to price of product in display format
display_price	String	The price of product in display format
display_tax_price	String	The tax price of product in display format
display_total_price	String	The total price of product in display format
on_sale	Boolean	Whether the product is on sale or not
on_sale_percentage	Float	The percentage of discount of product
show_price	Boolean	Whether to show product's price or not
has_tax	Boolean	Whether the product has tax or not
stock_items	Array	An array of product's stock items. Every stock item is an object with the following fields: - store - an object with information about stock item's store. This object contains the following fields: - uid - translations - an array of attribute's translations. Every translation is an object with following fields: - title - locale - email - visible - pickup_allowed - created_at - updated_at - quantity - created_at - updated_at
taxes	Array	An array of product's taxes. Every tax is an object with the following fields: - uid - translations - an array of tax's translations. Every translation is an object with following fields: - title - locale - is_default - rate - applies_to - included_in_price - created_at - updated_at
prices	Array	An array of product's price list prices. Every price is an object with the following fields: - price_list_title - price_list_api_uid - price - compare_to_price
Field	Type	Description
uid	Bigint	The ID of the variant
type	String	The type of item
translations	Array	An array of variant's translations. Every translation is an object with the following fields: - title - subtitle - slug - description - locale
sku	String	The sku of the variant
compare_to_price	Float	The compare to price of the variant
price	Float	The price of the variant
upc	String	The upc of the variant
weight	String	The weight of the variant
options	Array	An array with options of the variant. Every option is an object with the following fields: - option_uid - option_type_uid
option_types	Array	An array with option types of the variant. Every option type is an object with the following fields: - uid - filterable_key - input_type - preselect_default - translations - an array of attribute's translations. Every translation is an object with following fields: - title - locale - options - an array of option type's options. Every option is an abject with the following fields: - uid - filterable_key - translations - an array of attribute's translations. Every translation is an object with following fields: - title - locale - price_operator - price_operand - price - default_price_value - default - created_at - updated_at - created_at - updated_at
images	Array	An array of variant's images. Every image is an object with the following fields: - id - file_name - thumbnail - preview - list_view - banner
max_purchasable_quantity	Integer	The maximum purchasable quantity of this variant per order
max_product_quantity	Integer	The maximum purchasable quantity of products per order
order_status	Object	An object with informations about variant's order status. It contains the following fields: - can_backorder - can_preorder - available_on
created_at	String	The date that variant was created
updated_at	String	The date that variant was updated
display_total_compare_to_price	String	The total compare to price of variant in display format
display_price	String	The price of variant in display format
display_tax_price	String	The tax price of variant in display format
display_total_price	String	The total price of variant in display format
on_sale	Boolean	Whether the variant is on sale or not
on_sale_percentage	Float	The percentage of discount of variant
show_price	Boolean	Whether to show variant's price or not
has_tax	Boolean	Whether the variant has tax or not
stock_items	Array	An array of variant's stock items. Every stock item is an object with the following fields: - store - an object with information about stock item's store. This object contains the following fields: - uid - translations - an array of attribute's translations. Every translation is an object with following fields: - title - locale - email - visible - pickup_allowed - created_at - updated_at - quantity - created_at - updated_at
Field	Type	Description
uid	Bigint	The ID of the product
type	String	The type of item
translations	Array	An array of product's translations. Every translation is an object with the following fields: - title - subtitle - slug - description - locale
sku	String	The sku of the product
compare_to_price	Float	The compare to price of the product
price	Float	The price of the product
published	Boolean	Whether the product is published or not
prototype_uid	Bigint	The ID of product's category
attributes	Array	An array of product's attributes. Every attribute is an object with the following fields: - uid - filterable_key - translations - an array of attribute's translations. Every translation is an object with following fields: - title - locale - prototype_attribute_uid - prototype_attribute_key - created_at - updated_at
meta_tags	Object	An object with informations about product's meta_tags: - translations - an array of meta tag's translations. Every translation is an object with following fields: - title - description - keywords - locale
option_types	Array	An array with product's option types. Every option type is an object with the following fields: - uid - filterable_key - input_type - preselect_default - translations - an array of attribute's translations. Every translation is an object with following fields: - title - locale - options - an array of option type's options. Every option is an abject with the following fields: - uid - filterable_key - translations - an array of attribute's translations. Every translation is an object with following fields: - title - locale - price_operator - price_operand - price - default_price_value - default - created_at - updated_at - created_at - updated_at
variants	Array	An array of product's variants. Every variant is an object. For variant's fields see below
measurements	Object	An object with informations about product's measuments. It contains the following fields: - weight - length - width - height
order_status	Object	An object with informations about product's order status. It contains the following fields: - can_backorder - can_preorder - available_on
images	Array	An array of product's images. Every image is an object with the following fields: - id - file_name - thumbnail - preview - list_view - banner
max_purchasable_quantity	Integer	The maximum purchasable quantity of this product per order
max_product_quantity	Integer	The maximum purchasable quantity of products per order
created_at	String	The date that product was created
updated_at	String	The date that product was updated
display_total_compare_to_price	String	The total compare to price of product in display format
display_price	String	The price of product in display format
display_tax_price	String	The tax price of product in display format
display_total_price	String	The total price of product in display format
on_sale	Boolean	Whether the product is on sale or not
on_sale_percentage	Float	The percentage of discount of product
show_price	Boolean	Whether to show product's price or not
has_tax	Boolean	Whether the product has tax or not
stock_items	Array	An array of product's stock items. Every stock item is an object with the following fields: - store - an object with information about stock item's store. This object contains the following fields: - uid - translations - an array of attribute's translations. Every translation is an object with following fields: - title - locale - email - visible - pickup_allowed - created_at - updated_at - quantity - created_at - updated_at
taxes	Array	An array of product's taxes. Every tax is an object with the following fields: - uid - translations - an array of tax's translations. Every translation is an object with following fields: - title - locale - is_default - rate - applies_to - included_in_price - created_at - updated_at
prices	Array	An array of product's price list prices. Every price is an object with the following fields: - price_list_title - price_list_api_uid - price - compare_to_price
Field	Type	Description
type	String	The type of value (\"text\" or \"html\" or \"json\")
key	String	The key of custom field
value	String	The value of custom field
Required	Field	Type	Description
Mandatory	locale	String	The locale of the translation to be created
Mandatory	title	String	The title of product
Optional	slug	String	The slug of product
Optional	description	String	The description of the product's translation
Optional	subtitle	String	The subtitle of the product's translation
Optional	sku	String	The sku of the product
Optional	price	Float	The price of the product
Optional	compare_to_price	Float	The compare to price of the product
Optional	published	Boolean	Whether the product is published or not
Optional	applied_tax_uid	Bigint	The ID of the applied tax of the product
Optional	product_measurement	Object	An object with informations about product's measurement. It contains the following fields: - weight(Float) - in kg - length(Float) - in cm - width(Float) - in cm - height(Float) - in cm
Optional	prototype_uid	Bigint	The ID of the category of the product
Optional	prototype_attributes	Array	An array of product's category attributes. Every category attribute is an object with the following fields: - title(String) - prototype_attribute_uid(Bigint) - prototype attribute ID
Optional	option_types	Array	An array of product's category attributes. Every category attribute is an object with the following fields: - title(String) - options(Array) - an array of products available options. Every option is an object that contains the following fields: - title(String) - price_operator(Integer) - must be 0(+) or 1(-) - price_operand(Integer) - must be 0(x starting price) or 1(% of starting price) - price(Float)
Optional	stock_items	Array	An array of product's stock items. Every stock item is an object with the following fields: - store_uid(Bigint) - store ID - quantity(Integer)
Optional	product_images	Array	An array of product's images. Every image is an object with the following fields: - url - position(Integer) - the display order of image
Optional	seo	Object	An object with informations about product's seo. It contains the following fields: - title(String) - keywords(String) - description(String)
Optional	product_order_status	Object	An object with informations about product's order status. It contains the following fields: - can_backorder(Boolean) - can_preorder(Boolean) - available_on(String) - must be a date in format DD-MM-YYYY hh::mm (e.g. \"19-10-2023 11:00\")
Optional	prices	Array	An array of product's price list prices. Every price is an object with the following fields: - price_list_uid(Bigint) - the ID of price list - price(Float) - compare_to_price(Float)
Optional	custom_fields	Object	An object with product's custom fields. It contains the following a field for every custom field to be added. Field name follows the pattern custom_field. Can add up to 10 custom fields. Every custom field contains the following fields: - key(String) - value(String) - type(String) - must be \"text\" or \"html\" or \"json\"
Required	Field	Type	Description
Conditional	locale	String	Must be provided if there are changes in product/category attributes, options or seo. The locale of the translations to be updated.
Optional	sku	String	The sku of the product
Optional	price	Float	The price of the product
Optional	compare_to_price	Float	The compare to price of the product
Optional	published	Boolean	Whether the product is published or not
Optional	applied_tax_uid	Bigint	The ID of the applied tax of the product
Optional	product_measurement	Object	An object with informations about product's measurement. It contains the following fields: - weight(Float) - in kg - length(Float) - in cm - width(Float) - in cm - height(Float) - in cm
Optional	prototype_uid	Bigint	The ID of the category of the product
Conditional	prototype_attributes	Array	Must be provided if the existed category of the product will be changed. An array of product's category attributes. Every category attribute is an object with the following fields: - title(String) - prototype_attribute_uid(Bigint) - prototype attribute ID
Conditional	product_attributes	Array	Must be provided if the existed category of the product remains. An array of product's attributes. Every product attribute is an object with the following fields: - title(String) - product_attribute_uid(Bigint) - prototype attribute ID
Optional	option_types	Array	An array of product's category attributes. Every category attribute is an object with the following fields: - title(String) - option_type_api_uid(Bigint) - the ID of the product option - options(Array) - an array of products available options. Every option is an object that contains the following fields: 1. title(String) 2. price_operator(Integer) - must be 0(+) or 1(-) 3. price_operand(Integer) - must be 0(x starting price) or 1(% of starting price) 4. price(Float) 5. option_api_uid(Float) - the ID of the product option
Optional	stock_items	Array	An array of product's stock items. Every stock item is an object with the following fields: - store_uid(Bigint) - store ID - quantity(Integer)
Optional	product_images	Array	An array of product's images. Every image is an object with the following fields: - url - position(Integer) - the display order of image
Optional	seo	Object	An object with informations about product's seo. It contains the following fields: - title(String) - keywords(String) - description(String)
Optional	product_order_status	Object	An object with informations about product's order status. It contains the following fields: - can_backorder(Boolean) - can_preorder(Boolean) - available_on(String) - must be a date in format DD-MM-YYYY hh::mm (e.g. \"19-10-2023 11:00\")
Optional	prices	Array	An array of product's price list prices. Every price is an object with the following fields: - price_list_uid(Bigint) - the ID of price list - price(Float) - compare_to_price(Float)
Optional	custom_fields	Object	An object with product's custom fields. It contains the following a field for every custom field to be added. Field name follows the pattern custom_field. Can add up to 10 custom fields. Every custom field contains the following fields: - key(String) - value(String) - type(String) - must be \"text\" or \"html\" or \"json\"
Field	Type	Description
title	String	The title of the created product translation
subtitle	String	The subtitle of the created product translation
slug	String	The slug of the created product translation
description	String	The description of the created product translation
locale	String	The locale of the created product translation
Field	Type	Description
title	String	The title of the created product attribute translation
locale	String	The locale of the created product attribute translation
uid	Bigint	The ID of the product attribute
Field	Type	Description
title	String	The title of the created option type translation
locale	String	The locale of the created option type translation
uid	String	The ID of the option type
options_translations	Array	An array with created options translations. Every option translation is an object with the following fields: - title(String) - the title of the created option translation - locale(String) - the locale of the created option translation - uid(Bigint) - the ID of option
Field	Type	Description
title	String	The title of the product translation
subtitle	String	The subtitle of the product translation
slug	String	The slug of the product translation
description	String	The description of the product translation
locale	String	The locale of the product translation
Field	Type	Description
title	String	The title of the product attribute translation
locale	String	The locale of the product attribute translation
uid	Bigint	The ID of the product attribute
Field	Type	Description
title	String	The title of the option type translation
locale	String	The locale of the option type translation
uid	String	The ID of the option type
options_translations	Array	An array with options translations. Every option translation is an object with the following fields: - title(String) - the title of the option translation - locale(String) - the locale of the created option translation - uid(Bigint) - the ID of option
Field	Type	Description
translation	Object	An object with informations about deleted translation. It contains the following fields: - title - subtitle - slug - description - locale
attributes_translations	Array	An array of deleted product's attributes translations. Every attribute translation is an object with the following fields: - title - locale - uid
meta_tag_translations	Object	An object with informations about deleted product's meta_tags translations: - id - title - description - keywords - locale
option_types_translations	Array	An array with deleted product's option types translations. Every option type translation is an object with the following fields: - title - locale - uid - options_translations - an array of deleted option translations. Every option translation is an object with the following fields: - title - locale - uid
Field	Type	Description
uid	Bigint	The ID of the bundle
type	String	The type of item
translations	Array	An array of bundle's translations. Every translation is an object with the following fields: - title - subtitle - slug - description - locale
sku	String	The sku of the bundle
compare_to_price	Float	The compare to price of the bundle
price	Float	The price of the bundle
published	Boolean	Whether the bundle is published or not
prototype_uid	Bigint	The ID of bundle's category
attributes	Array	An array of bundle's attributes. Every attribute is an object with the following fields: - uid - filterable_key - translations - an array of attribute's translations. Every translation is an object with following fields: - title - locale - prototype_attribute_uid - prototype_attribute_key - created_at - updated_at
meta_tags	Object	An object with informations about bundle's meta_tags: - translations - an array of meta tag's translations. Every translation is an object with following fields: - title - description - keywords - locale
measurements	Object	An object with informations about bundle's measuments. It contains the following fields: - weight - length - width - height
images	Array	An array of bundle's images. Every image is an object with the following fields: - id - file_name - thumbnail - preview - list_view - banner
max_purchasable_quantity	Integer	The maximum purchasable quantity of this bundle per order
created_at	String	The date that bundle was created
updated_at	String	The date that bundle was updated
display_total_compare_to_price	String	The total compare to price of bundle in display format
display_price	String	The price of bundle in display format
display_tax_price	String	The tax price of bundle in display format
display_total_price	String	The total price of bundle in display format
on_sale	Boolean	Whether the bundle is on sale or not
on_sale_percentage	Float	The percentage of discount of bundle
show_price	Boolean	Whether to show bundle's price or not
has_tax	Boolean	Whether the bundle has tax or not
taxes	Array	An array of bundle's taxes. Every tax is an object with the following fields: - uid - translations - an array of tax's translations. Every translation is an object with following fields: - title - locale - is_default - rate - applies_to - included_in_price - created_at - updated_at
prices	Array	An array of bundle's price list prices. Every price is an object with the following fields: - price_list_title - price_list_api_uid - price - compare_to_price
Field	Type	Description
title	String	The title of the bundle translation
subtitle	String	The subtitle of the bundle translation
slug	String	The slug of the bundle translation
description	String	The description of the bundle translation
locale	String	The locale of the bundle translation
Field	Type	Description
title	String	The title of the bundle attribute translation
locale	String	The locale of the bundle attribute translation
uid	Bigint	The ID of the bundle attribute
Field	Type	Description
uid	Bigint	The ID of the category requested
translations	Array	An array of all the category's or category attribute's translations
title	String	The title of the translation
slug	String	The slug of of the translation
locale	String	The locale of the translation
prototype_attributes	Array	An array of all the category's attributes
visible	Boolean	Whether or not the attribute is visible
position	Int	The position of the attribute
created_at	DateTime	When the category was created.
updated_at	DateTime	When the category was last updated.
Field	Type	Description
uid	Bigint	The ID of the category created
translations	Array	An array of all the category's translations
prototype_attributes	Array	An array of the category's attributes
created_at	DateTime	When the category was created.
updated_at	DateTime	When the category was last updated.
Field	Type	Description
title	String	The title for the specified locale
slug	String	The slug of the category for the specified locale (if not specified then it's generated based on the title)
prototype_attributes	Array	An array with the translations for all the category attributes
prototype_attribute_uid	Bigint	The ID of the specified attribute (all attributes must be included for the translation to be created)
Field	Type	Description
prototype_translation	Object	The translation object of the category
title	String	The title of the translation
slug	String	The slug of the category's translation
locale	String	The locale of the translation
prototype_attribute_translations	Array	An array with the created translation for each attribute
Field	Type	Description
title	String	The title of the category for the specified locale
slug	String	The slug of the category for the specified locale (if not specified then it's generated based on the title)
Field	Type	Description
uid	Bigint	The ID of the category attribute requested
visible	Boolean	Whether or not the category attribute is visible
position	Int	The position of the category attribute
translations	Array	An array of all the translations
title	String	The title of the translation
locale	String	The locale of the translation
created_at	DateTime	When the category attribute was created
updated_at	DateTime	When the category attribute was last updated
Field	Type	Description
uid	Bigint	The ID of the category attribute
visible	Boolean	Whether or not the attribute is visible
position	Int	The position of the attribute
translations	Array	An array of all the category attribute's translations
title	String	The title of the translation
locale	String	The locale of the translation
created_at	DateTime	When the category attribute was created
updated_at	DateTime	When the category attribute was last updated