NAV Navbar
Logo
json

Introduction

Capillary Anywhere Commerce APIs are RESTful APIs that can be used to configure merchant data, handle customer activities, and manage orders. Anywhere Commerce APIs can be used for various in-house products and 3rd party integrations.

This document provides detailed information about each Anywhere Commerce API with appropriate sample codes.

Authentication (Merchant Setup on Admin Portal)

Capillary Anywhere Commerce APIs can be authenticated in two ways and the Authentication Headers differ based on the type you choose.

OAuth 1.0 Authentication

OAuth protocol authenticates users via tokens (a unique string that identifies a user), that is, instead of sending actual credentials to the server on every request, you can first exchange your user credentials for a ‘token’, and then authenticate the user based on this 'token’. The frequency of users passing credentials over the network will be less.

Headers

To use Anywhere Commerce Developer APIs, you need to include your application’s Authorization in the header in every request. However, you might require additional headers for few APIs which are mentioned in the respective sections.

Accept application/json
Content-Type application/x-www-form-urlencoded

Authorization

Authorization determines what permissions an authenticated identity has. To obtain access, you first need to obtain customer key and consumer secret of the app from the MartJack’s Control Panel > Apps > App Store and configure the header.

Authorization Type OAuth 1.0
PublicKey ${PublicKey}
Consumer Secret {app’s secret value}
APIVersion 3

JWT Authentication

JSON Web Token (JWT) Authentication is a new standard for creating token also called Token Based Authentication. This standard basically provides a set of rules for creating tokens in a very specific way, which makes tokens more useful for you in general.

The developer APIs provide sample code to create oAuth authentication token which contains Merchant Secret Key, Public Key and a few other parameters. For each data request, you need to pass the query string parameter with new oAuth signature along with other input parameters to the REST API.

To enable JWT for a merchant API integration app, you need to set the column EnableJWT=1 in the 'martjack.tblmerchantaddons` table for a specific merchant and public key combination.

** Back-end configuration required** To obtain access, you first need to add the app in the control panel and generate the Auth token (public key) for that app.

To generate Auth token use the API developerapi/OAuth/Token/${PublicKey}

Authorization Header

Accept application/json
Content-Type application/x-www-form-urlencoded
PublicKey ${PublicKey}
AuthToken ${AuthToken}
MerchantId ${merchantId}
languagecode The language of the application chosen by the end user in case on multilingual application. For example: en or ar

Request Information

Entry Description
URL {host}/developerapi/{resource}/. We recommend using secure HTTPS requests instead of http for all your calls
Host The server to which the API calls are made. This should be the URL of the respective cluster from where the calls are made.
- India: https://sg.ecom.capillary.in
- YUM: https://eu.ecom.capillary.in
- PH India: https://mb.ecom.capillary.in
- Walmart: wm.ecom.capillary.in
- Staging: http://staging.ecom.capillary.in
- Nightly: http://nightly.ecom.capillary.in
Resource Resource for which you want to perform an action. Supported resources: Banners, Brand, Carts, Category, Customer, CustomerGroups,GiftVoucher, Location, MailList, Merchant, Navigation, Order, PickList, Post, Pricelist, Product, ProductTags, ShoppingList, Store, and Voucher
HTTP Methods GET, POST, PATCH
Response Format JSON

How to pass POST body?

You always need to pass the POST body in the format specified below:

InputData={ <JSON PAYLOAD> }&InputFormat=application/json

For example:

InputData={ “customer”:{ “MobileNo”:“917411639xxx”, “UserName”:“917411639xxx”, “merchantId”:“98d18d82-ba59-4957-9c92-3f89207auyf6 ”}}&InputFormat=application/json

Generating Signature for Developer APIs

An API signature is a credential that consists of consumer key along with nonce, timestamp, oauth version and signature associated to the specific app. You can create API signature to authenticate your merchant app and access Anywhere Commerce APIs instead of the app’s consumer key and password. The signature allows our servers to verify whether a request generated using the API key is authorized. In an API call, signature is validated first followed by app permissions.

The following process guides you how to to generate and use signature.

What parameters are required for signature?

Following are the different parameters required to generate signature.

How to generate the parameters required for signature?

The following steps guide you how to generate each parameter required for generating signature. The value of oauth_signature_method is HMAC-SHA1 and oauth_version is 1.0.

The following sub-sections provide the process for generating values of other parameters.

Nonce:

You can generate Nonce using the following API

{host}/developerapi/OAuth/Nounce

Generating TimeStamp

Use the following API to generate TimeStamp

{host}/developerapi/OAuth/TimeStamp

Generating Outh Signature

To generate Outh Signature use the following

developerapi/OAuth/Signature/{public_key}/{secret_key}/{timeStamp}/{nonce}/{GET/POST}?url={URL}

Example:

http://www.martjack.com/developerapi/OAuth/Signature/QFTBNOUC/NDH1BYBFRYHSPDJXFV3RGISB/1548658024/5681074/POST?url=http://www.martjack.com/Customer/06e2d5fc-402b-475e-be79-592c2df95398/Create

Once you get the oauth_signature, you can make API calls. For example:

How to pass the signature?

You can pass the signature either as Headers or directly in the URL as explained below.

Passing as headers:

merchantId={merchantId}

oauth_consumer_key:{consumer key}

oauth_nonce:{Value generated from the nonce API}

oauth_signature_method: HMAC-SHA1

oauth_timestamp:{value generated from the timeStamp API}

oauth_version:1.0

oauth_signature:{generated through OAuth/Signature}

Passing directly in the request URL:

{API Request}?oauth_consumer_key=QFTBNOUC&oauth_nonce={oauth_nonce}&oauth_signature_method={HMAC-SHA1{&oauth_timestamp={timeStamp} &oauth_version=1.0&oauth_signature={oauth_signature}

For example: http://staging.ecom.capillary.in/developerapi/carts/applyvoucher/06e2d5fc-402b-475e-be79-592c2df95398/testvoucherCV1? oauth_consumer_key=QFTSEOUC &oauth_nonce=jREyWynNuaKAy3IA7s6l &oauth_signature_method=HMAC-SHB1 &oauth_timestamp=1548658766 &oauth_version=1.0 &oauth_signature=AeBXqh%2BfPmuVmUdksCAJ%2FyxNv3c%3D

OAuth SDKs

Alternatively, you can also use SDKs for authentication. Here you can see SDK and the installation process for different environments. Click here for the list of available OAuth SDKs

PHP SDK

Click here to access the PHP OAuth SDK.

Installation

Install pecl OAuth packages as mentioned below:

yum install pecl

sudo apt-get install php7.2-dev

pecl install oAuth

Usage

Go to examples and run

php7.2 ./request_signing.php

Java SDK

Click here to access the Java OAuth SDK.

oauth1-signature-builder:

Java 8 minimal library to create tailor-made OAuth-1.0a signatures (weights 24.5 KB).

Compatibility:

Java 7 or above

Usage

Run the java code in a compatible platform.

` public static void main(String[] args) {

OAuthConfig oauthConfig = new OAuthConfigBuilder(“myApiKey”, “myApiSecret”) .setTokenKeys(“myAccessKey”, “myAccessSecret”) .build();

OAuthSignature signature = oauthConfig.buildSignature(HttpMethod.GET, “http://serviceUrl”) .addQueryParam(“aParam”, “aValue”) .addFormUrlEncodedParam(“myParam”, “anotherValue”) .create();

System.out.println(signature.getAsHeader()); } `

This code will generate the value for a ready-to-be-used “Authorization” Header:

Authorization: OAuth oauth_nonce="1906386233", oauth_signature="sQYmuXQV2ROJS3ukvpeaNNl2Jp8=", oauth_token="myAccessKey", oauth_consumer_key="myApiKey", oauth_version="1.0", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1461291933"

Javascript SDK

The following process guides you in generating OAuth 1.0a signature for node and the browser. Click here to access the Javascript OAuth SDK.

Installation

Install with npm:

npm install oauth-signature

Usage

To generate the OAuth signature call the following method:

oauthSignature.generate(httpMethod, url, parameters, consumerSecret, tokenSecret, options)

The default options parameter is as follows. The following code will encode the signature following the RFC 3986 Spec by default

var options = { encodeSignature: true }

Example

The example on the right shows how to generate the signature for the reference sample

`

var httpMethod = 'GET’, url = 'http://photos.example.net/photos’, parameters = { oauth_consumer_key : 'dpf43f3p2l4k3l03’, oauth_token : 'nnch734d00sl2jdk’, oauth_nonce : 'kllo9940pd9333jh’, oauth_timestamp : '1191242096’, oauth_signature_method : 'HMAC-SHA1’, oauth_version : '1.0’, file : 'vacation.jpg’, size : 'original’ }, consumerSecret = 'kd94hf93k423kf44’, tokenSecret = 'pfkkdhi9sl3r4s00’, // generates a RFC 3986 encoded, BASE64 encoded HMAC-SHA1 hash encodedSignature = oauthSignature.generate(httpMethod, url, parameters, consumerSecret, tokenSecret), // generates a BASE64 encode HMAC-SHA1 hash signature = oauthSignature.generate(httpMethod, url, parameters, consumerSecret, tokenSecret, { encodeSignature: false}); `

The encodedSignature variable will contain the RFC 3986 encoded, BASE64 encoded HMAC-SHA1 hash, ready to be used as a query parameter in a request: tR3%2BTy81lMeYAr%2FFid0kMTYa%2FWM%3D.

The signature variable will contain the BASE64 HMAC-SHA1 hash, without encoding: tR3+Ty81lMeYAr/Fid0kMTYa/WM=.

.NET SDK

OAuth Generator is a .NET project written in C#. Click here to access the .NET SDK.

Requirements

Visual Studio should be installed and .NET packages installed.

Usage

Open OAuth.sln using Visual Studio and run directly to get a console window. The user will be prompted to enter the consumer key and consumer secret. The option for entering other values will be provided.

Customer

A customer is an individual who buys products from a merchant’s online store. This resource consists of APIs to create new customer accounts and manage their details and preferences.

Create Customer Account

This API lets you create a new user account on the Capillary’s Anywhere Commerce Platform for a specific merchant.

Sample Request

https://www.martjack.com/developerapi/Customer/12345678-1234-1234-1234-123456789xxx/Create

Sample POST Request

InputFormat=application/json&InputData={  
   "customer":{  
      "UserName":"tom.sawyer@capillarytech.com",
      "FirstName":"Tom",
      "LastName":"Sawyer",
      "PostalAddress":"100, Santa Plaza",
      "AlternateEmail":"alternateEmail@gmail.com",
      "City":"3451",
      "Pin":"560001",
      "State":"KA",
      "Country":"IN",
      "Street":"MG Road",
      "MobileNo":"917000000000",
      "BirthDate":"1/1/1994 12:00:00",
      "Gender":"F",
      "Occupation":"Professor",
      "Industry":"Education",
      "OtherArea":"otherArea",
      "CountryName":"India",
      "StateName":"Karnataka",
      "CityName":"Bangalore",
      "AreaName":"Area Name",
      "OtherCity":"OtherCity",
      "IsReceiveOffers":false,
      "States":null,
      "merchantId":"81e77da2-723b-483d-8c0d-49f800c1xxxx",
      "Password":"ABG-704@cp",
      "CommunicationType":null,
      "PreferredLanguage":"en"
   }
}

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "Customer": {
        "UserProfiles": null,
        "UserInfoId": "00000000-0000-0000-0000-000000000000",
        "UserId": "9b0df0ca-101c-4525-ac55-33829319085a",
        "MerchantId": "81e77da2-723b-483d-8c0d-49f800cxxxx",
        "UserName": "tom.sawyer@capillarytech.com",
        "FirstName": "Tom",
        "LastName": "Sawyer",
        "PostalAddress": "100, Santa Plaza",
        "AlternateEmail": "alternateEmail@gmail.com",
        "City": "3451",
        "Pin": "560001",
        "State": "KA",
        "Country": "IN",
        "Street": "MG Road",
        "MobileNo": "917000000000",
        "BirthDate": "1/1/1994 12:00:00 PM",
        "Gender": "M",
        "Occupation": "Job",
        "Industry": "Private",
        "OtherArea": "otherArea",
        "CountryName": "India",
        "StateName": "Karnataka",
        "CityName": "Bangalore",
        "AreaName": "Area Name",
        "OtherCity": "OtherCity",
        "IsReceiveOffers": false,
        "Password": null,
        "ConfirmPassword": null,
        "Countries": null,
        "States": null,
        "CommunicationType": "nochannel",
        "MarketingNotificationType": "sms|email|push",
        "PreferredLanguage":"en"
    },
    "ErrorCode": 0
}

Resource Information

URI Customer/{merchantId}/Create
Response Formats JSON
HTTP Method POST
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/{merchantId}/Create

Request Body Parameters

Parameter Type Description
UserName* string The username of the customer’s account on the merchant’s Anywhere Commerce platform. It could be email, mobile, or any other identifier
merchantId* string The unique id (GUID) of the merchant in which you want to register customer
Password* string Password of the customer account. Password policy is as configured for the merchant on the Merchant Panel
CommunicationType enum The preferred communication channel(s) of the customer. Possible Values: SMS, EMAIL
City int Unique code of the city (as saved in the system) of the customer’s billing address. Example, 0562 (for Agra), and 250 (Victoria)
CityName string Full name of the city. Example: Bangalore, Delhi, Tokyo, Singapore and Paris
State string State’s postal abbreviation. Example: KA (for Karnataka), CA (for California), IN (for Indiana)
StateName string Full name of the state. Example: Karnataka, California, and Indiana
Country string Alpha-2 code of the country as per the customer’s billing address. Example: IN (for India), AU (for Australia), and BR (for Brazil)
CountryName string Full name of the country. Example: India, Australia, and Brazil
IsReceiveOffers boolean Used by merchants with CRM enabled. Specify true subscribe customer’s mobile number/email id in CRM to receive offers, else speify false
PreferredLanguage string Specify the preferred language of the customer in ISO code. For example, en for English, ar Arabic

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
UserProfiles array Customer level custom field details
UserInfoId string Internal GUID generated for the customer. UserInfoId is used along with the userId in APIs like customer update
MarketingNotificationType enum Channel used for marketing communications. Supported value: SMS, Email

Update Customer Details

Sample Request

https://www.martjack.com/developerapi/Customer/7c778337-4652-4944-934f-09e0fe56xxxx/Update

Sample POST Request

InputFormat=application/json&InputData={  
   "customer":{  
      "UserInfoId":"021e57ca-f19a-42c4-8214-180ad7202044",
      "UserId":"1142e724-0f59-4b43-ace6-f10e0e2fxxxx",
      "merchantId":"7c778337-4652-4944-934f-09e0fe56xxxx",
      "UserName":"tom.sawyer@capillarytech.com",
      "FirstName":"Tom",
      "LastName":"Sawyer",
      "PostalAddress":"",
      "AlternateEmail":"",
      "City":"32",
      "Pin":"560001",
      "State":"KA",
      "Country":"IN",
      "PhoneNo":"",
      "Street":"",
      "MobileNo":"917400000000",
      "BirthDate":"01/01/1993",
      "Gender":"male",
      "Occupation":"",
      "Industry":"",
      "OtherArea":"",
      "CountryName":"",
      "IsReceiveOffers":false,
      "PreferredLanguage":"en"
   }
}

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "ErrorCode": 0
}

Updates the details of a registered customer except unique identifier.

Resource Information

URI Customer/{merchantId}/Update
Response Formats JSON
HTTP Methods POST
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/{merchantId}/Update

Additional Header Required

Header Description
accesstoken* Access token of the logged in user to validate the session

Request Body Parameters

Parameter Type Description
UserId* string Unique GUID of the customer that you want to update details
City string Unique code of the customer’s billing city (as saved in the system) Example: 0562 (for Agra), 250 (Victoria)
CityName string Full name of the city. Example: Bangalore,
State string State’s postal abbreviation. Example: KA (for Karnataka), CA (for California), IN (for Indiana)
StateName string Full name of the state such as Karnataka, California, and Indiana
Country string Alpha-2 code of the country of the customer. Example, IN (for India), AU (for Australia), BR (for Brazil)
CountryName string Full name of the country. Example, India, Australia, and Brazil
PreferredLanguage string Specify the preferred language of the customer in ISO code. For example, en for English, ar Arabic

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
IsReceiveOffers boolean Whether the user is subscribed to receive offers from the merchant or not

Customer Login (with OTP)

Sample Request

https://www.martjack.com/developerapi/Customer/81e77da2-723b-483d-8c0d-49f800c1exxx/LoginWithOTP/true?username=599999999&oTP=2222

Sample POST Request

InputFormat=application/json&InputData={
"OTP": "2222", 
"UserName": 599999999
}

Sample Response

{  
   "messageCode":"1004",
   "Message":"Logged In successfully",
   "Token":{  
      "AccessToken":"i1z1ouqyb3roglpei1vmpowe",
      "issued_at":"/Date(1533029929318+0530)/",
      "UserId":"132d3c1d-7d71-4b87-9a69-a4d216d63xxx",
      "MerchantId":"81e77da2-723b-483d-8c0d-49f800c1exxx"
   },
   "ErrorCode":0
}

Authorizes an existing user account through OTP for an existing customer; registers a new customer first and then authorizes the account through OTP for a new customer.

Resource Information

Parameter Description
URI /Customer/{merchantId}/LoginWithOTP/true?username={username}&oTP={OTP}
Response Formats JSON
HTTP Methods POST
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/{merchantId}/LoginWithOTP/true?username={username}&oTP={OTP}

Additional Headers Required

Header Description
AccessToken Access token of the current session (generate using GET AccessToken API)
otptoken OTP token of the issued OTP (Generated in the SendOTP API response)

Request Body Parameters

Parameter Type Description
username* string Username of the customer account
oTP* int Unique verification code received to the customer’s registered mobile number or email id (through SendOTP API)

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
AccessToken string An object or string that identifies the current user. Access token is required to make customer related API calls such as validate token, update customer details, update profile attributes, and so on
issued_at date-time The date and time when the access token was generated for the user

Customer Login (with Credentials)

Sample Request

https://www.martjack.com/developerapi/Customer/12345678-1234-1234-1234-1234567890AB/login

Sample POST Request

InputFormat=application/json&InputData={  
   "username":"tom.sawyer@capillarytech.com",
   "password":"123456!"
}

Sample Response

{  
   "messageCode":"1004",
   "Message":"Logged In successfully",
   "Token":{  
      "AccessToken":"i1z1ouqyb3roglpei1vmpowe",
      "issued_at":"/Date(1533029929318+0530)/",
      "UserId":"132d3c1d-7d71-4b87-9a69-a4d216d63xxx",
      "MerchantId":"81e77da2-723b-483d-8c0d-49f800c1exxx"
   },
   "ErrorCode":0
}

Authorizes login of a registered customer on the merchant’s Anywhere Commerce store based on the username and password passed. A unique user id is shown for the logged in user in response which is required to make customer related API calls.

Resource Information

Parameter Description
URI /Customer/{merchantId}/login
Response Formats JSON
HTTP Methods POST
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/{merchantId}/login

Request Body Parameters

Parameter Type Description
username* string Username of the customer account
password* string Password of the customer account

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
AccessToken string An object or string that identifies the current user. Access token is required to make customer related API calls such as validate token, update customer details, update profile attributes, and so on
issued_at date-time The date and time when the access token was generated for the user

Customer Login (with Third Party Authentication)

Authenticates customer login with a third-party provider such as Gmail, and Facebook.

Sample Request

http://martjack.com/developerapi/Customer/9820eca5-d11f-4df1-9b20-983a45ea9631/LoginWithThirdPartyProvider

Sample POST Request

InputFormat=application/json&InputData={
   "provider":"gmail",
   "profileId":"example123",
   "email":"tom.sawyer@capillarytech.com",
   "MobileNo":"91-7411600000",
   "FirstName":"Tom",
   "LastName":"Sawyer",
   "gender":"M",
   "loginId":"tom.sawyer@capillarytech.com",
   "subscribeToOffers":"true"
}

Sample Response

{
  "messageCode": "1004",
  "Message": "Logged In successfully",
  "Token": {
    "AccessToken": "50p2yjcmiizlfyltl3vrltvj",
    "issued_at": "/Date(1543483006985+0530)/",
    "UserId": "5820c36d-7148-4154-afa7-32b0798f21f6",
    "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631"
  },
  "ErrorCode": 0
}

Resource Information

URI /Customer/{merchantId}/LoginWithThirdPartyProvider
Response Formats JSON
HTTP Methods POST
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/{merchantId}/LoginWithThirdPartyProvider

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
provider* string Name of the third party service provider through which the customer wants to login
profileId* string Unique profile id of the service provider
email string Email id of the user registered with the third-party provider
firstName string First name of the user
lastName string Last name of the user
gender string Customer gender. Value: M for male and F for female
loginId string Login username (as per the third party)
mobileNo string Registered mobile number of the user that is registered with the provider
subscribeToOffers enum Specify true to subscribe the user to the merchant offers, specify false not to subscribe

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
AccessToken string An object or string that identifies the current user. Access token is required to make customer related API calls such as validate token, update customer details, update profile attributes, and so on
issued_at date-time The date and time when the access token was generated for the user

Customer Login (with Third Party Async)

Authenticates customer login with a third-party provider - Google and Facebook - through access token. This API works only for merchants having registration setting email or email/mobile provided the login id and/or email is email value.

Sample Request

http://martjack.com/developerapi/Customer/9820eca5-d11f-4df1-9b20-983a45ea9631/LoginWithThirdPartyProviderAsync

Sample POST Request

InputFormat=application/json&InputData={
   "provider":"google",
   "profileId":"example123",
   "email":"test.user@capillarytech.com",
   "MobileNo":"91-7411600000",
   "FirstName":"Test",
   "LastName":"User",
   "gender":"M",
   "loginId":"test.user@capillarytech.com",
   "”Token”":"ya29.ImG9BzJnCduB6sjq7xVEPlTVnEHtO4GnEwxbbvhStq6aaW6GgKtY1odasEKK5M6MkPpBhpncISyJ3fWA48IyhbhGeBvnD0db1oKf8fo5uXsfWGgXhSs2wqzTi3NIWVGkZLFG",
   "subscribeToOffers":"true"
}

Sample Response

{
  "messageCode": "1004",
  "Message": "Logged In successfully",
  "Token": {
    "AccessToken": "50p2yjcmiizlfyltl3vrltvj",
    "issued_at": "/Date(1543483006985+0530)/",
    "UserId": "5820c36d-7148-4154-afa7-32b0798f21f6",
    "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631"
  },
  "ErrorCode": 0
}

Resource Information

URI /Customer/{merchantId}/LoginWithThirdPartyProviderAsync
Response Formats JSON
HTTP Methods POST
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/{merchantId}/LoginWithThirdPartyProviderAsync

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
provider* string Name of the third party through which the customer wants to login. Currently supported values: google, facebook
profileId* string Unique profile id of the third-party provider
email** string Email id of the user registered with the third-party provider. Either email or loginId is mandatory.
firstName string First name of the user
lastName string Last name of the user
gender string Customer gender. Value: M for male and F for female
loginId** string Login username (as per the third party - usually, email ID). Either email or loginId is mandatory. If this is left blank, it considers the value of the email param.
Token* string Unique object or string generated for the current user
mobileNo string Registered mobile number of the user that is registered with the provider
subscribeToOffers enum Specify true to subscribe the user to the merchant offers, specify false not to subscribe

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
AccessToken string An object or string that identifies the current user. Access token is required to make customer related API calls such as validate token, update customer details, update profile attributes, and so on
issued_at date-time The date and time when the access token was generated for the user

Start Customer Session

Starts a new customer session and generates access token which is required to make customer related API calls.

Sample Request

http://martjack.com/developerapi/Customer/6c57599f-2c43-4c82-806a-e07c3410f5d3/StartCustomerSession

Sample POST Request

MerchantId=6c57599f-2c43-4c82-806a-e07c3410f5d3&InputFormat=application/json&InputData={  
   "username":"tom.sawyer@example.com",
   "operatorid":"00abbff7-50be-487e-a5f3-319eef982f2b",
   "password":"ABG-70@cp",
   "locationid":"17444"
}

Sample Response

{  
   "messageCode":"1004",
   "Message":"Logged In successfully",
   "Token":{  
      "AccessToken":"i1z1ouqyb3roglpei1vmpowe",
      "issued_at":"/Date(1533029929318+0530)/",
      "UserId":"132d3c1d-7d71-4b87-9a69-a4d216d63xxx",
      "MerchantId":"6c57599f-2c43-4c82-806a-e07c3410f5d3"
   },
   "ErrorCode":0
}

Resource Information

URI /Customer/{MerchantId}/StartCustomerSession
Response Formats JSON
HTTP Methods POST
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/{merchantId}/StartCustomerSession

Additional Header Required

Header Description
accesstoken* Access token of the logged in user that you want to logout

Request Parameters

Parameter Type Description
merchantId* string Unique id (GUID) of the merchant
username string Registered login username of the customer
operatorid string Unique GUID of the back-end operator or current CP user id. The generated access token will be associated to both the user and operator
password string Password of the operator account
locationid int Location id associated to the operator

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
AccessToken string An object or string that identifies the current user. Access token is required for making customer related API calls such as validate token, update customer details, update profile attributes, and so on
issued_at date-time Date and time of generation of the access token

Change Password

Sample Request

https://www.martjack.com/developerapi/Customer/f48fdd16-92db-4188-854d-1ecd9b62xxxx/132d3c1d-7d71-4b87-9a69-a4d216d63xxx/ChangePassword?password=1234

Sample Response

{  
   "messageCode":"1004",
   "Message":"Your Password changed Successfully",
   "ErrorCode":0
}

Lets you change password of the current customer account.

Resource Information

URI /Customer/{merchantId}/{UserId}/ChangePassword?password={newPassword}
Response Formats JSON
HTTP Methods POST (No POST body required)
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/{merchantId}/{UserId}/ChangePassword?password={newPassword}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant associated to the user account
UserId* string Unique GUID of the user to change the password
newPassword* string New password that you prefer

Change Password (V2)

Lets you change the password of an existing customer account.

Sample Request

https://www.martjack.com/DeveloperAPI/Customer/v2/changePassword/81e77da2-723b-483d-8c0d-49f800c1exxx/f72da7b6-9566-4c99-b0e6-aa882e7acxxx

Sample POST Request

InputFormat=application/json&InputData={
    "OldPassword":"passwordOld",
    "NewPassword":"passwordNew"
}


Sample Response

{  
   "messageCode":"1004",
   "Message":"Your Password changed Successfully",
   "ErrorCode":0
}

Resource Information

URI /Customer/v2/changePassword/{merchantId}/{userId}
Response Formats JSON
HTTP Methods POST
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/v2/changePassword/{{merchantid}}/{[userid}}

Additional Header Required

Header Description
AccessToken* Access token of the logged in user whose password needs to be changed
APIversion* 1

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
userId* string Unique GUID of the current user

Request Body Parameters

Parameter Type Description
OldPassword* string Current password of the customer account
NewPassword* string New password of the customer account

Generate Reset ID (V2 - ResetPassword)

Generates unique reset id to the provided email id to reset password.

Sample Request

https://www.martjack.com/DeveloperAPI/Customer/81e77da2-723b-483d-8c0d-49f800c1exxx/V2/ResetPassword

Sample POST Request

InputFormat=application/json&InputData={
  "ResetPasswordRequest": {
    "UserName": "tom.sawyer@example.com",
    "Url": "https://www.example.nightlysites.capillary.in"
  }
}

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "ErrorCode": 0
}

Resource Information

URI /Customer/{MerchantId}/v2/resetPassword
Response Formats JSON
HTTP Methods POST
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/{MerchantId}/v2/resetPassword

Additional Header Required

Header Description
AccessToken* Access token of the logged in user

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
UserName* string Unique login username of the customer. For example, email id
Url string Link to reset password that you want to send to the customer’s email id. Reset id generated automatically and is appended to the URL you specify

Validate Reset Request

Validates the mobile number or email id of the customer to process reset password request.

Sample Request

https://www.martjack.com/DeveloperAPI/Customer/81e77da2-723b-483d-8c0d-49f800c1exxx/ValidateResetRequest

Sample POST Request (for mobile number validation)

InputFormat=application/json&InputData={
  "ResetPasswordDetails": {
    "UserName": "9876000000",
    "Resettype": "mobile",
    "otp": "3423"
  }
}

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "ErrorCode": 0,
    "UserId": "3aed9e45-65d8-4b21-8ec1-b25134499744"
}

Resource Information

URI /Customer/{MerchantId}/ValidateResetRequest
Response Formats JSON
HTTP Methods POST
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/{MerchantId}/ValidateResetRequest

Additional Header Required

Header Description
AccessToken* Access token of the logged in user

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
UserName* string Username of the customer account - mobile number or email id
Resettype* enum Specify mobile for mobile number validation, email for email id validation
resetid string Unique reset id generated when resetting the password through email id. Required when Resettype is email (generated through ResetPassword API when username is email id)
OTP int OTP sent to the customer’s mobile number when Resettype is mobile (generated through ResetPassword API when username is mobile number)

