{
"info": {
"name": "Documentation of Opencart Shopping Cart REST API (OAuth version) (oauth-shopping-cart)",
"description": "Generated from Swagger/OpenAPI 2.0 index.json for easy import in Postman.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "POST /oauth2/token/{grant_type} - Get access token",
"request": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "",
"type": "text",
"description": "Authorization header value.
How to create Authorization header value:
- Concatenate the client id, a colon character \":\",and the client secret into a single string. So you’ll get
client_id:client_secret. - Base64 encode the concatenated string
Add \"Basic \" (including the space) before the encoded string. - If your client id is
shopping_oauth_client and your client secret is shopping_oauth_secret, your concatenated string will be shopping_oauth_client:shopping_oauth_secret. - After Base64 encode you will get
c2hvcHBpbmdfb2F1dGhfY2xpZW50OnNob3BwaW5nX29hdXRoX3NlY3JldA== and the header parameter will be Basic c2hvcHBpbmdfb2F1dGhfY2xpZW50OnNob3BwaW5nX29hdXRoX3NlY3JldA==
"
},
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/oauth2/token/{grant_type}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"oauth2",
"token",
"{grant_type}"
],
"variable": [
{
"key": "grant_type",
"value": ""
}
]
},
"description": "Creating client id/secret
Before you can authorize with the API you’ll need to set the client id and the secret on REST API admin page.
With the client id and client secret you can request an access token using the POST api/rest/oauth2/token api call.
Authenticate API requests with access token
The received token needs to be added to every API call.
Include an Authorization header with the following value: Bearer {access token} .
For example: Authorization: Bearer 7487c50afc37dbf6e5a484dc49c363128036c356
Service urls:
http://yourdomain.com/api/rest/oauth2/token/client_credentials
OR
http://yourdomain.com/index.php?route=feed/rest_api/gettoken&grant_type=client_credentials",
"body": {
"mode": "raw",
"raw": "{\n \"old_token\": \"db8da0586c299643d24aad2cc0ae3908ec39b21e\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "POST /affiliate - Set Affiliate code",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/affiliate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"affiliate"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/affiliate
OR
http://yourdomain.com/index.php?route=feed/rest_api/affiliate",
"body": {
"mode": "raw",
"raw": "{\n \"tracking\": \"demo\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "GET /affiliate - Get session Affiliate code",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/affiliate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"affiliate"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/affiliate
OR
http://yourdomain.com/index.php?route=feed/rest_api/affiliate"
},
"response": []
},
{
"name": "DELETE /affiliate - Remove Affiliate code",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/affiliate",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"affiliate"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/affiliate
OR
http://yourdomain.com/index.php?route=feed/rest_api/affiliate"
},
"response": []
},
{
"name": "POST /register - Create customer",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/register",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"register"
],
"variable": []
},
"description": "Create a new customer and automatically logs in after registration is successful.
Service urls:
http://yourdomain.com/api/rest/register
OR
http://yourdomain.com/index.php?route=rest/register/register",
"body": {
"mode": "raw",
"raw": "{\n \"firstname\": \"Demo\",\n \"lastname\": \"User\",\n \"email\": \"nash1@vipmail.hu\",\n \"password\": \"password\",\n \"confirm\": \"password\",\n \"telephone\": \"1-541-754-3010\",\n \"customer_group_id\": 1,\n \"agree\": 0,\n \"custom_field\": {\n \"account\": {\n \"1\": \"+364545454\"\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "POST /login - Logs user into the system",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/login",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"login"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/login
OR
http://yourdomain.com/index.php?route=rest/login/login",
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"demo@test.com\",\n \"password\": \"demo\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "POST /sociallogin - Social login",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/sociallogin",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"sociallogin"
],
"variable": []
},
"description": "Logs user into the system with email address. If the email address does not exist, new user will be created with the email address.
Service urls:
http://yourdomain.com/api/rest/sociallogin
OR
http://yourdomain.com/index.php?route=rest/login/socialLogin",
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"test@test.com\",\n \"social_access_token\": \"THIRD_PARTY_ACCESS_TOKEN\",\n \"provider\": \"facebook\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "POST /logout - Logs out current logged in user session",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/logout",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"logout"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/logout
OR
http://yourdomain.com/index.php?route=rest/logout/logout"
},
"response": []
},
{
"name": "POST /forgotten - Forgotten password",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/forgotten",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"forgotten"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/forgotten
OR
http://yourdomain.com/index.php?route=rest/forgotten/forgotten",
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"test@test.com\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "GET /cart - Get cart",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/cart",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"cart"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/cart
OR
http://yourdomain.com/index.php?route=rest/cart/cart
"
},
"response": []
},
{
"name": "POST /cart - Add item to cart",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/cart",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"cart"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/cart
OR
http://yourdomain.com/index.php?route=rest/cart/cart
Sample cart item object:
product_id=34 (iPod Shuffle)
product_option_id =235 (Size)
product_option_value_id = 30 (Large){
\"product_id\": \"34\",
\"quantity\": \"1\",
\"option\":
{
\"235\": \"30\"
}
}
Add recurring item to the cart:
{
\"product_id\": \"43\",
\"quantity\": \"1\",
\"recurring_id\": \"2\"
}
Option for text field:
\"option\": {
\"238\":\"demo text\"
}br>Option for date field:
\"option\": {
\"238\":\"2014-10-15\"
}
Option for checkbox field:
\"option\": {
\"236\": [\"33\"]
}
Option for checkbox field ( multiple selected ):
\"option\": {
\"236\": [\"33\", \"32\"]
}
Option for select field:
\"option\": {
\"235\":\"30\"
}
Option for radio field:
\"option\": {
\"237\":\"35\"
}
And all together:
\"option\": {
\"235\": \"30\",
\"237\":\"34\",
\"238\":\"demo text\",
\"239\":\"2014-11-20\",
\"236\": [\"33\"]
}
",
"body": {
"mode": "raw",
"raw": "{\n \"product_id\": 34,\n \"quantity\": 2\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "PUT /cart - Update cart item quantity",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/cart",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"cart"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/cart
OR
http://yourdomain.com/index.php?route=rest/cart/cart",
"body": {
"mode": "raw",
"raw": "{\n \"key\": \"120\",\n \"quantity\": 2\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "DELETE /cart - Delete cart item",
"request": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/cart",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"cart"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/cart
OR
http://yourdomain.com/index.php?route=rest/cart/cart
The product key can be found in the response of the GET /cart API call.",
"body": {
"mode": "raw",
"raw": "{\n \"key\": 120\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "DELETE /cart/{key} - Delete cart item",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/cart/{key}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"cart",
"{key}"
],
"variable": [
{
"key": "key",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/cart/{key}
OR
http://yourdomain.com/index.php?route=rest/cart/cart&key={key}
The product key can be found in the response of the GET /cart API call."
},
"response": []
},
{
"name": "DELETE /cart/empty - Empty cart",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/cart/empty",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"cart",
"empty"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/cart/empty
OR
http://yourdomain.com/index.php?route=rest/cart/emptycart"
},
"response": []
},
{
"name": "POST /cart_bulk - Add items to cart",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/cart_bulk",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"cart_bulk"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/cart_bulk
OR
http://yourdomain.com/index.php?route=rest/cart/bulkcart",
"body": {
"mode": "raw",
"raw": "[\n {\n \"product_id\": 34,\n \"quantity\": 2\n }\n]",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "GET /products - Get list of products",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/products",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"products"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/products
OR
http://yourdomain.com/index.php?route=feed/rest_api/productsSearch products with opencart rest api
You can combine filter parameters, you only need to use the long version of API urls.
You can combine these parameters:
- - limit
- - page
- - start
- - sort (sort by name, model, quantity, rating, sort order, date_added, date_modified, price)
- - order (order by desc or asc)
- - search (search keyword, search in product name, model, sku, upc, ean, jan, isbn, mpn)
- - filter_description (set this parameter 1, then the API will search in description too)
- - filters
- - manufacturer (manufacturer ID)
- - category (category ID)
- - filter_date_added_from, filter_date_added_to, filter_date_added_on
- - filter_date_modified_from, filter_date_modified_to, filter_date_modified_on
- - subcategory (subcategory ID)
- - tag
Example urls:
http://yourdomain.com/index.php?route=feed/rest_api/products&simple=1&custom_fields=id,name&search=ipod
http://yourdomain.com/index.php?route=feed/rest_api/products&sort=price&order=asc
http://yourdomain.com/index.php?route=feed/rest_api/products&sort=price&order=desc"
},
"response": []
},
{
"name": "GET /products/simple - Get simple list of products",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/products/simple",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"products",
"simple"
],
"variable": []
},
"description": "Get simple list of products. It is faster than previous one, but it returns limited product information.
Service urls:
http://yourdomain.com/api/rest/products/simple
OR
http://yourdomain.com/index.php?route=feed/rest_api/products&simple=1"
},
"response": []
},
{
"name": "GET /products/simple/customfields/{customfields} - Get list of products, it returns only the specified fields",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/products/simple/customfields/{customfields}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"products",
"simple",
"customfields",
"{customfields}"
],
"variable": [
{
"key": "customfields",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/products/simple/customfields/{customfields}
OR
http://yourdomain.com/index.php?route=feed/rest_api/products&simple=1&custom_fields={customfields}"
},
"response": []
},
{
"name": "GET /products/category/{id} - Get list of products by category ID",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/products/category/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"products",
"category",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/products/category/{category_id}
OR
http://yourdomain.com/index.php?route=feed/rest_api/products&category={category_id}"
},
"response": []
},
{
"name": "GET /products/category/{id}/limit/{limit}/page/{page} - Get list of products by category ID and page and limit",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/products/category/{id}/limit/{limit}/page/{page}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"products",
"category",
"{id}",
"limit",
"{limit}",
"page",
"{page}"
],
"variable": [
{
"key": "id",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "page",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/products/category/{category_id}/limit/{limit}/page/{page}
OR
http://yourdomain.com/index.php?route=feed/rest_api/products&category={category_id}&limit={limit}&page={page}"
},
"response": []
},
{
"name": "GET /products/category/{id}/filters/{filters} - Get list of products by category filters",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/products/category/{id}/filters/{filters}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"products",
"category",
"{id}",
"filters",
"{filters}"
],
"variable": [
{
"key": "id",
"value": ""
},
{
"key": "filters",
"value": ""
}
]
},
"description": "Get list of products by filters.If you load categories you will get category filters in the response.
Service urls:
http://yourdomain.com/api/rest/products/category/{category_id}/filters/{filters}
OR
http://yourdomain.com/index.php?route=feed/rest_api/products&category={category_id}&filters={filters}"
},
"response": []
},
{
"name": "GET /products/slug/{slug} - Get product by slug",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/products/slug/{slug}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"products",
"slug",
"{slug}"
],
"variable": [
{
"key": "slug",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/products/slug/{slug}
OR
http://yourdomain.com/index.php?route=feed/rest_api/products&slug={slug}"
},
"response": []
},
{
"name": "GET /products/manufacturer/{id} - Get list of products by manufacturer ID",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/products/manufacturer/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"products",
"manufacturer",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/products/manufacturer/{manufacturer_id}
OR
http://yourdomain.com/index.php?route=feed/rest_api/products&manufacturer={manufacturer_id}"
},
"response": []
},
{
"name": "GET /products/manufacturer/{id}/limit/{limit}/page/{page} - Get list of products by manufacturer ID and page and limit",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/products/manufacturer/{id}/limit/{limit}/page/{page}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"products",
"manufacturer",
"{id}",
"limit",
"{limit}",
"page",
"{page}"
],
"variable": [
{
"key": "id",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "page",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/products/manufacturer/{manufacturer_id}/limit/{limit}/page/{page}
OR
http://yourdomain.com/index.php?route=feed/rest_api/products&manufacturer={manufacturer_id}&limit={limit}&page={page}"
},
"response": []
},
{
"name": "POST /products/custom_search/limit/{limit}/page/{page} - Search products",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/products/custom_search/limit/{limit}/page/{page}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"products",
"custom_search",
"limit",
"{limit}",
"page",
"{page}"
],
"variable": [
{
"key": "limit",
"value": ""
},
{
"key": "page",
"value": ""
}
]
},
"description": "Search products, build your custom query.
Service urls:
http://yourdomain.com/api/rest/products/custom_search/limit/{limit}/page/{page}
OR
http://yourdomain.com/index.php?route=feed/rest_api/search&limit={limit}&page={page}
Supported fields
| Field |
|---|
| category |
| quantity |
| stock_status |
| manufacturer |
| model |
| upc |
| name |
| date_start |
| date_end |
| product_id |
| price |
|
|
|
| filter_text |
Comparison Operators
| Operator | Description | Example |
|---|
| = | Checks if the valuesof two operands are equal or not, if yes then condition becomes true. | (a = b) is not true. |
| != | Checks if the values of two operands are equal ornot, if values are not equal then condition becomes true. | (a != b) is true. |
| <> | Checks if the values of two operands are equal or not, if valuesare not equal then condition becomes true. | (a <> b) is true. |
| > | Checks if the value of left operand is greater than the value of rightoperand, if yes then condition becomes true. | (a > b) is not true. |
| < | Checks if the value of left operand is less than the value of rightoperand, if yes then condition becomes true. | (a < b) is true. |
| >= | Checks if the value of left operand is greater than or equal to the valueof right operand, if yes then condition becomes true. | (a >= b) is not true. |
| <= | Checks if the value of left operand is less than or equaltothe value of right operand, if yes then condition becomes true. | (a <= b) is true. |
| !< | Checks if the value of left operand is not lessthanthe value of right operand, if yes then condition becomes true. | (a !< b) is false. |
| !> | Checks if the value of left operand is notgreaterthan the value of right operand, if yes then condition becomes true. | (a !> b) is true. |
| IN | The IN operator is used to compare a value to alist of literal values that have been specified. |
| LIKE | The LIKE operator is used to compare a value to similar values using wildcard operators. |
Logical Operators
| Operator | Description |
|---|
| AND | The AND operator allows the existence of multiple conditionsinan SQL statement's WHERE clause. |
| OR | The OR operator is used to combine multiple conditions in an SQL statement's WHERE clause. |
Supported sort fields
| Field |
|---|
| name |
| model |
| quantity |
| price |
| rating |
| sort_order |
| date_added |
Supported order types
Example usage
{
\"sort\":\"quantity\",
\"order\":\"asc\",
\"filters\":[
{
\"field\":\"price\",
\"operand\":\">=\",
\"value\":\"10\"
},
{
\"field\":\"manufacturer\",
\"operand\":\"in\",
\"logical_operand\":\"and\",
\"value\":[
1,
2,
3
]
},
{
\"field\":\"name\",
\"operand\":\"like\",
\"value\":\"apple\"
}
]
}",
"body": {
"mode": "raw",
"raw": "{\n \"fields\": [\n {\n \"field\": \"\",\n \"value\": \"\",\n \"operand\": \"\",\n \"logical_operand\": \"\"\n }\n ],\n \"debug\": \"\",\n \"order\": \"\",\n \"sort\": \"\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "GET /products/{id} - Get product details by ID",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/products/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"products",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/products/{product_id}
OR
http://yourdomain.com/index.php?route=feed/rest_api/products&id={product_id}"
},
"response": []
},
{
"name": "GET /products/limit/{limit}/page/{page} - Get list of products by page and limit",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/products/limit/{limit}/page/{page}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"products",
"limit",
"{limit}",
"page",
"{page}"
],
"variable": [
{
"key": "limit",
"value": ""
},
{
"key": "page",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/products/limit/{limit}/page/{page}
OR
http://yourdomain.com/index.php?route=feed/rest_api/products&limit={limit}&page={page}"
},
"response": []
},
{
"name": "GET /products/search/{search} - Search products",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/products/search/{search}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"products",
"search",
"{search}"
],
"variable": [
{
"key": "search",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/products/search/{search}
OR
http://yourdomain.com/index.php?route=feed/rest_api/products&search={search}Search products with opencart rest api
You can combine filter parameters, you only need to use the long version of API urls.
You can combine these parameters:
- - limit
- - page
- - start
- - sort (sort by name, model, quantity, rating, sort order, date_added)
- - order (order by desc or asc)
- - search (search keyword, search in product name, model, sku, upc, ean, jan, isbn, mpn)
- - filter_description (set this parameter 1, then the API will search in description too)
- - filters
- - manufacturer (manufacturer ID)
- - category (category ID)
- - subcategory (subcategory ID)
- - tag
"
},
"response": []
},
{
"name": "GET /products/search/{search}/limit/{limit}/page/{page} - Search products by page and limit",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/products/search/{search}/limit/{limit}/page/{page}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"products",
"search",
"{search}",
"limit",
"{limit}",
"page",
"{page}"
],
"variable": [
{
"key": "search",
"value": ""
},
{
"key": "limit",
"value": ""
},
{
"key": "page",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/products/search/{search}/limit/{limit}/page/{page}
OR
http://yourdomain.com/index.php?route=feed/rest_api/products&search={search}&limit={limit}&page={page}"
},
"response": []
},
{
"name": "GET /compare/{ids} - Compare products",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/compare/{ids}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"compare",
"{ids}"
],
"variable": [
{
"key": "ids",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/compare/{ids}
OR
http://yourdomain.com/index.php?route=feed/rest_api/compare&ids{ids}"
},
"response": []
},
{
"name": "GET /featured - Get list of featured products",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/featured",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"featured"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/featured
OR
http://yourdomain.com/index.php?route=feed/rest_api/featured"
},
"response": []
},
{
"name": "GET /featured/limit/{limit} - Get list of featured products per limit",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/featured/limit/{limit}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"featured",
"limit",
"{limit}"
],
"variable": [
{
"key": "limit",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/featured/limit/{limit}
OR
http://yourdomain.com/index.php?route=feed/rest_api/featured&limit={limit}"
},
"response": []
},
{
"name": "POST /products/{id}/review - Add review to product.",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/products/{id}/review",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"products",
"{id}",
"review"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/products/{product_id}/review
OR
http://yourdomain.com/index.php?route=feed/rest_api/reviews&id={product_id}",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Demo User\",\n \"text\": \"This is a great product, I like it!\",\n \"rating\": 5\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "GET /bestsellers/limit/{limit} - Get list of bestsellers",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/bestsellers/limit/{limit}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"bestsellers",
"limit",
"{limit}"
],
"variable": [
{
"key": "limit",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/bestsellers/limit/{limit}
OR
http://yourdomain.com/index.php?route=feed/rest_api/bestsellers&limit={limit}"
},
"response": []
},
{
"name": "GET /related/{id} - Get list of related products",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/related/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"related",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/related/{id}
OR
http://yourdomain.com/index.php?route=feed/rest_api/related&id={id}"
},
"response": []
},
{
"name": "GET /latest/limit/{limit} - Get list of latest products",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/latest/limit/{limit}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"latest",
"limit",
"{limit}"
],
"variable": [
{
"key": "limit",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/latest/{limit}
OR
http://yourdomain.com/index.php?route=feed/rest_api/latest&limit={limit}"
},
"response": []
},
{
"name": "GET /latest - Get list of latest products",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/latest",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"latest"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/latest
OR
http://yourdomain.com/index.php?route=feed/rest_api/latest"
},
"response": []
},
{
"name": "GET /specials/limit/{limit} - Get list of special products",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/specials/limit/{limit}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"specials",
"limit",
"{limit}"
],
"variable": [
{
"key": "limit",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/specials/{limit}
OR
http://yourdomain.com/index.php?route=feed/rest_api/specials&limit={limit}"
},
"response": []
},
{
"name": "GET /specials - Get list of special products",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/specials",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"specials"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/specials
OR
http://yourdomain.com/index.php?route=feed/rest_api/specials"
},
"response": []
},
{
"name": "GET /product_classes - Get product classes and other select values: stock_statuses, currencies, return_reasons, etc.",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/product_classes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"product_classes"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/product_classes
OR
http://yourdomain.com/index.php?route=feed/rest_api/productclasses"
},
"response": []
},
{
"name": "GET /utc_offset - Get UTC offset",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/utc_offset",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"utc_offset"
],
"variable": []
},
"description": "Get UTC offset, returns offset in seconds.
Service urls:
http://yourdomain.com/api/rest/utc_offset
OR
http://yourdomain.com/index.php?route=feed/rest_api/utc_offset"
},
"response": []
},
{
"name": "GET /order_statuses - Get order statuses",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/order_statuses",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"order_statuses"
],
"variable": []
},
"description": "Get order statuses.
Service urls:
http://yourdomain.com/api/rest/order_statuses
OR
http://yourdomain.com/index.php?route=feed/rest_api/order_statuses"
},
"response": []
},
{
"name": "PUT /orderhistory/{id} - Add order history",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/orderhistory/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"orderhistory",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/orderhistory/{order_id}
OR
http://yourdomain.com/index.php?route=feed/rest_api/orderhistory&id={order_id}Set notify value to 1, to send notification to your customer",
"body": {
"mode": "raw",
"raw": "{\n \"order_status_id\": 8,\n \"notify\": 0,\n \"comment\": \"This is the comment\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "POST /voucher - Add voucher to order",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/voucher",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"voucher"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/voucher
OR
http://yourdomain.com/index.php?route=rest/cart/voucher",
"body": {
"mode": "raw",
"raw": "{\n \"voucher\": \"1111\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "DELETE /voucher - Remove voucher",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/voucher",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"voucher"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/voucher
OR
http://yourdomain.com/index.php?route=rest/cart/voucher
"
},
"response": []
},
{
"name": "POST /shippingquotes - Get shipping quotes",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/shippingquotes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"shippingquotes"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/shippingquotes
OR
http://yourdomain.com/index.php?route=rest/cart/shippingquotes",
"body": {
"mode": "raw",
"raw": "{\n \"country_id\": 97,\n \"zone_id\": 0,\n \"postcode\": \"1111\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "PUT /shippingquotes/{code} - Save shipping quotes",
"request": {
"method": "PUT",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/shippingquotes/{code}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"shippingquotes",
"{code}"
],
"variable": [
{
"key": "code",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/shippingquotes/{code}
OR
http://yourdomain.com/index.php?route=rest/cart/shippingquotes&id={code}
"
},
"response": []
},
{
"name": "POST /coupon - Add coupon to order",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/coupon",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"coupon"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/coupon
OR
http://yourdomain.com/index.php?route=rest/cart/coupon",
"body": {
"mode": "raw",
"raw": "{\n \"coupon\": \"2222\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "DELETE /coupon - Remove coupon",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/coupon",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"coupon"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/coupon
OR
http://yourdomain.com/index.php?route=rest/cart/coupon
"
},
"response": []
},
{
"name": "POST /reward - Add reward to order",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/reward",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"reward"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/reward
OR
http://yourdomain.com/index.php?route=rest/cart/reward",
"body": {
"mode": "raw",
"raw": "{\n \"reward\": 100\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "DELETE /reward - Remove reward",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/reward",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"reward"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/reward
OR
http://yourdomain.com/index.php?route=rest/cart/reward
"
},
"response": []
},
{
"name": "GET /paymentaddress - Get customers payment addresses",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/paymentaddress",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"paymentaddress"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/paymentaddress
OR
http://yourdomain.com/index.php?route=rest/payment_address/paymentaddress
"
},
"response": []
},
{
"name": "POST /paymentaddress - Add new payment address to order",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/paymentaddress",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"paymentaddress"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/paymentaddress
OR
http://yourdomain.com/index.php?route=rest/payment_address/paymentaddress",
"body": {
"mode": "raw",
"raw": "{\n \"firstname\": \"Demo\",\n \"lastname\": \"User\",\n \"city\": \"Berlin\",\n \"address_1\": \"Demo\",\n \"address_2\": \"Demo\",\n \"country_id\": 81,\n \"postcode\": \"3333\",\n \"zone_id\": 1256,\n \"custom_field\": {\n \"address\": {\n \"3\": \"demo address 3\"\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "POST /paymentaddress/existing - Set existing payment address to order",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/paymentaddress/existing",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"paymentaddress",
"existing"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/paymentaddress/existing
OR
http://yourdomain.com/index.php?route=rest/payment_address/paymentaddress&existing=1",
"body": {
"mode": "raw",
"raw": "{\n \"address_id\": 1\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "GET /shippingaddress - Get customer's shipping addresses",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/shippingaddress",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"shippingaddress"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/shippingaddress
OR
http://yourdomain.com/index.php?route=rest/shipping_address/shippingaddress
"
},
"response": []
},
{
"name": "POST /shippingaddress - Add new shipping address to order",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/shippingaddress",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"shippingaddress"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/shippingaddress
OR
http://yourdomain.com/index.php?route=rest/shipping_address/shippingaddress",
"body": {
"mode": "raw",
"raw": "{\n \"firstname\": \"Demo\",\n \"lastname\": \"User\",\n \"city\": \"Berlin\",\n \"address_1\": \"Demo\",\n \"address_2\": \"Demo\",\n \"country_id\": 81,\n \"postcode\": \"3333\",\n \"zone_id\": 1256,\n \"custom_field\": {\n \"address\": {\n \"3\": \"demo address 3\"\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "POST /shippingaddress/existing - Set existing shipping address to order",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/shippingaddress/existing",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"shippingaddress",
"existing"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/shippingaddress/existing
OR
http://yourdomain.com/index.php?route=rest/shipping_address/shippingaddress&existing=1",
"body": {
"mode": "raw",
"raw": "{\n \"address_id\": 1\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "GET /shippingmethods - Get shipping methods",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/shippingmethods",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"shippingmethods"
],
"variable": []
},
"description": "This method must called after POST guestshipping or POST shippingaddress because it depends on the customers delivery details.
Service urls:
http://yourdomain.com/api/rest/shippingmethods
OR
http://yourdomain.com/index.php?route=rest/shipping_method/shippingmethods"
},
"response": []
},
{
"name": "POST /shippingmethods - Set shipping method",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/shippingmethods",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"shippingmethods"
],
"variable": []
},
"description": "GET shippingmethods service must be called before this service call.
Service urls:
http://yourdomain.com/api/rest/shippingmethods
OR
http://yourdomain.com/index.php?route=rest/shipping_method/shippingmethods",
"body": {
"mode": "raw",
"raw": "{\n \"shipping_method\": \"flat.flat\",\n \"comment\": \"\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "GET /paymentmethods - Get payment methods",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/paymentmethods",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"paymentmethods"
],
"variable": []
},
"description": "This method must called after POST guest or POST paymentaddress because it depends on the customers billing details.
Service urls:
http://yourdomain.com/api/rest/paymentmethods
OR
http://yourdomain.com/index.php?route=rest/payment_method/payments"
},
"response": []
},
{
"name": "POST /paymentmethods - Set payment method",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/paymentmethods",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"paymentmethods"
],
"variable": []
},
"description": "GET paymentmethods service must be called before this service call.
Service urls:
http://yourdomain.com/api/rest/paymentmethods
OR
http://yourdomain.com/index.php?route=rest/payment_method/payments",
"body": {
"mode": "raw",
"raw": "{\n \"payment_method\": \"cod\",\n \"agree\": 1,\n \"comment\": \"\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "POST /confirm - Get an overview of the order(it contains the order id)",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/confirm",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"confirm"
],
"variable": []
},
"description": "Get an overview of the order(it contains the order id)
Service urls:
http://yourdomain.com/api/rest/confirm
OR
http://yourdomain.com/index.php?route=rest/confirm/confirm"
},
"response": []
},
{
"name": "PUT /confirm - This api call must be called when the payment succeeded so the carts content can be cleared and some session data can be unset.",
"request": {
"method": "PUT",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/confirm",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"confirm"
],
"variable": []
},
"description": "Empty cart, and clear session.
Service urls:
http://yourdomain.com/api/rest/confirm
OR
http://yourdomain.com/index.php?route=rest/confirm/confirm"
},
"response": []
},
{
"name": "GET /pay - Start payment",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/pay",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"pay"
],
"variable": []
},
"description": "You only need to call this service, if you want to start payment process in webview.
You'll know it's finished when one of the following routes is loaded in the webview:
checkout/success (order success)
checkout/cart (order failed)
You need to intercepting these url’s to check when to get the focus back in your application and whether the payment succeeded or not.
Service urls:
http://yourdomain.com/api/rest/pay
OR
http://yourdomain.com/index.php?route=rest/confirm/confirm&page=pay"
},
"response": []
},
{
"name": "POST /simpleconfirm - Simple confirm order",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/simpleconfirm",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"simpleconfirm"
],
"variable": []
},
"description": "No need to set payment address, shipping address, payment method, and shipping method.Confirm order, check order data before save to database
This simple order only requires these steps:
1;login user
2;add item to cart
3;call simple order service with POST method
4;call simple order service with PUT method.
Service urls:
http://yourdomain.com/api/rest/simpleconfirm
OR
http://yourdomain.com/index.php?route=rest/simple_confirm/confirm"
},
"response": []
},
{
"name": "PUT /simpleconfirm - Save order to database",
"request": {
"method": "PUT",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/simpleconfirm",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"simpleconfirm"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/simpleconfirm
OR
http://yourdomain.com/index.php?route=rest/simple_confirm/confirm"
},
"response": []
},
{
"name": "POST /guest - Create guest user",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/guest",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"guest"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/guest
OR
http://yourdomain.com/index.php?route=rest/guest/guest",
"body": {
"mode": "raw",
"raw": "{\n \"firstname\": \"Demo\",\n \"lastname\": \"User\",\n \"email\": \"nash1@vipmail.hu\",\n \"telephone\": \"1-541-754-3010\",\n \"company\": \"\",\n \"city\": \"Berlin\",\n \"address_1\": \"Demo\",\n \"address_2\": \"Demo\",\n \"country_id\": 81,\n \"postcode\": \"3333\",\n \"zone_id\": 1256\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "POST /guestshipping - Set shipping address to order",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/guestshipping",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"guestshipping"
],
"variable": []
},
"description": "This method can be used by guests only.
Service urls:
http://yourdomain.com/api/rest/guestshipping
OR
http://yourdomain.com/index.php?route=rest/guest_shipping/guestshipping",
"body": {
"mode": "raw",
"raw": "{\n \"firstname\": \"Demo\",\n \"lastname\": \"User\",\n \"city\": \"Berlin\",\n \"address_1\": \"Demo\",\n \"address_2\": \"Demo\",\n \"country_id\": 81,\n \"postcode\": \"3333\",\n \"zone_id\": 1256\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "GET /account - Get account details",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/account",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"account"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/account
OR
http://yourdomain.com/index.php?route=rest/account/account"
},
"response": []
},
{
"name": "PUT /account - Update account data",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/account",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"account"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/account
OR
http://yourdomain.com/index.php?route=rest/account/account",
"body": {
"mode": "raw",
"raw": "{\n \"firstname\": \"Demo\",\n \"lastname\": \"User\",\n \"email\": \"nash1@vipmail.hu\",\n \"telephone\": \"1-541-754-3010\",\n \"custom_field\": {\n \"account\": {\n \"1\": \"+364545454\"\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "GET /customfield - Get list of customfields",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/customfield",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"customfield"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/account/customfield
OR
http://yourdomain.com/index.php?route=rest/account/customfield"
},
"response": []
},
{
"name": "PUT /account/password - Change customer's password",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/account/password",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"account",
"password"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/account/password
OR
http://yourdomain.com/index.php?route=rest/account/password",
"body": {
"mode": "raw",
"raw": "{\n \"password\": \"demopass\",\n \"confirm\": \"demopass\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "PUT /newsletter/subscribe - Subscribe newsletter",
"request": {
"method": "PUT",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/newsletter/subscribe",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"newsletter",
"subscribe"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/newsletter/subscribe
OR
http://yourdomain.com/index.php?route=rest/account/newsletter&subscribe=1"
},
"response": []
},
{
"name": "PUT /newsletter/unsubscribe - Unsubscribe newsletter",
"request": {
"method": "PUT",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/newsletter/unsubscribe",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"newsletter",
"unsubscribe"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/newsletter/unsubscribe
OR
http://yourdomain.com/index.php?route=rest/account/newsletter&subscribe=0"
},
"response": []
},
{
"name": "GET /account/transactions - List transactions",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/account/transactions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"account",
"transactions"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/account/transactions
OR
http://yourdomain.com/index.php?route=rest/account/transactions"
},
"response": []
},
{
"name": "GET /account/downloads - List downloads",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/account/downloads",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"account",
"downloads"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/account/downloads
OR
http://yourdomain.com/index.php?route=rest/account/downloads"
},
"response": []
},
{
"name": "GET /account/recurrings - List Recurrings",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/account/recurrings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"account",
"recurrings"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/account/recurrings
OR
http://yourdomain.com/index.php?route=rest/account/recurrings"
},
"response": []
},
{
"name": "GET /account/recurrings/{id} - Get recurring details",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/account/recurrings/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"account",
"recurrings",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/account/recurrings/{id}
OR
http://yourdomain.com/index.php?route=rest/account/recurrings&id={id}"
},
"response": []
},
{
"name": "GET /account/voucherthemes - List voucher themes",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/account/voucherthemes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"account",
"voucherthemes"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/account/voucherthemes
OR
http://yourdomain.com/index.php?route=rest/account/voucherthemes"
},
"response": []
},
{
"name": "POST /account/voucher - Add new voucher",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/account/voucher",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"account",
"voucher"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/account/voucher
OR
http://yourdomain.com/index.php?route=rest/account/voucher",
"body": {
"mode": "raw",
"raw": "{\n \"to_name\": \"Demo User\",\n \"to_email\": \"nash1@vipmail.hu\",\n \"from_name\": \"Demo Sender\",\n \"from_email\": \"demo@sender.com\",\n \"voucher_theme_id\": 8,\n \"message\": \"Hi Friend, this is your voucher.\",\n \"amount\": 8\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "GET /account/address - List addresses",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/account/address",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"account",
"address"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/account/address
OR
http://yourdomain.com/index.php?route=rest/account/address"
},
"response": []
},
{
"name": "POST /account/address - Add new address to customer",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/account/address",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"account",
"address"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/account/address
OR
http://yourdomain.com/index.php?route=rest/account/address",
"body": {
"mode": "raw",
"raw": "{\n \"firstname\": \"Demo\",\n \"lastname\": \"User\",\n \"city\": \"Berlin\",\n \"address_1\": \"Demo\",\n \"address_2\": \"Demo\",\n \"country_id\": 81,\n \"postcode\": \"3333\",\n \"zone_id\": 1256,\n \"company\": \"Demo Company name\",\n \"custom_field\": {\n \"address\": {\n \"3\": \"demo address 3\"\n }\n },\n \"default\": 0\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "GET /account/address/{id} - Get address by id",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/account/address/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"account",
"address",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/account/address/{address_id}
OR
http://yourdomain.com/index.php?route=rest/account/address&id={address_id}"
},
"response": []
},
{
"name": "PUT /account/address/{id} - Edit address",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/account/address/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"account",
"address",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/account/address/{address_id}
OR
http://yourdomain.com/index.php?route=rest/account/address&id={address_id}",
"body": {
"mode": "raw",
"raw": "{\n \"firstname\": \"Demo\",\n \"lastname\": \"User\",\n \"city\": \"Berlin\",\n \"address_1\": \"Demo\",\n \"address_2\": \"Demo\",\n \"country_id\": 81,\n \"postcode\": \"3333\",\n \"zone_id\": 1256,\n \"company\": \"Demo Company name\",\n \"custom_field\": {\n \"address\": {\n \"3\": \"demo address 3\"\n }\n },\n \"default\": 0\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "DELETE /account/address/{id} - Delete address",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/account/address/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"account",
"address",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/account/address/{address_id}
OR
http://yourdomain.com/index.php?route=rest/account/address&id={address_id}"
},
"response": []
},
{
"name": "GET /customerorders/limit/{limit}/page/{page} - Get list of customer orders",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/customerorders/limit/{limit}/page/{page}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"customerorders",
"limit",
"{limit}",
"page",
"{page}"
],
"variable": [
{
"key": "limit",
"value": ""
},
{
"key": "page",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/customerorders/limit/{limit}/page/{page}
OR
http://yourdomain.com/index.php?route=rest/order/orders&limit={limit}&page={page}"
},
"response": []
},
{
"name": "GET /customerorders/{id} - Get order details by ID",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/customerorders/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"customerorders",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/customerorders/{order_id}
OR
http://yourdomain.com/index.php?route=rest/order/orders&id={order_id}"
},
"response": []
},
{
"name": "POST /customerorders/{id}/product_id/{order_product_id} - Reorder order by ID",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/customerorders/{id}/product_id/{order_product_id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"customerorders",
"{id}",
"product_id",
"{order_product_id}"
],
"variable": [
{
"key": "id",
"value": ""
},
{
"key": "order_product_id",
"value": ""
}
]
},
"description": "After call this method, you have to confirm order, if you want really reorder..
Service urls:
http://yourdomain.com/api/rest/customerorders/{order_id}/product_id/{order_product_id}
OR
http://yourdomain.com/index.php?route=rest/order/orders&id={order_id}&order_product_id={order_product_id}"
},
"response": []
},
{
"name": "GET /returns - Get returns",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/returns",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"returns"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/returns
OR
http://yourdomain.com/index.php?route=rest/return/returns"
},
"response": []
},
{
"name": "POST /returns - Send return request",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/returns",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"returns"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/returns
OR
http://yourdomain.com/index.php?route=rest/return/returns
You can list return reasons with product classes service:
http://newapi2.opencart-api.com/demo/#!/product/products_productclasses",
"body": {
"mode": "raw",
"raw": "{\n \"firstname\": \"Demo\",\n \"lastname\": \"User\",\n \"email\": \"demo@demo.com\",\n \"telephone\": \"1-2566-45464\",\n \"date_ordered\": \"2017-05-14\",\n \"order_id\": 1,\n \"product\": \"Demo product\",\n \"model\": \"demo model\",\n \"return_reason_id\": 4,\n \"opened\": 1,\n \"quantity\": 1,\n \"comment\": \"\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "GET /returns/{id} - Get return details",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/returns/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"returns",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/returns/{return_id}
OR
http://yourdomain.com/index.php?route=rest/return/returns&id={return_id}"
},
"response": []
},
{
"name": "GET /wishlist - Get wishlist",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/wishlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"wishlist"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/wishlist
OR
http://yourdomain.com/index.php?route=rest/wishlist/wishlist"
},
"response": []
},
{
"name": "POST /wishlist/{id} - Add product to wishlist",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/wishlist/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"wishlist",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/wishlist/{product_id}
OR
http://yourdomain.com/index.php?route=rest/wishlist/wishlist&id={product_id}"
},
"response": []
},
{
"name": "DELETE /wishlist/{id} - Remove product from wishlist",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/wishlist/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"wishlist",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/wishlist/{product_id}
OR
http://yourdomain.com/index.php?route=rest/wishlist/wishlist&id={product_id}"
},
"response": []
},
{
"name": "GET /manufacturers - Get list of manufacturers",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/manufacturers",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"manufacturers"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/manufacturers
OR
http://yourdomain.com/index.php?route=feed/rest_api/manufacturers"
},
"response": []
},
{
"name": "GET /manufacturers/{id} - Get manufacturer details by ID",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/manufacturers/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"manufacturers",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/manufacturers/{manufacturer_id}
OR
http://yourdomain.com/index.php?route=feed/rest_api/manufacturers&id={manufacturer_id}"
},
"response": []
},
{
"name": "GET /categories - Get list of categories (default 1 level)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/categories",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"categories"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/categories
OR
http://yourdomain.com/index.php?route=feed/rest_api/categories"
},
"response": []
},
{
"name": "GET /categories/extended/limit/{limit}/page/{page} - Get list of categories (all in one request)",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/categories/extended/limit/{limit}/page/{page}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"categories",
"extended",
"limit",
"{limit}",
"page",
"{page}"
],
"variable": [
{
"key": "limit",
"value": ""
},
{
"key": "page",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/categories/extended/limit/{limit}/page/{page}
OR
http://yourdomain.com/index.php?route=feed/rest_api/categories&extended=1&limit={limit}&page={page}"
},
"response": []
},
{
"name": "GET /categories/slug/{slug} - Get category by slug",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/categories/slug/{slug}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"categories",
"slug",
"{slug}"
],
"variable": [
{
"key": "slug",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/categories/slug/{slug}
OR
http://yourdomain.com/index.php?route=feed/rest_api/categories&slug={slug}"
},
"response": []
},
{
"name": "GET /categories/level/{level} - Get list of categories by depth level",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/categories/level/{level}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"categories",
"level",
"{level}"
],
"variable": [
{
"key": "level",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/categories/level/{level}
OR
http://yourdomain.com/index.php?route=feed/rest_api/categories&level={level}"
},
"response": []
},
{
"name": "GET /categories/parent/{parent} - Get list of categories by parent ID",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/categories/parent/{parent}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"categories",
"parent",
"{parent}"
],
"variable": [
{
"key": "parent",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/categories/parent/{parent_id}
OR
http://yourdomain.com/index.php?route=feed/rest_api/categories%26parent={parent_id}"
},
"response": []
},
{
"name": "GET /categories/parent/{parent}/level/{level} - Get list of categories by parent ID and level",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/categories/parent/{parent}/level/{level}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"categories",
"parent",
"{parent}",
"level",
"{level}"
],
"variable": [
{
"key": "parent",
"value": ""
},
{
"key": "level",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/categories/parent/{parent_id}/level/{level}
OR
http://yourdomain.com/index.php?route=feed/rest_api/categories&parent={parent_id}&level={level}"
},
"response": []
},
{
"name": "GET /categories/{id} - Get category details by ID",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/categories/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"categories",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/categories/{catergory_id}
OR
http://yourdomain.com/index.php?route=feed/rest_api/categories&id={catergory_id}"
},
"response": []
},
{
"name": "GET /languages - Get list of languages",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/languages",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"languages"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/languages
OR
http://yourdomain.com/index.php?route=feed/rest_api/languages"
},
"response": []
},
{
"name": "GET /languages/{id} - Get language details by ID",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/languages/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"languages",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/languages/{language_id}
OR
http://yourdomain.com/index.php?route=feed/rest_api/languages&id={language_id}"
},
"response": []
},
{
"name": "GET /stores - Get list of stores",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/stores",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"stores"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/stores
OR
http://yourdomain.com/index.php?route=feed/rest_api/stores"
},
"response": []
},
{
"name": "GET /stores/{id} - Get store details by ID",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/stores/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"stores",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/stores/{store_id}
OR
http://yourdomain.com/index.php?route=feed/rest_api/stores&id={store_id}"
},
"response": []
},
{
"name": "GET /countries - Get list of countries",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/countries",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"countries"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/countries
OR
http://yourdomain.com/index.php?route=feed/rest_api/countries"
},
"response": []
},
{
"name": "GET /countries/{id} - Get zones by ID",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/countries/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"countries",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/countries/{country_id}
OR
http://yourdomain.com/index.php?route=feed/rest_api/countries&id={country_id}"
},
"response": []
},
{
"name": "GET /checksums - Get checksum of product specific tables",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/checksums",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"checksums"
],
"variable": []
},
"description": ""
},
"response": []
},
{
"name": "POST /contact - Send contact message",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/api/rest/contact",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"contact"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/contact
OR
http://yourdomain.com/index.php?route=rest/contact/send",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Demo User\",\n \"email\": \"test@test.com\",\n \"enquiry\": \"This is just a demo contact message.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "GET /slideshows - Get slideshows",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/slideshows",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"slideshows"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/slideshows
OR
http://yourdomain.com/index.php?route=feed/rest_api/slideshows"
},
"response": []
},
{
"name": "GET /banners - Get list of banners",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/banners",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"banners"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/banners
OR
http://yourdomain.com/index.php?route=feed/rest_api/banners"
},
"response": []
},
{
"name": "GET /banners/{id} - Get banner details",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/banners/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"banners",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/banners/{id}
OR
http://yourdomain.com/index.php?route=feed/rest_api/banners&id={id}"
},
"response": []
},
{
"name": "GET /information - Get list of information",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/information",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"information"
],
"variable": []
},
"description": "Service urls:
http://yourdomain.com/api/rest/information
OR
http://yourdomain.com/index.php?route=feed/rest_api/information"
},
"response": []
},
{
"name": "GET /information/{id} - Get information details by ID",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/rest/information/{id}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"rest",
"information",
"{id}"
],
"variable": [
{
"key": "id",
"value": ""
}
]
},
"description": "Service urls:
http://yourdomain.com/api/rest/information/{information_id}
OR
http://yourdomain.com/index.php?route=feed/rest_api/information&id={information_id}"
},
"response": []
}
],
"variable": [
{
"key": "baseUrl",
"value": "opencart3-oauth.opencart-api.com"
},
{
"key": "bearerToken",
"value": ""
},
{
"key": "ocSession",
"value": ""
}
],
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{bearerToken}}",
"type": "string"
}
]
}
}