Documentation of Opencart Shopping Cart REST API
Number of APIs: 116
For this demo, you can use the api key 123 to test the API services. Click on the Authorize button and set the secret key.HEADER parameter name Description X-Oc-Merchant-Id You have to send an extra header parameter with the secret key X-Oc-Merchant-Language Change the response language X-Oc-Currency Change response currency.You can load all available currecies with this service: http://yourdomain.com/api/rest/product_classes X-Oc-Image-Dimension Change the response image dimension. Possible values are: 1000x1000, 600x600, etc. Change Store If you want to load the categories or products of selected store, you need to send 'store_id' as GET parameter(default store id = 0) Checkout steps
Step 1 GET api/rest/sessionThe received session id needs to be added to every API call.
You have to send the received session id as an extra header parameter.
The extra header parameter name is X-Oc-Session.Add item to cart, register / login or be a guest buyer Create Guest user (only for guest checkout) POST api/rest/guestSet shipping address to Guest user (only for guest checkout) POST api/rest/guestshippingStep 2 (only for registered users) GET api/rest/paymentaddressload the payment address of the customer Step 3 (only for registered users) POST api/rest/paymentaddressset the payment address Step 4 (only for registered users) GET api/rest/shippingaddressload the shipping address of the customer. Step 5 (only for registered users) POST api/rest/shippingaddressset the shipping address Step 6 GET api/rest/shippingmethodsget all available shipping methods Step 7 POST api/rest/shippingmethodsset the shipping method Step 8 GET api/rest/paymentmethodsget all available payment methods Step 9 POST api/rest/paymentmethodsset the payment method Step 10 POST api/rest/confirmget an overview of the order Step 11 GET api/rest/payYou only need to call this service, if you want to start payment process in webview Step 12 PUT api/rest/confirmUpdate order status, empty cart, and clear session data.
GET {{baseUrl}}/session
The received session id needs to be added to every API call. You need to send as extra header parameter, the parameter's name is “X-Oc-Session“.
Service urls:
http://yourdomain.com/api/rest/session
OR
http://yourdomain.com/index.php?route=feed/rest_api/session
POST {{baseUrl}}/register
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
POST {{baseUrl}}/login
Service urls:
http://yourdomain.com/api/rest/login
OR
http://yourdomain.com/index.php?route=rest/login/login
4. Social login
POST {{baseUrl}}/sociallogin
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
5. Logs out current logged in user session
POST {{baseUrl}}/logout
ENDPOINTS