The Mystore API v1.0 will be deprecated and reach its end of life on 31th December 2018
The Mystore API v1.0 will be completely replaced with a new and more robust version.
This new version (Mystore API v2.0) is already live and new integrations are discouraged to use this older version of the Mystore API.
Please reference to this URL for the documentation of the new Mystore API 2.0: https://mystoreapi.docs.apiary.io
Note that despite the examples all using .json, each endpoint accepts both json and xml as "extension" when being called, depending on what you would like returned.
The API is throttled at 30 requests per second, any usage that exceeds this will trigger an HTTP 429.
categories
-
Get categoriesGET/categories.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. get_all_categories Optional, default true Set to false to only return the top-level categories. Default will return all. Example request
https://mystore-api.no/categories.json?api_key=EXAMPLE-API-KEY
Example response
{ "code":200, "data":{ "category_data":{ "40":{ "id":"40", "parent":"0", "name":"Hovedkategori", "slug":"hoved", "type":"parent", "spacing":"0", "breadcrumbs":"Hovedkategori", "selected":"0", "href":"http:\/\/mystore-demo.no\/categories\/hoved", "haschild":"true" }, "41":{ "id":"41", "parent":"40", "name":"Underkategori", "slug":"under", "type":"child", "spacing":"1", "breadcrumbs":"Underkategori", "selected":"0", "href":"http:\/\/mystore-demo.no\/categories\/under" } } } }
products
-
Get all productsGET/products.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. page Optional, default 1 The page-number to fetch, used with page_size. page_size Optional, default 25 (maximum 250) Number of entries to return. only_specials Optional, default false Set to true to get only products that are on special only_featured Optional, default false Set to true to get only featured products only_ids Optional, default false Set to true to get only product ids back filter[age] Optional Filter by age "3" to get only products created in the last 3 days Example request
https://mystore-api.no/products.json?api_key=EXAMPLE-API-KEY
Example response
NOTE: since browsers tend to sort JSON rather randomly, we've added "products_index" which is the order the products are stored in.
{ "code":200, "data":{ "product_data":{ "122":{ "products_id":"122", "products_name":"Camilla armchair", "products_model":"", "products_url":"http:\/\/mystore-demo.no\/products\/camilla-armchair", "products_url_identifier":"camilla-armchair", "products_sort_order":"0", "products_quantity":"0", "products_weight":"0", "products_status":"1", "products_price_ex_tax":"249.0000", "products_tax_percentage":"25", "products_description":"Beskrivelse Camilla armchair", "products_date_added":"2011-10-12 15:32:06", "products_last_modified":"2011-10-12 15:32:06", "products_brand_name":"", "products_brand_id":"0", "products_categories":[ "42", "44" ], "products_attributes":[ ], "products_tabs":[ ], "products_images":[ "http:\/\/mystore-demo.no\/users\/demo_mystore_no\/images\/122_Camilla_armchair_1.jpg" ], "products_index": "2" }, "123":{ "products_id":"123", "products_name":"Egg Chair", "products_model":"", "products_url":"http:\/\/mystore-demo.no\/products\/egg-chair", "products_url_identifier":"egg-chair", "products_sort_order":"0", "products_quantity":"0", "products_weight":"0", "products_status":"1", "products_price_ex_tax":"2999.0000", "products_tax_percentage":"25", "products_description":"Beskrivelse Egg Chair", "products_date_added":"2011-10-12 15:33:27", "products_last_modified":"2011-10-12 15:33:27", "products_brand_name":"", "products_brand_id":"0", "products_categories":[ "42" ], "products_attributes":[ ], "products_tabs":[ ], "products_images":[ "http:\/\/mystore-demo.no\/users\/demo_mystore_no\/images\/123_Egg_Chair_1.jpg" ], "products_index": "3" }, "121":{ "products_id":"121", "products_name":"Round chair", "products_model":"", "products_url":"http:\/\/mystore-demo.no\/products\/round-chair", "products_url_identifier":"round-chair", "products_sort_order":"0", "products_quantity":"0", "products_weight":"0", "products_status":"1", "products_price_ex_tax":"1599.0000", "products_tax_percentage":"25", "products_description":"Beskrivelse Round Chair", "products_date_added":"2011-10-11 10:43:42", "products_last_modified":"2011-10-11 10:43:42", "products_brand_name":"", "products_brand_id":"0", "products_categories":[ "42" ], "products_attributes":[ ], "products_tabs":[ ], "products_images":[ "http:\/\/mystore-demo.no\/users\/demo_mystore_no\/images\/121_Round_chair_1.jpg" ] , "products_index": "1" } }, "product_count_total":3 } }
-
Get all productsGET/products/product/:products_id.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. products_id Required Supplied in the URL, the ID of the product you want to fetch Example request
https://mystore-api.no/products/product/122.json?api_key=EXAMPLE-API-KEY
Example response
{ "code":200, "data":{ "product_data":{ "122":{ "products_id":"122", "products_name":"Camilla armchair", "products_model":"", "products_url":"http:\/\/mystore-demo.no\/products\/camilla-armchair", "products_url_identifier":"camilla-armchair", "products_sort_order":"0", "products_quantity":"0", "products_weight":"0", "products_status":"1", "products_price_ex_tax":"249.0000", "products_tax_percentage":"25", "products_description":"Beskrivelse Camilla armchair", "products_date_added":"2011-10-12 15:32:06", "products_last_modified":"2011-10-12 15:32:06", "products_brand_name":"", "products_brand_id":"0", "products_categories":[ "42", "44" ], "products_attributes":[ ], "products_tabs":[ ], "products_images":[ "http:\/\/mystore-demo.no\/users\/demo_mystore_no\/images\/122_Camilla_armchair_1.jpg" ], "products_index": "2" } } } }
-
Get all products for a specific categoryGET/products/:category_id.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. Example request
https://mystore-api.no/products/42.json?api_key=EXAMPLE-API-KEY
Example response
{ "code":200, "data":{ "product_data":{ "122":{ "products_id":"122", "products_name":"Camilla armchair", "products_model":"", "products_url":"http:\/\/mystore-demo.no\/products\/camilla-armchair", "products_url_identifier":"camilla-armchair", "products_sort_order":"0", "products_quantity":"0", "products_weight":"0", "products_status":"1", "products_price_ex_tax":"249.0000", "products_tax_percentage":"25", "products_description":"Beskrivelse Camilla armchair", "products_date_added":"2011-10-12 15:32:06", "products_last_modified":"2011-11-01 09:05:01", "products_brand_name":"", "products_brand_id":"0", "products_categories":[ "42", "44" ], "products_attributes":[ ], "products_tabs":[ ], "products_images":[ "http:\/\/mystore-demo.no\/users\/demo_mystore_no\/images\/122_Camilla_armchair_1.jpg" ] } }, "product_count_total":1 } }
-
Do a fulltext search for productsGET/products/search/:keyword.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. Example request
https://mystore-api.no/products/search/gent.json?api_key=EXAMPLE-API-KEY
Example response
{ "code": 200, "data": { "data": { "1": { "categories_id": "38", "categories_name": "Herresko", "result_entries": [ { "products_id": "115", "categories_id": "38", "products_url": "http://malresplin.mystore3.no/products/gentlemens-brown", "products_image": "images/115_Gentlemens_brown_1.jpg", "products_name": "Gentleman's brown", "products_model": "", "manufacturers_name": "Gucci", "highlight": "gent", "products_price": "100", "specials_price": "" } ] } } } }
-
Create new product, update if product exists.POST/products/create_or_update.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. product_data Required JSON-string containing the product data to create (or update) product. Example request
NOTE: to update a product, either the products_id-field or the products_model-field must be present and have valid data.
At the moment, you can only update attribute stock, you cannot create attributes or update any other values on existing attributes using the API.
Also note that if you assign the product to categories, we will replace existing category assignments with the IDs you specify in "products_categories_assignment". Send an empty array (or no value) to leave unchanged.
https://mystore-api.no/products/create_or_update.json?api_key=EXAMPLE-API-KEY
POST-parameter "product_data" example:
{ "products_model":"MODEL test", "products_name":"My test product", "products_ean":"12345678910", "products_price":"100", "products_weight":"1500", "products_quantity":"5", "products_tax_class_id":"1", "products_status":"1", "products_categories_assignment": [31,42], "products_attributes": { "1-4,3-8": { "qty": "25" }, "1-4,3-9": { "qty": "10" } } }
Example response
{ "code": 200, "data": { "message": { "success": "true", "msg": "UPDATED_EXISTING_PRODUCT", "product_id": "128" } } }
You can create or update several products in one call, by sending in an array of products:
https://mystore-api.no/products/create_or_update.json?api_key=EXAMPLE-API-KEY
POST-parameter "product_data" example:
[ { "products_model":"MODEL test", "products_name":"My test product", "products_ean":"12345678910", "products_price":"100", "products_weight":"1500", "products_quantity":"5", "products_tax_class_id":"1", "products_status":"1", "products_attributes": { "1-4,3-8": { "qty": "25" }, "1-4,3-9": { "qty": "10" } } }, { "products_model":"MODEL new", "products_name":"My second test product", "products_ean":"234567891011", "products_price":"200", "products_weight":"500", "products_quantity":"3", "products_tax_class_id":"1", "products_status":"1" } ]
Example response
[ { "code": 200, "data": { "message": { "success": "true", "msg": "UPDATED_EXISTING_PRODUCT", "product_id": "128" } } }, { "code": 200, "data": { "message": { "success": "true", "msg": "CREATED_NEW_PRODUCT", "product_id": "141" } } } ]
-
Update product stock by modelPOST/products/update_stock_by_model.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. product_data Required JSON-string containing the model and quantity needed to update stock. Example request
This endpoint will update stock for a product or a product's attribute, as long as you supply the model for either. If you try to update stock for a product that has attributes, an error will be returned
https://mystore-api.no/products/update_stock_by_model.json?api_key=EXAMPLE-API-KEY
POST-parameter "product_data" example:
{ "products_model": "A123", "products_quantity": "11" }
Example response
{ "code": 200, "data": { "message": { "success": "true", "msg": "ATTRIBUTE_UPDATED", "product_id": "128" } } }
-
Get all attribute options and their possible valuesGET/products/attributes.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. Example request
https://mystore-api.no/products/attributes.json?api_key=EXAMPLE-API-KEY
Example response
{ "code": 200, "data": { "attributes": { "3": { "name": "Color", "values": { "8": "Black", "9": "Red", "10": "Blue" } }, "4": { "name": "Size", "values": { "13": "M", "14": "L" } } } } }
-
Attach an attribute to a productPOST/products/attributes/attach_to_product.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. product_data Required JSON-string containing the necessary info (please note that all fields in the example data below are required) Example request
This endpoint requires that you know the IDs of each option-value combination you want to attach to a product. It is also important that the lowest option-id comes first, so 3-9,4-13 is OK because 3 comes before 4, but 4-13,3-9 will cause problems. If you later want to update stock for this entry later you must assign a model and use "update_stock_by_model".
https://mystore-api.no/products/attributes/attach_to_product.json?api_key=EXAMPLE-API-KEY
POST-parameter "product_data" example:
{ "products_id":"122", "attributes_combo":"3-9,4-13", "model":"A123", "quantity":"3" }
Example response
{ "code": 200, "data": { "message": { "success": "true", "msg": "ATTRIBUTE_ATTACHED" } } }
-
Update model on a specific attributes on a productPOST/products/attributes/update_stock_model.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. product_data Required JSON-string containing the necessary info (please note that all fields in the example data below are required) Example request
This endpoint requires that you know the IDs of each option-value combination you want to update model for. It is also important that the lowest option-id comes first, so 3-9,4-13 is OK because 3 comes before 4, but 4-13,3-9 will cause problems.
https://mystore-api.no/products/attributes/update_stock_model.json?api_key=EXAMPLE-API-KEY
POST-parameter "product_data" example:
{ "products_id":"122", "attributes_combo":"3-9,4-13", "model":"B234" }
Example response
{ "code": 200, "data": { "message": { "success": "true", "msg": "ATTRIBUTE_MODEL_UPDATED" } } }
orders
-
Get all ordersGET/orders.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. page Optional, default 1 The page-number to fetch, used with page_size. page_size Optional, default 25 Number of entries to return. filter[status] Optional Filter by status "new" to get only new orders filter[age] Optional Filter by age "30" to get only orders from the last 30 days Example request
https://mystore-api.no/orders.json?api_key=EXAMPLE-API-KEY
Example response
{ "code":200, "data":{ "order_data":{ "1":{ "customers_id":"12004", "customers_name":"Customer Name 1", "customers_company_number": "900900900", "date_purchased":"2012-02-15 10:15:09", "orders_status_id": "1", "orders_status_name":"Ikke behandlet", "order_total":"1.150", "currency":"NOK", "invoice_id":"0", "estimated_delivery_date": "", "payment_method":"paypal_ipn" }, "2":{ "customers_name":"Customer Name 2", "customers_company_number": "", "date_purchased":"2012-02-14 23:04:17", "orders_status_id": "1", "orders_status_name":"Levert", "order_total":"378", "currency":"NOK", "invoice_id":"6192", "estimated_delivery_date": "", "payment_method":"Faktura", "tags": [ { "ckey": "requires_supplier_order", "value": "true" } ], "kid": "00100200361928" } } } }
-
Get a specific order's detailsGET/orders/:id.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. Example request
https://mystore-api.no/orders/1.json?api_key=EXAMPLE-API-KEY
Example response
{ "code":200, "data":{ "order":{ "info":{ "orders_id":"1", "invoice_id":"0", "invoice_date":null, "purring":null, "purring_forfallsdato":null, "forfallsdato":null, "kredittnota":null, "currency":"NOK", "currency_value":"1.000000", "payment_method":"paypal_ipn", "shipping_metod":"Hentes", "shipping_module":"pickup_pickup", "cc_type":"", "cc_owner":"", "cc_number":"", "cc_expires":"", "date_purchased":"2012-02-15 10:15:09", "orders_status":"1", "orders_ip":null, "orders_hostname":null, "orders_total":"1150.4000", "orders_invoice_tax":null, "orders_shipping_tax":"0.0000", "orders_discount":"-287.6000", "last_modified":"2012-02-15 10:21:38", "economic":null, "wheight":0, "tracking_number":null, "tax_groups":{ "25":287.6 }, "weight":0 }, "totals":[ {"title":"Sub-Total:","text":"1.150,-"}, {"title":"Rabattkode:","text":"-288,-"}, {"title":"Hentes","text":"0,-"}, {"title":"Herav 25% mva:","text":"230,-"}, {"title":"Totalsum:","text":"1.150,-"} ], "products":[ { "products_id":"573", "qty":"1", "name":"Tavle m treramme", "model":"709450", "products_stock_attributes":"", "tax":"25.0000", "price":"999.2000", "final_price":"999.2000", "weight":0 }, { "products_id":"736", "qty":"1", "name":"Krus", "model":"215002", "products_stock_attributes":"", "tax":"25.0000", "price":"151.2000", "final_price":"151.2000", "weight":0 } ], "customer":{ "id":"12196", "name":"Customer Name 1", "company":"", "company_co":null, "street_address":"Testvegen 2", "suburb":"", "city":"Oslo", "postcode":"0150", "state":"", "country":"Norge", "format_id":"5", "telephone":"", "email_address":"epost@gmail.com" ,"notes":"", "date_of_birth":"0000-00-00 00:00:00" }, "delivery":{ "name":"Customer Name 1", "company":"", "company_co":null, "street_address":"Testvegen 2", "suburb":"", "city":"Oslo", "postcode":"0150", "state":"", "country":"Norge", "format_id":"5" }, "billing":{ "name":"Customer Name 1", "company":"", "company_co":null, "street_address":"Testvegen 2", "suburb":"", "city":"Oslo", "postcode":"0150", "state":"", "country":"Norge", "format_id":"5" }, "history":{ "1999":{ "orders_status_history_id":"1999", "orders_id":"532", "orders_status_id":"4", "date_added":"2012-02-15 10:15:09", "customer_notified":"0", "comments":"", "tracking_id":"", "orders_status_change_user_id":null }, "2000":{ "orders_status_history_id":"2000", "orders_id":"532", "orders_status_id":"1", "date_added":"2012-02-15 10:21:38", "customer_notified":"1", "comments":"PayPal IPN Verified", "tracking_id":"", "orders_status_change_user_id":null } } } } }
-
Get all available order statusesGET/orders_statuses.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. Example request
https://mystore-api.no/orders_statuses.json?api_key=EXAMPLE-API-KEY
Example response
{ "code": 200, "data": { "order_statuses": [ { "orders_status_id": "1", "public_name": "", "private_name": "Ikke behandlet", "is_default_status": "true" }, { "orders_status_id": "2", "public_name": "", "private_name": "Under behandling", "is_default_status": "false" }, { "orders_status_id": "3", "public_name": "", "private_name": "Levert", "is_default_status": "false" }, { "orders_status_id": "4", "public_name": "", "private_name": "Kansellert", "is_default_status": "false" }, { "orders_status_id": "5", "public_name": "", "private_name": "Returnert", "is_default_status": "false" }, { "orders_status_id": "6", "public_name": "", "private_name": "Til plukk", "is_default_status": "false" } ] } }
-
Update order status for an orderPOST/orders/update_status.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. orders_id Required The order to update status for status_id Required The new status id (see orders_statuses above, to get available status ids) status_message Optional Status message that will be visible on the order's status history Example request
Send each parameter as normal POST-parameters to:
https://mystore-api.no/orders/update_status.json?api_key=EXAMPLE-API-KEY
Example response
{ "code": 200, "data": { "message": [ "success", "status_updated" ] } }
-
Create a new orderPOST/orders/create.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. customer_id Required Date and time of purchase (Y-m-d H:i:s) time Required The customers id (who is buying) products Required Array of products bought, see bellow for details shipping Optional Array of shipping price and method, see bellow for details payment_name Optional What payment method was used comment Optional Order comment Example request
https://mystore-api.no/orders/create.json?api_key=EXAMPLE-API-KEY
POST-parameter "orders/create" example:
{ customer_id: "1", time: "2015-12-24 12:52:00" products: { { "id":"1", "model":"MODEL test", "name":"My test product", "price_ex":"80", "products_tax":"25", "quantity":"10", "products_attributes": "1-4,3-8" }, { "id":"5", "model":"MODEL test 2", "name":"My test product", "price_ex":"25", "products_tax":"15", "quantity":"2", "products_attributes": "" } }, shipping: { "name":"servicepakke_servicepakke", "price_inc_tax":"100", "price_ex_tax":"80", "price_tax_rate":"25" }, payment_name: "postoppkrav", comment: "This is a test order" }
Example response
Not documented
customers
-
Get all customersGET/customers.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. page Optional, default 1 The page-number to fetch, used with page_size. page_size Optional, default 25 Number of entries to return. Example request
https://mystore-api.no/customers.json?api_key=EXAMPLE-API-KEY
Example response
{ "code":200, "data":{ "customer_data":{ "1":{ "customers_firstname":"Yngve", "customers_lastname":"Larsen", "customers_email_address":"tester@gmail.com", "customers_telephone":"21982474", "customers_info_date_account_created": "2006-07-22 05:51:47", "customers_newsletter":"0" }, "2":{ "customers_firstname":"Ørjan", "customers_lastname":"Larsen", "customers_email_address":"tester@hotmail.com", "customers_telephone":"21982474", "customers_info_date_account_created": "2006-07-22 05:51:47", "customers_newsletter":"1" } } } }
-
Get a specific customer's detailsGET/customers/:id.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. Example request
https://mystore-api.no/customers/1.json?api_key=EXAMPLE-API-KEY
Example response
{ "code":200, "data":{ "customer":{ "customers_id":"1", "customers_gender":"Male", "customers_firstname":"Yngve", "customers_lastname":"Larsen", "customers_dob":"0000-00-00 00:00:00", "customers_email_address":"tester@gmail.com", "customers_default_address_id":"2962", "customers_default_billing_address_id":null, "customers_telephone":"21982474", "customers_fax":"", "customers_newsletter":"1", "customers_notes":"CEO, Mystore", "customers_bounce":"0", "address_book_id":"2962", "entry_gender":"", "entry_company":null, "entry_company_co":null, "entry_firstname":"Yngve", "entry_lastname":"Larsen", "entry_street_address":"Erik Vangbergs gate 7", "entry_suburb":null, "entry_postcode":"9008", "entry_city":"Tromsø", "entry_state":null, "entry_country_id":"153", "entry_zone_id":"0", "entry_company_number":null } } }
cart
-
Get products from a cart, based on cart idGET/cart/:id.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. Example request
https://mystore-api.no/cart/taa65rr9irip6h03r0n4n3d2r4.json?api_key=EXAMPLE-API-KEY
Example response
{ "code": 200, "data": { "data": { "cart_content": { "115{1}4{3}9": { "qty": "1", "cart_type": "cart", "recurring": "0", "attributes": { "1": "4", "3": "9" }, "stock_attribute": "1-4,3-9", "attributes_names": { "Størrelse": "L", "Farge": "Rød" }, "products_name": "Vintage Jeans", "products_image": "../users/foobar3_mystore_no/images/115_Gentlemens_brown_1.jpg", "products_price": "999" }, "119{3}9": { "qty": "1", "cart_type": "cart", "recurring": "0", "attributes": { "3": "9" }, "stock_attribute": "3-9", "attributes_names": { "Farge": "Rød" }, "products_name": "Vintage Jeans", "products_image": "../users/foobar3_mystore_no/images/119_Striped_Polo_1.jpg", "products_price": "499" } }, "cart_total": "1348.2" } } }
modules
-
Returns modules of type "shipping" or "payment"GET/modules/:type.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. type Required The type of module to list, available types are "shipping" and "payment". Example request
https://mystore-api.no/modules/shipping.json?api_key=EXAMPLE-API-KEY
Example response
{ "code": 200, "data": { "types": [ { "id": "mypackv2", "text": "Tollpost MyPack" }, { "id": "pickup", "text": "Hentes i butikk" }, { "id": "pnhomedelivery", "text": "Postnord Hjemlevering" }, { "id": "pnstykkgods", "text": "Postnord Stykkgods" }, { "id": "svalbard", "text": "Svalbard - ekstra gebyr" } ] } }
pos
-
Returns zreports for the specified dateGET/pos/zreports.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. date Required The date to look up zreports for, in the following format: "dd.mm.YYYY" Example request
https://mystore-api.no/pos/zreports.json?api_key=EXAMPLE-API-KEY&date=03.08.2016
Example response
{ "code": 200, "data": { "data": [{ "id": "8", "register_id": "1", "start": { "date": "2016-08-03 11:58:47", "timezone_type": 3, "timezone": "Europe\/London" }, "stop": { "date": "2016-08-03 14:45:27", "timezone_type": 3, "timezone": "Europe\/London" } }, { "id": "9", "register_id": "1", "start": { "date": "2016-08-03 11:58:47", "timezone_type": 3, "timezone": "Europe\/London" }, "stop": { "date": "2016-08-03 14:45:28", "timezone_type": 3, "timezone": "Europe\/London" } }] } }
-
Returns details for a specific zreportGET/pos/zreports/:id.json
Parameters
Parameter Notes Description api_key Required The user's API-key, generated from the Mystore control panel. id Required The id for the zreport to get details for Example request
https://mystore-api.no/pos/zreports/8.json?api_key=EXAMPLE-API-KEY
Example response
{ "code": 200, "data": { "data": { "cashier": { "firstname": "Mystore", "lastname": "Cashier", "email": "noreply@mystore.no" }, "paymentsRaw": { "cash": { "total": "21659.0500", "type": "cash", "count": "11" }, "giftcard": { "total": "400.0000", "type": "giftcard", "count": "3" } }, "giftcardsSold": { "cash": { "total": "600.0000", "count": "4", "paymentMethod": "cash" } }, "payments": { "cash": { "total": 21059.05, "type": "cash", "count": 7 }, "giftcard": { "total": "400.0000", "type": "giftcard", "count": "3" } }, "salesReturn": { "sales": { "total": "21071.550000000000", "type": "sales" } }, "mva": { "0.0000": { "basis": "13725.3000", "total": "0.000000000000", "mva": "0.0000" }, "25.0000": { "basis": "5397.0000", "total": "1349.250000000000", "mva": "25.0000" } }, "payment": { "cash": { "total": "21659.0500", "type": "cash", "count": "11" }, "giftcard": { "total": "400.0000", "type": "giftcard", "count": "3" } } } } }
If the API-key is invalid or does not have access to the specified endpoint
{"code":403,"error":{"message":"No access to this resource","type":"Exception"}}
If a request for e.g. products in a specific category returns nothing, a plain 404 will be returned
{"code":404}