Customer Logout

Sample Request

https://www.martjack.com/DeveloperAPI/Customer/81e77da2-723b-483d-8c0d-49f800c1exxx/Logout

Sample Response

{
  "messageCode": "1004",
  "Message": "Logout Successfully",
  "ErrorCode": 0
}

Logs out the current user account. No POST body is required for this API.

Resource Information

URI /Customer/{MerchantId}/Logout
Response Formats JSON
HTTP Methods POST (No POST body is required)
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/{merchantId}/Logout

Additional Header Required

Header Description
accesstoken* Access token of the logged in user that you want to logout

Request Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant

Get Access Token

Sample Request

 https://www.martjack.com/developerapi/Customer/GetAccessToken/6c57599f-2c43-4c82-806a-e07c3410xxx

Sample Response

{
  "messageCode": "1004",
  "Message": "Logged In successfully",
  "Token": {
    "AccessToken": "gmah4uer4x5clfm1pxczhxxx",
    "issued_at": "/Date(1534759560943+0530)/",
    "UserId": "f72da7b6-9566-4c99-b0e6-aa882e7acxxx",
    "MerchantId": "6c57599f-2c43-4c82-806a-e07c3410xxx"
  },
  "ErrorCode": 0
}

Creates a dummy access token for the current user who did not logged in to the merchant Anywhere Commerce store. No POST body is required for this API.

Resource Information

URI Customer/GetAccessToken/{MerchantId}
Response Formats JSON
HTTP Methods POST (No POST body is required)
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/GetAccessToken/{MerchantId}

Request Parameters

Parameter Type Description
merchantId* string The unique GUID of the merchant

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
AccessToken string An object or string that identifies the current session
issued_at date-time Date and time of generation of the access token

Validate Access Token

Sample Request

https://www.martjack.com/developerapi/Customer/81e77da2-723b-483d-8c0d-49f800c1exxx/gmah4uer4x5clfm1pxczhxxx/ValidateToken

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "SessionValid": "true",
    "ErrorCode": 0
}

Verifies if the provided access token is valid or invalid.

Resource Information

URI /Customer/{merchantId}/{accesstoken}/ValidateToken
Response Formats JSON
HTTP Methods GET
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/{merchantId}/{accesstoken}/ValidateToken

Request Parameters

Parameter Type Description
merchantId* string The unique GUID of the merchant where to validate access token
accesstoken* string The access token generated for the current user session (use /Customer/GetAccessToken/ to get access token of a user session)

Activate User Account

Activates a deactivated user account.

Sample Request

https://www.martjack.com/developerapi/Customer/Activation/f48fdd16-92db-4188-854d-1ecd9b62xxxx/07e8f0eb-8c5d-4ad7-ab6e-ca7a72687d63

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "ErrorCode": 0
}

Resource Information

URI /Customer/Activation/{MerchantId}/{UserId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Customer/Activation/{MerchantId}/{UserId}

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
UserId* string Unique GUID of the user that you want to activate

Deactivate User Account

Deactivates an active user account.

Sample Request

https://www.martjack.com/developerapi/Customer/DeActivation/f48fdd16-92db-4188-854d-1ecd9b62xxxx/07e8f0eb-8c5d-4ad7-ab6e-ca7a72687d63

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "ErrorCode": 0
}

Resource Information

URI /Customer/DeActivation{MerchantId}/{UserId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Customer/DeActivation/{MerchantId}/{UserId}

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
UserId* string Unique GUID of the user that you want to deactivate

Search Customers

Sample Request

https://www.martjack.com/developerapi/Customer/f48fdd16-92db-4188-854d-1ecd9b62xxxx/Search

Sample POST Request

InputFormat=application/json&InputData={  
   "customerSearch":{  
      "UserName":"tom"
   }
}

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "Customers": [
        {
            "UserProfiles": [],
            "UserInfoId": "4370d39c-d5e6-44e3-8fa3-2e3caf9432bf",
            "UserId": "07e8f0eb-8c5d-4ad7-ab6e-ca7a72687d63",
            "MerchantId": "f48fdd16-92db-4188-854d-1ecd9b62xxxx",
            "UserName": "tom.sawyer@example.com",
            "FirstName": "Tom",
            "LastName": "Sawyer",
            "PostalAddress": "silkboard",
            "AlternateEmail": "",
            "City": "32",
            "Pin": "560068",
            "State": "KA",
            "Country": "IN",
            "PhoneNo": "91-",
            "Street": "",
            "MobileNo": "91-7411639213",
            "BirthDate": "1/1/1900",
            "Gender": "",
            "Occupation": "",
            "Industry": "",
            "OtherArea": "silkboard",
            "CountryName": "India",
            "StateName": "Karnataka",
            "CityName": "Bangalore",
            "AreaName": "",
            "OtherCity": "",
            "IsReceiveOffers": false,
            "Password": null,
            "ConfirmPassword": null,
            "Countries": null,
            "States": null,
            "CommunicationType": null,
            "MarketingNotificationType": null
        }
    ],
    "ErrorCode": 0
}

Retrieves customers matching the specified search keyword in either username, mobile number or email id.

Resource Information

URI /Customer/{merchantId}/Search
Response Formats JSON
HTTP Methods POST
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/{merchantId}/Search

Request Body Parameters

Parameter Type Description
UserName** string Fetches all customers matching the specified keyword in the username. For example, if you specify tom, you will get all customers whose username start with tom
mobile** string Fetch customers whose registered mobile number contains the specified keyword. For example, you can get all customers whose mobile numbers contain 9945
email** string Search customers whose registered email id contains a specified keyword. For example, you can get all customers whose email ids contain john
SearchType** CreateDate, UserName

FromDate:“2019/04/25”, ToDate:“2019/04/25”

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
UserProfiles array Customer level custom field details
UserInfoId string GUID generated for the customer internally. UserInfoId is used in APIs like customer update along with the UserId
CommunicationType string The preferred communication channel(s) of the customer. Possible Values: SMS, EMAIL
MarketingNotificationType enum Channel used for marketing communications. Values: SMS/Email

Get Customer Details

Sample Request

https://www.martjack.com/developerapi/Customer/81e77da2-723b-483d-8c0d-49f800c1xxxx/132d3c1d-7d71-4b87-9a69-a4d216d634fa

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "Customer":{  
      "UserProfiles":[  
         {  
            "UserId":"132d3c1d-7d71-4b87-9a69-a4d216d634fa",
            "ProfileAttributeId":660,
            "ProfileAttributeValueId":0,
            "ProfileAttributeName":"Favorite Game",
            "ProfileAttributeValue":"Football"
         }
      ],
      "UserInfoId":"08a0dffe-86f0-45b6-9fae-df276fe9abb5",
      "UserId":"132d3c1d-7d71-4b87-9a69-a4d216d634fa",
      "MerchantId":"81e77da2-723b-483d-8c0d-49f800c1xxxx",
      "UserName":"tom.sawyer@capillarytech.com",
      "FirstName":"Tom",
      "LastName":"Sawyer",
      "PostalAddress":"",
      "AlternateEmail":"",
      "City":"32",
      "Pin":"560001",
      "State":"KA",
      "Country":"IN",
      "PhoneNo":"",
      "Street":"MG Road",
      "MobileNo":"917000000000",
      "BirthDate":"1/1/1994",
      "Gender":"male",
      "Occupation":"Professor",
      "Industry":"Education",
      "OtherArea":"",
      "CountryName":"India",
      "StateName":"Karnataka",
      "CityName":"Bangalore",
      "AreaName":"MG Road",
      "OtherCity":"OtherCity",
      "IsReceiveOffers":false,
      "Password":null,
      "ConfirmPassword":null,
      "Countries":null,
      "States":null,
      "CommunicationType":"nochannel",
      "MarketingNotificationType":"sms|email|push",
      "PreferredLanguage": "en",
      "IsActivated": true
   },
   "ErrorCode":0
}

Retrieves the details of a specific customer based on the user id passed.

Resource Information

URI /Customer/{merchantId}/{UserId}
Response Formats JSON
HTTP Methods GET
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/{merchantId}/{UserId}

Request Parameters

Parameter Type Description
merchantId* string The unique GUID of the merchant associated to the customer account
UserId* string The unique GUID of the customer to fetch details

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
UserProfiles array Customer level custom field details
UserInfoId string GUID generated for the customer internally. UserInfoId is used in APIs like customer update along with the UserId
CommunicationType string The preferred communication channel(s) of the customer. Possible Values: SMS, EMAIL
MarketingNotificationType enum Channel(s) used for marketing communications. Value: SMS, Email
PreferredLanguage string Preferred language of the customer in ISO code. For example, en for English, ar Arabic
IsActivated boolean Flag that specifies if the customer is active (true) or inactive false

Get All Customers

Sample Request

 https://www.martjack.com/DeveloperAPI/Customer/9820eca5-d11f-4df1-9b20-983a45ea9631/All

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "Customers": [
    {
      "UserProfiles": [],
      "UserInfoId": "f017da55-32fe-4ce4-966b-fe38be1965af",
      "UserId": "4a9cab14-36d2-4326-a4e4-9b3f5b216adc",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "UserName": "tom.sawyer@example.com",
      "FirstName": "Tom",
      "LastName": "Sawyer",
      "PostalAddress": "321/1, MG Road",
      "AlternateEmail": "",
      "City": "",
      "Pin": "560076",
      "State": "KA",
      "Country": "IN",
      "PhoneNo": "",
      "Street": "",
      "MobileNo": "919050000000",
      "BirthDate": "1/1/1900",
      "Gender": "",
      "Occupation": "",
      "Industry": "",
      "OtherArea": "",
      "CountryName": "India",
      "StateName": "Karnataka",
      "CityName": "",
      "AreaName": "",
      "OtherCity": "",
      "IsReceiveOffers": false,
      "Password": null,
      "ConfirmPassword": null,
      "Countries": null,
      "States": null,
      "CommunicationType": "sms|email|push",
      "MarketingNotificationType": "sms|email|push",
      "PreferredLanguage": "en",
      "IsActivated": true
    },
    {
      "UserProfiles": [
        {
          "UserId": "4ae38f81-f459-41f5-bddd-4115bd726d2c",
          "ProfileAttributeId": 972,
          "ProfileAttributeValueId": 0,
          "ProfileAttributeName": "Ser",
          "ProfileAttributeValue": ""
        },
        {
          "UserId": "4ae38f81-f459-41f5-bddd-4115bd726d2c",
          "ProfileAttributeId": 974,
          "ProfileAttributeValueId": 0,
          "ProfileAttributeName": "test",
          "ProfileAttributeValue": ""
        }
      ],
      "UserInfoId": "a1caa9d8-585b-47bd-866c-96f599f35256",
      "UserId": "4ae38f81-f459-41f5-bddd-4115bd726d2c",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "UserName": "bhaarath@example.com",
      "FirstName": "Bhaarat",
      "LastName": "",
      "PostalAddress": "",
      "AlternateEmail": "",
      "City": "554",
      "Pin": "",
      "State": "",
      "Country": "",
      "PhoneNo": "",
      "Street": "",
      "MobileNo": "91-9533000000",
      "BirthDate": "1/1/1900",
      "Gender": "M",
      "Occupation": "",
      "Industry": "",
      "OtherArea": "",
      "CountryName": "",
      "StateName": "",
      "CityName": "",
      "AreaName": "",
      "OtherCity": "",
      "IsReceiveOffers": true,
      "Password": null,
      "ConfirmPassword": null,
      "Countries": null,
      "States": null,
      "CommunicationType": "sms|email|push",
      "MarketingNotificationType": "sms|email|push",
      "PreferredLanguage": "en",
      "IsActivated": true
    },
    {
      "UserProfiles": [],
      "UserInfoId": "0b059921-adbc-4443-ab41-e06e90f836c5",
      "UserId": "4ca92fd6-6a48-4f83-984f-b794670ba812",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "UserName": "james@example.com",
      "FirstName": "James",
      "LastName": "",
      "PostalAddress": "",
      "AlternateEmail": "",
      "City": "554",
      "Pin": "",
      "State": "",
      "Country": "",
      "PhoneNo": "",
      "Street": "",
      "MobileNo": "0-",
      "BirthDate": "1/1/1900",
      "Gender": "M",
      "Occupation": "",
      "Industry": "",
      "OtherArea": "",
      "CountryName": "",
      "StateName": "",
      "CityName": "",
      "AreaName": "",
      "OtherCity": "",
      "IsReceiveOffers": false,
      "Password": null,
      "ConfirmPassword": null,
      "Countries": null,
      "States": null,
      "CommunicationType": "sms|email|push",
      "MarketingNotificationType": "sms|email|push",
      "PreferredLanguage": "en",
      "IsActivated": true
    },
    {
      "UserProfiles": [],
      "UserInfoId": "a0d51fd9-8522-45c4-bd21-4ba76eab97ec",
      "UserId": "4cbc4ce9-53d6-48c0-86b5-50de737faacd",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "UserName": "z@d.com",
      "FirstName": "tyg",
      "LastName": "erd",
      "PostalAddress": "fggb",
      "AlternateEmail": "",
      "City": "554",
      "Pin": "560076",
      "State": "Chhattisgarh",
      "Country": "IN",
      "PhoneNo": "",
      "Street": "",
      "MobileNo": "915656565656",
      "BirthDate": "1/1/1900",
      "Gender": "",
      "Occupation": "",
      "Industry": "",
      "OtherArea": "",
      "CountryName": "India",
      "StateName": "Chhattisgarh",
      "CityName": "Other",
      "AreaName": "",
      "OtherCity": "",
      "IsReceiveOffers": false,
      "Password": null,
      "ConfirmPassword": null,
      "Countries": null,
      "States": null,
      "CommunicationType": "sms|email|push",
      "MarketingNotificationType": "sms|email|push",
      "PreferredLanguage": "en",
      "IsActivated": true
    },
    {
      "UserProfiles": [
        {
          "UserId": "4d32b17d-5f36-4849-8d83-e17f17597efa",
          "ProfileAttributeId": 972,
          "ProfileAttributeValueId": 0,
          "ProfileAttributeName": "Ser",
          "ProfileAttributeValue": ""
        },
        {
          "UserId": "4d32b17d-5f36-4849-8d83-e17f17597efa",
          "ProfileAttributeId": 974,
          "ProfileAttributeValueId": 0,
          "ProfileAttributeName": "test",
          "ProfileAttributeValue": ""
        }
      ],
      "UserInfoId": "3a412fe0-2b47-450b-8beb-16ec634df913",
      "UserId": "4d32b17d-5f36-4849-8d83-e17f17597efa",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "UserName": "test@martjack.com",
      "FirstName": "test",
      "LastName": "asv",
      "PostalAddress": "test&amp;#10;&amp;#10;&amp;#10;&amp;#10;",
      "AlternateEmail": "test@martjack.com",
      "City": "554",
      "Pin": "500033",
      "State": "TG",
      "Country": "IN",
      "PhoneNo": "",
      "Street": "",
      "MobileNo": "91-9422996500",
      "BirthDate": "1/1/1900",
      "Gender": "M",
      "Occupation": "",
      "Industry": "",
      "OtherArea": "",
      "CountryName": "India",
      "StateName": "Telangana",
      "CityName": "Other",
      "AreaName": "",
      "OtherCity": "Hyderabad",
      "IsReceiveOffers": true,
      "Password": null,
      "ConfirmPassword": null,
      "Countries": null,
      "States": null,
      "CommunicationType": "sms|email|push",
      "MarketingNotificationType": "sms|email|push",
      "PreferredLanguage":"en",
      "IsActivated": true
    }
  ],
  "ErrorCode": 0
}

Retrieves the details of all registered customers of the merchant.

Resource Information

URI Customer/{MerchantId}/All
Response Formats JSON
HTTP Methods GET
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/{merchantId}/All

Request Parameter

Parameter Type Description
merchantId* string Unique GUID of the merchant

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
UserName* string The login username of the customer. It could be email, mobile, or any other identifier
PostalAddress string Customer address
City int Unique code of the city (as saved in the system) associated to the address. Example, 0562 (for Agra), and 250 (Victoria)
CityName string Full name of the city. Example: Bangalore, Delhi, Tokyo, Singapore and Paris
State string Postal abbreviation of the state associated to the address. Example: KA (for Karnataka), CA (for California), IN (for Indiana)
StateName string Full name of the state. Example: Karnataka, California, and Indiana
Country string Alpha-2 code of the country associated to the address. Example: IN (for India), AU (for Australia), and BR (for Brazil)
CountryName string Full name of the country. Example: India, Australia, and Brazil
IsReceiveOffers boolean Applicable for merchants where CRM is enabled. States whether the customer has subscribed his mobile number or email id to receive offers
CommunicationType enum The preferred communication channel(s) of the customer. Possible Values: sms, email, push
PreferredLanguage string Preferred language of the customer in ISO code. For example, en for English, ar Arabic
IsActivated boolean Flag that specifies if the customer is active (true) or inactive false

Get Saved Cart Items

Retrieves the details of cart items saved for a specific user. Cart abandoned items will be saved in the cart automatically.

Sample Request

https://www.martjack.com/developerapi/Customer/SavedCart/9820eca5-d11f-4df1-9b20-983a45ea9631/0025fc54-a2d2-4ba8-800f-3c0ac91d9385

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "SavedCartItems": [
    {
      "CartItemId": 13222238,
      "ProductId": 11000246,
      "VariantProductId": 6752012,
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "StockAvailability": true,
      "LastUpdated": "/Date(1474022999000+0530)/"
    }
  ],
  "ErrorCode": 0
}

Resource Information

URI /Customer/SavedCart/{merchantId}/{UserId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Customer/SavedCart/{merchantId}/{UserId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
user* string Unique GUID of the user to fetch saved cart items

Response Parameters

Parameter Type Description
CartItemId int Unique cart id
ProductId long Unique id of the product in cart
VariantProductId long Unique id of the variant product
StockAvailability boolean Whether the product is in stock or not
LastUpdated date Date (in UST) when the cart is recently updated

Get Customer Count

Retrieves the count of all registered customers of the merchant.

Sample Request

https://www.martjack.com/DeveloperAPI/Customer/81e77da2-723b-483d-8c0d-49f800c1exxx/Count

Sample Response

{
  "Count": 100,
  "Message": "Successful",
  "messageCode": "1004"
}

Resource Information

URI Customer/{MerchantId}/Count
Response Formats JSON
HTTP Methods GET
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/{merchantId}/Count

Resource Information

URI Customer/{MerchantId}/Count
Response Formats JSON
HTTP Methods GET
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/{merchantId}/Count

Request Path Parameter

Parameter Type Description
merchantId* string Unique GUID of the merchant

Update Profile Attributes (Custom Fields)

Sample Request

https://www.martjack.com/developerapi/Customer/7c778337-4652-4944-934f-09e0fe56xxxx/UpdateUserProfile

Sample POST Request

InputFormat=application/json&InputData={  
   "UserProfile":{  
      "UserId":"3562a74e-1292-4d47-ba17-bc0a06af3xxx",
      "ProfileAttributes":{  
         "ProfileAttribute":{  
            "ProfileAttributeId":"1058",
            "ProfileAttributeValue":"Football"
         }
      }
   }
}

Sample Response

{
    "messageCode": "1004",
    "Message": "Updated Successfully",
    "ErrorCode": 0
}

Adds new custom field details or updates existing custom field details of a customer. These are customer level custom fields and are configured as per the merchant’s requirement. You need to know the configured fields and its datatypes before adding/updating.

Resource Information

URI /Customer/{merchantId}/UpdateUserProfile
Response Formats JSON
HTTP Methods POST
Batch Support No
Rate Limited? No
Authentication Yes

Additional Header Required

Header Description
accesstoken* Access token of the logged in user to validate the session

Request URL

{host}/developerapi/Customer/{merchantId}/UpdateUserProfile

Request Body Parameters

Parameter Type Description
ProfileAttributeId* string ID of the attribute that you want to add or update
ProfileAttributeValue string Respective attribute value preferred by the customer

Add/Update Shipping Address

Sample Request

https://www.martjack.com/DeveloperAPI/Customer/AddShippingAddress/81e77da2-723b-483d-8c0d-49f800c1exxx

Sample POST Request

InputFormat=application/json&InputData={  
   "shippingaddress":{  
      "shippingaddressid":"0",
      "userId":"4cded968-8ee1-4591-a50b-41649387bxxx",
      "firstname":"Tom",
      "lastname":"Sawyer",
      "address1":"H.no.6-51, plot.31, ECIL",
      "address2":"",
      "state":"KA",
      "pin":"560068",
      "countrycode":"IN",
      "citycode":"32",
      "phoneno":"",
      "mobileno":"91-7411000000",
      "email":"tom.sawyer@example.com",
      "AddressType":"Home Address"
   }
}

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "ShippingAddresses": [
        {
            "shippingaddressid": 1714453,
            "userId": "00000000-0000-0000-0000-000000000000",
            "firstname": null,
            "lastname": null,
            "address1": null,
            "address2": null,
            "state": null,
            "pin": null,
            "countrycode": null,
            "citycode": null,
            "phoneno": null,
            "mobileno": null,
            "email": null,
            "othercity": null
        }
    ],
    "ErrorCode": 0
}

Adds a new shipping address to a customer’s account or updates an existing shipping address.

Resource Information

URI /Customer/AddShippingAddress/{merchantId}
Response Formats JSON
HTTP Methods POST
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/AddShippingAddress/{merchantId}

Request Body Parameters

Parameter Type Description
ShippingAddressId* int Unique id of the order shipment that you want to update. Pass 0 to create a new shipping address
userId* string Unique GUID of the customer to add or update shipping address
firstname* string The first name of the customer
lastname* string The last name of the customer
address1*, address2 string Specify the customer’s shipping address related information
state string Postal abbreviation of the state of the current shipping address. Example: KA (for Karnataka), CA (for California), IN (for Indiana)
pin string Specify the PIN of the current shipping address
countrycode string Alpha-2 code of the country of the current shipping address. Example: IN (for India), AU (for Australia), and BR (for Brazil)
citycode string Unique code of the city (as saved in the system) such as 0562 (for Agra), and 250 (Victoria)
phoneno string The landline number of the customer associated to the shipping address
mobileno string The mobile number of the customer associated to the shipping address
email string The email id of the customer associated to the shipping address
addressType string Type of address. For example Home, Office

Get Customer’s Shipping Address

Sample Request


http://www.martjack.com/developerapi/Customer/GetShippingAddress/81e77da2-723b-483d-8c0d-49f800c1xxxx/4cded968-8ee1-4591-a50b-41649387bxxx

Sample Response


{
   "messageCode":"1004",
   "Message":"Successful",
   "ShippingAddresses":[
      {
         "shippingaddressid":1711980,
         "userId":"4cded968-8ee1-4591-a50b-41649387bxxx",
         "firstname":"Tom",
         "lastname":"Sawyer",
         "address1":"H.no.6-51, plot.31, ECIL",
         "address2":"",
         "state":"KA",
         "pin":"560068",
         "countrycode":"IN",
         "citycode":"32",
         "phoneno":"91-",
         "mobileno":"91-7411000000",
         "email":"tom.sawyer@example.com",
         "othercity":"Bangalore",
         "CityName":"Bangalore",
         "StateName":"Karnataka",
         "CountryName":"India",
         "AddressType":"1"
      },
      {
         "shippingaddressid":1714178,
         "userId":"4cded968-8ee1-4591-a50b-41649387bxxx",
         "firstname":"Tom",
         "lastname":"Sawyer",
         "address1":"Door: 12, 4th Floor, #12",
         "address2":"3rd cross, Roopena agrahara",
         "state":"KA",
         "pin":"560068",
         "countrycode":"IN",
         "citycode":"32",
         "phoneno":"91-",
         "mobileno":"91-7411000000",
         "email":"tom.sawyer@example.com",
         "othercity":"Bangalore",
         "CityName":"Bangalore",
         "StateName":"Karnataka",
         "CountryName":"India",
         "AddressType":"1"
      }
   ],
   "ErrorCode":0
}

Retrieves all shipping addresses of a specific customer.

Resource Information

URI /Customer/GetShippingAddress/{merchantId}/{UserId}
Response Formats JSON
HTTP Methods GET
Batch Support No
Rate Limited? No
Authentication Yes

Additional Header Required

Header Name Value
apiversion 4

Request URL

{host}/developerapi/Customer/GetShippingAddress/{merchantId}{UserId}

Request Path Parameters

Parameter Type Description
merchantId* string The unique GUID of the merchant associated to the customer
UserId* string The unique GUID of the user to fetch all shipping addresses

Delete Shipping Address

Sample Request

http://www.martjack.com/DeveloperAPI/Customer/DeleteShippingAddress/81e77da2-723b-483d-8c0d-49f800c1exxx/4cded968-8ee1-4591-a50b-41649387bxxx/1711980

Sample Response

{  
   "Message":"Success",
   "messageCode":"1004"
}

Deletes a specific shipping address of a customer for the current login session.

Resource Information

URI Customer/DeleteShippingAddress/{MerchantId}/{UserId}/{ShippingAddressId}
Response Formats JSON
HTTP Methods GET
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Customer/DeleteShippingAddress/{MerchantId}/{UserId}/{ShippingAddressId}

Request Parameters

Parameter Type Description
MerchantId* string The unique GUID of the merchant associated to the customer account
UserId* string The unique GUID of the customer whose shipping address needs to be deleted
ShippingAddressId* string Unique id of the shipping address that you want to delete

Get Store Operators

Retrieves the details of store operators of a specific role in a particular location or all locations.

Sample Request

https://www.martjack.com/developerapi/Customer/GetStoreOperators/9820eca5-d11f-4df1-9b20-983a45ea9631/17722/0abde087-16c9-4057-ac9d-f82d94473c39

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "StoreOperators": [
    {
      "FirstName": "Jim",
      "LastName": "karpet",
      "Email": "jim@cmail.com",
      "OperatorId": "03b3a81d-c168-4cbc-ae9d-c79ccee5adb9",
      "StoreIDs": [
        17722
      ]
    }
  ],
  "ErrorCode": 0
}

Resource Information

URI /Customer/GetStoreOperators/{merchantId}/{locationId}/{roleid}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Customer/GetStoreOperators/{merchantId}/{locationId}/{roleid}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
locationId* int Pass the location id to get operators of that specific location. If you want to fetch from all the locations, pass ‘0’
roleid* string Pass the unique role id to get operators of that specific role

Agent Login

Lets agents of the merchant login to the merchant’s Anywhere Commerce site.

Sample Request

https://www.martjack.com/developerapi/Customer/9820eca5-d11f-4df1-9b20-983a45ea9631/AgentLogin

Sample POST Request (RAW)

MerchantId=9820eca5-d11f-4df1-9b20-983a45ea9631&username=39249@capillary.com&password=sam123

Sample Response

{
   "messageCode":"1004",
   "Message":"Logged In successfully",
   "AgentDetails":{
      "AgentId":"389f81f2-3508-4391-bc7a-5e369a030398",
      "FirstName":"Tim",
      "LastName":"James",
      "Email":"39249@capillary.com",
      "LocationDetails":[
         {
            "LocationId":190,
            "LocationCode":"4716",
            "LocationName":"Bangalore"
         }
      ],
      "RoleDetails":[
         {
            "RoleId":"b88fa8bb-b916-11e0-9bb5-001d7d24e785",
            "RoleName":"Order Manager"
         }
      ]
   },
   "ErrorCode":0
}

Resource Information

URI /Customer/{merchantId}/AgentLogin
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Customer/{merchantId}/AgentLogin

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant associated to the agent account
username* string Username of the agent’s login account
password* string Password of the agent account

Customer Groups

Customer grouping is a classification of customers into different segments based on a similar attribute or rule. You can provide discounts or special prices to customer groups.

Customers can be added to a group manually or using rules. This resource contains APIs related to accessing group details and managing group members.

Add User to a Customer Group

Adds a user to a specific customer group.

Sample Request

https://www.martjack.com/developerapi/CustomerGroups/Consumer/9820eca5-d11f-4df1-9b20-983a45ea9631/32124/9820eca5-d11f-4df1-9b20-983a45ea9631/Add

Sample Response

{
  "messageCode": "1004",
  "Message": "Customer Created Successfully",
  "ErrorCode": 0
}

Resource Information

URI /CustomerGroups/Consumer/{merchantId}/{userGroupId}/{userId}/Add
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/CustomerGroups/Consumer/{merchantId}/{userGroupId}/{userId}/Add

Request Path Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchantId
userGroupId* int Unique id of the customer group to which you want to add a customer
userId* string Unique GUID of the customer that you want to add

Get Group Details

Retrieves the details of a specific user group based on the user group id passed.

Sample Request

https://www.martjack.com/developerapi/CustomerGroups/9820eca5-d11f-4df1-9b20-983a45ea9631/8714

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "CostumerGroup": [
    {
      "UserGroupId": 8714,
      "UserGroupName": "NewUser",
      "GroupDescription": "NewGroup",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "CreatedDate": "/Date(1498093383000+0530)/",
      "IsActive": false,
      "MessageDate": "/Date(-2208988800000)/",
      "UpdatedDate": "/Date(-2208988800000)/",
      "MemberCount": 0
    }
  ],
  "ErrorCode": 0
}

Resource Information

URI /CustomerGroups/{merchantId}/{userGroupId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/CustomerGroups/{merchantId}/{userGroupId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
userGroupId* int Unique id of the customer group that you want to fetch

Get Users of a Group

Retrieves the details of all members of a specific group based on the group id passed.

Sample Request

https://www.martjack.com/developerapi/CustomerGroups/Consumer/9820eca5-d11f-4df1-9b20-983a45ea9631/{userGroupId}

Sample Response


{
  "messageCode": "1004",
  "Message": "Successful",
  "Customers": [
    {
      "UserProfiles": null,
      "UserInfoId": "0597c6ee-eb13-42a2-bbdf-38690b272cc1",
      "UserId": "31a7d819-e4ab-4c2d-985a-5ee9a003d694",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "UserName": "tom.sawyer@capillarytech.com",
      "FirstName": "Tom",
      "LastName": "Sawyer",
      "PostalAddress": "",
      "AlternateEmail": "",
      "City": "32",
      "Pin": "560001",
      "State": "KA",
      "Country": "IN",
      "PhoneNo": "",
      "Street": "MG Road",
      "MobileNo": "917400000000",
      "BirthDate": "1/1/1993 12:00:00 AM",
      "Gender": "male",
      "Occupation": "",
      "Industry": "",
      "OtherArea": "",
      "CountryName": "India",
      "StateName": "Karnataka",
      "CityName": "Bangalore",
      "AreaName": "MG Road",
      "OtherCity": "OtherCity",
      "IsReceiveOffers": false,
      "Password": null,
      "ConfirmPassword": null,
      "Countries": null,
      "States": null,
      "CommunicationType": null,
      "MarketingNotificationType": null
    },
    {
      "UserProfiles": null,
      "UserInfoId": "9f39c75e-ca82-4284-a1a8-05668a3a9941",
      "UserId": "0025fc54-a2d2-4ba8-800f-3c0ac91e9385",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "UserName": "Jim.carvan@example.com",
      "FirstName": "Jim",
      "LastName": "Carvan",
      "PostalAddress": "",
      "AlternateEmail": "",
      "City": "554",
      "Pin": "",
      "State": "TG",
      "Country": "IN",
      "PhoneNo": "-",
      "Street": "",
      "MobileNo": "91-9898000000",
      "BirthDate": "1/1/1900 12:00:00 AM",
      "Gender": "M",
      "Occupation": "",
      "Industry": "",
      "OtherArea": "",
      "CountryName": "India",
      "StateName": "Telangana",
      "CityName": "Other",
      "AreaName": "",
      "OtherCity": "554",
      "IsReceiveOffers": false,
      "Password": null,
      "ConfirmPassword": null,
      "Countries": null,
      "States": null,
      "CommunicationType": null,
      "MarketingNotificationType": null
    },
    {
      "UserProfiles": null,
      "UserInfoId": "6fa05537-c88e-4339-833e-45fd0eb2e67b",
      "UserId": "0cdaacfc-b705-4803-9864-56d169d9c65b",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "UserName": "d@p.jo",
      "FirstName": "fn",
      "LastName": "ln",
      "PostalAddress": "zs",
      "AlternateEmail": "",
      "City": "554",
      "Pin": "560076",
      "State": "Bihar",
      "Country": "IN",
      "PhoneNo": "",
      "Street": "",
      "MobileNo": "919843111111",
      "BirthDate": "1/1/0001 12:00:00 AM",
      "Gender": "",
      "Occupation": "",
      "Industry": "",
      "OtherArea": "",
      "CountryName": "India",
      "StateName": "Bihar",
      "CityName": "Other",
      "AreaName": "",
      "OtherCity": "",
      "IsReceiveOffers": false,
      "Password": null,
      "ConfirmPassword": null,
      "Countries": null,
      "States": null,
      "CommunicationType": null,
      "MarketingNotificationType": null
    }
  ],
  "ErrorCode": 0
}

Resource Information

URI /CustomerGroups/Consumer/{merchantId}/{userGroupId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/CustomerGroups/Consumer/{merchantId}/{userGroupId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchantId
userGroupId* int Unique id of the user group

Get Customer Groups by User ID

Retrieves the list of groups in which a specific user is available based on the user id passed.

Sample Request

https://www.martjack.com/developerapi/CustomerGroups/Group/9820eca5-d11f-4df1-9b20-983a45ea9631/31a7d819-e4ab-4c2d-985a-5ee9a003d694

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "CostumerGroup": [
    {
      "UserGroupId": 8714,
      "UserGroupName": "NewUser",
      "GroupDescription": "NewGroup",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "CreatedDate": "/Date(1498093383000+0530)/",
      "IsActive": false,
      "MessageDate": "/Date(-2208988800000)/",
      "UpdatedDate": "/Date(-2208988800000)/",
      "MemberCount": 2
    }
  ],
  "ErrorCode": 0
}

Resource Information

URI /CustomerGroups/Group/{merchantId}/{userId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/CustomerGroups/Group/{merchantId}/{userId}

Request Path Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchantId
userId* string Unique GUID of the user by which you want to fetch user groups

Get All Groups of the Merchant

Retrieves all customer groups of the merchant.

Sample Request

https://www.martjack.com/developerapi/CustomerGroups/9820eca5-d11f-4df1-9b20-983a45ea9631

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "CostumerGroup": [
    {
      "UserGroupId": 7990,
      "UserGroupName": "Group1",
      "GroupDescription": "Default",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "CreatedDate": "/Date(1457510943000+0530)/",
      "IsActive": false,
      "MessageDate": "/Date(-2208988800000)/",
      "UpdatedDate": "/Date(-2208988800000)/",
      "MemberCount": 143
    },
    {
      "UserGroupId": 8188,
      "UserGroupName": "Group2",
      "GroupDescription": "Testing Purpose",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "CreatedDate": "/Date(1465542242000+0530)/",
      "IsActive": false,
      "MessageDate": "/Date(-2208988800000)/",
      "UpdatedDate": "/Date(-2208988800000)/",
      "MemberCount": 32
    },
    {
      "UserGroupId": 8496,
      "UserGroupName": "Group3",
      "GroupDescription": "hi",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "CreatedDate": "/Date(1488417120000+0530)/",
      "IsActive": false,
      "MessageDate": "/Date(-2208988800000)/",
      "UpdatedDate": "/Date(-2208988800000)/",
      "MemberCount": 2
    },
    {
      "UserGroupId": 9313,
      "UserGroupName": "Group3",
      "GroupDescription": "Testing",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "CreatedDate": "/Date(1547103219000+0530)/",
      "IsActive": false,
      "MessageDate": "/Date(-2208988800000)/",
      "UpdatedDate": "/Date(-2208988800000)/",
      "MemberCount": 0
    }
  ],
  "ErrorCode": 0
}

Resource Information

URI /CustomerGroups/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/CustomerGroups/{merchantId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant

Response Parameters

Parameter Type Description
CreatedDate date Date when the group is created
IsActive enum States whether the group is in active state (true) or inactive state (false)
MessageDate date -NA-
UpdatedDate date Date when the group is updated, i.e., either an user added or removed
MemberCount int Total members in the group

Remove User

Removes a specific user from a group.

Sample Request

https://www.martjack.com/developerapi/CustomerGroups/Consumer/9820eca5-d11f-4df1-9b20-983a45ea9631/8714/0cdaacfc-b705-4803-9864-56d199d9c65b/Remove

Sample Response


{
  "messageCode": "1004",
  "Message": "Deleted Successfully",
  "ErrorCode": 0
}

Resource Information

URI /CustomerGroups/Consumer/{merchantId}/{userGroupId}/{userId}/Remove
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/CustomerGroups/Consumer/{merchantId}/{userGroupId}/{userId}/Remove

Request Path Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchant
userGroupId* int Unique group id from which you want to remove a user
userId* string Unique GUID of the user that you want to remove

Product

A product is an item that a merchant sells on the Anywhere Commerce platform. You can use this resource to create and manage inventory items and its groups across channels.

Update Location wise Stock & Price

Sample Request

https://www.martjack.com/developerapi/product/UpdateLocationWiseStock

Sample POST Body

MerchantId=0639f7a6-34cc-48b2-9fd9-a80e2ed8xxxx&InputFormat=application/json&InputData={
    "products": {
        "product": {
            "sku":"sku1234121",
            "variantsku":"",
            "stock":"10",
            "locationrefcode":"4702",
            "Quantity":"1",
            "MRP":"444",
            "WebPrice":"333",
            "TokenPrice":"222"
        },
        "product": {
            "sku":"sun1234121",
            "variantsku":"",
            "stock":"10",
            "locationrefcode":"48976",
            "Quantity":"2",
            "MRP":"200",
            "WebPrice":"190",
            "TokenPrice":"50"
        }
    }
  }

Sample Response

{
   "messageCode":"1018",
   "Message":"Data update added to task queue. You can view the status of update in control panel. Also email will be send to merchant registered email after task completion.",
   "Taskid":"2718751",
   "ErrorCode":0
}

Updates stock and price of an item for a specific location.

Resource Information

URI /product/UpdateLocationWiseStock
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support Yes

Request URL

{host}/developerapi/product/UpdateLocationWiseStock

Request Body Parameters

Parameter Datatype Description
sku* string SKU of the product for which you want to update stock and price
variantsku* string The variant SKU to update variant product
stock int Number of available items of the current SKU. Specify NA if product needs to be dissociated with the location, 0 for out of stock
locationrefcode* string Location reference code of the location for which product stock/price update is made (physical store or warehouse)
Quantity** int The quantity of the item for which you want to update the price. This is required to update prices.
MRP float Retail price of the item
WebPrice float Selling price of the item
TokenPrice float Minimum amount required for the customer to reserve the item and purchase later on (prebooking price)

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
Taskid int Unique id generated for the current update location task

Update Product Information (normal product)

Sample Request

https://www.martjack.com/developerapi/product/UpdateProductInfo 

Sample POST Request

MerchantId=0639f7a6-34cc-48b2-9fd9-a80e2ed8xxxx&InputFormat=application/json&InputData={  
   "products":{  
      "product":[{  
         "CategoryReference":"CU00378158",
         "sku":"458636",
         "variantsku":"",
         "BrandID":"1756",
         "ProductTitle":"Capillary Mens Jeans",
         "Inventory":"2000",
         "MRP":"499",
         "Webprice":"499",
         "Availability":"Y",
         "ProductType":"P",
         "SmallImage":"filename.jpg",
         "LargeImage":"image.jpg",
         "ShortDescription":"Mens jeans blue denim",
         "ProductDescription":"Example description",
         "PaymentOptionOnline":"Y",
         "PaymentOptionChequeOrDD":"Y",
         "PaymentOptionBankTransfer":"N",
         "PaymentOptionCOD":"Y",
         "DeliveryOptionShip":"Y",
         "DeliveryOptionOffline":"N",
         "DeliveryOptionOnline":"Y",
         "DeliveryOptionInStorePickup":"Y",
         "LocationBased":"Y",
         "ShippingCode":"flat",
         "TaxCode":"GST",
         "DeliveryTime":"2-5 business days",
         "CatalogSequence":"50",
         "ProductWeight":"200",
         "BankProductId":"654786",
         "OfferProductDescription":"example.xml",
         "OfferProductImage":"image.jpg",
         "PageTitle":"Mens Trousers",
         "Keywords":"",
         "KeywordDescription":"",
         "SEOURL":"example.com",
         "SmallImageAltText":"altimage.jpg",
         "LargeImageAltText":"altimage.jpg",
         "StartDate":"11/03/2018",
         "EndDate":"1/03/2020",
         "StartTime":"12:00:00",
         "EndTime":"1:00:00",
         "PeriodicityType":"monthly",
         "PeriodicityRangeWeekly":"1-30",
         "ShowExpired":"Y",
         "UOM":"gms",
         "LBH":"",
         "BuyingWeight":"250",
         "PkgQty":"1",
         "MinimumOrderQuantity":"1",
         "MaximumOrderQuantity":"5",
         "PreOrder":"Y",
         "BackOrder":"10",
         "StockAvailableMessage":"Stock will be available in 2 days",
         "ProductCondition":"",
         "Warrantybearer":"",
         "WarrantyInMonths":"",
         "ReserveQuantity":"",
         "Reorderstocklevel":"",
         "StockAlertQuantity":"5",
         "BarCode":"barcode123,barcode2",
         "ModelNumber":"UG654",
         "CatalogCode":"P",
         "PurchaseDate":"",
         "ProductNote":"Mens blue jeans",
         "FormCode":"",
         "CheckoutWithTokenPrice":"Y",
         "TokenPrice":"50",
         "CostPrice":"350",
         "HidePrice":"N",
         "FulfillmentServiceRefCode":"",
         "SectionRefCode":"",
         "StdProductCode":"72.02.01-01",
         "MPN":"",
         "Vendor":"SampleVendor",
         "VendorSKU":"SV123",
         "StdProductType":"HSN"
      }
      ]
   }
}

Sample Response

{
    "messageCode": "1018",
    "Message": "Data update added to task queue. You can view the status of update in control panel. Also email will be send to merchant registered email after task completion.",
    "Taskid": "2718747",
    "ErrorCode": 0
}

Updates the details of a normal product.

Resource Information

URI /Product/UpdateProductInfo
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Product/UpdateProductInfo

Request Body Parameters

Parameter Type Description
CategoryReference* string Unique category reference code
SKU* string Unique SKU of the product
VariantSKU string Unique SKU of the variant product to update
VariantProperty string The property of the variant product such as size, color, and weight. *Required for a Variant Product update
VariantValue string The value of the specified variantProperty. *Required for a Variant Product
BrandID* string Brand id associated to the product
ProductTitle* string Title of the product to appear on the product’s page of the storefront
ProductType* string Type of the product. Values: P for a normal product, A for an add-on product, and B for a bundle product or deal product
CategoryRefCode string Reference code of the product category
Inventory int New stock count of the current product
MRP float Retail price of the product
Webprice float Selling price of the product to show up on the storefront. Cannot be more than MRP
Availability string Specify Y if the product is in stock, N if unavailable
BarCode string Bar code of the product
SmallImage string Name (with extension) of the product’s small image (100*100) shown in the product showcase. This param is required if the Custom Type of the image is not defined and the Extended Properties section of that product showcase is not configured accordingly. Supported formats: .png, jpg,jpeg, .svc, and .gif
LargeImage string Name (with extension) of the product’s large image (300*300) shown on the product details page of the storefront. Supported formats: .png, jpg,jpeg, .svc, and .gif
ShortDescription string Brief description of the product within 500 characters. This will appear on the product details page
ProductDescription string Detailed description of the product which will appear in the Description tab of the product page. Supports up to 50000 characters
PaymentOptionOnline enum Specify Y if the product can be purchased online through options such as Credit Card,Debit Card, and Net Banking, N if not supported
PaymentOptionChequeOrDD enum Specify Y if payment through cheque or DD is supported for the product; N if not supported
PaymentOptionBankTransfer enum Specify Y if payment through online bank transfer is supported for the product; N if not supported
PaymentOptionCOD enum Specify Y if cash on delivery is supported for the product; N if not supported
DeliveryOptionShip enum Specify Y if the product is available for shipping, N if cannot be shipped
DeliveryOptionOffline enum Specify Y if the product can be ordered offline such as ‘Call for actions’
DeliveryOptionOnline enum Specify Y for online delivery products such as such as movies, music, ringtones, donations, mobile recharges, gift cards, softwares etc, else specify N
DeliveryOptionInStorePickup enum Specify Y if store pick up is supported for the product, else specify N
LocationBased enum Specify Y if the product inventory needs to be considered as per the shipping location or store, else specify N
ShippingCode enum The code of the the type of shipping charges. Most commonly used: flat, india, international, surfaceways, airways
TaxCode string The tax code applicable for the product. Tax code have configured in the CP first. You can associate the relevant value here. For example, CSST, IGST, SGST, USST, SGI18
DeliveryTime string The estimated delivery time to be shown on the product page. Example: This product will be delivered in 7 days from the date of order
CatalogSequence int Sequence of the product to show up on the storefront
ProductWeight float Weight of the product as per the UOM mentioned
BankProductId string System generated id for the product source
OfferProductDescription string .xml file name related to the product offer. Use for sale items
OfferProductImage string Preferred image of the offer product (supported formats: .png, jpg,jpeg, .svc, and .gif)
PageTitle string Title of the product you prefer to appear in the search results for SEO
Keywords string Preferred meta tag search keyword for the product
KeywordDescription string Description of the specified search keyword
SEOURL string The redirect URL when searched on Google
SmallImageAltText string The mouse hover text for small image
LargeImageAltText string The mouse hover text for large image
StartDate date The date when you want to begin showing the product on the storefront in DD/MM/YY format
EndDate date The date when you want to end showing the product on the storefront in DD/MM/YY format
StartTime time The time (on the specified StartDate) from when you want to show the product on the storefront. Format: HH:MM:SS
EndTime time The time (on the specified EndDate) when you want to stop showing the product on the storefront on the specified end date. Format: HH:MM:SS
PeriodicityType enum The recurring interval when you want to show the product on the storefront. Values: Monthly, Weekly, oneTime
PeriodicityRange string The days of the recurring interval (PeriodicityType) that you want to show the product. For example: in Monthly recurring interval, if you set PeriodicityRange 1-30, you will see products on all 30 days of a month. Similarly, in a weekly PeriodicityType, if you set 1, 3, 5 in PeriodicityRange, you will see the product on Sun, Tue, and Thu respectively. No value is required for oneTime. To pass multiple days, use comma separated values. For example, 1,2,5,10. You can either pass as 1-5, or 1, 2, 3, 4, 5 and so on. Not required for onetime
ShowExpired enum Y, N. To show if the product has to be displayed irrespective of the periodicityRange
UOM enum Unit of measurement of the product. Values: ltrs, kgs, gms, pieces
LBH string Dimensions of the product (Length*Breadth*Height) or the product volume
BuyingWeight float Weight of the product as per the specified UOM. For example, if UOM is kgs then it will consider the specified value in kilo grams
PkgQty int Lot size (package quantity) of the product that can be purchased. Customer can buy the product only in multiples of the specified PkgQuantity
MinimumOrderQuantity int Minimum allowed product quantity per order
MaximumOrderQuantity int Maximum allowed product quantity per order
PreOrder enum Preorder facilitates booking or reserving an item in advance, usually prebooking new products even before it is launched. Specify Y to allow the product booking in advance, else, specify N
BackOrder enum Backorder lets users to place an order even if the product is out of stock. Specify Y if you want to allow users to place orders even in no stock (0). Specify N to disable ordering in case of out of stock
StockAvailableMessage string Specify the stock availability message to show on the product page when it goes out of stock. For example, “Stock will be available in 2 days”
ProductCondition enum Current condition of the product. Value: New, Used
Warrantybearer enum Warranty bearer. Value: No Warranty, Manufacturer, Dealer
WarrantyInMonths int Warranty period in months (if Warrantybearer is Manufacturer or Dealer)
ReserveQuantity int Quantity of items the merchant needs to reserve for special purposes. For example, merchant could reserve some products to fulfill for loyalty customers
StockAlertQuantity int Sends an alert when the quantity of the product is less than this value
BarCode string Barcode of the product. You can pass comma separated values in case of multiple bar codes
ModelNumber string Model number of the product (if applicable)
CatalogCode string Catelogue code of the product (if any)
PurchaseDate date Required for the used product. Date when the used product is purchased in MM:DD:YY format
ProductNote string Additional information to mention about the product for internal reference
FormCode enum Predefined form codes for deal products. Ad-hoc Forms allow you to create customised web forms with a number of custom fields and you can use them to receive customized orders from end-users.
CheckoutWithTokenPrice enum Specify Y to enable checkout with token price (preorder amount)
TokenPrice float The token amount required for preorder (if CheckoutWithTokenPrice is enabled)
CostPrice float The cost price of the product
HidePrice enum Specify Y to hide the price on the storefront, N to show the product price. You can show 'Price on Request’ Call for Action to reveal the price on customer requests
StdProductCode int For international standard product, specify the HSN (Homogeneous Serial Number) of the product as per the chosen standard product type
MPN string Manufacturer’s part number - A unique part number given by the manufacturer of the product
Vendor enum Vendor name associated to the measurement for the product (Predefined vendor)
VendorSKU string SKU of the product in the vendor system for supplier product
StdProductType enum For international standard products, specify the type of identification or HSN of the product type. Values: UPC (Universal Product Code), EAN (European Article Numbering), GTIN (Global Trade Item Number), ASIIN (Amazon Standard Identification Number), ISBN10, ISBN13 (International Standard Book Number)
FulfillmentServiceRefCode string Reference code of the order fulfillment service. These services are required for the fulfillment of a deal or online product deliveries such as music, ringtones, movies. It’s mandatory for Local Deals

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
Taskid int Unique id generated for the current update task

Update Product Information (Variant)

Sample Request

https://www.martjack.com/developerapi/product/UpdateProductInfo 

Sample POST Request

MerchantId=0639f7a6-34cc-48b2-9fd9-a80e2ed8xxxx&InputFormat=application/json&InputData={  
   "products":{  
      "product":[{  
         "CategoryReference":"CU00378158",
         "sku":"458636",
         "variantsku":"",
         "BrandID":"1756",
         "ProductTitle":"Capillary Mens Jeans",
         "Inventory":"2000",
         "MRP":"499",
         "Webprice":"499",
         "Availability":"Y",
         "ProductType":"P",
         "SmallImage":"filename.jpg",
         "LargeImage":"image.jpg",
         "ShortDescription":"Mens jeans blue denim",
         "ProductDescription":"Example description",
         "PaymentOptionOnline":"Y",
         "PaymentOptionChequeOrDD":"Y",
         "PaymentOptionBankTransfer":"N",
         "PaymentOptionCOD":"Y",
         "DeliveryOptionShip":"Y",
         "DeliveryOptionOffline":"N",
         "DeliveryOptionOnline":"Y",
         "DeliveryOptionInStorePickup":"Y",
         "LocationBased":"Y",
         "ShippingCode":"flat",
         "TaxCode":"GST",
         "DeliveryTime":"2-5 business days",
         "CatalogSequence":"50",
         "ProductWeight":"200",
         "BankProductId":"654786",
         "OfferProductDescription":"example.xml",
         "OfferProductImage":"image.jpg",
         "PageTitle":"Mens Trousers",
         "Keywords":"",
         "KeywordDescription":"",
         "SEOURL":"example.com",
         "SmallImageAltText":"altimage.jpg",
         "LargeImageAltText":"altimage.jpg",
         "StartDate":"11/03/2018",
         "EndDate":"1/03/2020",
         "StartTime":"12:00:00",
         "EndTime":"1:00:00",
         "PeriodicityType":"monthly",
         "PeriodicityRangeWeekly":"1-30",
         "ShowExpired":"Y",
         "UOM":"gms",
         "LBH":"",
         "BuyingWeight":"250",
         "PkgQty":"1",
         "MinimumOrderQuantity":"1",
         "MaximumOrderQuantity":"5",
         "PreOrder":"Y",
         "BackOrder":"10",
         "StockAvailableMessage":"Stock will be available in 2 days",
         "ProductCondition":"",
         "Warrantybearer":"",
         "WarrantyInMonths":"",
         "ReserveQuantity":"",
         "Reorderstocklevel":"",
         "StockAlertQuantity":"5",
         "BarCode":"barcode123,barcode2",
         "ModelNumber":"UG654",
         "CatalogCode":"P",
         "PurchaseDate":"",
         "ProductNote":"Mens blue jeans",
         "FormCode":"",
         "CheckoutWithTokenPrice":"Y",
         "TokenPrice":"50",
         "CostPrice":"350",
         "HidePrice":"N",
         "FulfillmentServiceRefCode":"",
         "SectionRefCode":"",
         "StdProductCode":"72.02.01-01",
         "MPN":"",
         "Vendor":"SampleVendor",
         "VendorSKU":"SV123",
         "StdProductType":"HSN"
      },
       {  
        "sku":"458636",
        "variantsku":"variantSKU1",
        "BrandID":"1756",
        "ProductTitle":"Capillary Mens Jeans",
        "Inventory":"2000",
        "MRP":"499",
        "Webprice":"499",
        "Availability":"Y",
        "ProductType":"P",
        "VariantProperty1":"color",
        "value1":"red",
        "VariantProperty2":"",
        "value2":"",
        "SmallImage":"filename.jpg",
        "LargeImage":"image.jpg",
        "ShortDescription":"Mens jeans blue denim",
        "ProductDescription":"Example description",
        "PaymentOptionOnline":"Y",
        "PaymentOptionChequeOrDD":"Y",
        "PaymentOptionBankTransfer":"N",
        "PaymentOptionCOD":"Y",
        "DeliveryOptionShip":"Y",
        "DeliveryOptionOffline":"N",
        "DeliveryOptionOnline":"Y",
        "DeliveryOptionInStorePickup":"Y",
        "LocationBased":"Y",
        "ShippingCode":"flat",
        "TaxCode":"GST",
        "DeliveryTime":"2-5 business days",
        "CatalogSequence":"50",
        "ProductWeight":"200",
        "VariantProperty1":"Color",
        "Value1":"Red",
        "VariantProperty2":"Size",
        "Value2":"S",
        "VariantProperty3":"",
        "Value3":"",
        "BankProductId":"654786",
        "OfferProductDescription":"example.xml",
        "OfferProductImage":"image.jpg",
        "PageTitle":"Mens Trousers",
        "Keywords":"",
        "KeywordDescription":"",
        "SEOURL":"example.com",
        "SmallImageAltText":"altimage.jpg",
        "LargeImageAltText":"altimage.jpg",
        "StartDate":"11/03/2018",
        "EndDate":"1/03/2020",
        "StartTime":"12:00:00",
        "EndTime":"1:00:00",
        "PeriodicityType":"monthly",
        "PeriodicityRangeWeekly":"1-30",
        "ShowExpired":"Y",
        "UOM":"gms",
        "LBH":"",
        "BuyingWeight":"250",
        "PkgQty":"1",
        "MinimumOrderQuantity":"1",
        "MaximumOrderQuantity":"5",
        "PreOrder":"Y",
        "BackOrder":"10",
        "StockAvailableMessage":"Stock will be available in 2 days",
        "ProductCondition":"",
        "Warrantybearer":"",
        "WarrantyInMonths":"",
        "ReserveQuantity":"",
        "Reorderstocklevel":"",
        "StockAlertQuantity":"5",
        "BarCode":"barcode123,barcode2",
        "ModelNumber":"UG654",
        "CatalogCode":"P",
        "PurchaseDate":"",
        "ProductNote":"Mens blue jeans",
        "FormCode":"",
        "CheckoutWithTokenPrice":"Y",
        "TokenPrice":"50",
        "CostPrice":"350",
        "HidePrice":"N",
        "FulfillmentServiceRefCode":"",
        "SectionRefCode":"",
        "StdProductCode":"72.02.01-01",
        "MPN":"",
        "Vendor":"SampleVendor",
        "VendorSKU":"SV123",
        "StdProductType":"HSN"
     }]
   }
}

Sample Response

{
    "messageCode": "1018",
    "Message": "Data update added to task queue. You can view the status of update in control panel. Also email will be send to merchant registered email after task completion.",
    "Taskid": "2718747",
    "ErrorCode": 0
}

Lets you update variant product details.

Resource Information

URI /Product/UpdateProductInfo
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Product/UpdateProductInfo

Request Body Parameters

Parameter Type Description
CategoryReference* string Unique category reference code
SKU* string Unique SKU of the product
VariantSKU* string Unique SKU of the variant product
VariantProperty* string The property of the variant product such as size, color, and weight
VariantValue* string The value of the specified property. *Required for Variant Product
BrandID* string Unique id of the brand associated to the product
ProductTitle* string Title of the product to appear on the product’s page
ProductType* string Type of the product. Values: P for a normal product, A for an add-on product, and B for a bundle product or deal product
CategoryRefCode string Reference code of the product category
Inventory int The number of available stock of the current SKU (quantity)
MRP float Retail price of the product
Webprice float Selling price of the product on the storefront. Cannot be more than MRP
Availability string Specify Y if the product is in stock, N if unavailable
BarCode string Bar code of the product
SmallImage string Name (with extension) of the product’s small image (100*100) shown in the product showcase. This param is required if the Custom Type of the image is not defined and the Extended Properties section of that product showcase is not configured accordingly. Supported formats: .png, jpg,jpeg, .svc, and .gif
LargeImage string Name (with extension) of the product’s large image (300*300) shown on the product details page of the storefront. Supported formats: .png, jpg,jpeg, .svc, and .gif
ShortDescription string Brief description of the product within 500 characters. This will appear on the product details page
ProductDescription string Detailed description of the product which will appear in the Description tab of the product page. Supports up to 50000 characters
PaymentOptionOnline enum Specify Y if the product can be purchased online through options such as Credit Card,Debit Card, and Net Banking, N if not supported
PaymentOptionChequeOrDD enum Specify Y if payment through cheque or DD is supported for the product; N if not supported
PaymentOptionBankTransfer enum Specify Y if payment through online bank transfer is supported for the product; N if not supported
PaymentOptionCOD enum Specify Y if cash on delivery is supported for the product; N if not supported
DeliveryOptionShip enum Specify Y if the product is available for shipping, N if cannot be shipped
DeliveryOptionOffline enum Specify Y
DeliveryOptionOnline enum Specify Y for online delivery products such as such as movies, music, ringtones, donations, mobile recharges, gift cards, softwares etc, else specify N
DeliveryOptionInStorePickup enum Specify Y if store pick up is supported for the product, else specify N
LocationBased enum Specify Y if the product inventory needs to be considered as per the shipping location or store, else specify N
ShippingCode enum The code of the the type of shipping charges. Most commonly used: flat, india, international, surfaceways, airways
TaxCode string The tax code applicable for the product. Tax code have configured in the CP first. You can associate the relevant value here
DeliveryTime string The estimated delivery time to be shown on the product page. Example: This product will be delivered in 7 days from the date of order
CatalogSequence int Sequence of the product to show up on the storefront
ProductWeight float Weight of the product
BankProductId string System generated id for the product source
OfferProductDescription string .xml file name related to the product offer. Use for sale items
OfferProductImage string Preferred image of the offer product (supported formats: .png, jpg,jpeg, .svc, and .gif)
PageTitle string Title of the product you prefer to appear in the search results for SEO
Keywords string Preferred meta tag search keyword for the product
KeywordDescription Description of the specified search keyword
SEOURL string The redirect URL when searched on Google
SmallImageAltText string The mouse hover text for small image
LargeImageAltText string The mouse hover text for large image
StartDate date The date when you want to begin showing the product on the storefront in DD/MM/YY format
EndDate date The date when you want to end showing the product on the storefront in DD/MM/YY format
StartTime time The time (on the specified StartDate) from when you want to show the product on the storefront. Format: HH:MM:SS
EndTime time The time (on the specified EndDate) when you want to stop showing the product on the storefront on the specified end date. Format: HH:MM:SS
PeriodicityType enum The recurring interval when you want to show the product on the storefront. Values: Monthly, Weekly, oneTime
PeriodicityRange string The days of the recurring interval (PeriodicityType) that you want to show the product. For example: in Monthly recurring interval, if you set PeriodicityRange 1-30, you will see products on all 30 days of a month. Similarly, in a weekly PeriodicityType, if you set 1, 3, 5 in PeriodicityRange, you will see the product on Sun, Tue, and Thu respectively. No value is required for oneTime. To pass multiple days, use comma separated values. For example, 1,2,5,10. You can either pass as 1-5, or 1, 2, 3, 4, 5 and so on. Not required for onetime
ShowExpired enum Y, N. To show if the product has to be displayed irrespective of the periodicityRange
UOM enum Unit of measurement of the product. Values: ltrs, kgs, gms, pieces
LBH string Dimensions of the product (Length*Breadth*Height) or the product volume
BuyingWeight float Weight of the product as per the specified UOM. For example, if UOM is kgs then it will consider the specified value in kilo grams
PkgQty int Lot size (package quantity) of the product that can be purchased. Customer can buy the product only in multiples of the specified PkgQuantity
MinimumOrderQuantity int Minimum allowed product quantity per order
MaximumOrderQuantity int Maximum allowed product quantity per order
PreOrder enum Preorder facilitates booking or reserving an item in advance, usually prebooking new products even before it is launched. Specify Y to allow the product booking in advance, else, specify N
BackOrder enum Backorder lets users to place an order even if the product is out of stock. Specify Y if you want to allow users to place orders even in no stock (0). Specify N to disable ordering in case of out of stock
StockAvailableMessage string Specify the stock availability message to show on the product page when it goes out of stock. For example, “Stock will be available in 2 days”
ProductCondition enum Current condition of the product. Value: New, Used
Warrantybearer enum Warranty bearer. Value: No Warranty, Manufacturer, Dealer
WarrantyInMonths int Warranty period in months (if Warrantybearer is Manufacturer or Dealer)
ReserveQuantity int Quantity of items the merchant needs to reserve for special purposes. For example, merchant could reserve some products to fulfill for loyalty customers
StockAlertQuantity int Sends an alert when the quantity of the product is less than this value
BarCode string Barcode of the product. You can pass comma separated values in case of multiple bar codes
ModelNumber string Model number of the product (if applicable)
CatalogCode string Catelogue code of the product (if any)
PurchaseDate date Required for the used product. Date when the used product is purchased in MM:DD:YY format
ProductNote string Additional information to mention about the product for internal reference
FormCode enum Predefined form codes for deal products. Ad-hoc Forms allow you to create customised web forms with a number of custom fields and you can use them to receive customized orders from end-users.
CheckoutWithTokenPrice enum Specify Y to enable checkout with token price (preorder amount)
TokenPrice float The token amount required for preorder (if CheckoutWithTokenPrice is enabled)
CostPrice float The cost price of the product
HidePrice enum Specify Y to hide the price on the storefront, N to show the product price. You can show 'Price on Request’ Call for Action to reveal the price on customer requests
StdProductCode int For international standard product, specify the HSN (Homogeneous Serial Number) of the product as per the chosen standard product type
MPN string Manufacturer’s part number - A unique part number given by the manufacturer of the product
Vendor enum Vendor name associated to the measurement for the product (Predefined vendor)
VendorSKU string SKU of the product in the vendor system for supplier product
StdProductType enum For international standard products, specify the type of identification or HSN of the product type. Values: UPC (Universal Product Code), EAN (European Article Numbering), GTIN (Global Trade Item Number), ASIIN (Amazon Standard Identification Number), ISBN10, ISBN13 (International Standard Book Number)
FulfillmentServiceRefCode string Reference code of the order fulfillment service. These services are required for the fulfillment of a deal or online product deliveries such as music, ringtones, movies. It’s mandatory for Local Deals

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
taskid int Unique id generated for the current update task

Attach Product Images

Associates images to a parent product, variant product and variant properties & values.

Sample Request

https://www.martjack.com/developerapi/Product/AttachImages/f48fdd16-92db-4188-854d-1ecd9b62xxxx

Sample POST Request


[
  {
    "sku": "sku42134125",
    "variants": [
      {
        "variantsku": "sku4113231",
        "images": [
          {
            "filename": "filnemae.jpg",
            "sequence": 1,
            "deepzoom": "file.xml(deprecated",
            "zoom": "filename.png",
            "smallimage": "filename.jpg",
            "thumbnail": "filename.jpg",
            "alttext": "product image text",
            "viewport": "Front"
          }
        ],
        "documents": [
          {
            "type": "Specifications",
            "seoinfo": "specifications of the product ",
            "filename": "filename.Doc",
            "sequence": 1
          }
        ],
        "videos": [
          {
            "type": "Youtube",
            "seoinfo": "video description of the product",
            "filename": "filename.etxn",
            "sequence": 1
          }
        ],
        "view360": [
          {
            "type": "Local_flash",
            "seoinfo": "desc of the product",
            "filename": "filename.png",
            "sequence": 0
          }
        ]
      }
    ],
    "images": [
      {
        "variantproperty": "Color",
        "variantvalue": "Yellow",
        "filename": "Filename.png",
        "sequence": 1,
        "deepzoom": "file.xml",
        "zoom": "filename.xml",
        "smallimage": "filename.jpg",
        "thumbnail": "filename.png",
        "alttext": "test of the image",
        "viewport": "Back"
      }
    ],
    "swatchimages": [
      {
        "variantproperty": "color",
        "variantvalue": "Red",
        "filename": "filename.png"
      }
    ],
    "documents": [
      {
         "type": "Specifications",
         "seoinfo": "specifications of the product ",
         "filename": "filename.Doc",
         "sequence": 1
      }
    ],
    "videos": [
      {
         "type": "Youtube",
            "seoinfo": "video description of the product",
            "filename": "filename.etxn",
            "sequence": 1
      }
    ],
    "view360": [
      {
         "type": "Local_flash",
            "seoinfo": "desc of the product",
            "filename": "filename.png",
            "sequence": 0
      }
    ]
  }
]

Sample Response

{
    "messageCode": "1018",
    "Message": "Data update added to task queue. You can view the status of update in control panel. Also email will be send to merchant registered email after task completion.",
    "Taskid": "2718747",
    "ErrorCode": 0
}

Resource Information

URI /Product/AttachImages/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support Yes

Request URL

{host}/developerapi/Product/AttachImages/{MerchantId}

Additional Header Required

Header Value
content-type* Pass this as application/json

Request Body Parameters

PageTitle Type Description
sku string SKU of the item for which you want to add images
images json obj Image details to be attached based on the variant property and value
filename string Name of the image file
deepzoom string .xml file regarding the zooming effects on mouse hover or product clicks
zoom string The large image that you need to show when clicked on the product ((supported formats: .png, jpg,jpeg, .svc, and .gif))
smallimage string The small image that appears on the product quick view - showcase (supported formats: .png, jpg,jpeg,.svc, and .gif)
thumbnail string Thumbnails of the product images that appears on the product view page (supported formats: .png, jpg,jpeg,.svc, and .gif)
alttext string The alternative text or mouse hover text for the image
viewport enum The view angle of the current image. Values: Front, Back, Left, Right, Bottom
swatchimages obj A swatch image is used to provide an accurate representation of color, and also illustrate a pattern or texture of a product. A swatch is a small image that represents the accurate color or pattern of each variant
variantproperty enum Property name of the current variant. Property names as defined for the merchant
variantvalue enum Property value of the current variant. Supported value as defined for the property for the merchant
filename string File name of the swatch image with extension (supported formats: .png, jpg,jpeg,.svc, and .gif)
documents Documents of the product pertaining to the product information
type string Document purpose. Supported Values: Overview, Product Tour, Specifications, Menu, How it works, Terms and Conditions
seoinfo string Search Engine Optimization of the document
filename string Document type with extension. Supported formats: .doc, .docx, .pdf
sequence int Sequence order of the respective document/picture/video on the product page
videos obj Videos related to the product
type string Source of the video. Supported Values: YouTube, Vimeo, Scribd,
seoinfo string Search Engine Optimization information of the video
filename string Filename of the video with the respective extension
view360 obj 3d images of the product
type string Type of the view 360 degree file name. Value: local_flash

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
Taskid int Unique id generated for the current task

Get SKU Price

Sample Request

https://www.martjack.com/developerapi/Product/Price/f48fdd16-92db-4188-854d-1ecd9b62e234

Sample POST Request

{
  "sku": "TEQUILA11547BLK",
  "variantsku": "11547BLK",
  "usergroupid": 67,
  "locationrefcode": "",
  "channelrefcode": "string"
}

Sample Response

{
   "messageCode":"1004",
   "Message":"Successful",
   "CurrentPrice":[
      {
         "merchantid":"81e77da2-723b-483d-8c0d-49f800c1exxx",
         "sku":"100002587",
         "variantsku":"0",
         "usergroupname":null,
         "locationrefcode":"1001",
         "channelrefcode":null,
         "mrp":6402,
         "webprice":6401,
         "quantity":1,
         "tokenprice":0
      },
      {
         "merchantid":"f48fdd16-92db-4188-854d-1ecd9b62d066",
         "sku":"100002587",
         "variantsku":"0",
         "usergroupname":null,
         "locationrefcode":"Azmi Nagar",
         "channelrefcode":null,
         "mrp":6402,
         "webprice":6401,
         "quantity":1,
         "tokenprice":0
      }
   ]
}

Retrieves the price of a specific item

Resource Information

URI /Product/Price/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Product/Price/{MerchantId}

Additional Header Required

Header Value
content-type* Pass this as application/json

Request Body Parameters Information

Parameter Type Description
sku* string SKU of the item
variantsku string SKU of the variant product (required for variant product)
usergroupid int Specify the user group id associated to the price list
locationrefcode string Location/store code associated to the price list
channelrefcode string Channel reference code to which the price list is associated

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
usergroupname string Name of the user group. It can be related to promotions, subscription events, etc.
tokenprice float Minimum amount required for the customer for prebooking the item
channelrefcode string Channel code to which the price list is associated

Get Product Price and Inventory (LocationStockPrice)

Retrieves the details of inventory and price of a specific product across all locations or a particular location based on the input parameters passed.

Sample Request

https://www.martjack.com/developerapi/Product/f48fdd16-92db-4188-854d-1ecd9b62d066/LocationStockPrice

Sample POST Request (RAW)


MerchantId=f48fdd16-92db-4188-854d-1ecd9b62d066&sku=&variantsku=&productid=14106036&locationid=17586


Sample Response


{
    "messageCode": "1004",
    "Message": "Successful",
    "LocationStockPrices": [
        {
            "MerchantId": "f48fdd16-92db-4188-854d-1ecd9b62d066",
            "PriceListId": 0,
            "LocationId": 17586,
            "UserGroupId": 0,
            "ProductId": 14106036,
            "VariantProductId": 10178766,
            "Quantity": 0,
            "MRP": 0,
            "WebPrice": 0,
            "Inventory": "100"
        },
        {
            "MerchantId": "f48fdd16-92db-4188-854d-1ecd9b62d066",
            "PriceListId": 2838,
            "LocationId": 18340,
            "UserGroupId": 8402,
            "ProductId": 14106036,
            "VariantProductId": 0,
            "Quantity": 0,
            "MRP": 0,
            "WebPrice": 0,
            "Inventory": "11"
        }
    ]

Resource Information

URI /Product/{merchantId}/LocationStockPrice
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Product/{merchantId}/LocationStockPrice

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
sku string SKU of product for which you want to see inventory and price details
variantSKU string SKU of variant product for which you want to see inventory and price details
productId int Specify the product id for which you want to see inventory and price details
locationId int Retrieves the inventory and product details of a specific location

Get Product Information (by Location)

Retrieves the details of a product for a specific location.

Sample Request

https://www.martjack.com/developerapi/Product/Information/9820eca5-d11f-4df1-9b20-983a45ea9631/11982534/16696

Sample Response

{
    "messageCode":"1004",
    "Message":"Successful",
    "Product":
    {
        "ProductId":11982534,
        "ProductTitle":"Mothers Dairy Safal Frozen Vegetables - Mixed Vegetables,",
        "MRP":50.0,
        "WebPrice":50.0,
        "CostPrice":0.0,
        "Rating":0,
        "IsParentProduct":false,
        "Availability":true,
        "BrandId":"0",
        "CatlogSequence":0,
        "CatalogCode":"",
        "SKU":"100040621",
        "Taxtotal":0,
        "MarkupPrice":0,
        "MarkupType":"",
        "BulkQuantity":1,
        "ProductWeight":0.0,
        "ProductType":"P",
        "SmallImageAltText":"0",
        "IsShippingConfigured":false,
        "IsTaxConfigured":false,
        "StartDate":"\/Date(1537209000000+0530)\/",
        "EndDate":"\/Date(1537295400000+0530)\/",
        "SeoURL":"http:\/\/www.example.martjack.com\/mothers-dairy-safal-frozen-vegetables---mixed-vegetables\/p\/11982534",
        "DeliveryTime":"Delivered in 5 Working days",
        "TokenPriceCheckout":false,
        "IsReferPrice":false,
        "ShortDescription":"",
        "TokenPrice":0.0,
        "SmallImage":"",
        "Brandname":"Safal",
        "CategoryId":"CU00333866",
        "CategoryName":"Frozen Mixed Vegetable",
        "Fulldescription":"",
        "NoofReview":"0",
        "BarCode":"9876567892",
        "Inventory":"120",
        "PreOrder":"0",
        "BackOrder":"0",
        "OfferDescription":"",
        "RefProductId":"0",
        "Sellerid":"00000000-0000-0000-0000-000000000000",
        "ShippingCodes":"Cart amount",
        "IsInStock":"true",
        "ProductSequence":0,
        "UOM":"Pieces"
    },
    "ErrorCode":0
}


Resource Information

URI /Product/Information/{merchantId}/{productId}/{locationId}
Response Formats JSON
HTTP Methods GET
Batch Support Yes
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Product/Information/{merchantId}/{productId}/{locationId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
productId* int Product id of the SKU
locationId* int Location id of the location

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
CatlogSequence int Sequence of the product in the respective product category to appear on the storefront
MarkupPrice float -NA-
MarkupType string -NA-
IsShippingConfigured boolean Whether the shipping is enabled for the item or not
IsTaxConfigured boolean Whether tax is enabled for the item or not
StartDate date-time The duration for which the product is shown on the storefront (StartDate - EndDate)
EndDate date-time The duration for which the product is shown on the storefront (StartDate - EndDate)
SeoURL string The SEO friendly URL of the product
TokenPriceCheckout float Minimum amount required for the customer to reserve the item during checkout and purchase later on
IsReferPrice boolean -NA-
NoofReview string Number of reviews received for the product
UOM string Unit of measurement of the product. It could be pieces for the items that are sold in numbers and the respective measure for other items such as kgs, and gms

Get Product Information with Attributes

Retrieves details of a specific product along with the product attributes based on the product id passed.

Sample Request

https://www.martjack.com/developerapi/Product/InformrationNAttr/993c939a-a2e8-4934-bbf5-390f37457a55/13036942

Sample Response

{
   "Message":"Successful",
   "messageCode":"1004",
   "Products":[
      {
         "ProductId":"13036942",
         "ProductTitle":"AutomationProduct_pdd",
         "MRP":"9999",
         "WebPrice":"9995",
         "Rating":"0",
         "IsParentProduct":"True",
         "Availability":"True",
         "BrandId":"Nik002",
         "CatlogSequence":"0",
         "CatalogCode":"",
         "SKU":"AutoSKU085",
         "BulkQuantity":"1",
         "ProductWeight":"0",
         "ProductType":"A",
         "SmallImageAltText":"",
         "StartDate":"1/1/1900",
         "EndDate":"1/1/1900",
         "DeliveryTime":"",
         "IsTokenPriceCheckout":"False",
         "ShortDescription":"",
         "TokenPrice":"0",
         "CategoryId":"CU00366336",
         "Inventory":"1200",
         "PreOrder":"1",
         "BackOrder":"0",
         "RefProductId":"0",
         "Sellerid":"00000000-0000-0000-0000-000000000000",
         "ShippingCodes":[

         ],
         "ReserveQuantity":"0",
         "ProductVariantList":[

         ],
         "lstProductAttribute":[
            {
               "Attributeid":"CU00366336-002",
               "Name":"ClothMaterial",
               "Unit":"1",
               "Iscompulsory":false,
               "Ispredefined":false,
               "Description":"",
               "Attributegroup":"1",
               "AttributeValue":"1",
               "ObjAttributeValueEnt":[

               ],
               "IsDisplay":false,
               "CategoryId":"CU00366336",
               "Rank":0,
               "PredefinedValueId":0,
               "IsParentCategoryAttribute":false,
               "AttributeValueId":"",
               "DataType":"String",
               "NoOfColumns":1,
               "ReferenceCode":"cmat"
            },
            {
               "Attributeid":"CU00366336-001",
               "Name":"Fit",
               "Unit":"1",
               "Iscompulsory":false,
               "Ispredefined":false,
               "Description":"",
               "Attributegroup":"2",
               "AttributeValue":"1",
               "ObjAttributeValueEnt":[

               ],
               "IsDisplay":false,
               "CategoryId":"CU00366336",
               "Rank":1,
               "PredefinedValueId":0,
               "IsParentCategoryAttribute":false,
               "AttributeValueId":"",
               "DataType":"String",
               "NoOfColumns":0,
               "ReferenceCode":"fit"
            },
            {
               "Attributeid":"CU00366334-001",
               "Name":"new",
               "Unit":"1",
               "Iscompulsory":false,
               "Ispredefined":false,
               "Description":"",
               "Attributegroup":"new",
               "AttributeValue":"1",
               "ObjAttributeValueEnt":[

               ],
               "IsDisplay":false,
               "CategoryId":"CU00366334",
               "Rank":1,
               "PredefinedValueId":0,
               "IsParentCategoryAttribute":false,
               "AttributeValueId":"",
               "DataType":"String",
               "NoOfColumns":0,
               "ReferenceCode":"CU00366334_001"
            }
         ],
         "IsLocationShip":"True",
         "DeliveryOptions":{
            "IsLocationShip":"True",
            "IsOffline":"False",
            "IsOnline":"False",
            "IsShip":"True"
         },
         "BrandName":"NIKE",
         "IsInStock":"True",
         "IsQtyBasedPricing":"False",
         "SoldOut":"False"
      }
   ]
}

Resource Information

URI /Product/InformationNAttr/{merchantid}/{productid}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/InformationNAttr/{merchantid}/{productid}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
productid* int Unique id of the product that you want to fetch

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
CatlogSequence int Sequence of the product in the respective product category (to appear on the storefront)
CatalogCode string Catalog code associated to the product
BulkQuantity int Lot size or batch size of the product. Value will 0 if not applicable
ProductType enum Type of the product. Values: P for a normal product, A for an add-on product, and B for a bundle product, D for deal product
SmallImageAltText string Mouse hover text for small image
IsTokenPriceCheckout boolean For out of stock products, you can sell them as pre-orders allowing customers to book an item with a minimum price (token price) and pay rest when the product is in stock. This parameter states whether the product supports pre-order booking with token price or not.
TokenPrice float Token price for preorder if IsTokenPriceCheckout is enabled
CategoryId string Products are grouped into categories based on the type and each category will have a unique category id
Inventory int The number of products (stock) available
BackOrder enum Whether the order can be placed even when the product is out of stock
Sellerid string Unique GUID of the product seller
ReserveQuantity int Quantity of items reserved for special purposes. For example, merchant could reserve some products for the fulfillment for loyalty customers
_ProductAttribute obj Details of each product attribute in prefex 1st, 2nd, 3rd and so on.

Get Product Details (by SKU)

Sample Request

https://www.martjack.com/developerapi/Product/SKU/81e77da2-723b-483d-8c0d-49f800c1exxx/100040621

Sample Response


{
    "messageCode":"1004",
    "Message":"Successful",
    "Product":
    {
        "ProductId":11982534,
        "ProductTitle":"Mothers Dairy Safal Frozen Vegetables - Mixed Vegetables,",
        "MRP":50.0,
        "WebPrice":50.0,
        "CostPrice":0.0,
        "Rating":0,
        "IsParentProduct":false,
        "Availability":true,
        "BrandId":"0",
        "CatlogSequence":0,
        "CatalogCode":"",
        "SKU":"100040621",
        "Taxtotal":0,
        "MarkupPrice":0,
        "MarkupType":"",
        "BulkQuantity":0,
        "ProductWeight":0.0,
        "ProductType":"P",
        "SmallImageAltText":"0",
        "IsShippingConfigured":false,
        "IsTaxConfigured":false,
        "StartDate":"\/Date(1537209000000+0530)\/",
        "EndDate":"\/Date(1537295400000+0530)\/",
        "SeoURL":"",
        "DeliveryTime":"Delivered in 5 Working days",
        "TokenPriceCheckout":false,
        "IsReferPrice":false,
        "ShortDescription":"",
        "TokenPrice":0.0,
        "SmallImage":"",
        "Brandname":null,
        "CategoryId":"CU00333866",
        "CategoryName":null,
        "Fulldescription":null,
        "NoofReview":null,
        "BarCode":null,
        "ProductSequence":0,
        "UOM":null
    },
    "ErrorCode":0
}

Retrieves the details of a specific product by SKU.

Resource Information

URI /Product/SKU/{merchantId}/{sku}
Response Formats JSON
HTTP Methods GET
Batch Support Yes
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Product/SKU/{merchantId}/{sku}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
sku* string SKU of the product that you want to fetch

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
CatlogSequence int Sequence of the product in the respective product category to appear on the storefront
BulkQuantity int Lot size or batch size of the product. Value will be 0 if not applicable
NoofReview string Number of reviews received for the product
UOM string Unit of measurement of the product. The value will be pieces for items that are sold as pieces and the respective measure for other items sold on weight basis -kgs for kilograms, and gms for grams

Get Products by Product Tag & Location

Retrieves products with a specific product tag in a given location.

Sample Request

https://www.martjack.com/developerapi/Product/993c939a-a2e8-4934-bbf5-390f37457a55/Automation9/24342

Sample Response

{
   "messageCode":"1004",
   "Message":"Successful",
   "Products":[
      {
         "ProductId":13038134,
         "ProductTitle":"TShirt Product 01",
         "MRP":1500,
         "WebPrice":1350,
         "CostPrice":0,
         "Rating":2,
         "IsParentProduct":true,
         "Availability":true,
         "BrandId":"0",
         "CatlogSequence":0,
         "CatalogCode":"",
         "SKU":"tshirt-001",
         "Taxtotal":0,
         "MarkupPrice":0,
         "MarkupType":"",
         "BulkQuantity":1,
         "ProductWeight":0,
         "ProductType":"P",
         "SmallImageAltText":"t-shirt",
         "IsShippingConfigured":false,
         "IsTaxConfigured":false,
         "StartDate":"/Date(-2209008600000+0530)/",
         "EndDate":"/Date(-2209008600000+0530)/",
         "SeoURL":"http://www.example.martjack.com/products/mens-t-shirts/nike/tshirt-product-01/pid-13038134.aspx",
         "DeliveryTime":"",
         "TokenPriceCheckout":false,
         "IsReferPrice":false,
         "ShortDescription":"",
         "TokenPrice":0,
         "SmallImage":"",
         "Brandname":"NIKE",
         "CategoryId":"CU00366336",
         "CategoryName":"T-Shirts",
         "Fulldescription":null,
         "NoofReview":"12",
         "BarCode":"",
         "ProductSequence":1,
         "UOM":"Pieces"
      },
      {
         "ProductId":13038136,
         "ProductTitle":"TShirt Product 02",
         "MRP":1500,
         "WebPrice":1350,
         "CostPrice":0,
         "Rating":0,
         "IsParentProduct":true,
         "Availability":true,
         "BrandId":"0",
         "CatlogSequence":0,
         "CatalogCode":"",
         "SKU":"tshirt-002",
         "Taxtotal":0,
         "MarkupPrice":0,
         "MarkupType":"",
         "BulkQuantity":1,
         "ProductWeight":0,
         "ProductType":"P",
         "SmallImageAltText":"TShirt Product 02",
         "IsShippingConfigured":false,
         "IsTaxConfigured":false,
         "StartDate":"/Date(-2209008600000+0530)/",
         "EndDate":"/Date(-2209008600000+0530)/",
         "SeoURL":"http://www.example.martjack.com/products/mens-t-shirts/nike/tshirt-product-02/pid-13038136.aspx",
         "DeliveryTime":"",
         "TokenPriceCheckout":false,
         "IsReferPrice":false,
         "ShortDescription":"",
         "TokenPrice":0,
         "SmallImage":"",
         "Brandname":"NIKE",
         "CategoryId":"CU00366336",
         "CategoryName":"T-Shirts",
         "Fulldescription":null,
         "NoofReview":"0",
         "BarCode":"",
         "ProductSequence":0,
         "UOM":"Pieces"
      }
   ],
   "ErrorCode":0
}

Resource Information

URI /Product/{merchantId}/{productTag}/{locationId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/{merchantId}/{productTag}/{locationId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
productTag* string Specify the name of product tag by which you want to fetch products
locationId* int Location id for which you want to fetch products with specified tag

Get Products (by Type & Page Number)

Retrieves the details of products of a specific category by product type and page number.

Sample Request

https://www.martjack.com/developerapi/Product/Category/f48fdd16-92db-4188-854d-1ecd9b62d066/CU00333414/P/1

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "Products": [
        {
            "ProductId": 11996474,
            "ProductTitle": "Y Cook Sweet, Corn Kernels Boiled,African Peri, Peri Seasoning, 100g Pouch",
            "MRP": 35,
            "WebPrice": 35,
            "CostPrice": 0,
            "Rating": 0,
            "IsParentProduct": false,
            "Availability": true,
            "BrandId": "298460",
            "CatlogSequence": 0,
            "CatalogCode": "",
            "SKU": "100646952",
            "Taxtotal": 0,
            "MarkupPrice": 0,
            "MarkupType": "",
            "BulkQuantity": 1,
            "ProductWeight": 0,
            "ProductType": "P",
            "SmallImageAltText": "Y Cook Sweet, Corn Kernels Boiled,African Peri, Peri Seasoning, 100g Pouch",
            "IsShippingConfigured": false,
            "IsTaxConfigured": false,
            "StartDate": "/Date(-2209008600000+0530)/",
            "EndDate": "/Date(-2209008600000+0530)/",
            "SeoURL": "http://www.hyctest.nightlysites.capillary.in/y-cook-sweet-corn-kernels-boiledafrican-peri-peri-seasoning-100g-pouch/p/11996474",
            "DeliveryTime": "Delivered in 5 Working days",
            "TokenPriceCheckout": false,
            "IsReferPrice": false,
            "ShortDescription": "",
            "TokenPrice": 0,
            "SmallImage": "",
            "Brandname": "Healthy No 1",
            "CategoryId": "CU00333414",
            "CategoryName": "Fresh Vegetables",
            "Fulldescription": null,
            "NoofReview": "0",
            "BarCode": "",
            "ProductSequence": 0,
            "UOM": "Pieces"
        },
        {
            "ProductId": 11997154,
            "ProductTitle": "Y Cook Sweet Corn Boiled - Double, 2 Pieces Pouch",
            "MRP": 68,
            "WebPrice": 68,
            "CostPrice": 0,
            "Rating": 0,
            "IsParentProduct": false,
            "Availability": true,
            "BrandId": "298460",
            "CatlogSequence": 0,
            "CatalogCode": "",
            "SKU": "100646951",
            "Taxtotal": 0,
            "MarkupPrice": 0,
            "MarkupType": "",
            "BulkQuantity": 1,
            "ProductWeight": 0,
            "ProductType": "P",
            "SmallImageAltText": "Y Cook Sweet Corn Boiled - Double, 2 Pieces Pouch",
            "IsShippingConfigured": false,
            "IsTaxConfigured": false,
            "StartDate": "/Date(-2209008600000+0530)/",
            "EndDate": "/Date(-2209008600000+0530)/",
            "SeoURL": "http://www.hyctest.nightlysites.capillary.in/y-cook-sweet-corn-boiled---double-2-pieces-pouch/p/11997154",
            "DeliveryTime": "Delivered in 5 Working days",
            "TokenPriceCheckout": false,
            "IsReferPrice": false,
            "ShortDescription": "",
            "TokenPrice": 0,
            "SmallImage": "",
            "Brandname": "Healthy No 1",
            "CategoryId": "CU00333414",
            "CategoryName": "Fresh Vegetables",
            "Fulldescription": null,
            "NoofReview": "0",
            "BarCode": "",
            "ProductSequence": 0,
            "UOM": "Pieces"
        }
]
}


Resource Information

URI /Product/Category/{merchantId}/{categoryId}/{productType}/{pageNumber}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/Category/{merchantId}/{categoryId}/{productType}/{pageNumber}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
categoryId* string Unique id of the category by which you want to fetch products
productType enum Type of the product. Values: P for a normal product, A for an add-on product, and B for a bundle product, D for deal product
pageNumber int Get products of a specific page number based on the pagination set. Supported value: 1-100

Get Multiple Parent Products

Retrieves the details of parent products based on the variant product ids you specify. You can pass multiple variant product IDs (batch) in a request.

Sample Request

https://www.martjack.com/developerapi/Product/993c939a-a2e8-4934-bbf5-390f37457a55/GetMultipleParentproducts

Sample POST Request (RAW)

MerchantId=993c939a-a2e8-4934-bbf5-390f37457a55&varientProductIds=10603855,10604855

Sample Response

{
   "messageCode":"1004",
   "Message":"Successful",
   "ProductVarient":[
      {
         "variantProductId":"10603855",
         "productId":14577393,
         "MRP":1000,
         "WebPrice":900,
         "SKU":"AutoVarSKU28625553183",
         "Inventory":100,
         "ReferenceProductVariantId":0,
         "productType":"",
         "merchantId":"993c939a-a2e8-4934-bbf5-390f37457a55",
         "BulkQuantity":1,
         "Availability":true,
         "StartDate":"/Date(-2209008600000+0530)/",
         "EndDate":"/Date(-2209008600000+0530)/",
         "CostPrice":0,
         "BarCode":"",
         "CatalogCode":"",
         "IsDropShipping":false,
         "MarkupPrice":0,
         "MarkupType":"",
         "IsReferProductInfo":false,
         "IsReferPrice":false,
         "TokenPrice":0,
         "Flag":null,
         "ReserveQuantity":0,
         "ReOrderStockLevel":0,
         "StockAlertQuantity":0,
         "PreOrderMessage":"",
         "PreOrder":false,
         "BackOrder":false,
         "IsStockEnabled":false,
         "WebPriceWithoutDiscount":0,
         "ProductVariantValueViews":[
            {
               "valueId":18096205,
               "variantProductId":10603855,
               "variantPropertyId":14682,
               "variantPropertyValueId":319514,
               "IsDisplaySwatch":false,
               "Rank":2,
               "variantPropertyName":"Size",
               "variantValue":"Small",
               "flag":""
            }
         ]
      },
      {
         "variantProductId":"10604855",
         "productId":14577393,
         "MRP":1000,
         "WebPrice":900,
         "SKU":"AutoVarSKU28625553183",
         "Inventory":100,
         "ReferenceProductVariantId":0,
         "productType":"",
         "merchantId":"993c939a-a2e8-4934-bbf5-390f37457a55",
         "BulkQuantity":1,
         "Availability":true,
         "StartDate":"/Date(-2209008600000+0530)/",
         "EndDate":"/Date(-2209008600000+0530)/",
         "CostPrice":0,
         "BarCode":"",
         "CatalogCode":"",
         "IsDropShipping":false,
         "MarkupPrice":0,
         "MarkupType":"",
         "IsReferProductInfo":false,
         "IsReferPrice":false,
         "TokenPrice":0,
         "Flag":null,
         "ReserveQuantity":0,
         "ReOrderStockLevel":0,
         "StockAlertQuantity":0,
         "PreOrderMessage":"",
         "PreOrder":false,
         "BackOrder":false,
         "IsStockEnabled":false,
         "WebPriceWithoutDiscount":0,
         "ProductVariantValueViews":[
            {
               "valueId":18096205,
               "variantProductId":10604855,
               "variantPropertyId":14682,
               "variantPropertyValueId":319514,
               "IsDisplaySwatch":false,
               "Rank":2,
               "variantPropertyName":"Size",
               "variantValue":"Small",
               "flag":""
            }
         ]
      }
   ],
   "ErrorCode":0
}

Resource Information

URI /Product/{merchantId}/GetMultipleParentproducts
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support Yes

Request URL

{host}/developerapi/Product/{merchantId}/GetMultipleParentproducts

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
variantProductId* int Specify the variant product ids for which you want to fetch parent products

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
VariantProperty string Unique id associated to the variant property such as size, color, and weight
VariantPropertyName string Name of the variant property
VariantValue string Value of that specific variant property
ProductTitle string Title of the product that appears on the product’s page on the storefront
ProductType string Type of the product. Values: P for a normal product, A for an add-on product, and B for a bundle product, D for deal product
BarCode string Bar code of the product
CatalogCode string Catalog code associated to the product
IsDropShipping boolean
ReserveQuantity int Quantity of items reserved for special purposes. For example, merchant could reserve some products for the fulfillment of loyalty customers
ReOrderStockLevel int Minimum stock (quantity of the product) level when you want to allow reorder
StockAlertQuantity int Sends an alert to the POCs when the quantity of the product is less than this value
PreOrderMessage string
PreOrder boolean Whether prebooking is available for the product
BackOrder boolean Whether can the product be ordered even when out of stock
IsStockEnabled boolean
WebPriceWithoutDiscount float Price on the storefront excluding discount
Rank int sequence of the variant product in the

Get Product Variants (by Parent Product ID)

Sample Request

https://www.martjack.com/developerapi/Product/Varients/9820eca5-d11f-4df1-9b20-983a45ea9631/12322048/true

Sample Response

{
    "messageCode":"1004",
    "Message":"Successful",
    "ProductVarient":
    [
        {
            "variantProductId":"9076980",
            "productId":12322048,
            "MRP":400,
            "WebPrice":400.0,
            "SKU":"100309195",
            "Inventory":110,
            "ReferenceProductVariantId":0,
            "productType":"",
            "merchantId":"f48fdd16-92db-4188-854d-1ecd9b62d066",
            "BulkQuantity":1,
            "Availability":true,
            "StartDate":"\/Date(-2209008600000+0530)\/",
            "EndDate":"\/Date(-2209008600000+0530)\/",
            "CostPrice":0,
            "BarCode":"100309195,8906001020547",
            "CatalogCode":"",
            "IsDropShipping":false,
            "MarkupPrice":0,
            "MarkupType":"",
            "IsReferProductInfo":false,
            "IsReferPrice":false,
            "TokenPrice":0,
            "Flag":"",
            "ReserveQuantity":0,
            "ReOrderStockLevel":0,
            "StockAlertQuantity":0,
            "PreOrderMessage":"",
            "PreOrder":false,
            "BackOrder":false,
            "IsStockEnabled":false,
            "WebPriceWithoutDiscount":0,
            "ProductVariantValueViews":
            [
                {
                    "valueId":14870754,
                    "variantProductId":9076980,
                    "variantPropertyId":13068,
                    "variantPropertyValueId":297444,
                    "IsDisplaySwatch":false,
                    "Rank":100375,
                    "variantPropertyName":"Weight",
                    "variantValue":"1kg Box",
                    "flag":""
                }
            ]
        },
        {
            "variantProductId":"9077536",
            "productId":12322048,
            "MRP":115,
            "WebPrice":115.0,
            "SKU":"100258508",
            "Inventory":120,
            "ReferenceProductVariantId":0,
            "productType":"",
            "merchantId":"f48fdd16-92db-4188-854d-1ecd9b62d066",
            "BulkQuantity":1,
            "Availability":true,
            "StartDate":"\/Date(-2209008600000+0530)\/",
            "EndDate":"\/Date(-2209008600000+0530)\/",
            "CostPrice":0,
            "BarCode":"100258508,8906001020431",
            "CatalogCode":"",
            "IsDropShipping":false,
            "MarkupPrice":0,
            "MarkupType":"",
            "IsReferProductInfo":false,
            "IsReferPrice":false,
            "TokenPrice":0,
            "Flag":"",
            "ReserveQuantity":0,
            "ReOrderStockLevel":0,
            "StockAlertQuantity":0,
            "PreOrderMessage":"",
            "PreOrder":false,
            "BackOrder":false,
            "IsStockEnabled":false,
            "WebPriceWithoutDiscount":0,
            "ProductVariantValueViews":
            [
                {
                    "valueId":14871310,
                    "variantProductId":9077536,
                    "variantPropertyId":13068,
                    "variantPropertyValueId":297450,
                    "IsDisplaySwatch":false,
                    "Rank":100378,
                    "variantPropertyName":"Weight",
                    "variantValue":"200g Box",
                    "flag":""
                }
            ]
        }
    ],
    "ErrorCode":0
}


Retrieves all variants of a parent product.

Resource Information

URI /Product/Varients/{merchantId}/{ParentProductId}/{availability}
Response Formats JSON
HTTP Methods GET
Batch Support Yes
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Product/Varients/{merchantId}/{ParentProductId}/{availability}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
productId* string Unique id of the parent product for which you want to fetch available variants
availability enum Specify active to get only active variants

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
ReferenceProductVariantId int Reference id of the product variant
StartDate date-time The duration (between StartDate and EndDate) for which the product is shown on the storefront
EndDate date-time The duration (between StartDate and EndDate) for which the product is shown on the storefront
IsReferPrice float -NA-
ReserveQuantity int Quantity of items the merchant needs to reserve for special purposes. For example, merchant could reserve some products to fulfill for loyalty customers
ReOrderStockLevel int Minimum stock (quantity of the product) when you want to allow reorder
IsDisplaySwatch boolean Whether the illustration of accurate representation of color, pattern or texture of the product is shown on the storefront

Get Product Variants (by Variant ID)

Retrieves the details of all products of a variant (by variant id).

Sample Request

https://www.martjack.com/developerapi/Product/ProductVarient/0639f7a6-34cc-48b2-9fd9-a80e2ed88dfe/27686

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "ProductVarient": [
        {
            "variantProductId": "27686",
            "productId": 8283282,
            "MRP": 70,
            "WebPrice": 70,
            "SKU": "IN-Veg-Cheese-Rglr-Mdm",
            "Inventory": 15540000,
            "ReferenceProductVariantId": 0,
            "productType": "",
            "merchantId": "98d18d82-ba59-4957-9c92-3f89207a34f6",
            "BulkQuantity": 1,
            "Availability": true,
            "StartDate": "/Date(-2209008600000+0530)/",
            "EndDate": "/Date(-2209008600000+0530)/",
            "CostPrice": 0,
            "BarCode": "",
            "CatalogCode": "",
            "IsDropShipping": false,
            "MarkupPrice": 0,
            "MarkupType": "",
            "IsReferProductInfo": false,
            "IsReferPrice": false,
            "TokenPrice": 0,
            "Flag": null,
            "ReserveQuantity": 0,
            "ReOrderStockLevel": 0,
            "StockAlertQuantity": 0,
            "PreOrderMessage": "",
            "PreOrder": false,
            "BackOrder": false,
            "IsStockEnabled": false,
            "WebPriceWithoutDiscount": 0,
            "ProductVariantValueViews": [
                {
                    "valueId": 5008728,
                    "variantProductId": 27686,
                    "variantPropertyId": 2108,
                    "variantPropertyValueId": 24374,
                    "IsDisplaySwatch": false,
                    "Rank": 1,
                    "variantPropertyName": "Size",
                    "variantValue": "Medium | Serves 2",
                    "flag": ""
                },
                {
                    "valueId": 5008730,
                    "variantProductId": 27686,
                    "variantPropertyId": 2110,
                    "variantPropertyValueId": 24378,
                    "IsDisplaySwatch": false,
                    "Rank": 1,
                    "variantPropertyName": "Strength",
                    "variantValue": "Regular",
                    "flag": ""
                }
            ]
        }
    ],
    "ErrorCode": 0
}

Resource Information

URI /Product/ProductVarient/{MerchantId}/{variantProductId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/ProductVarient/{MerchantId}/{variantProductId}

Request Path Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchant
variantProductId* int Unique id of the variant product that you want to fetch

Get Attributes of Variant Products

Retrieves all attributes of a variant product for a specific location.

Sample Request

https://www.martjack.com/developerapi/Product/LocationAttribute/993c939a-a2e8-4934-bbf5-390f37457a55/formalshirt-001/formalshirt-var-001/Begur

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "LocationProductAttribute": [
        {
            "SKU": "formalshirt-001",
            "VariantSKU": "formalshirt-var-001",
            "LocationRefCode": "Begur",
            "Attributeid": "CU00366338-003",
            "AttributeValue": "Cotton_test"
        }
    ],
    "ErrorCode": 0
}


Resource Information

URI /Product/LocationAttribute/{merchantId}/{sku}/{variantSku}/{locationRefCode}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/LocationAttribute/{merchantId}/{sku}/{variantSku}/{locationRefCode}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
sku* string SKU of the product
variantsku* string SKU of the variant product for which you want to fetch attributes
locationrefcode* string Unique location reference code for which you want to see attributes

Get Products by Tag

Sample Request

https://www.martjack.com/developerapi/Product/9820eca5-d11f-4df1-9b20-983a45ea9631/bestoffers/16654

Sample Response

{
   "messageCode":"1004",
   "Message":"Successful",
   "Products":
   [
       {
           "ProductId":11631476,
           "ProductTitle":"Fresho Pomegranate - Peeled, 200 gm 12",
           "MRP":1000.0,
           "WebPrice":1000.0,
           "CostPrice":0.0,
           "Rating":0,
           "IsParentProduct":false,
           "Availability":false,
           "BrandId":"282504",
           "CatlogSequence":1,
           "CatalogCode":"1234",
           "SKU":"Fruits0001",
           "Taxtotal":0,
           "MarkupPrice":0,
           "MarkupType":"",
           "BulkQuantity":1,
           "ProductWeight":150.0,
           "ProductType":"P",
           "SmallImageAltText":"Fresho Pomegranate - Peeled, 200 gm 12",
           "IsShippingConfigured":false,
           "IsTaxConfigured":false,
           "StartDate":"\/Date(1525372200000+0530)\/",
           "EndDate":"\/Date(1528050600000+0530)\/",
           "SeoURL":"http:\/\/www.test.stagesites.capillary.in\/seo-url\/p\/11631476",
           "DeliveryTime":"2-4 days",
           "TokenPriceCheckout":false,
           "IsReferPrice":false,
           "ShortDescription":"api_test",
           "TokenPrice":0.0,
           "SmallImage":"",
           "Brandname":"Fresho",
           "CategoryId":"CU00325882",
           "CategoryName":"Cut & Peeled Fruits",
           "Fulldescription":null,
           "NoofReview":"0",
           "BarCode":"",
           "ProductSequence":0,
           "UOM":"Pieces"
       }
   ],
   "ErrorCode":0
}

Retrieves products with a specific product tag.

Resource Information

URI /Product/{merchantId}/{productTag}/{locationId}
Response Formats JSON
HTTP Methods GET
Batch Support Yes
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Product/{merchantId}/{productTag}/{locationId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
productTag* string Associated Tag name by which you want to fetch products
locationId* int Fetch products of a specific location. Pass 0 to choose the default location of the merchant

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
TokenPriceCheckout float Prebooking price for the product, i.e., Minimum amount required for the customer to reserve the item during checkout and purchase later on
IsReferPrice boolean -NA-
UOM string Unit of measurement of the product. Value will be pieces for items that are sold in numbers and kgs or gms for items sold in kilograms or grams respectively

Get Multiple Products Information

Retrieves the details of multiple products based on the product ids passed.

Sample Request

https://www.martjack.com/developerapi/Product/993c939a-a2e8-4934-bbf5-390f37457a55/GetMultipleProductInformation

Sample POST Request (RAW)

MerchantId=993c939a-a2e8-4934-bbf5-390f37457a55&productIds=14577401,14577451

Sample Response

{
   "messageCode":"1004",
   "Message":"Successful",
   "Products":[
      {
         "ProductId":14577401,
         "ProductTitle":"AutoTitle11316542375",
         "MRP":1000,
         "WebPrice":900,
         "CostPrice":0,
         "Rating":0,
         "IsParentProduct":true,
         "Availability":true,
         "BrandId":"322101",
         "CatlogSequence":0,
         "CatalogCode":"",
         "SKU":"AutoSKU77721210280",
         "Taxtotal":0,
         "MarkupPrice":0,
         "MarkupType":"",
         "BulkQuantity":1,
         "ProductWeight":0,
         "ProductType":"P",
         "SmallImageAltText":"AutoTitle11316542375",
         "IsShippingConfigured":false,
         "IsTaxConfigured":false,
         "StartDate":"/Date(-2209008600000+0530)/",
         "EndDate":"/Date(-2209008600000+0530)/",
         "SeoURL":"http://www.testorg2.martjack.com/products/automation-productaddupdate/automation/autotitle11316542375/pid-14577401.aspx",
         "DeliveryTime":"",
         "TokenPriceCheckout":false,
         "IsReferPrice":false,
         "ShortDescription":"",
         "TokenPrice":0,
         "SmallImage":"",
         "Brandname":"Automation",
         "CategoryId":"CU00379869",
         "CategoryName":"productadd/update",
         "Fulldescription":null,
         "NoofReview":"0",
         "BarCode":"",
         "Inventory":"100",
         "PreOrder":"0",
         "BackOrder":"0",
         "RefProductId":"0",
         "ProductSequence":0,
         "UOM":"Pieces"
      },
      {
         "ProductId":14577451,
         "ProductTitle":"AutoTitle64610622188",
         "MRP":1000,
         "WebPrice":900,
         "CostPrice":0,
         "Rating":0,
         "IsParentProduct":false,
         "Availability":false,
         "BrandId":"322101",
         "CatlogSequence":0,
         "CatalogCode":"",
         "SKU":"AutoSKU36398752078",
         "Taxtotal":0,
         "MarkupPrice":0,
         "MarkupType":"",
         "BulkQuantity":1,
         "ProductWeight":0,
         "ProductType":"P",
         "SmallImageAltText":"AutoTitle64610622188",
         "IsShippingConfigured":false,
         "IsTaxConfigured":false,
         "StartDate":"/Date(1549521000000+0530)/",
         "EndDate":"/Date(1579737600000+0530)/",
         "SeoURL":"http://www.testorg2.martjack.com/products/automation-productaddupdate/automation/autotitle64610622188/pid-14577451.aspx",
         "DeliveryTime":"",
         "TokenPriceCheckout":false,
         "IsReferPrice":false,
         "ShortDescription":"AutomationProduct",
         "TokenPrice":0,
         "SmallImage":"",
         "Brandname":"Automation",
         "CategoryId":"CU00379869",
         "CategoryName":"productadd/update",
         "Fulldescription":null,
         "NoofReview":"0",
         "BarCode":"87451721735",
         "Inventory":"100",
         "PreOrder":"1",
         "BackOrder":"0",
         "RefProductId":"0",
         "ProductSequence":0,
         "UOM":"Pieces"
      }
   ],
   "ErrorCode":0
}

Resource Information

URI /Product/{merchantId}/GetMultipleProductInformation
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support Yes

Request URL

{host}/developerapi/Product/{merchantId}/GetMultipleProductInformation

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
Rating int Rating received for the product from customers
IsParentProduct boolean Whether the product is a parent product or not
Availability boolean Whether the product is in stock or not
BrandId int Unique id of the product brand
CatlogSequence int Sequence of the product in the respective product category as on the storefront
CatalogCode string Catalog code associated to the product
StartDate date The duration for which the product is shown on the storefront (StartDate - EndDate)
EndDate date The duration for which the product is shown on the storefront (StartDate - EndDate)
SmallImageAltText string The mouse hover text for small image
SeoURL string The redirect URL when searched on Google
BackOrder enum Can the product be ordered even when it is out of stock
NoofReview int Number of reviews available for the product
TokenPriceCheckout float Prebooking price - Minimum amount required for the customer to reserve the item during checkout and purchase later on
UOM string Unit of measurement of the product. It could be the pieces for items that are sold in numbers and the respective measure for other items such as kgs, and gms

Get Products Tags

Retrieves all the product tags associated to a product.

Sample Request

https://www.martjack.com/developerapi/Product/GetProductsTagsByProductId/20993c939a-a2e8-4934-bbf5-390f37457a55/13036942

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "ProductTags": [
    {
    "Tag": "Best-Prices",
    "TagDescription": null,
    "CreateDate": "/Date(1527842767000+0530)/"
    },
    {
    "Tag": "FE",
    "TagDescription": null,
    "CreateDate": "/Date(1527842767000+0530)/"
    },
    {
    "Tag": "New Tag 01",
    "TagDescription": null,
    "CreateDate": "/Date(1525795514000+0530)/"
    }
  ],
  "ErrorCode": 0
}


Resource Information

URI /Product/GetProductsTagsByProductId/{merchantid}/{productid}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/GetProductsTagsByProductId/{merchantid}/{productid}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
productId* int Specify the product id to fetch the product tags associated to it

Get Products by Category

Retrieves product details based on the category id passed.

Sample Request

https://www.martjack.com/developerapi/Product/Category/188a59ab-e1b0-4dae-be64-654f5c4dd531/CU00378213/ALL

Sample Response

{
   "messageCode":"1004",
   "Message":"Successful",
   "Products":[
      {
         "ProductId":14498019,
         "ProductTitle":"ALDA GRAPHITO NON STICK GRILL PAN  26 CM",
         "MRP":1490,
         "WebPrice":1341,
         "CostPrice":0,
         "Rating":0,
         "IsParentProduct":false,
         "Availability":true,
         "BrandId":"318923",
         "CatlogSequence":2,
         "CatalogCode":"",
         "SKU":"027617",
         "Taxtotal":0,
         "MarkupPrice":0,
         "MarkupType":"",
         "BulkQuantity":1,
         "ProductWeight":0,
         "ProductType":"P",
         "SmallImageAltText":"ALDA GRAPHITO NON STICK GRILL PAN  26 CM",
         "IsShippingConfigured":false,
         "IsTaxConfigured":false,
         "StartDate":"/Date(-2209008600000+0530)/",
         "EndDate":"/Date(-2209008600000+0530)/",
         "SeoURL":"https://www.onlydbest.in/alda-graphito-non-stick-grill-pan--26-cm/p/14498019",
         "DeliveryTime":"",
         "TokenPriceCheckout":false,
         "IsReferPrice":false,
         "ShortDescription":"ALDA GRAPHITO NON STICK GRILL PAN  26 CM",
         "TokenPrice":0,
         "SmallImage":"",
         "Brandname":"ALDA GRAPHITO",
         "CategoryId":"CU00378213",
         "CategoryName":"Grill Pans",
         "Fulldescription":null,
         "NoofReview":"0",
         "BarCode":"",
         "ProductSequence":2,
         "UOM":"Pieces"
      },
      {
         "ProductId":14559259,
         "ProductTitle":"Vinod Non Stick Double Griller Zpsgdw",
         "MRP":2490,
         "WebPrice":2241,
         "CostPrice":0,
         "Rating":0,
         "IsParentProduct":false,
         "Availability":true,
         "BrandId":"318939",
         "CatlogSequence":2,
         "CatalogCode":"",
         "SKU":"010788",
         "Taxtotal":0,
         "MarkupPrice":0,
         "MarkupType":"",
         "BulkQuantity":1,
         "ProductWeight":0,
         "ProductType":"P",
         "SmallImageAltText":"Vinod Non Stick Double Griller Zpsgdw",
         "IsShippingConfigured":false,
         "IsTaxConfigured":false,
         "StartDate":"/Date(-2209008600000+0530)/",
         "EndDate":"/Date(-2209008600000+0530)/",
         "SeoURL":"https://www.onlydbest.in/vinod-non-stick-double-griller-zpsgdw/p/14559259",
         "DeliveryTime":"",
         "TokenPriceCheckout":false,
         "IsReferPrice":false,
         "ShortDescription":"Vinod Non Stick Double Griller Zpsgdw",
         "TokenPrice":0,
         "SmallImage":"",
         "Brandname":"VINOD",
         "CategoryId":"CU00378213",
         "CategoryName":"Grill Pans",
         "Fulldescription":null,
         "NoofReview":"0",
         "BarCode":"",
         "ProductSequence":2,
         "UOM":"Pieces"
      }
   ],
   "ErrorCode":0
}

Resource Information

URI /Product/Category/{merchantid}/{CatagoryId}/{availibility}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/Category/{merchantid}/{CatagoryId}/{availibility}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
CatagoryId* int Unique category id by which you want to fetch products
availibility* enum Specify Active to get only active products, All to get all products

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
CatlogSequence int Sequence of the product in the respective product category to appear on the storefront
IsShippingConfigured boolean Whether the shipping is enabled for the item or not
IsTaxConfigured boolean Whether tax is enabled for the item or not
StartDate date-time The duration for which the product is shown on the storefront (StartDate - EndDate)
EndDate date-time The duration for which the product is shown on the storefront (StartDate - EndDate)
SeoURL string The SEO friendly URL of the product
TokenPriceCheckout float Minimum amount required for the customer to reserve the item during checkout and purchase later on
IsReferPrice boolean -NA-
NoofReview string Number of reviews received for the product
UOM string Unit of measurement of the product. It could be pieces for the items that are sold in numbers and the respective measure for other items such as kgs, and gms

Add Review

https://www.martjack.com/developerapi/Product/AddReview/81e77da2-723b-483d-8c0d-49f800c1exxx/0639f7a6-34cc-48b2-9fd9-a80e2ed8xxxx/PZLG-WM

Sample POST Request

{
    "title": "Title31",
    "message": "message75",
    "isGoLive": "True"
}

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "ErrorCode": 0
}

Publishes customer review for a specific product.

Resource Information

URI Product/AddReview/{MerchantId}/{UserId}/{SKU}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Product/AddReview/{MerchantId}/{UserId}/{SKU}

Request Path Parameters

Parameter Type Description
MerchantId* string Specify the merchant id for which the review has to be associated
UserId* string Specify the unique id of the customer that provided the review
SKU* string Specify the product SKU for which the review has to be associated

Request Body Parameters

Parameter Type Description
title* string Specify the title of the product review as provided by the customer
message* string Specify the entire review content as entered by the customer
isGoLive* boolean Specify true to show the review on the storefront, false to hide it

Get Product Reviews

https://www.martjack.com/developerapi/Product/GetReviews/81e77da2-723b-483d-8c0d-49f800c1exxx/PZLG-WM

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "Reviews": [{
            "UserId": "0639f7a6-34cc-48b2-9fd9-a80e2ed8xxxx",
            "UserName": "Tom",
            "ProductTitle": "Capillary Men's Slim Fit Striped Collar Shirt",
            "ReviewTitle": "Special occasion wear",
            "ReviewDescription": "Looks semi-formal as per my liking. The shirt is very comfortable and feels really nice for both as a casual wear or occasional wear.",
            "CreatedDateTime": "10/9/2018 5:46:25 AM",
            "Rating": 1,
            "IsGoLive": "True"
        },
        {
            "UserId": "0639f7a6-34cc-48b2-9fd9-a80e2ed8xxxx",
            "UserName": "James",
            "ProductTitle": "Capillary Men's Slim Fit Striped Collar Shirt",
            "ReviewTitle": "Nice material and comfortable wear",
            "ReviewDescription": "Beautiful color, and material. A very well made shirt",
            "CreatedDateTime": "10/9/2018 12:44:00 AM",
            "Rating": 1,
            "IsGoLive": "False"
        }
    ]
}

Retrieves the user reviews of a specific product.

Resource Information

URI Product/GetReviews/{MerchantId}/{Sku}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/GetReviews/{MerchantId}/{Sku}

Request Body Parameters

Parameter Type Description
MerchantId* string The unique GUID of the merchant
Sku* string SKU of the product for which you want to fetch reviews

Update Product Attribute

Lets you update an attribute of a product by SKU or product id.

Sample Request

https://www.martjack.com/developerapi/Product/UpdateProductAttribute/0639f7a6-34cc-48b2-9fd9-a80e2ed8xxxx

Sample POST Request


MerchantId=0639f7a6-34cc-48b2-9fd9-a80e2ed8xxxx&InputFormat=application/json&InputData={
  "ProductAttribute": {
    "sku": "Fruits0023",
    "variantsku": "Fruits0023-1",
    "locationrefcode": "Hyd001",
    "AttributeId": "CU00325850-001",
    "AttributeValue": "NewValue",
    "ProductId": "11631696"
  }
}

Sample Response

{
    "messageCode": "1018",
    "Message": "Data update added to task queue. You can view the status of update in control panel. Also email will be send to merchant registered email after task completion.",
    "Taskid": "2718747",
    "ErrorCode": 0
}

Resource Information

URI Product/UpdateProductAttribute/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Product/UpdateProductAttribute/{MerchantId}

Request Body Parameters

Parameter Type Description
sku string SKU of the product for which you want to update attributes
variantsku string SKU of the variant product
locationrefcode string Location reference code of the product
AttributeId string Unique id of the attribute that you want to update
AttributeValue string New value of the current attribute
ProductId int Unique id of the product (to update product by product id)

Get Bundle Items by Bundle Product ID

Retrieves the items of a specific bundle by product id. You can also fetch the details of all default items of each bundle group.

Sample Request

https://www.martjack.com/developerapi/Product/GetBundleItemsbyBundleProductId/4d00cd2b-28e8-4950-b8b9-2ecf50e88933/8284396

Sample Response


{
    "messageCode": "1004",
    "Message": "Successful",
    "BundleItems": [
        {
            "ProductId": 8284396,
            "VariantProductId": "28732",
            "ProductSku": "IN-veg-GreenCapsicum",
            "VariantSKU": "IN-veg-GreenCapsicum-Rglr-Mdm",
            "ProductTitle": "Green Capsicum",
            "ProductType": "A",
            "MRP": 70,
            "WebPrice": 70
        },
        {
            "ProductId": 8284396,
            "VariantProductId": "28734",
            "ProductSku": "IN-veg-GreenCapsicum",
            "VariantSKU": "IN-veg-GreenCapsicum-Rglr-Sml",
            "ProductTitle": "Green Capsicum",
            "ProductType": "A",
            "MRP": 50,
            "WebPrice": 50
        },
        {
            "ProductId": 8284396,
            "VariantProductId": "29028",
            "ProductSku": "IN-veg-GreenCapsicum",
            "VariantSKU": "IN-Veg-GreenCapsicum-GrDip",
            "ProductTitle": "Green Capsicum",
            "ProductType": "A",
            "MRP": 100,
            "WebPrice": 100
        },
        {
            "ProductId": 8283298,
            "VariantProductId": "27750",
            "ProductSku": "IN-Veg-Onion",
            "VariantSKU": "IN-Veg-Onion-Rglr-Mdm",
            "ProductTitle": "Onion",
            "ProductType": "A",
            "MRP": 70,
            "WebPrice": 70
        },
        {
            "ProductId": 8283298,
            "VariantProductId": "27754",
            "ProductSku": "IN-Veg-Onion",
            "VariantSKU": "IN-Veg-Onion-Rglr-Sml",
            "ProductTitle": "Onion",
            "ProductType": "A",
            "MRP": 50,
            "WebPrice": 50
        },
        {
            "ProductId": 8283298,
            "VariantProductId": "28984",
            "ProductSku": "IN-Veg-Onion",
            "VariantSKU": "IN-Veg-Onion-GrDip",
            "ProductTitle": "Onion",
            "ProductType": "A",
            "MRP": 100,
            "WebPrice": 100
        },
        {
            "ProductId": 8283296,
            "VariantProductId": "27742",
            "ProductSku": "IN-Veg-Sweet-Corn",
            "VariantSKU": "IN-Veg-Sweet-Corn-Rglr-Mdm",
            "ProductTitle": "Sweet Corn",
            "ProductType": "A",
            "MRP": 70,
            "WebPrice": 70
        },
        {
            "ProductId": 8283296,
            "VariantProductId": "27746",
            "ProductSku": "IN-Veg-Sweet-Corn",
            "VariantSKU": "IN-Veg-Sweet-Corn-Rglr-Sml",
            "ProductTitle": "Sweet Corn",
            "ProductType": "A",
            "MRP": 50,
            "WebPrice": 50
        },
        {
            "ProductId": 8283296,
            "VariantProductId": "29014",
            "ProductSku": "IN-Veg-Sweet-Corn",
            "VariantSKU": "IN-Veg-Sweet-Corn-GrDip",
            "ProductTitle": "Sweet Corn",
            "ProductType": "A",
            "MRP": 100,
            "WebPrice": 100
        }
    ],
    "ErrorCode": 0
}

Resource Information

URI /Product/GetBundleItemsbyBundleProductId/{Merchantid}/{Productid}/{isdefault}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/GetBundleItemsbyBundleProductId/{Merchantid}/{Productid}/{isdefault}

Request Path Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchant
ProductId* int Product id of the bundle product that you want fetch
isdefault boolean Specify true to get the details of only bundle default items

Response Parameters

Parameter Type Description
ProductTitle string Product title as appears on the product page of the storefront
ProductType enum Type of the product. Values: P for a normal product, A for an add-on product, and B for a bundle product, D for deal product
MRP float Retail price of the product
WebPrice float Selling price of the product

Get MSMQ Task Details

Retrieves the details of the specific bulk task. Bulk tools could be bulk product upload, bundle upload, product images upload, pricelist upload, stock-price upload and so on.

MSMQ: Microsoft Messaging Queue

Sample Request

https://www.martjack.com/developerapi/Product/MSMQTaskDetails/993c939a-a2e8-4934-bbf5-390f37457a55/7374227

Sample Response

{

    "Message": "Successful",

    "TaskMsmqDetails": {

        "StartDate": "/Date(1550819955000+0530)/",

        "Validations": null,

        "TaskID": 7374227,

        "NoOfRows": 1,

        "TaskName": "LctnWiseStocknPriceUploadTask",

        "CreatedDate": "/Date(1550819985882+0530)/",

        "ParamValue": "/mnt/bulkupload/Resources/993c939a-a2e8-4934-bbf5-390f37457a55/Upload/API_LocationWiseStock[22022019124914475].xlsx",

        "MerchantId": "993c939a-a2e8-4934-bbf5-390f37457a55",

        "LastUpdated": "/Date(1550819985882+0530)/",

        "TaskStatus": "C",

        "ParamName": " (stock-price) "

    },

    "messageCode": "1004",

    "ErrorCode": 0

}

Resource Information

URI /Product/MSMQTaskDetails/{merchantid}/{taskid}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/MSMQTaskDetails/{merchantid}/{taskid}

Request Path Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchant
taskId* int Unique id of the bulk upload task

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
taskId int Unique id generated for the task

Get MSMQ Error Details

Retrieves error details of a specific bulk upload task. Bulk tools could be bulk product upload, bundle upload, product images upload, pricelist upload, stock-price upload and so on.

Sample Request

https://www.martjack.com/developerapi/Product/MSMQErrorDetails/993c939a-a2e8-4934-bbf5-390f37457a55/7374227

Sample Response

{

    "Message": "Successful",

    "TaskMsmqDetails": {

        "StartDate": "/Date(1550819955000+0530)/",

        "Validations": null,

        "TaskID": 7374227,

        "NoOfRows": 1,

        "TaskName": "LctnWiseStocknPriceUploadTask",

        "CreatedDate": "/Date(1550819985882+0530)/",

        "ParamValue": "/mnt/bulkupload/Resources/993c939a-a2e8-4934-bbf5-390f37457a55/Upload/API_LocationWiseStock[22022019124914475].xlsx",

        "MerchantId": "993c939a-a2e8-4934-bbf5-390f37457a55",

        "LastUpdated": "/Date(1550819985882+0530)/",

        "TaskStatus": "C",

        "ParamName": " (stock-price) "

    },

    "messageCode": "1004",

    "ErrorCode": 0

}




Resource Information

URI /Product/MSMQErrorDetails/{merchantid}/{taskid}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/MSMQErrorDetails/{merchantid}/{taskid}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
taskId* int Unique id of the bulk upload task

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
TaskStatus enum Status of the task. Values C for completed, U for in progress, F for failed
ParamValue string Path of the file with file name
Task name string Name of the task based on the bulk action. Example, LctnWiseStocknPriceUploadTask, ProductPriceListUpload, and BulkProductTagsUpload

Add Product Tags

Adds tags to a specific product for a particular location. An email will be sent to the registered email id of the merchant when the task is completed.

Sample Request

https://www.martjack.com/developerapi/product/AddLocationTagtoProduct/0639f7a6-34cc-48b2-9fd9-a80e2ed8xxxx

Sample POST Request


MerchantId=0639f7a6-34cc-48b2-9fd9-a80e2ed8xxxx&InputFormat=application/json&InputData=
{
  "products": {
    "product": {
      "sku": "100040621",
      "locationrefcode": "4702",
      "tag": "Discounted"
    }
  }
}

Sample Response

{
   "messageCode":"1018",
   "Message":"Data update added to task queue. You can view the status of update in control panel. Also email will be send to merchant registered email after task completion.",
   "Taskid":"2718751",
   "ErrorCode":0
}

Resource Information

URI /product/AddLocationTagtoProduct/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/product/AddLocationTagtoProduct/{merchantId}

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
sku* string SKU of the product for which you want to update tags
locationrefcode int Unique reference code of the product location to update tags if the specific location
tag* string Tag that you want to add to the product. Tags are predefined for the merchant

Remove Product Tag

Removes a tag of a product for a specific location.

Sample Request

https://www.martjack.com/developerapi/Product/RemoveLocationTagFromProduct/f48fdd16-92db-4188-854d-1ecd9b62d066

Sample POST Request (RAW)


merchantid=f48fdd16-92db-4188-854d-1ecd9b62d066&sku=100359979&producttag=MixTag&locationid=18340

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "ErrorCode": 0
}


Resource Information

URI /Product/RemoveLocationTagFromProduct/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Product/RemoveLocationTagFromProduct/{MerchantId}

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
sku string SKU of the product for which you want to remove a product tag
producttag string Name of the product tag that you want to remove
locationid int Location id for which you want to remove the product tag

Search Products

Sample Request

https://www.martjack.com/developerapi/Product/81e77da2-723b-483d-8c0d-49f800c1exxx/Search

Sample POST Request

InputFormat=application/json&InputData={
  "merchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631"
}

Sample Response

{
  "Message": "Successful",
  "ProductIds": [
    "11360864",
    "11360866",
    "11360868",
    "11360870",
    "11360872",
    "11360896",
    "11360898",
    "11360900",
    "11360902",
    "11360904",
    "11360906",
    "11360908",
    "11148708"
  ],
  "messageCode": "1004"
}

Retrieves product ids based on the input parameters

Resource Information

URI /Product/{MerchantId}/Search
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Product/{MerchantId}/Search

Request Body Parameters

Parameter Type Description
MerchantId string Unique GUID of the merchant
keyword string Search product by meta tag keyword
SKU string Search product by SKU
catalogcode string Fetch products of a specific catalog code
category string Search by category
brand string Search product ids by brand
productTag string Search product ids by an associated product tag
pageNumber int Page number from which you want to fetch products on storefront
pageSize int Number of results to be shown per page

Get Product Tags (By ProductId)

Retrieves all the associated product tags based on the product id passed.

Sample Request

https://www.martjack.com/developerapi/Product/GetProductsTagsByProductId/f48fdd16-92db-4188-854d-1ecd9b62d066/11995006/18340

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "ProductTags": [
        {
            "Tag": "Eggtag",
            "TagDescription": null,
            "CreateDate": "/Date(1522158891000+0530)/"
        },
        {
            "Tag": "13.3HF",
            "TagDescription": null,
            "CreateDate": "/Date(1543886875000+0530)/"
        },
        {
            "Tag": "MixTag",
            "TagDescription": null,
            "CreateDate": "/Date(1544748971000+0530)/"
        }
    ],
    "ErrorCode": 0
}


Resource Information

URI /Product/GetProductsTagsByProductId/{merchantid}/{productid}/{locationid}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/GetProductsTagsByProductId/{merchantid}/{productid}/{locationid}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
productId* int Unique id of the product for which you want to fetch tags
locationId int Location id of the product

Get Product Attributes

Retrieves the details of all product attributes (custom fields) associated to the product.

Sample Request

https://www.martjack.com/developerapi/Product/Attribute/993c939a-a2e8-4934-bbf5-390f37457a55/13036942

Sample Response

{
   "messageCode":"1004",
   "Message":"Successful",
   "ProductAttributes":[
      {
         "Attributeid":"CU00366336-002",
         "Name":"ClothMaterial",
         "Unit":"1",
         "Iscompulsory":false,
         "Ispredefined":false,
         "Description":"",
         "Attributegroup":"1",
         "AttributeValue":"1",
         "ObjAttributeValueEnt":[

         ],
         "IsDisplay":false,
         "CategoryId":"CU00366336",
         "Rank":0,
         "PredefinedValueId":0,
         "IsParentCategoryAttribute":false,
         "AttributeValueId":"",
         "DataType":"String",
         "NoOfColumns":1,
         "ReferenceCode":"cmat"
      },
      {
         "Attributeid":"CU00366334-001",
         "Name":"new",
         "Unit":"1",
         "Iscompulsory":false,
         "Ispredefined":false,
         "Description":"",
         "Attributegroup":"new",
         "AttributeValue":"1",
         "ObjAttributeValueEnt":[

         ],
         "IsDisplay":false,
         "CategoryId":"CU00366334",
         "Rank":1,
         "PredefinedValueId":0,
         "IsParentCategoryAttribute":false,
         "AttributeValueId":"",
         "DataType":"String",
         "NoOfColumns":0,
         "ReferenceCode":"CU00366334_001"
      }
   ],
   "ErrorCode":0
}

Resource Information

URI /Product/Attribute/{merchantid}/{productid}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/Attribute/{merchantid}/{productid}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
productid* int Unique id of the product for which you want to fetch attributes.

Get Product Comments

Retrieves a specific comment received for a product based on the post id passed.

Sample Request

https://www.martjack.com/developerapi/Product/Comments/13038134/28958/993c939a-a2e8-4934-bbf5-390f37457a55

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "ProductComment": [
    {
    "Id": "5b09ffb12ac24337b48e3e1e",
    "ParentId": "5b09ffb12ac24337b48e3e1e",
    "RootParentId": "5b09ffb12ac24337b48e3e1e",
    "Type": "C",
    "UserName": "Capillary ",
    "TargetName": "TShirt Product 01",
    "MerchantId": "993c939a-a2e8-4934-bbf5-390f37457a55",
    "Title": "Title12",
    "Description": "message18",
    "ModuleType": "C",
    "IsGoLive": false,
    "IsAbusive": false,
    "HelpfulCount": 0,
    "NotHelpfulCount": 0,
    "TotalCount": 0,
    "HelpfulControlId": "5b09ffb12ac24337b48e3e1e_yes",
    "NotHelpfulControlId": "5b09ffb12ac24337b48e3e1e_no",
    "AbusiveControlId": "5b09ffb12ac24337b48e3e1e_abuse",
    "ReplyControlId": "5b09ffb12ac24337b48e3e1e_reply",
    "CreatedDateTime": "27-May-2018",
    "UpdatedDateTime": "27-May-2018",
    "Margin": "margin-left: 0px;",
    "Level": 0,
    "Rating": 4,
    "RatingClass": "rating_result_verygood",
    "FacebookScript": "<div class='social_twitter'><fb:like href=\"http://www.testorg2.martjack.com/products/mens-t-shirts/nike/tshirt-product-01/pid-13038134.aspx#5b09ffb12ac24337b48e3e1e\" layout=\"button_count\" show_faces=\"false\" action=\"like\" width=\"100\" font=\"verdana\"></fb:like></div><div class='clear'></div>",
    "TwitterScript": "<div class='social_twitter'><a href=\"http://twitter.com/share\" class=\"twitter-share-button\" data-url=\"http://www.testorg2.martjack.com/products/mens-t-shirts/nike/tshirt-product-01/pid-13038134.aspx#5b09ffb12ac24337b48e3e1e\" data-via=\"\" data-related=\"anywhere:The Javascript API\" data-count=\"horizontal\">Tweet</a></div><div class='clear'></div>",
    "ShareScript": "<div class=\"addthis_toolbox addthis_default_style \"><a href=\"http://www.addthis.com/bookmark.php?v=250&amp;pubid=xa-4d8997d82887abcd\" class=\"addthis_button_compact\">Share</a></div>"
    },
    {
    "Id": "5b09faaf2ac24337b48e3e1d",
    "ParentId": "5b09faaf2ac24337b48e3e1d",
    "RootParentId": "5b09faaf2ac24337b48e3e1d",
    "Type": "C",
    "UserName": "Capillary ",
    "TargetName": "TShirt Product 01",
    "MerchantId": "993c939a-a2e8-4934-bbf5-390f37457a55",
    "Title": "Title18",
    "Description": "message71",
    "ModuleType": "C",
    "IsGoLive": true,
    "IsAbusive": false,
    "HelpfulCount": 0,
    "NotHelpfulCount": 0,
    "TotalCount": 0,
    "HelpfulControlId": "5b09faaf2ac24337b48e3e1d_yes",
    "NotHelpfulControlId": "5b09faaf2ac24337b48e3e1d_no",
    "AbusiveControlId": "5b09faaf2ac24337b48e3e1d_abuse",
    "ReplyControlId": "5b09faaf2ac24337b48e3e1d_reply",
    "CreatedDateTime": "27-May-2018",
    "UpdatedDateTime": "27-May-2018",
    "Margin": "margin-left: 0px;",
    "Level": 0,
    "Rating": 2,
    "RatingClass": "rating_result_average",
    "FacebookScript": "<div class='social_twitter'><fb:like href=\"http://www.testorg2.martjack.com/products/mens-t-shirts/nike/tshirt-product-01/pid-13038134.aspx#5b09faaf2ac24337b48e3e1d\" layout=\"button_count\" show_faces=\"false\" action=\"like\" width=\"100\" font=\"verdana\"></fb:like></div><div class='clear'></div>",
    "TwitterScript": "<div class='social_twitter'><a href=\"http://twitter.com/share\" class=\"twitter-share-button\" data-url=\"http://www.testorg2.martjack.com/products/mens-t-shirts/nike/tshirt-product-01/pid-13038134.aspx#5b09faaf2ac24337b48e3e1d\" data-via=\"\" data-related=\"anywhere:The Javascript API\" data-count=\"horizontal\">Tweet</a></div><div class='clear'></div>",
    "ShareScript": "<div class=\"addthis_toolbox addthis_default_style \"><a href=\"http://www.addthis.com/bookmark.php?v=250&amp;pubid=xa-4d8997d82887abcd\" class=\"addthis_button_compact\">Share</a></div>"
    }
  ],
  "ErrorCode": 0
}

Resource Information

URI /Product/Comments/{productid}/{postid}/{merchantid}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/Comments/{productid}/{postid}/{merchantid}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
productid* int Product id for which you want to see a specific comment
postId* string Specify the unique post id generated for the actual review (root comment)

Response Parameters

Parameter Type Description
Id string Unique id of the comment
ParentId string Unique id of the comment to which the current reply is posted. This will be same as the id if no parent comment exists
RootParentId string Unique id of the root of the comment (actual review). This will be same as the id if no parent comment exists
Type enum Type will be C for comment
UserName string Username linked to the customer account who commented
TargetName string Product title to which the comment is posted
Title string Title of the root comment
Description string Actual content of the comment
ModuleType enum Module type will be C for comment
IsAbusive boolean Whether the comment is abusive or not
HelpfulCount int Number of likes (helpful) received to the comment
NotHelpfulCount int Number of dislikes received to the comment
TotalCount int Total helpful and not helpful count
HelpfulControlId string Unique id associated to the action Helpful
NotHelpfulControlId string Unique id associated to the action Not Helpful
AbusiveControlId string Unique id associated to the action Report Abusive
ReplyControlId string Unique id associated to the action Reply
CreatedDateTime date Date when the comment was added
UpdatedDateTime date Date when the comment was recently updated
Rating int Rating provided for the current review

Get Product Contents

Retrieves additional product information such as images, variant property details, product file repository & groupId.

Sample Request

https://www.martjack.com/developerapi/Product/Contents/f48fdd16-92db-4188-854d-1ecd9b62d066/14106036

Sample Response


{
    "messageCode": "1004",
    "Message": "Successful",
    "ProductContent": [
        {
            "ProductId": 14106036,
            "FileRepositoryGroupId": "51429671",
            "VariantValueId": 0,
            "VariantValueName": "",
            "VariantPropertyId": 0,
            "VariantPropertyName": "",
            "LargeImage": "//images.sg.content-cdn.io/cdn//test-resources/f48fdd16-92db-4188-854d-1ecd9b62d066/Images/ProductImages/Source/;width=500",
            "ThumbNail": "//images.sg.content-cdn.io/cdn//test-resources/f48fdd16-92db-4188-854d-1ecd9b62d066/Images/ProductImages/Source/;width=92",
            "LargeIcon": "http://storage.sg.content-cdn.io/test-resources/f48fdd16-92db-4188-854d-1ecd9b62d066/Images/ProductImages/Swatch/Large_Icon/",
            "ZoomType": "Zoom",
            "ZoomPath": "//images.sg.content-cdn.io/cdn//test-resources/f48fdd16-92db-4188-854d-1ecd9b62d066/Images/ProductImages/Source/;width=100",
            "ZoomContent": null,
            "LargeImageSequence": 1,
            "FileName": "",
            "ProductFileRepositoryId": 0,
            "FileType": "AdditionalImage",
            "ContentType": "LargeImage",
            "Sequence": 0,
            "DeepZoomPath": ""
        }
    ],
    "ErrorCode": 0
}


Resource Information

URI /Product/Contents/{merchantId}/{productId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/Contents/{merchantId}/{productId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
productId* int Unique id of the product for which you want to see additional content details

Retrieves featured products of the merchant. Featured products are a great way to promote intended products or brands on the ecommerce platform.

Sample Request

https://www.martjack.com/developerapi/Product/Featured/f48fdd16-92db-4188-854d-1ecd9b62d066

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "Products": [
        {
            "ProductId": 11982546,
            "ProductTitle": "Amul Kool Milkshake - Badam, 200ml Pack bottle",
            "MRP": 15,
            "WebPrice": 15,
            "CostPrice": 0,
            "Rating": 0,
            "IsParentProduct": false,
            "Availability": true,
            "BrandId": "0",
            "CatlogSequence": 0,
            "CatalogCode": "",
            "SKU": "100703792",
            "Taxtotal": 0,
            "MarkupPrice": 0,
            "MarkupType": "",
            "BulkQuantity": 1,
            "ProductWeight": 0,
            "ProductType": "P",
            "SmallImageAltText": "Amul Kool Milkshake - Badam, 200ml Pack bottle",
            "IsShippingConfigured": false,
            "IsTaxConfigured": false,
            "StartDate": "/Date(-2209008600000+0530)/",
            "EndDate": "/Date(-2209008600000+0530)/",
            "SeoURL": "http://www.hyctest.nightlysites.capillary.in/amul-kool-milkshake---badam-200ml-pack-bottle/p/11982546",
            "DeliveryTime": "Delivered in 5 Working days",
            "TokenPriceCheckout": false,
            "IsReferPrice": false,
            "ShortDescription": "",
            "TokenPrice": 0,
            "SmallImage": "",
            "Brandname": "Amul",
            "CategoryId": "CU00333530",
            "CategoryName": "Flavoured Milk",
            "Fulldescription": null,
            "NoofReview": "0",
            "BarCode": "",
            "ProductSequence": 0,
            "UOM": "Pieces"
        }
    ],
    "ErrorCode": 0
}


Resource Information

URI Product/Featured/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/Featured/{merchantId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant

Update Product Stock (of Default Location)

Updates inventory or stock of a product for the default location.

Sample Request

https://www.martjack.com/developerapi/product/updatestock

Sample POST Request (RAW)

merchantid=f48fdd16-92db-4188-854d-1ecd9b62d066&sku=100556&Inventory=100


Sample Response


{
    "messageCode": "1004",
    "Message": "Successful",
    "ErrorCode": 0
}

Resource Information

URI /product/updatestock
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/product/updatestock

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
sku* string SKU of the product for which you want to update inventory
Inventory* int New stock count that you want to update with

Update Product Stock (by Location)

Updates inventory of a product for a specific location.

Sample Request

https://www.martjack.com/developerapi/Product/UpdateLocationProductStock

Sample POST Request

merchantid=f48fdd16-92db-4188-854d-1ecd9b62d066&sku=100359979&locationReferenceCode=Hyd001&Inventory=100

Sample Response


{
    "messageCode": "1004",
    "Message": "Successful",
    "ErrorCode": 0
}

Resource Information

URI /Product/UpdateLocationProductStock
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Product/UpdateLocationProductStock

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
sku* string Unique SKU of the product that you want to update
locationReferenceCode* string Unique location reference code for which you want to update the product inventory
Inventory* int New stock count available for sale or distribution

Get Similar Products

Retrieves similar products based on the product id passed. Similar products are either mapped manually or automatically in the CP based on the criteria set. These are used for cross selling.

Sample Request

https://www.martjack.com/developerapi/Product/Similar/f48fdd16-92db-4188-854d-1ecd9b62d066/11997154/0

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "Products": [
        {
            "ProductId": 11991732,
            "ProductTitle": "Sangam Eggs - Nutri, 6 Pieces Pack",
            "MRP": 26,
            "WebPrice": 26,
            "CostPrice": 0,
            "Rating": 0,
            "IsParentProduct": false,
            "Availability": true,
            "BrandId": "284010",
            "CatlogSequence": 0,
            "CatalogCode": "",
            "SKU": "100492832",
            "Taxtotal": 0,
            "MarkupPrice": 0,
            "MarkupType": "",
            "BulkQuantity": 1,
            "ProductWeight": 0,
            "ProductType": "P",
            "SmallImageAltText": "Sangam Eggs - Nutri, 6 Pieces Pack",
            "IsShippingConfigured": false,
            "IsTaxConfigured": false,
            "StartDate": "/Date(-2209008600000+0530)/",
            "EndDate": "/Date(-2209008600000+0530)/",
            "SeoURL": "http://www.example.nightlysites.capillary.in/sangam-eggs---nutri-6-pieces-pack/p/11991732",
            "DeliveryTime": "Delivered in 5 Working days",
            "TokenPriceCheckout": false,
            "IsReferPrice": false,
            "ShortDescription": "",
            "TokenPrice": 0,
            "SmallImage": "",
            "Brandname": "Sangam",
            "CategoryId": "CU00333436",
            "CategoryName": "Regular Eggs",
            "Fulldescription": null,
            "NoofReview": "0",
            "BarCode": "",
            "ProductSequence": 0,
            "UOM": "Pieces"
        }
    ],
    "ErrorCode": 0
}


Resource Information

URI /Product/Similar/{merchantId}/{productId}/{LocationId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/Similar/{merchantId}/{productId}/{LocationId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
productId* int Unique id of the product for which you want to fetch similar products
LocationId* int Fetch similar products by location id of the product

Get Tier Price Details

Retrieves tier pricing of a product associated to a user group for a specific location. Tier pricing refers to the variation of the product price based on the purchase quantity and user group.

Sample Request

https://www.martjack.com/developerapi/Product/GetTierPriceDetailsbyproductId/993c939a-a2e8-4934-bbf5-390f37457a55/0639f7a6-34cc-48b2-9fd9-a80e2ed87458/13037156/24342

Sample Response


{
    "messageCode": "1004",
    "Message": "Successful",
    "TierPrice": [
        {
            "MRP": 1500,
            "Qty": 1,
            "Webprice": 1100
        },
        {
            "MRP": 1400,
            "Qty": 3,
            "Webprice": 1000
        }
    ],
    "ErrorCode": 0
}

Resource Information

URI /Product/GetTierPriceDetailsbyproductId/{merchantId}/{userId}/{productId}/{locationId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/GetTierPriceDetailsbyproductId/{merchantId}/{userId}/{productId}/{locationId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
userId* string Unique GUID of the user to get tier price associated to the user group
productId* int Unique id of the product for which you want to see tier pricing details
locationId* int Location id for which you want to see tier pricing

Check PIN Code Serviceability of a Product

Checks whether a product can be shipped to a specific PIN code.

Sample Request

https://www.martjack.com/developerapi/Product/PincodeServiceability/f48fdd16-92db-4188-854d-1ecd9b62d066/11997156

Sample POST Request (RAW)


MerchantId=f48fdd16-92db-4188-854d-1ecd9b62d066&productid=11997156&pincode=500090&locationid=18340

Sample Response

{
    "messageCode": "1027",
    "Message": "Service is not available.",
    "IsServiceable": "False",
    "ServiceableForPostpaid": "False",
    "ServiceableForPrepaid": "False",
    "ErrorCode": 0
}


Resource Information

URI /Product/PincodeServiceability/{merchantId}/{productId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Product/PincodeServiceability/{merchantId}/{productId}

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
productId* int Product id to check the serviceability
pincode* int Checks the serviceability for the PIN code specified here
locationid* int Specify the location id of the specified PIN code. A location will have multiple PIN codes

Get Product IDs (Auto Complete)

Retrieves product ids of a specific location matching the search keyword. You can limit the number of results to display.

Sample Request

http://www.martjack.com/developerapi/Product/ProductAutoComplete/993c939a-a2e8-4934-bbf5-390f37457a55/t-shirt/5/24342

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "Suggestions": [
        "13036942"
    ],
    "ErrorCode": 0
}

Resource Information

URI /ProductAutoComplete/{merchantId}/{keyword}/{limit}/{locationId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/ProductAutoComplete/{merchantId}/{keyword}/{limit}/{locationId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
keyword* string Search meta tag keyword by which you want to get product ids
limit* int Limit number of results to be displayed
locationId* int Location id from which you want to fetch product ids

Get Upscale Products

Retrieves all up sale products of a specific location along with the respective product details.

Sample Request

http://www.martjack.com/developerapi/Product/UpSale/f48fdd16-92db-4188-854d-1ecd9b62d066/11996474/0

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "Products": [
        {
            "ProductId": 11997154,
            "ProductTitle": "Y Cook Sweet Corn Boiled - Double, 2 Pieces Pouch",
            "MRP": 68,
            "WebPrice": 68,
            "CostPrice": 0,
            "Rating": 0,
            "IsParentProduct": false,
            "Availability": true,
            "BrandId": "298460",
            "CatlogSequence": 0,
            "CatalogCode": "",
            "SKU": "100646951",
            "Taxtotal": 0,
            "MarkupPrice": 0,
            "MarkupType": "",
            "BulkQuantity": 1,
            "ProductWeight": 0,
            "ProductType": "P",
            "SmallImageAltText": "Y Cook Sweet Corn Boiled - Double, 2 Pieces Pouch",
            "IsShippingConfigured": false,
            "IsTaxConfigured": false,
            "StartDate": "/Date(-2209008600000+0530)/",
            "EndDate": "/Date(-2209008600000+0530)/",
            "SeoURL": "http://www.hyctest.nightlysites.capillary.in/y-cook-sweet-corn-boiled---double-2-pieces-pouch/p/11997154",
            "DeliveryTime": "Delivered in 5 Working days",
            "TokenPriceCheckout": false,
            "IsReferPrice": false,
            "ShortDescription": "",
            "TokenPrice": 0,
            "SmallImage": "",
            "Brandname": "Healthy No 1",
            "CategoryId": "CU00333414",
            "CategoryName": "Fresh Vegetables",
            "Fulldescription": null,
            "NoofReview": "0",
            "BarCode": "",
            "ProductSequence": 0,
            "UOM": "Pieces"
        },
        {
            "ProductId": 11997156,
            "ProductTitle": "Y Cook Sweet Corn Boiled - Single, 1 Piece Pouch",
            "MRP": 35,
            "WebPrice": 35,
            "CostPrice": 0,
            "Rating": 0,
            "IsParentProduct": false,
            "Availability": true,
            "BrandId": "298460",
            "CatlogSequence": 0,
            "CatalogCode": "",
            "SKU": "100646950",
            "Taxtotal": 0,
            "MarkupPrice": 0,
            "MarkupType": "",
            "BulkQuantity": 1,
            "ProductWeight": 0,
            "ProductType": "P",
            "SmallImageAltText": "Y Cook Sweet Corn Boiled - Single, 1 Piece Pouch",
            "IsShippingConfigured": false,
            "IsTaxConfigured": false,
            "StartDate": "/Date(-2209008600000+0530)/",
            "EndDate": "/Date(-2209008600000+0530)/",
            "SeoURL": "http://www.hyctest.nightlysites.capillary.in/y-cook-sweet-corn-boiled---single-1-piece-pouch/p/11997156",
            "DeliveryTime": "Delivered in 5 Working days",
            "TokenPriceCheckout": false,
            "IsReferPrice": false,
            "ShortDescription": "",
            "TokenPrice": 0,
            "SmallImage": "",
            "Brandname": "Healthy No 1",
            "CategoryId": "CU00333414",
            "CategoryName": "Fresh Vegetables",
            "Fulldescription": null,
            "NoofReview": "0",
            "BarCode": "",
            "ProductSequence": 0,
            "UOM": "Pieces"
        }
    ],
    "ErrorCode": 0
}

Resource Information

URI /Product/UpSale/{merchantId}/{productId}/{locationId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GEY
Batch Support No

Request URL

{host}/developerapi/Product/UpSale/{merchantId}/{productId}/{locationId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
productId* int Product id for which you want to fetch upscale products
locationId* int Provide the specific location id

Validate Location

Validates whether a specific inventory of a variant product is available in a specific location.

Sample Request

http://www.martjack.com/developerapi/Product/ValidateLocation/f48fdd16-92db-4188-854d-1ecd9b62d066/14106036/10178766/500090/18340/1

Sample Response:

{
    "messageCode": "1004",
    "Message": "Successful",
    "ErrorCode": 0
}

Resource Information

URI /Product/ValidateLocation/{merchantId}/{productId}/{variantProductId}/{pinCode}/{locationId}/{quantity}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/ValidateLocation/{merchantId}/{productId}/{variantProductId}/{pinCode}/{locationId}/{quantity}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
productId* int Unique id of the parent product
variantProductId* int Unique id of the variant product that you want to validate the stock available
pinCode* int PIN code for which you want to validate the stock availability
locationId* int Specify the location id associated to the specified PIN code
quantity* int Quantity of items that you want to check the availability

Remove Offer Text

Removes all offer descriptions of the merchant.

Sample Request

https://www.martjack.com/developerapi/Product/RemoveOfferText/f48fdd16-92db-4188-854d-1ecd9b62d066

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "ErrorCode": 0
}

Resource Information

URI Product/RemoveOfferText/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Product/RemoveOfferText/{merchantId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant

Product Tags

Product tags are a way of organizing or relating products on the Capillary Anywhere Commerce platform. ProductTags provide APIs to access and manage product tags of a merchant.

Get Product Tags

Retrieves all the product tags of the merchant.

Sample Request

https://www.martjack.com/developerapi/ProductTags/f48fdd16-92db-4188-854d-1ecd9b62d066

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "ProductTags": [
        {
            "Tag": "Best-deals",
            "TagDescription": "Best deals",
            "CreateDate": "/Date(1482299299000+0530)/"
        },
        {
            "Tag": "Best-Offers",
            "TagDescription": "Best Offers",
            "CreateDate": "/Date(1482299299000+0530)/"
        }
]
}

Resource Information

URI /ProductTags/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/ProductTags/{MerchantId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant

Get Tag Details

Retrieves the details of a specific product tag.

Sample Request

https://www.martjack.com/developerapi/ProductTags/f48fdd16-92db-4188-854d-1ecd9b62d066/Featured

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "ProductTags": [
        {
            "Tag": "Featured",
            "TagDescription": "Featured",
            "CreateDate": "/Date(-2208988800000)/"
        }
    ],
    "ErrorCode": 0
}

Resource Information

URI /ProductTags/{MerchantId}/{ProductTag}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/ProductTags/{MerchantId}/{ProductTag}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
ProductTag* string Specify the product tag that you want to fetch

Get Tag Count

Retrieves the count of product tags configured for the merchant.

Sample Request

https://www.martjack.com/developerapi/ProductTags/f48fdd16-92db-4188-854d-1ecd9b62d066/count

Sample Response


{
    "Count": 50,
    "Message": "Successful",
    "messageCode": "1004"
}

Resource Information

URI ProductTags/{MerchantId}/count
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/ProductTags/{MerchantId}/count

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant

Carts

Cart keeps the record of the items that a customer selects from the merchant store to buy. The carts resource provides APIs to make modifications to the cart items, shipping modes, coupons; and retrieve cart items, shipping modes, payment options, and online payment types.

Send OTP

Sample Request

https://www.martjack.com/developerapi/carts/V2/SendOTP/81e77da2-723b-483d-8c0d-49f800c1exxx

Sample POST Request

InputFormat=application/json&InputData={
  "customer": {
    "UserName": "tom.sawyer@example.com",
    "merchantId": "81e77da2-723b-483d-8c0d-49f800c1exxx",
    "MobileNo": "917000000000"
  }
}

Sample Response

{
   "messageCode":"1004",
   "Message":"Successful",
   "OTPToken":"x2yiqjhjhoqulghae2wtp4u2",
   "ErrorCode":0,
   "IsEmailSentToAlternateEmail":"True"
}

Sends OTP to the specified mobile number or email id.

Resource Information

Parameter Description
URI carts/V2/SendOTP/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/carts/V2/SendOTP/{MerchantId}

Additional Header

Header Description
APISessionRequired* Pass true to not see OTP in the response. If not passed, you will see OTP sent to the customer in the response

Request Parameters

Parameter Description
UserName* Username of the customer’s account (mobile number or email id)
merchantId* The unique id (GUID) of the merchant associated to the customer account
MobileNo* The registered mobile number to which the OTP has to be sent

Validate OTP

Sample Request

https://www.martjack.com/developerapi/carts/V2/ValidateOTP/81e77da2-723b-483d-8c0d-49f800c1exxx

Sample POST Request (RAW)


OTP=345432&mobile=7411000000

Sample Response

{
"messageCode":"1004",
"Message":"Successful",
"ErrorCode":0
}

Validates OTP sent to a customer’s registered mobile number.

Resource Information

Parameter Description
URI carts/V2/ValidateOTP/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/carts/V2/ValidateOTP/{merchantId}

Additional Header

Header Description
APISessionRequired* Pass true to not see OTP in the response. If not passed, you will see OTP sent to the customer in the response

Request Parameters

Parameter Description
mobile* The registered mobile number of the customer to which the OTP has sent
OTP* The verification code or OTP received to the mobile number

Add Items to Cart (Normal/Variant)

Sample Request

https://www.martjack.com/developerapi/carts/AddCartItems/81e77da2-723b-483d-8c0d-49f800c1exxx

Sample POST Request

InputFormat=application/json&InputData={  
   "cart":{  
      "DelveryMode":"H",
      "Item":[  
         {  
            "Status":"A",
            "VariantProductID":"9727627",
            "LocationId":"22612",
            "CartReferenceKey":"00000000-0000-0000-0000-000000000000",
            "ProductID":"12688220",
            "Quantity":"1"
         },
         {  
            "Status":"A",
            "VariantProductID":"9727682",
            "LocationId":"22612",
            "CartReferenceKey":"00000000-0000-0000-0000-000000000000",
            "ProductID":"12688543",
            "Quantity":"2"
         }
      ]
   }
}

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "Carts":{  
      "MerchantId":"81e77da2-723b-483d-8c0d-49f800c1xxxx",
      "ProductCost":60.528000000000006,
      "ShippingCost":12.9,
      "VoucherDiscount":0,
      "PromotionDiscount":0,
      "TaxAmount":0,
      "OrderTotal":73.428,
      "VoucherCode":"",
      "UserSelectedCurrency":"INR",
      "Bill_FirstName":"Tom",
      "Bill_LastName":"Sawyer",
      "Bill_Address1":"#103, MG Road",
      "Bill_Address2":"",
      "Bill_CountryCode":"IN",
      "_Bill_StateCode":"KA",
      "Bill_City":"Bangalore",
      "Bill_CityCode":"2148",
      "Bill_OtherCityName":"",
      "Bill_Telephone":"9967000000",
      "Bill_Mobile":"9967000000",
      "Bill_PostCode":"",
      "Bill_Email":"",
      "Ship_FirstName":"Tom",
      "Ship_LastName":"Sawyer",
      "Ship_Address1":"AutoTestAddres1Bill",
      "Ship_Address2":"",
      "Ship_CountryCode":"IN",
      "Ship_StateCode":"KA",
      "Ship_City":"2148",
      "Ship_CityCode":"2148",
      "Ship_OtherCityName":"",
      "Ship_Telephone":"9967000000",
      "Ship_Mobile":"9967000000",
      "Ship_PostCode":"",
      "Ship_Email":"",
      "CartItems":[  
         {  
            "ProductId":12688208,
            "VariantProductId":0,
            "MRP":4.5,
            "WebPrice":0,
            "Quantity":1,
            "description":"Seafood Supreme",
            "SupplierId":"81e77da2-723b-483d-8c0d-49f800c1e288",
            "CartReferenceKey":"18e18f60-a1a9-44f0-b256-536e2fe0a3a7",
            "IsFreeProduct":false,
            "PriceCapped":false,
            "TotalCap":0,
            "CappedRefKey":"00000000-0000-0000-0000-000000000000",
            "CatalogpromotionDiscount":0,
            "BundleCartReferenceKey":"00000000-0000-0000-0000-000000000000",
            "BundleCartItems":[  
               {  
                  "ProductId":12688172,
                  "VariantProductId":9727843,
                  "MRP":5.9,
                  "WebPrice":4.5,
                  "Quantity":1,
                  "description":"Seafood Supreme Crust",
                  "SupplierId":"81e77da2-723b-483d-8c0d-49f800c1e288",
                  "CartReferenceKey":"752b5193-af86-43ea-86e4-b9e5ccb8a941",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"18e18f60-a1a9-44f0-b256-536e2fe0a3a7",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":true,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Crust",
                        "Value":"Pan"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CN00215782",
                  "CategoryName":null,
                  "BrandId":"311548",
                  "BrandName":"PizzaHut",
                  "GroupId":0
               }
            ],
            "IsPrimaryProduct":false,
            "ItemPromotionDiscountAmount":0,
            "IsPromotionProduct":false,
            "Por":"",
            "IsDefaultBundleItem":false,
            "ProductImage":"//images-cdn-test.azureedge.net/azure/test-resources/81e77da2-723b-483d-8c0d-49f800c1e288/Images/ProductImages/Source/Opt-SEAFOOD_ISLAND_showcase.png;width=100;height=100;scale=canvas;anchor=bottomcenter",
            "CartPromotionRules":[  

            ],
            "CategoryId":"CN00215794",
            "CategoryName":null,
            "BrandId":"311548",
            "BrandName":"PizzaHut",
            "ParentCartItems":null
         },
         {  
            "ProductId":12688220,
            "VariantProductId":0,
            "MRP":90.567,
            "WebPrice":50.328,
            "Quantity":1,
            "description":"Classic Pepperoni",
            "SupplierId":"81e77da2-723b-483d-8c0d-49f800c1e288",
            "CartReferenceKey":"ff462a81-699f-4798-9b73-4f9d9753xxxx",
            "IsFreeProduct":false,
            "PriceCapped":false,
            "TotalCap":0,
            "CappedRefKey":"00000000-0000-0000-0000-000000000000",
            "CatalogpromotionDiscount":0,
            "BundleCartReferenceKey":"00000000-0000-0000-0000-000000000000",
            "BundleCartItems":[  
               {  
                  "ProductId":12688160,
                  "VariantProductId":0,
                  "MRP":5.7,
                  "WebPrice":5.7,
                  "Quantity":1,
                  "description":"Classic Pepperoni Crust",
                  "SupplierId":"81e77da2-723b-483d-8c0d-49f800c1xxxx",
                  "CartReferenceKey":"ab59003f-81b5-45ea-8de8-4cd76f9bxxxx",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"ff462a81-699f-4798-9b73-4f9d97536xxx",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  

                  ],
                  "Por":"",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CN0021xxxx",
                  "CategoryName":null,
                  "BrandId":"311548",
                  "BrandName":"Capillary",
                  "GroupId":0
               }
            ],
            "IsPrimaryProduct":false,
            "ItemPromotionDiscountAmount":0,
            "IsPromotionProduct":false,
            "Por":"",
            "IsDefaultBundleItem":false,
            "ProductImage":"//images-cdn-test.azureedge.net/azure/test-resources/81e77da2-723b-483d-8c0d-49f800c1e288/Images/ProductImages/Source/Opt-Classic_Pepperoni_showcase.png;width=100;height=100;scale=canvas;anchor=bottomcenter",
            "CartPromotionRules":[  

            ],
            "CategoryId":"CN00215792",
            "CategoryName":null,
            "BrandId":"311548",
            "BrandName":"PizzaHut",
            "ParentCartItems":null
         }
      ],
      "Suppliers":[  
         {  
            "SupplierId":"81e77da2-723b-483d-8c0d-49f800c1xxxx",
            "SupplierName":"Capillary Pizza",
            "IsSelected":false,
            "OrderStatus":null
         }
      ],
      "ShippingOptions":[  
         {  
            "SupplierId":"81e77da2-723b-483d-8c0d-49f800c1xxxx",
            "ShippingMode":"12174",
            "ShippingModeId":12174,
            "isselected":true
         }
      ],
      "PaymentOptionsChannel":[  
         {  
            "MerchantId":"81e77da2-723b-483d-8c0d-49f800c1xxxx",
            "PaymentType":"COD",
            "Paymentoption":"COD",
            "GatewayId":"0",
            "GatewayTitle":"COD",
            "PaidAmount":0,
            "EnalbeOTP":false
         }
      ],
      "ErrorCollection":null,
      "GiftMsg":"",
      "DemandedDeliveryDate":"/Date(1536228000000+0530)/",
      "RemainTotal":0,
      "ShippingZoneType":null,
      "DeliverySlotID":0,
      "FailedProducts":null,
      "PickupFirstName":"AutoTestNameBillg23fff",
      "PickupLastName":"AutoTestLastNameBill",
      "PickupEmail":"",
      "PickupMobile":"9967819918",
      "LocationId":"22612",
      "TaxDetail":[  

      ],
      "ComboSuggestion":[  

      ],
      "BusinessRuleDescriptionView":[  
         {  
            "RuleId":41689,
            "RuleDescription":"Product Price",
            "IsShowCaseCrietriaSet":"true",
            "RuleProductShowCase":{  
               "Attributes":[  

               ],
               "Brands":[  

               ],
               "Categories":[  
                  "CU00215758"
               ],
               "Groups":[  

               ],
               "Products":[  

               ],
               "Suppliers":[  

               ],
               "Tags":[  

               ],
               "Variants":[  

               ]
            },
            "IsAutoAdd":false,
            "IsFreeActionInstructionType":true
         }
      ],
      "AppliedPromotionDetailsList":null,
      "ConvertedDeals":[  
      ]
   },
   "ErrorCode":0
}

Lets you add items of normal and variant products to cart.

Resource Information

URI carts/AddCartItems/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/carts/AddCartItems/{merchantId}

Request Body Parameters

Parameter Type Description
DelveryMode* enum Preferred delivery mode. Values: H for home delivery and S for store pickup
Status* enum Status of the cart item. Specify A to add an item to the cart, D to delete an item from cart
VariantProductID int Unique id of the variant product to add
LocationId int Unique id of the current store location
CartReferenceKey string Unique reference code of a line item added to the cart. It is used in updating item quantity in cart
ProductID* int Unique id of the product generated by the system
Quantity* string Quantity of the items that you want to add the cart

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
CartReferenceKey string Unique GUID of the item in the cart
IsFreeProduct boolean Whether the item is a free or gift product
Por enum The portion of the product for which the topping is applied. Value: W for whole, R for right, L for left (left, right usually applies for toppings)
CartPromotionRules array The rules that are applied to the cart items
DemandedDeliveryDate date Date and time of delivery as requested by the customer
RemainTotal float -Deprecated-
ShippingZoneType string Dictionary containing merchant id mapping to the payment type. It is used in validations
ComboSuggestion array Suggestions related to deal products based on the cart items
ConvertedDeals array The cart items that are converted to deal items
PriceCapped float Deprecated
TotalCap float Deprecated
CappedRefKey string Deprecated

Success/Error Codes

Code Description
5001 No Bundle items present for the specified product id
5002 Invalid Delivery Mode: {DeliveryMode} for Product as IsShip/IsOnline/Instore Pickup is not set
5003 Invalid Delivery Mode: {DeliveryMode} for Location Id: {LocationId}
5004 ProductId is not available at the specified locationId
5005 Product with the specified ProductId is not available
5006 Product with the specified ProductId has type ‘A’ which is not allowed. You cannot add an add-on product directly
5007 Invalid variant ProductId

Add Items to Cart (Default Deal)

Sample Request

https://www.martjack.com/developerapi/carts/AddCartItems/81e77da2-723b-483d-8c0d-49f800c1exxx

Sample POST Request

InputFormat=application/json&InputData={
   "cart":{
      "ShipCity":"10773",
      "ShipCountry":"IN",
      "ShipState":"KA",
      "DelveryMode":"H",
      "Item":[
         {
            "ProductID":8293532,
            "VariantProductID":0,
            "Quantity":2,
            "Status":"A",
            "LocationId":15254,
            "Portion":"W",
            "CartReferenceKey":"00000000-0000-0000-0000-000000000000",
            "Price":204,
            "ChildItem":[
               {
                  "ProductID":8293826,
                  "VariantProductID":0,
                  "Quantity":8,
                  "Status":"A",
                  "Portion":"W",
                  "GroupID":21104
               },
               {
                  "ProductID":8286856,
                  "VariantProductID":0,
                  "Quantity":4,
                  "Status":"A",
                  "Portion":"W",
                  "GroupID":20608
               },
               {
                  "ProductID":8286858,
                  "VariantProductID":0,
                  "Quantity":4,
                  "Status":"A",
                  "Portion":"W",
                  "GroupID":20608
               },
               {
                  "ProductID":8293052,
                  "VariantProductID":0,
                  "Quantity":2,
                  "Status":"A",
                  "Portion":"W",
                  "GroupID":20606
               },
               {
                  "ProductID":8286910,
                  "VariantProductID":0,
                  "Quantity":2,
                  "Status":"A",
                  "Portion":"W",
                  "GroupID":20604
               }
            ]
         }
      ]
   }
}

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "Carts":{  
      "MerchantId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
      "ProductCost":5.650000000000001,
      "ShippingCost":0.5,
      "VoucherDiscount":0,
      "PromotionDiscount":0,
      "TaxAmount":0,
      "OrderTotal":6.15,
      "VoucherCode":"",
      "UserSelectedCurrency":"INR",
      "Bill_FirstName":"Pallav",
      "Bill_LastName":"Kumar",
      "Bill_Address1":"",
      "Bill_Address2":"",
      "Bill_CountryCode":"",
      "_Bill_StateCode":"",
      "Bill_City":"Other",
      "Bill_CityCode":"554",
      "Bill_OtherCityName":"",
      "Bill_Telephone":"",
      "Bill_Mobile":"55555555",
      "Bill_PostCode":"",
      "Bill_Email":"tom.sawyer@example.com",
      "Ship_FirstName":"Pallav",
      "Ship_LastName":"Kumar",
      "Ship_Address1":"",
      "Ship_Address2":"",
      "Ship_CountryCode":"KW",
      "Ship_StateCode":"KW2",
      "Ship_City":"846",
      "Ship_CityCode":"846",
      "Ship_OtherCityName":"",
      "Ship_Telephone":"",
      "Ship_Mobile":"55555555",
      "Ship_PostCode":"",
      "Ship_Email":"tom.sawyer@example.com",
      "CartItems":[  
         {  
            "ProductId":13047461,
            "VariantProductId":0,
            "MRP":0,
            "WebPrice":0,
            "Quantity":1,
            "description":"BUY ONE GET ONE FREE- Medium",
            "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
            "CartReferenceKey":"97fe77f4-412e-4aea-8d3c-e95dd0423861",
            "IsFreeProduct":false,
            "PriceCapped":false,
            "TotalCap":0,
            "CappedRefKey":"00000000-0000-0000-0000-000000000000",
            "CatalogpromotionDiscount":0,
            "BundleCartReferenceKey":"00000000-0000-0000-0000-000000000000",
            "BundleCartItems":[  
               {  
                  "ProductId":13047273,
                  "VariantProductId":0,
                  "MRP":0,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Chicken Supreme",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"97fe77f4-412e-4aea-8d3c-e95dd0423861",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  

                  ],
                  "Por":"W",
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357451",
                  "CategoryName":"Chicken",
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13317
               },
               {  
                  "ProductId":13047215,
                  "VariantProductId":9757487,
                  "MRP":4.25,
                  "WebPrice":3.25,
                  "Quantity":1,
                  "description":"Chicken Supreme",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"0ab3f8ab-7840-4d40-bad5-950e64da288a",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":true,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Crust",
                        "Value":"Classic"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357457",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13317
               },
               {  
                  "ProductId":13047255,
                  "VariantProductId":9757701,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Mozarella",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"d2b252a0-58ff-4a56-8a2f-a4b828bc15a6",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13129
               },
               {  
                  "ProductId":13047267,
                  "VariantProductId":9757725,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Sliced Black Olives",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"c946dfbb-c7d4-4482-be3a-0f55ea0ff701",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13129
               },
               {  
                  "ProductId":13047231,
                  "VariantProductId":9757689,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Chargrilled Chicken",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"a944f99d-5729-41f1-a51a-a6ca7b7d8637",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13131
               },
               {  
                  "ProductId":13047233,
                  "VariantProductId":9757695,
                  "MRP":0.5,
                  "WebPrice":0.4,
                  "Quantity":1,
                  "description":"Beef Pepperoni",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"a6d6f5ee-0b60-49b1-a504-9a63b42a4789",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13131
               },
               {  
                  "ProductId":13047235,
                  "VariantProductId":9757693,
                  "MRP":0.5,
                  "WebPrice":0.4,
                  "Quantity":1,
                  "description":"Calamari Catch",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"5caec831-1597-45ca-af9d-11beafc35b91",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13131
               },
               {  
                  "ProductId":13047237,
                  "VariantProductId":9757691,
                  "MRP":0.5,
                  "WebPrice":0.4,
                  "Quantity":1,
                  "description":"Beef",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"ca206f95-ec4b-4a07-8651-652b61838960",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13131
               },
               {  
                  "ProductId":13047241,
                  "VariantProductId":9757697,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Chicken Pepperoni",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"10ec62e0-0938-4b4e-a066-254d9aa65818",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13131
               },
               {  
                  "ProductId":13047257,
                  "VariantProductId":9757699,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Pizza Sauce",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"b3aa047a-091d-488f-b8a8-abde211ad008",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13133
               },
               {  
                  "ProductId":13047319,
                  "VariantProductId":0,
                  "MRP":0,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Classic Pepperoni",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"e4d5eecd-62a1-40a6-bd00-7607f3d1107d",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"97fe77f4-412e-4aea-8d3c-e95dd0423861",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  

                  ],
                  "Por":"W",
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357450",
                  "CategoryName":"Beef",
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13319
               },
               {  
                  "ProductId":13047219,
                  "VariantProductId":9757497,
                  "MRP":4.25,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Classic Pepperoni",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"0255ff10-0bc2-4518-aef5-9af37668750d",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"e4d5eecd-62a1-40a6-bd00-7607f3d1107d",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":true,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Crust",
                        "Value":"Pan"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357457",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13319
               },
               {  
                  "ProductId":13047247,
                  "VariantProductId":9757709,
                  "MRP":0.5,
                  "WebPrice":0.4,
                  "Quantity":1,
                  "description":"Green Chillies",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"368a2174-938e-47f2-94e9-aafed11206f8",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"e4d5eecd-62a1-40a6-bd00-7607f3d1107d",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13219
               },
               {  
                  "ProductId":13047249,
                  "VariantProductId":9757711,
                  "MRP":0.5,
                  "WebPrice":0.4,
                  "Quantity":1,
                  "description":"Green Pepper Strips",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"cff5fc90-375e-4914-b09b-1a3a97b64c1e",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"e4d5eecd-62a1-40a6-bd00-7607f3d1107d",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13219
               },
               {  
                  "ProductId":13047251,
                  "VariantProductId":9757713,
                  "MRP":0.5,
                  "WebPrice":0.4,
                  "Quantity":1,
                  "description":"Jalapeno",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"9b9e43cd-a4e2-4ad2-aa5a-eb165c371ecf",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"e4d5eecd-62a1-40a6-bd00-7607f3d1107d",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13219
               },
               {  
                  "ProductId":13047255,
                  "VariantProductId":9757701,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Mozarella",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"8a61d1b4-c496-4b41-8a3a-c70a0fa510ef",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"e4d5eecd-62a1-40a6-bd00-7607f3d1107d",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13219
               },
               {  
                  "ProductId":13047233,
                  "VariantProductId":9757695,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Beef Pepperoni",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"920be3f6-7eff-41d7-9521-fceaae03cd30",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"e4d5eecd-62a1-40a6-bd00-7607f3d1107d",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13221
               },
               {  
                  "ProductId":13047257,
                  "VariantProductId":9757699,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Pizza Sauce",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"fe6c9b1b-55b4-4db0-aea7-fe5bd253865b",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"e4d5eecd-62a1-40a6-bd00-7607f3d1107d",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13223
               }
            ],
            "IsPrimaryProduct":false,
            "ItemPromotionDiscountAmount":0,
            "IsPromotionProduct":false,
            "Por":"",
            "IsDefaultBundleItem":false,
            "ProductImage":"//images.sg.content-cdn.io/cdn//in-resources/4d00cd2b-28e8-4950-b8b9-2ecf50e44933/Images/ProductImages/Source/PWA-PHBOGOF-270718.jpg;width=100;height=100;scale=canvas;anchor=bottomcenter",
            "CartPromotionRules":[  

            ],
            "CategoryId":"CU00357471",
            "CategoryName":"Deals",
            "BrandId":"BB1760",
            "BrandName":"Pizza Hut",
            "ParentCartItems":null
         }
      ],
      "Suppliers":[  
         {  
            "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
            "SupplierName":"KuwaitTestStore",
            "IsSelected":false,
            "OrderStatus":null
         }
      ],
      "ShippingOptions":[  
         {  
            "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
            "ShippingMode":"12141",
            "ShippingModeId":12141,
            "isselected":true
         }
      ],
      "PaymentOptionsChannel":[  
         {  
            "MerchantId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
            "PaymentType":"COD",
            "Paymentoption":"COD",
            "GatewayId":"0",
            "GatewayTitle":"COD",
            "PaidAmount":0,
            "EnalbeOTP":false
         },
         {  
            "MerchantId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
            "PaymentType":"OnlineBankTrans",
            "Paymentoption":"OnlineBankTransfer",
            "GatewayId":"10961",
            "GatewayTitle":"OnlineBankTrans",
            "PaidAmount":0,
            "EnalbeOTP":false
         }
      ],
      "ErrorCollection":null,
      "GiftMsg":"",
      "DemandedDeliveryDate":"/Date(-2208988800000)/",
      "RemainTotal":0,
      "ShippingZoneType":null,
      "DeliverySlotID":0,
      "FailedProducts":null,
      "PickupFirstName":"Tom",
      "PickupLastName":"Sawyer",
      "PickupEmail":"tom.sawyer@example.com",
      "PickupMobile":"55555555",
      "LocationId":"27299",
      "TaxDetail":[  

      ],
      "ComboSuggestion":[  

      ],
      "ConvertedDeals":[  

      ]
   },
   "FailedItems":[  

   ],
   "ErrorCode":0
}

Provides a payload to add non-customized default bundle products to cart.

Resource Information

URI carts/AddCartItems/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Additional Header Required

Header Description
accesstoken* Access token of the logged in user to validate the session

Request URL

{host}/developerapi/carts/AddCartItems/{merchantId}

Request Body Parameters

Parameter Type Description
ShipCity string Unique code of the shipping city (as saved in the system). Example: 0562 (for Agra), and 250 (Victoria)
ShipCountry string Alpha-2 code of the shipping country. Example: IN (for India), AU (for Australia), and BR (for Brazil)
ShipState string State’s postal abbreviation (shipping state). Example: KA (for Karnataka), CA (for California), IN (for Indiana)
DelveryMode enum Preferred mode of delivery for the current item. Value: H for home delivery, S for takeaway items
Item obj Details of the product with the attributes mentioned below
ProductID int Unique id of the parent product that you want to add to cart
VariantProductID int Unique id of the variant product that you want to add to cart
Quantity int Number of the current item you want to add
Status enum Status of the cart item. Specify A to add item to cart, D to delete item from cart
LocationId int Unique id of the order fulfillment location
Portion enum The portion for which the child product is applied. Value: W for whole, R for right, L for left (left, right usually applies for toppings)
CartReferenceKey string Unique reference id of the specific cart item
ChildItem obj Similar to the parent product details, specify the details of child items that you want add to cart
GroupID string The group id of the specific item. Applicable for bundle or deal products

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
CartReferenceKey string Unique reference key of the specific item in the cart
IsFreeProduct boolean Whether the item is a free gift item
Por enum The portion of the product for which the topping is applied. Value: W for whole, R for right, L for left (left, right usually applies for toppings)
CartPromotionRules array The rules that are applied to the cart items
DemandedDeliveryDate date Customer preferred date and time of delivery
RemainTotal float Deprecated
ShippingZoneType string Dictionary containing merchant id mapping to the payment type. It is being used in validations
ComboSuggestion array Suggestions related the deal items based on the cart items
ConvertedDeals array The cart items that are converted to deal items

Success/Error Codes

Code Description
5001 No Bundle items present for the specified product id
5002 Invalid Delivery Mode: {DeliveryMode} for Product as IsShip/IsOnline/Instore Pickup is not set
5003 Invalid Delivery Mode: {DeliveryMode} for Location Id: {LocationId}
5004 ProductId is not available at the specified locationId
5005 Product with the specified ProductId is not available
5006 Product with the specified ProductId has type 'A’ which is not allowed. You cannot add an add-on product directly
5007 Invalid variant ProductId

Add to Cart (Customized Deal)

Sample Request

https://www.martjack.com/developerapi/carts/AddCartItems/81e77da2-723b-483d-8c0d-49f800c1exxx

Sample POST Request

InputFormat=application/json&InputData={
  "cart": {
    "ShipCity": "846",
    "ShipCountry": "KW",
    "ShipState": "KW2",
    "DelveryMode": "H",
    "Item": [
      {
        "ProductID": 13047461,
        "VariantProductID": 0,
        "Quantity": 1,
        "Status": "A",
        "LocationId": 27299,
        "Portion": "W",
        "CartReferenceKey": "00000000-0000-0000-0000-000000000000",
        "Price": 3.25,
        "ChildItem": [
          {
            "ProductID": 13047273,
            "VariantProductID": 0,
            "Quantity": 1,
            "Status": "A",
            "Portion": "W",
            "GroupID": 13317,
            "ChildItem": [
              {
                "childItems": [],
                "productId": 13047215,
                "variantProductId": 9757487,
                "quantity": 1,
                "portion": "W",
                "bundleProductId": 13047273,
                "groupId": 13317
              },
              {
                "childItems": [],
                "productId": 13047255,
                "variantProductId": 9757701,
                "quantity": 1,
                "isBundle": false,
                "bundleProductId": 13047273,
                "bundleItemId": 88013,
                "portion": "W",
                "title": "Mozarella",
                "type": "V",
                "groupId": 13129
              },
              {
                "childItems": [],
                "productId": 13047267,
                "variantProductId": 9757725,
                "quantity": 1,
                "isBundle": false,
                "bundleProductId": 13047273,
                "bundleItemId": 88019,
                "portion": "W",
                "title": "Sliced Black Olives",
                "type": "V",
                "groupId": 13129
              },
              {
                "childItems": [],
                "productId": 13047231,
                "variantProductId": 9757689,
                "quantity": 1,
                "isBundle": false,
                "bundleProductId": 13047273,
                "bundleItemId": 88029,
                "portion": "W",
                "title": "Chargrilled Chicken",
                "type": "V",
                "groupId": 13131
              },
              {
                "childItems": [],
                "productId": 13047233,
                "variantProductId": 9757695,
                "quantity": 1,
                "isBundle": false,
                "bundleProductId": 13047273,
                "bundleItemId": 88025,
                "portion": "W",
                "title": "Beef Pepperoni",
                "type": "V",
                "groupId": 13131
              },
              {
                "childItems": [],
                "productId": 13047235,
                "variantProductId": 9757693,
                "quantity": 1,
                "isBundle": false,
                "bundleProductId": 13047273,
                "bundleItemId": 88027,
                "portion": "W",
                "title": "Calamari Catch",
                "type": "V",
                "groupId": 13131
              },
              {
                "childItems": [],
                "productId": 13047237,
                "variantProductId": 9757691,
                "quantity": 1,
                "isBundle": false,
                "bundleProductId": 13047273,
                "bundleItemId": 88023,
                "portion": "W",
                "title": "Beef",
                "type": "V",
                "groupId": 13131
              },
              {
                "childItems": [],
                "productId": 13047241,
                "variantProductId": 9757697,
                "quantity": 1,
                "isBundle": false,
                "bundleProductId": 13047273,
                "bundleItemId": 88031,
                "portion": "W",
                "title": "Chicken Pepperoni",
                "type": "V",
                "groupId": 13131
              },
              {
                "childItems": [],
                "productId": 13047257,
                "variantProductId": 9757699,
                "quantity": 1,
                "isBundle": false,
                "bundleProductId": 13047273,
                "bundleItemId": 88039,
                "portion": "W",
                "title": "Pizza Sauce",
                "type": "V",
                "groupId": 13133
              }
            ]
          },
          {
            "ProductID": 13047319,
            "VariantProductID": 0,
            "Quantity": 1,
            "Status": "A",
            "Portion": "W",
            "GroupID": 13319,
            "ChildItem": [
              {
                "childItems": [],
                "productId": 13047219,
                "variantProductId": 9757497,
                "quantity": 1,
                "portion": "W",
                "bundleProductId": 13047319,
                "groupId": 13319
              },
              {
                "childItems": [],
                "productId": 13047247,
                "variantProductId": 9757709,
                "quantity": 1,
                "isBundle": false,
                "bundleProductId": 13047319,
                "bundleItemId": 88457,
                "portion": "W",
                "title": "Green Chillies",
                "type": "V",
                "groupId": 13219
              },
              {
                "childItems": [],
                "productId": 13047249,
                "variantProductId": 9757711,
                "quantity": 1,
                "isBundle": false,
                "bundleProductId": 13047319,
                "bundleItemId": 88459,
                "portion": "W",
                "title": "Green Pepper Strips",
                "type": "V",
                "groupId": 13219
              },
              {
                "childItems": [],
                "productId": 13047251,
                "variantProductId": 9757713,
                "quantity": 1,
                "isBundle": false,
                "bundleProductId": 13047319,
                "bundleItemId": 88461,
                "portion": "W",
                "title": "Jalapeno",
                "type": "V",
                "groupId": 13219
              },
              {
                "childItems": [],
                "productId": 13047255,
                "variantProductId": 9757701,
                "quantity": 1,
                "isBundle": false,
                "bundleProductId": 13047319,
                "bundleItemId": 88465,
                "portion": "W",
                "title": "Mozarella",
                "type": "V",
                "groupId": 13219
              },
              {
                "childItems": [],
                "productId": 13047233,
                "variantProductId": 9757695,
                "quantity": 1,
                "isBundle": false,
                "bundleProductId": 13047319,
                "bundleItemId": 88477,
                "portion": "W",
                "title": "Beef Pepperoni",
                "type": "V",
                "groupId": 13221
              },
              {
                "childItems": [],
                "productId": 13047257,
                "variantProductId": 9757699,
                "quantity": 1,
                "isBundle": false,
                "bundleProductId": 13047319,
                "bundleItemId": 88491,
                "portion": "W",
                "title": "Pizza Sauce",
                "type": "V",
                "groupId": 13223
              }
            ]
          }
        ]
      }
    ]
  }
}

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "Carts":{  
      "MerchantId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
      "ProductCost":5.650000000000001,
      "ShippingCost":0.5,
      "VoucherDiscount":0,
      "PromotionDiscount":0,
      "TaxAmount":0,
      "OrderTotal":6.15,
      "VoucherCode":"",
      "UserSelectedCurrency":"INR",
      "Bill_FirstName":"Pallav",
      "Bill_LastName":"Kumar",
      "Bill_Address1":"",
      "Bill_Address2":"",
      "Bill_CountryCode":"",
      "_Bill_StateCode":"",
      "Bill_City":"Other",
      "Bill_CityCode":"554",
      "Bill_OtherCityName":"",
      "Bill_Telephone":"",
      "Bill_Mobile":"55555555",
      "Bill_PostCode":"",
      "Bill_Email":"tom.sawyer@example.com",
      "Ship_FirstName":"Pallav",
      "Ship_LastName":"Kumar",
      "Ship_Address1":"",
      "Ship_Address2":"",
      "Ship_CountryCode":"KW",
      "Ship_StateCode":"KW2",
      "Ship_City":"846",
      "Ship_CityCode":"846",
      "Ship_OtherCityName":"",
      "Ship_Telephone":"",
      "Ship_Mobile":"55555555",
      "Ship_PostCode":"",
      "Ship_Email":"tom.sawyer@example.com",
      "CartItems":[  
         {  
            "ProductId":13047461,
            "VariantProductId":0,
            "MRP":0,
            "WebPrice":0,
            "Quantity":1,
            "description":"BUY ONE GET ONE FREE- Medium",
            "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
            "CartReferenceKey":"97fe77f4-412e-4aea-8d3c-e95dd0423861",
            "IsFreeProduct":false,
            "PriceCapped":false,
            "TotalCap":0,
            "CappedRefKey":"00000000-0000-0000-0000-000000000000",
            "CatalogpromotionDiscount":0,
            "BundleCartReferenceKey":"00000000-0000-0000-0000-000000000000",
            "BundleCartItems":[  
               {  
                  "ProductId":13047273,
                  "VariantProductId":0,
                  "MRP":0,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Chicken Supreme",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"97fe77f4-412e-4aea-8d3c-e95dd0423861",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  

                  ],
                  "Por":"W",
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357451",
                  "CategoryName":"Chicken",
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13317
               },
               {  
                  "ProductId":13047215,
                  "VariantProductId":9757487,
                  "MRP":4.25,
                  "WebPrice":3.25,
                  "Quantity":1,
                  "description":"Chicken Supreme",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"0ab3f8ab-7840-4d40-bad5-950e64da288a",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":true,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Crust",
                        "Value":"Classic"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357457",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13317
               },
               {  
                  "ProductId":13047255,
                  "VariantProductId":9757701,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Mozarella",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"d2b252a0-58ff-4a56-8a2f-a4b828bc15a6",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13129
               },
               {  
                  "ProductId":13047267,
                  "VariantProductId":9757725,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Sliced Black Olives",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"c946dfbb-c7d4-4482-be3a-0f55ea0ff701",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13129
               },
               {  
                  "ProductId":13047231,
                  "VariantProductId":9757689,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Chargrilled Chicken",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"a944f99d-5729-41f1-a51a-a6ca7b7d8637",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13131
               },
               {  
                  "ProductId":13047233,
                  "VariantProductId":9757695,
                  "MRP":0.5,
                  "WebPrice":0.4,
                  "Quantity":1,
                  "description":"Beef Pepperoni",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"a6d6f5ee-0b60-49b1-a504-9a63b42a4789",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13131
               },
               {  
                  "ProductId":13047235,
                  "VariantProductId":9757693,
                  "MRP":0.5,
                  "WebPrice":0.4,
                  "Quantity":1,
                  "description":"Calamari Catch",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"5caec831-1597-45ca-af9d-11beafc35b91",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13131
               },
               {  
                  "ProductId":13047237,
                  "VariantProductId":9757691,
                  "MRP":0.5,
                  "WebPrice":0.4,
                  "Quantity":1,
                  "description":"Beef",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"ca206f95-ec4b-4a07-8651-652b61838960",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13131
               },
               {  
                  "ProductId":13047241,
                  "VariantProductId":9757697,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Chicken Pepperoni",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"10ec62e0-0938-4b4e-a066-254d9aa65818",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13131
               },
               {  
                  "ProductId":13047257,
                  "VariantProductId":9757699,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Pizza Sauce",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"b3aa047a-091d-488f-b8a8-abde211ad008",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"13a4fab9-3bbc-484c-b081-b3ed72d83342",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13133
               },
               {  
                  "ProductId":13047319,
                  "VariantProductId":0,
                  "MRP":0,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Classic Pepperoni",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"e4d5eecd-62a1-40a6-bd00-7607f3d1107d",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"97fe77f4-412e-4aea-8d3c-e95dd0423861",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  

                  ],
                  "Por":"W",
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357450",
                  "CategoryName":"Beef",
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13319
               },
               {  
                  "ProductId":13047219,
                  "VariantProductId":9757497,
                  "MRP":4.25,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Classic Pepperoni",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"0255ff10-0bc2-4518-aef5-9af37668750d",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"e4d5eecd-62a1-40a6-bd00-7607f3d1107d",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":true,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Crust",
                        "Value":"Pan"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357457",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13319
               },
               {  
                  "ProductId":13047247,
                  "VariantProductId":9757709,
                  "MRP":0.5,
                  "WebPrice":0.4,
                  "Quantity":1,
                  "description":"Green Chillies",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"368a2174-938e-47f2-94e9-aafed11206f8",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"e4d5eecd-62a1-40a6-bd00-7607f3d1107d",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13219
               },
               {  
                  "ProductId":13047249,
                  "VariantProductId":9757711,
                  "MRP":0.5,
                  "WebPrice":0.4,
                  "Quantity":1,
                  "description":"Green Pepper Strips",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"cff5fc90-375e-4914-b09b-1a3a97b64c1e",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"e4d5eecd-62a1-40a6-bd00-7607f3d1107d",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13219
               },
               {  
                  "ProductId":13047251,
                  "VariantProductId":9757713,
                  "MRP":0.5,
                  "WebPrice":0.4,
                  "Quantity":1,
                  "description":"Jalapeno",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"9b9e43cd-a4e2-4ad2-aa5a-eb165c371ecf",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"e4d5eecd-62a1-40a6-bd00-7607f3d1107d",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13219
               },
               {  
                  "ProductId":13047255,
                  "VariantProductId":9757701,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Mozarella",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"8a61d1b4-c496-4b41-8a3a-c70a0fa510ef",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"e4d5eecd-62a1-40a6-bd00-7607f3d1107d",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13219
               },
               {  
                  "ProductId":13047233,
                  "VariantProductId":9757695,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Beef Pepperoni",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"920be3f6-7eff-41d7-9521-fceaae03cd30",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"e4d5eecd-62a1-40a6-bd00-7607f3d1107d",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13221
               },
               {  
                  "ProductId":13047257,
                  "VariantProductId":9757699,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Pizza Sauce",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"fe6c9b1b-55b4-4db0-aea7-fe5bd253865b",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"e4d5eecd-62a1-40a6-bd00-7607f3d1107d",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13223
               }
            ],
            "IsPrimaryProduct":false,
            "ItemPromotionDiscountAmount":0,
            "IsPromotionProduct":false,
            "Por":"",
            "IsDefaultBundleItem":false,
            "ProductImage":"//images.sg.content-cdn.io/cdn//in-resources/4d00cd2b-28e8-4950-b8b9-2ecf50e44933/Images/ProductImages/Source/PWA-PHBOGOF-270718.jpg;width=100;height=100;scale=canvas;anchor=bottomcenter",
            "CartPromotionRules":[  

            ],
            "CategoryId":"CU00357471",
            "CategoryName":"Deals",
            "BrandId":"BB1760",
            "BrandName":"Pizza Hut",
            "ParentCartItems":null
         }
      ],
      "Suppliers":[  
         {  
            "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
            "SupplierName":"KuwaitTestStore",
            "IsSelected":false,
            "OrderStatus":null
         }
      ],
      "ShippingOptions":[  
         {  
            "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
            "ShippingMode":"12141",
            "ShippingModeId":12141,
            "isselected":true
         }
      ],
      "PaymentOptionsChannel":[  
         {  
            "MerchantId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
            "PaymentType":"COD",
            "Paymentoption":"COD",
            "GatewayId":"0",
            "GatewayTitle":"COD",
            "PaidAmount":0,
            "EnalbeOTP":false
         },
         {  
            "MerchantId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
            "PaymentType":"OnlineBankTrans",
            "Paymentoption":"OnlineBankTransfer",
            "GatewayId":"10961",
            "GatewayTitle":"OnlineBankTrans",
            "PaidAmount":0,
            "EnalbeOTP":false
         }
      ],
      "ErrorCollection":null,
      "GiftMsg":"",
      "DemandedDeliveryDate":"/Date(-2208988800000)/",
      "RemainTotal":0,
      "ShippingZoneType":null,
      "DeliverySlotID":0,
      "FailedProducts":null,
      "PickupFirstName":"Tom",
      "PickupLastName":"Sawyer",
      "PickupEmail":"tom.sawyer@example.com",
      "PickupMobile":"55555555",
      "LocationId":"27299",
      "TaxDetail":[  

      ],
      "ComboSuggestion":[  

      ],
      "ConvertedDeals":[  

      ]
   },
   "FailedItems":[  

   ],
   "ErrorCode":0
}

Lets you add customized deal products to the cart.

Resource Information

Parameter Description
URI carts/AddCartItems/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Additional Header Required

Header Description
accesstoken* Access token of the logged in user to validate the session

Request URL

{host}/developerapi/carts/AddCartItems/{merchantId}

Request Body Parameters

Parameter Type Description
ShipCity string Unique code of the shipping city (as saved in the system) to which the item has to be shipped. Example: 0562 (for Agra), and 250 (Victoria)
ShipCountry string Alpha-2 code of the country of the shipping address. Example: IN (for India), AU (for Australia), and BR (for Brazil)
ShipState string State code associated to the shipping city
DelveryMode enum The mode of delivery. Value: S for store pick up and H for home delivery
ProductID int Unique id of the product that you want to add
VariantProductID int Unique id of the variant product
Quantity int Quantity of the current item that you want to add to cart
Status enum Status of the cart item. Specify A to add item to cart, D to delete item from cart
LocationId int Unique id of the delivery location
Portion enum The portion of the current child item. Value: W for whole,L for left, R for right
CartReferenceKey string Unique reference key associated to the cart item
Price float Price of the current item
ChildItem json obj All add-ons are child items of a bundle. For example, crust, sauce, and toppings
GroupID int Unique user group id associated to the product group. One group can have only one type of item. For example, in a group you can either add only pizzas, drinks, appetizers or deserts

Response Parameters

Following table contains descriptions of a few response parameters that require more information. It does not include the parameters that are already in the request body or self explanatory.

Parameter Type Description
CartReferenceKey string Unique reference key of the specific cart item
IsFreeProduct boolean Whether the item is a free gift item
Por enum The portion of the product for which the topping is applied. Value: W for whole, R for right, L for left (left, right usually applies for toppings)
CartPromotionRules array The rules that are applied to the cart items
DemandedDeliveryDate date-time Customer preferred delivery time
RemainTotal float Deprecated
ShippingZoneType string Dictionary containing merchant id mapping to the payment type. It is used in validations
ComboSuggestion array Suggestions related to deal items based on the items in the cart
ConvertedDeals array The cart items that are converted to deal items

Add Items to Cart (Customized Bundle)

Sample Request

https://www.martjack.com/developerapi/carts/AddCartItems/81e77da2-723b-483d-8c0d-49f800c1exxx

Sample POST Request

InputFormat=application/json&InputData={
  "cart": {
    "ShipCity": "",
    "ShipCountry": "",
    "ShipState": "",
    "DelveryMode": "H",
    "Item": [
      {
        "ProductID": 13047325,
        "VariantProductID": 0,
        "Quantity": 1,
        "Status": "A",
        "LocationId": 27299,
        "Portion": "W",
        "CartReferenceKey": "027ea92e-65f2-408c-b78f-42d860b59d32",
        "Price": 7.25,
        "ChildItem": [
          {
            "ProductID": 13047223,
            "VariantProductID": 9757573,
            "Quantity": 1,
            "Status": "A",
            "Portion": "W"
          },
          {
            "ProductID": 13047239,
            "VariantProductID": 9757649,
            "Quantity": 1,
            "Status": "A",
            "Portion": "W",
            "GroupID": 13245
          },
          {
            "ProductID": 13047245,
            "VariantProductID": 9757653,
            "Quantity": 1,
            "Status": "A",
            "Portion": "W",
            "GroupID": 13245
          },
          {
            "ProductID": 13047247,
            "VariantProductID": 9757655,
            "Quantity": 1,
            "Status": "A",
            "Portion": "W",
            "GroupID": 13245
          },
          {
            "ProductID": 13047255,
            "VariantProductID": 9757645,
            "Quantity": 1,
            "Status": "A",
            "Portion": "W",
            "GroupID": 13245
          },
          {
            "ProductID": 13047231,
            "VariantProductID": 9757639,
            "Quantity": 1,
            "Status": "A",
            "Portion": "W",
            "GroupID": 13249
          },
          {
            "ProductID": 13047233,
            "VariantProductID": 9757641,
            "Quantity": 1,
            "Status": "A",
            "Portion": "W",
            "GroupID": 13249
          },
          {
            "ProductID": 13047235,
            "VariantProductID": 9757635,
            "Quantity": 1,
            "Status": "A",
            "Portion": "W",
            "GroupID": 13249
          },
          {
            "ProductID": 13047237,
            "VariantProductID": 9757637,
            "Quantity": 1,
            "Status": "A",
            "Portion": "W",
            "GroupID": 13249
          },
          {
            "ProductID": 13047257,
            "VariantProductID": 9757643,
            "Quantity": 1,
            "Status": "A",
            "Portion": "W",
            "GroupID": 13251
          }
        ]
      }
    ]
  }
}

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "Carts":{  
      "MerchantId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
      "ProductCost":5.75,
      "ShippingCost":0.5,
      "VoucherDiscount":0,
      "PromotionDiscount":0,
      "TaxAmount":0,
      "OrderTotal":6.25,
      "VoucherCode":"",
      "UserSelectedCurrency":"INR",
      "Bill_FirstName":"Pallav",
      "Bill_LastName":"Kumar",
      "Bill_Address1":"",
      "Bill_Address2":"",
      "Bill_CountryCode":"",
      "_Bill_StateCode":"",
      "Bill_City":"Other",
      "Bill_CityCode":"554",
      "Bill_OtherCityName":"",
      "Bill_Telephone":"",
      "Bill_Mobile":"55555555",
      "Bill_PostCode":"",
      "Bill_Email":"pallav.kumar@capillarytech.com",
      "Ship_FirstName":"Pallav",
      "Ship_LastName":"Kumar",
      "Ship_Address1":"",
      "Ship_Address2":"",
      "Ship_CountryCode":"KW",
      "Ship_StateCode":"KW2",
      "Ship_City":"846",
      "Ship_CityCode":"846",
      "Ship_OtherCityName":"",
      "Ship_Telephone":"",
      "Ship_Mobile":"55555555",
      "Ship_PostCode":"",
      "Ship_Email":"pallav.kumar@capillarytech.com",
      "CartItems":[  
         {  
            "ProductId":13047325,
            "VariantProductId":0,
            "MRP":4.25,
            "WebPrice":0,
            "Quantity":1,
            "description":"New Spicy Chicken Ranch",
            "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
            "CartReferenceKey":"97da4fe2-89da-43c8-afc9-5fd8c487d546",
            "IsFreeProduct":false,
            "PriceCapped":false,
            "TotalCap":0,
            "CappedRefKey":"00000000-0000-0000-0000-000000000000",
            "CatalogpromotionDiscount":0,
            "BundleCartReferenceKey":"00000000-0000-0000-0000-000000000000",
            "BundleCartItems":[  
               {  
                  "ProductId":13047223,
                  "VariantProductId":9757573,
                  "MRP":4.25,
                  "WebPrice":4.25,
                  "Quantity":1,
                  "description":"New Spicy Chicken Ranch",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"37fedeb2-749b-4b08-9f70-3143d553f0c8",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"97da4fe2-89da-43c8-afc9-5fd8c487d546",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":true,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Crust",
                        "Value":"Classic"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Large"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357457",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13241
               },
               {  
                  "ProductId":13047239,
                  "VariantProductId":9757649,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Onions",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"d8888912-96ef-4ac5-bc84-82bceebaaa0c",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"97da4fe2-89da-43c8-afc9-5fd8c487d546",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Large"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13245
               },
               {  
                  "ProductId":13047245,
                  "VariantProductId":9757653,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Tomatoes",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"ae4cad02-31bc-4cd9-99d2-3aa574b19c25",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"97da4fe2-89da-43c8-afc9-5fd8c487d546",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Large"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13245
               },
               {  
                  "ProductId":13047247,
                  "VariantProductId":9757655,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Green Chillies",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"17b0bb8e-87a2-4d29-978e-29ad71773d1a",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"97da4fe2-89da-43c8-afc9-5fd8c487d546",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Large"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13245
               },
               {  
                  "ProductId":13047255,
                  "VariantProductId":9757645,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Mozarella",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"3de9a60b-54d6-4a47-82f0-ee4fc79a3ab7",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"97da4fe2-89da-43c8-afc9-5fd8c487d546",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Large"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13245
               },
               {  
                  "ProductId":13047231,
                  "VariantProductId":9757639,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Chargrilled Chicken",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"d783e091-92cc-435c-bc11-ecfaa1db3e25",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"97da4fe2-89da-43c8-afc9-5fd8c487d546",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Large"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13249
               },
               {  
                  "ProductId":13047233,
                  "VariantProductId":9757641,
                  "MRP":0.5,
                  "WebPrice":0.5,
                  "Quantity":1,
                  "description":"Beef Pepperoni",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"5e0d5dd6-41f7-42ae-a180-72bcf61f6c16",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"97da4fe2-89da-43c8-afc9-5fd8c487d546",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Large"
                     }
                  ],
                  "Por":"W",
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Store",
                  "GroupId":13249
               },
               {  
                  "ProductId":13047235,
                  "VariantProductId":9757635,
                  "MRP":0.5,
                  "WebPrice":0.5,
                  "Quantity":1,
                  "description":"Calamari Catch",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"a0b6eebd-c051-49aa-915d-fe99847a8ea8",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"97da4fe2-89da-43c8-afc9-5fd8c487d546",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Large"
                     }<