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"
                     }
                  ],
                  "Por":"W",
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00357497",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":13249
               },
               {  
                  "ProductId":13047237,
                  "VariantProductId":9757637,
                  "MRP":0.5,
                  "WebPrice":0.5,
                  "Quantity":1,
                  "description":"Beef",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"0fa3e24d-ae93-434a-9475-50b8e13e2c13",
                  "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":13047257,
                  "VariantProductId":9757643,
                  "MRP":0.5,
                  "WebPrice":0,
                  "Quantity":1,
                  "description":"Pizza Sauce",
                  "SupplierId":"4d00cd2b-28e8-4950-b8b9-2ecf50e44933",
                  "CartReferenceKey":"2db7ebad-2f53-4f94-87ae-383f735af331",
                  "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 Store",
                  "GroupId":13251
               }
            ],
            "IsPrimaryProduct":false,
            "ItemPromotionDiscountAmount":0,
            "IsPromotionProduct":false,
            "Por":"",
            "IsDefaultBundleItem":false,
            "ProductImage":"/Images/ProductImages/Source/FCDS-newtxt-spycy-pizza.png;width=100;height=100;scale=canvas;anchor=bottomcenter",
            "CartPromotionRules":[  

            ],
            "CategoryId":"CU00357451",
            "CategoryName":"Chicken",
            "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":[  

      ]
   },
   "ErrorCode":0
}

Lets you add customized bundle items 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 string Mode of delivery. Value: S for store pick up, H for home delivery
Item obj Details of each cart item
ProductID int Unique id of the product
VariantProductID int Unique id of the variant product
Quantity int Number of the current items 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 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 key of the cart item
Price float Price of the current item
ChildItem obj Details of each child item. Applicable for bundle products
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)
GroupID int Group id associated to the specific item. Applicable in case of a 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
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 to the deal items based on the cart items
ConvertedDeals array The cart items that are converted to deal items

Add Free Products to Cart

Lets you add free products to the cart.

Sample Request

https://www.martjack.com/developerapi/Carts/AddFreeProducts/{merchantId}/{promotionruleid}

Sample POST Request

InputFormat=application/json&InputData={  
   "cart":{  
      "DelveryMode":"H",
      "Item":[  
         {  
            "Status":"A",
            "VariantProductID":0,
            "LocationId":13378,
            "CartReferenceKey":"00000000-0000-0000-0000-000000000000",
            "ProductID":8278046,
            "Quantity":1
         }
      ]
   }
}

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "Carts": {
        "MerchantId": "81e77da2-723b-483d-8c0d-49f800c1e288",
        "ProductCost": 2.860596,
        "ShippingCost": 0,
        "VoucherDiscount": 0,
        "PromotionDiscount": 0,
        "TaxAmount": 0.29,
        "OrderTotal": 3.150596,
        "VoucherCode": "",
        "UserSelectedCurrency": "OMR",
        "Bill_FirstName": null,
        "Bill_LastName": "",
        "Bill_Address1": "",
        "Bill_Address2": null,
        "Bill_CountryCode": "",
        "_Bill_StateCode": null,
        "Bill_City": "Other",
        "Bill_CityCode": "554",
        "Bill_OtherCityName": null,
        "Bill_Telephone": null,
        "Bill_Mobile": null,
        "Bill_PostCode": null,
        "Bill_Email": "",
        "Ship_FirstName": null,
        "Ship_LastName": "",
        "Ship_Address1": "",
        "Ship_Address2": null,
        "Ship_CountryCode": "OM",
        "Ship_StateCode": "OM11",
        "Ship_City": "29879",
        "Ship_CityCode": "29879",
        "Ship_OtherCityName": null,
        "Ship_Telephone": null,
        "Ship_Mobile": null,
        "Ship_PostCode": null,
        "Ship_Email": null,
        "CartItems": [
            {
                "ProductId": 8278046,
                "VariantProductId": 0,
                "MRP": 5.17,
                "WebPrice": 2.860596,
                "Quantity": 1,
                "description": "Hershey's cookie",
                "SupplierId": "81e77da2-723b-483d-8c0d-49f800c1e288",
                "CartReferenceKey": "32f4332f-2e2e-4942-8c94-51149925835c",
                "IsFreeProduct": false,
                "PriceCapped": false,
                "TotalCap": 0,
                "CappedRefKey": "00000000-0000-0000-0000-000000000000",
                "CatalogpromotionDiscount": 0,
                "BundleCartReferenceKey": "00000000-0000-0000-0000-000000000000",
                "IsPrimaryProduct": false,
                "ItemPromotionDiscountAmount": 0,
                "IsPromotionProduct": false,
                "Por": "",
                "IsDefaultBundleItem": false,
                "ProductImage": "//imagecdn.example.me/azure//stage-resources/81e77da2-723b-483d-8c0d-49f800c1e288/Images/ProductImages/Source/Hersheys_cookie_showcase.png;width=100;height=100;scale=canvas;anchor=bottomcenter",
                "CartPromotionRules": [],
                "CategoryId": "CU00215760",
                "CategoryName": null,
                "BrandId": "207264",
                "BrandName": "PizzaHut",
                "ParentCartItems": []
            }
        ],
        "Suppliers": [
            {
                "SupplierId": "81e77da2-723b-483d-8c0d-49f800c1e288",
                "SupplierName": "Pizza Hut",
                "IsSelected": false,
                "OrderStatus": null
            }
        ],
        "ShippingOptions": [
            {
                "SupplierId": "81e77da2-723b-483d-8c0d-49f800c1e288",
                "ShippingMode": "9284",
                "ShippingModeId": 9284,
                "isselected": true
            }
        ],
        "PaymentOptionsChannel": [
            {
                "MerchantId": "81e77da2-723b-483d-8c0d-49f800c1e288",
                "PaymentType": "COD",
                "Paymentoption": "COD",
                "GatewayId": "0",
                "GatewayTitle": "COD",
                "PaidAmount": 0,
                "EnalbeOTP": false
            },
            {
                "MerchantId": "81e77da2-723b-483d-8c0d-49f800c1e288",
                "PaymentType": "Credit",
                "Paymentoption": "<div style=\"padding-left:30px;\"><img src=\"/images/paymentoptions/Visa.jpg\"/><img src=\"/images/paymentoptions/Mastercard.jpg\" style=\"margin-left:4px;\" /><div >You can pay using Master or Visa Credit Card</div></div>",
                "GatewayId": "14017",
                "GatewayTitle": "Pay Fort",
                "PaidAmount": 0,
                "EnalbeOTP": false
            }
        ],
        "ErrorCollection": null,
        "GiftMsg": "",
        "DemandedDeliveryDate": "/Date(-2208988800000)/",
        "RemainTotal": 0,
        "ShippingZoneType": null,
        "DeliverySlotID": 0,
        "FailedProducts": null,
        "PickupLastName": "",
        "PickupEmail": "",
        "LocationId": "13378",
        "TaxDetail": [
            {
                "TaxCategory": " (5%) خدمة توصيل",
                "TaxRate": "5",
                "TaxAmount": 0.1430298,
                "IsTaxRatePercentage": false,
                "TaxCode": "0",
                "TaxCategoryID": "6"
            },
            {
                "TaxCategory": "(5%) ضريبة البلدية",
                "TaxRate": "5",
                "TaxAmount": 0.1430298,
                "IsTaxRatePercentage": false,
                "TaxCode": "0",
                "TaxCategoryID": "2"
            }
        ],
        "ComboSuggestion": [],
        "ConvertedDeals": [],
        "BusinessRuleDescriptionView": [
            {
                "RuleId": 41689,
                "RuleDescription": "Product Price",
                "IsShowCaseCrietriaSet": true,
                "RuleProductShowCase": {
                    "Attributes": [],
                    "Brands": [],
                    "Categories": [
                        "CU00215758",
                        ""
                    ],
                    "Groups": [],
                    "Products": [],
                    "Suppliers": [],
                    "Tags": [],
                    "Variants": []
                },
                "IsAutoAdd": false,
                "IsFreeActionInstructionType": true
            }
        ],
        "AppliedPromotionDetailsList": null
    },
    "FailedItems": [],
    "ErrorCode": 0
}

Resource Information
URI /AddFreeProducts/{merchantId}/{promotionruleid}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

https://{host}/developerapi/Carts/AddFreeProducts/{merchantId}/{promotionruleid}

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
DelveryMode enum Delivery mode of the product. Value: H for home delivery, S for takeaway
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 Variant id of the product that you want to add
LocationId int Location id of the product
CartReferenceKey string Unique GUID of the item in the cart as per AddCartItems
ProductID int Unique id of the product that you want to add
Quantity int Quantity of the item that you want to add the cart

Location Add to Cart

Sample Request

http://www.martjack.com/developerapi/Carts/LocationCart/993c939a-a2e8-4934-bbf5-390f37457a55/13038134/9972544/1/24342/INR

Sample Response

{
   "messageCode":"1004",
   "Message":"Successful",
   "Carts":{
      "MerchantId":"993c939a-a2e8-4934-bbf5-390f37457a55",
      "ProductCost":7660.0,
      "ShippingCost":120.0,
      "VoucherDiscount":0.0,
      "PromotionDiscount":0.0,
      "TaxAmount":0.0,
      "OrderTotal":7780.0,
      "VoucherCode":"",
      "UserSelectedCurrency":"INR",
      "Bill_FirstName":null,
      "Bill_LastName":"Test",
      "Bill_Address1":"AutoTestAddres1Bill",
      "Bill_Address2":"",
      "Bill_CountryCode":"IN",
      "_Bill_StateCode":"KA",
      "Bill_City":"Bangalore",
      "Bill_CityCode":"32",
      "Bill_OtherCityName":"195",
      "Bill_Telephone":"040-33123456",
      "Bill_Mobile":"91-9898989898",
      "Bill_PostCode":"560029",
      "Bill_Email":"",
      "Ship_FirstName":"AutoTestNameBill2337g1",
      "Ship_LastName":"Test",
      "Ship_Address1":"AutoTestAddres1Bill",
      "Ship_Address2":"",
      "Ship_CountryCode":"IN",
      "Ship_StateCode":"KA",
      "Ship_City":"32",
      "Ship_CityCode":"32",
      "Ship_OtherCityName":"195",
      "Ship_Telephone":"040-33123456",
      "Ship_Mobile":"91-9898989898",
      "Ship_PostCode":"560029",
      "Ship_Email":"",
      "CartItems":[
         {
            "ProductId":13037156,
            "VariantProductId":9970442,
            "MRP":1500.0,
            "WebPrice":1200.0,
            "Quantity":3.0,
            "description":"Format Shirt 01",
            "SupplierId":"993c939a-a2e8-4934-bbf5-390f37457a55",
            "CartReferenceKey":"c4f7081a-89b2-460a-a60a-b5f312a79c50",
            "PriceCapped":false,
            "IsFreeProduct":false,
            "TotalCap":0,
            "CappedRefKey":"00000000-0000-0000-0000-000000000000",
            "CatalogpromotionDiscount":0.0,
            "BundleCartReferenceKey":"00000000-0000-0000-0000-000000000000",
            "ItemPromotionDiscountAmount":0.0,
            "IsPrimaryProduct":false,
            "IsPromotionProduct":false,
            "VariantsInfo":[
               {
                  "PropertyName":"Size",
                  "Value":"Medium"
               }
            ],
            "Por":"",
            "IsDefaultBundleItem":false,
            "ProductImage":"//images.sg.content-cdn.io/cdn//test-resources/993c939a-a2e8-4934-bbf5-390f37457a55/Images/ProductImages/Source/formalshirt.jpg;width=100;height=100;scale=canvas;anchor=bottomcenter",
            "CartPromotionRules":[

            ],
            "CategoryId":"CU00366338",
            "CategoryName":null,
            "BrandId":"All001",
            "BrandName":"Allen Solly",
            "ParentCartItems":null
         },
         {
            "ProductId":13038134,
            "VariantProductId":9972546,
            "MRP":1500.0,
            "WebPrice":1355.0,
            "Quantity":2.0,
            "description":"TShirt Product 01",
            "SupplierId":"993c939a-a2e8-4934-bbf5-390f37457a55",
            "CartReferenceKey":"2a48bc32-bf8c-4097-9a85-0a728749dc57",
            "PriceCapped":false,
            "IsFreeProduct":false,
            "TotalCap":0,
            "CappedRefKey":"00000000-0000-0000-0000-000000000000",
            "CatalogpromotionDiscount":0.0,
            "BundleCartReferenceKey":"00000000-0000-0000-0000-000000000000",
            "ItemPromotionDiscountAmount":0.0,
            "IsPrimaryProduct":false,
            "IsPromotionProduct":false,
            "VariantsInfo":[
               {
                  "PropertyName":"Size",
                  "Value":"Small"
               }
            ],
            "Por":"",
            "IsDefaultBundleItem":false,
            "ProductImage":"//images.sg.content-cdn.io/cdn//test-resources/993c939a-a2e8-4934-bbf5-390f37457a55/Images/ProductImages/Source/71FItmnzmdL._UL1500_.jpg;width=100;height=100;scale=canvas;anchor=bottomcenter",
            "CartPromotionRules":[

            ],
            "CategoryId":"CU00366336",
            "CategoryName":null,
            "BrandId":"Nik002",
            "BrandName":"NIKE",
            "ParentCartItems":null
         },
         {
            "ProductId":13038134,
            "VariantProductId":9972544,
            "MRP":1500.0,
            "WebPrice":1350.0,
            "Quantity":1.0,
            "description":"TShirt Product 01",
            "SupplierId":"993c939a-a2e8-4934-bbf5-390f37457a55",
            "CartReferenceKey":"8dd9ce47-e35d-4f23-b37c-d8299ea7c95b",
            "PriceCapped":false,
            "IsFreeProduct":false,
            "TotalCap":0,
            "CappedRefKey":"00000000-0000-0000-0000-000000000000",
            "CatalogpromotionDiscount":0.0,
            "BundleCartReferenceKey":"00000000-0000-0000-0000-000000000000",
            "ItemPromotionDiscountAmount":0.0,
            "IsPrimaryProduct":false,
            "IsPromotionProduct":false,
            "VariantsInfo":[
               {
                  "PropertyName":"Size",
                  "Value":"Medium"
               }
            ],
            "Por":"",
            "IsDefaultBundleItem":false,
            "ProductImage":"//images.sg.content-cdn.io/cdn//test-resources/993c939a-a2e8-4934-bbf5-390f37457a55/Images/ProductImages/Source/71FItmnzmdL._UL1500_.jpg;width=100;height=100;scale=canvas;anchor=bottomcenter",
            "CartPromotionRules":[

            ],
            "CategoryId":"CU00366336",
            "CategoryName":null,
            "BrandId":"Nik002",
            "BrandName":"NIKE",
            "ParentCartItems":null
         }
      ],
      "Suppliers":[
         {
            "SupplierId":"993c939a-a2e8-4934-bbf5-390f37457a55",
            "SupplierName":"testorg2",
            "IsSelected":false,
            "OrderStatus":null
         }
      ],
      "ShippingOptions":[
         {
            "SupplierId":"993c939a-a2e8-4934-bbf5-390f37457a55",
            "ShippingMode":"0",
            "ShippingModeId":0,
            "isselected":true
         }
      ],
      "PaymentOptionsChannel":[
         {
            "MerchantId":"993c939a-a2e8-4934-bbf5-390f37457a55",
            "PaymentType":"COD",
            "Paymentoption":"COD",
            "GatewayId":"0",
            "GatewayTitle":"COD",
            "PaidAmount":0.0,
            "EnalbeOTP":false
         },
         {
            "MerchantId":"993c939a-a2e8-4934-bbf5-390f37457a55",
            "PaymentType":"ChequeDD",
            "Paymentoption":"ChequeDD",
            "GatewayId":"10994",
            "GatewayTitle":"ChequeDD",
            "PaidAmount":0.0,
            "EnalbeOTP":false
         },
         {
            "MerchantId":"993c939a-a2e8-4934-bbf5-390f37457a55",
            "PaymentType":"OnlineBankTrans",
            "Paymentoption":"OnlineBankTransfer",
            "GatewayId":"10996",
            "GatewayTitle":"OnlineBankTrans",
            "PaidAmount":0.0,
            "EnalbeOTP":false
         }
      ],
      "ErrorCollection":null,
      "GiftMsg":"",
      "DemandedDeliveryDate":"1900-01-01T00:00:00Z",
      "RemainTotal":0.0,
      "ShippingZoneType":null,
      "DeliverySlotID":0,
      "FailedProducts":null,
      "PickupLastName":"Test",
      "PickupEmail":"",
      "PickupMobile":"91-9898989898",
      "LocationId":"24342",
      "TaxDetail":[

      ],
      "ComboSuggestion":[

      ],
      "ConvertedDeals":[

      ]
   },
   "ErrorCode":0
}

Adds products of a specific location to the cart.

Resource Information
URI /Carts/LocationCart/{merchantId}/{productId}/{varProductId}/{quantity}/{locationId}/{currency}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Carts/LocationCart/{merchantId}/{productId}/{varProductId}/{quantity}/{locationId}/{currency}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
productId* int Unique id the parent product that you want to add to cart
varProductId* string Unique variant id of the variant product
quantity* int Quantity of items that you want to add
locationId* int Location id of the current store location
currency* float Currency code as per the store location

Edit Cart Item

Lets you modify a current cart item with a different variant, quantity and bundle item.

Sample Request

https://www.martjack.com/developerapi/carts/edit/2002cbfe-9adf-42ac-9bfd-8e013fee7c18

Sample POST Request

InputData={
   "CartID":"5yef3kq51no12tgqwmyqdtsy",
   "DeliveryMode":"S",
   "Item":{
      "ProductID":8504427,
      "VariantProductID":0,
      "Quantity":1,
      "Status":"A",
      "LocationId":13250,
      "Portion":"W",
      "CartReferenceKey":"757eca2a-edac-435d-9025-0ecc3487d847",
      "Price":2.95,
      "ChildItem":[
         {
            "ProductID":8302873,
            "VariantProductID":55531,
            "Quantity":1,
            "Status":"A",
            "Portion":"W"
         },
         {
            "ProductID":8302905,
            "VariantProductID":55669,
            "Quantity":1,
            "Status":"A",
            "Portion":"W",
            "GroupID":25865
         },
         {
            "ProductID":8302895,
            "VariantProductID":55673,
            "Quantity":1,
            "Status":"A",
            "Portion":"W",
            "GroupID":25873
         }
      ]
   }
}&InputFormat=application/json

Sample Response

{
   "messageCode":"1004",
   "Message":"Successful",
   "Carts":{
      "MerchantId":"2002cbfe-9adf-42ac-9bfd-8e013fee7c18",
      "ProductCost":2.95,
      "ShippingCost":0.0,
      "VoucherDiscount":0.0,
      "PromotionDiscount":0.0,
      "TaxAmount":0.0,
      "OrderTotal":2.95,
      "VoucherCode":"",
      "UserSelectedCurrency":"KWD",
      "Bill_FirstName":null,
      "Bill_LastName":"",
      "Bill_Address1":"",
      "Bill_Address2":null,
      "Bill_CountryCode":"",
      "_Bill_StateCode":null,
      "Bill_City":"Other",
      "Bill_CityCode":"554",
      "Bill_OtherCityName":null,
      "Bill_Telephone":null,
      "Bill_Mobile":null,
      "Bill_PostCode":null,
      "Bill_Email":"",
      "Ship_FirstName":null,
      "Ship_LastName":"",
      "Ship_Address1":"",
      "Ship_Address2":null,
      "Ship_CountryCode":"KW",
      "Ship_StateCode":"KW13",
      "Ship_City":"39432",
      "Ship_CityCode":"39432",
      "Ship_OtherCityName":null,
      "Ship_Telephone":null,
      "Ship_Mobile":null,
      "Ship_PostCode":null,
      "Ship_Email":null,
      "CartItems":[
         {
            "ProductId":8504427,
            "VariantProductId":0,
            "MRP":2.95,
            "WebPrice":0.0,
            "Quantity":1.0,
            "description":"Margherita",
            "SupplierId":"2002cbfe-9adf-42ac-9bfd-8e013fee7c18",
            "CartReferenceKey":"fcea905c-281a-4d2f-9f25-bba358fd724c",
            "PriceCapped":false,
            "IsFreeProduct":false,
            "TotalCap":0,
            "CappedRefKey":"00000000-0000-0000-0000-000000000000",
            "CatalogpromotionDiscount":0.0,
            "BundleCartReferenceKey":"00000000-0000-0000-0000-000000000000",
            "BundleCartItems":[
               {
                  "ProductId":8302873,
                  "VariantProductId":55531,
                  "MRP":3.95,
                  "WebPrice":2.95,
                  "Quantity":1.0,
                  "description":"Margherita",
                  "SupplierId":"2002cbfe-9adf-42ac-9bfd-8e013fee7c18",
                  "CartReferenceKey":"ca541045-a4d3-4ff1-9bfa-5edfb00200f3",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0.0,
                  "BundleCartReferenceKey":"fcea905c-281a-4d2f-9f25-bba358fd724c",
                  "ItemPromotionDiscountAmount":0.0,
                  "IsPrimaryProduct":true,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[
                     {
                        "PropertyName":"Crust",
                        "Value":"San Francisco"
                     },
                     {
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[

                  ],
                  "CategoryId":"CU00215634",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":25857
               },
               {
                  "ProductId":8302905,
                  "VariantProductId":55669,
                  "MRP":0.5,
                  "WebPrice":0.0,
                  "Quantity":1.0,
                  "description":"Mozarella",
                  "SupplierId":"2002cbfe-9adf-42ac-9bfd-8e013fee7c18",
                  "CartReferenceKey":"fe969f1b-a3a7-4907-9df4-fa130709056e",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0.0,
                  "BundleCartReferenceKey":"fcea905c-281a-4d2f-9f25-bba358fd724c",
                  "ItemPromotionDiscountAmount":0.0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[
                     {
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[

                  ],
                  "CategoryId":"CU00217392",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":25865
               },
               {
                  "ProductId":8302895,
                  "VariantProductId":55673,
                  "MRP":0.5,
                  "WebPrice":0.0,
                  "Quantity":1.0,
                  "description":"Pizza Sauce",
                  "SupplierId":"2002cbfe-9adf-42ac-9bfd-8e013fee7c18",
                  "CartReferenceKey":"7f2cb6a7-9787-4d56-bcda-a8a5980ca9bf",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0.0,
                  "BundleCartReferenceKey":"fcea905c-281a-4d2f-9f25-bba358fd724c",
                  "ItemPromotionDiscountAmount":0.0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[
                     {
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     },
                     {
                        "PropertyName":"Size",
                        "Value":"Medium"
                     }
                  ],
                  "Por":"W",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[

                  ],
                  "CategoryId":"CU00217392",
                  "CategoryName":null,
                  "BrandId":"BB1760",
                  "BrandName":"Pizza Hut",
                  "GroupId":25873
               }
            ],
            "ItemPromotionDiscountAmount":0.0,
            "IsPrimaryProduct":false,
            "IsPromotionProduct":false,
            "Por":"",
            "IsDefaultBundleItem":false,
            "ProductImage":"//imagecdn.pizzahut.me/azure//yum-resources/2002cbfe-9adf-42ac-9bfd-8e013fee7c18/Images/ProductImages/Large/PWA-Margherita.jpg;width=100;height=100;scale=canvas;anchor=bottomcenter",
            "CartPromotionRules":[

            ],
            "CategoryId":"CU00215658",
            "CategoryName":"Vegetarian",
            "BrandId":"BB1760",
            "BrandName":"Pizza Hut",
            "ParentCartItems":null
         }
      ],
      "Suppliers":[
         {
            "SupplierId":"2002cbfe-9adf-42ac-9bfd-8e013fee7c18",
            "SupplierName":"Pizza Hut",
            "IsSelected":false,
            "OrderStatus":null
         }
      ],
      "ShippingOptions":[
         {
            "SupplierId":"2002cbfe-9adf-42ac-9bfd-8e013fee7c18",
            "ShippingMode":"9276",
            "ShippingModeId":9276,
            "isselected":true
         }
      ],
      "PaymentOptionsChannel":[
         {
            "MerchantId":"2002cbfe-9adf-42ac-9bfd-8e013fee7c18",
            "PaymentType":"COD",
            "Paymentoption":"COD",
            "GatewayId":"0",
            "GatewayTitle":"COD",
            "PaidAmount":0.0,
            "EnalbeOTP":false
         },
         {
            "MerchantId":"2002cbfe-9adf-42ac-9bfd-8e013fee7c18",
            "PaymentType":"Credit",
            "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":[

      ]
   },
   "ErrorCode":0
}

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

Request URL

{host}/developerapi/carts/edit/{merchantId}

Additional Header Required

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

Request Body Parameters

Parameter Type Description
CartID* string Unique id of the current cart
DeliveryMode enum Mode of delivery. Value: H for home delivery, S for takeaway
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

Update Quantity of a Cart Item

Sample Request

https://www.martjack.com/developerapi/Carts/Update/dc21b529-2057-402a-972a-e1ba0c8a08eb/4a2a68a9-208d-4039-8635-7d26611f4dcd/3

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "Carts":{  
      "MerchantId":"dc21b529-2057-402a-972a-e1ba0c8a08eb",
      "ProductCost":0.75,
      "ShippingCost":50,
      "VoucherDiscount":0,
      "PromotionDiscount":0.025,
      "TaxAmount":0.03,
      "OrderTotal":50.255,
      "VoucherCode":"",
      "UserSelectedCurrency":"INR",
      "Bill_FirstName":"Smoke",
      "Bill_LastName":"Automation",
      "Bill_Address1":"Hyderabad",
      "Bill_Address2":"Hyderabad",
      "Bill_CountryCode":"IN",
      "_Bill_StateCode":"TG",
      "Bill_City":"Hyderabad",
      "Bill_CityCode":"195",
      "Bill_OtherCityName":"",
      "Bill_Telephone":"-8899887xxx",
      "Bill_Mobile":"91-8899887xxx",
      "Bill_PostCode":"500002",
      "Bill_Email":"store2@example.com",
      "Ship_FirstName":"Smoke",
      "Ship_LastName":"Automation",
      "Ship_Address1":"Hyderabad",
      "Ship_Address2":"Hyderabad",
      "Ship_CountryCode":"IN",
      "Ship_StateCode":"TG",
      "Ship_City":"195",
      "Ship_CityCode":"195",
      "Ship_OtherCityName":"",
      "Ship_Telephone":"-8899887xxx",
      "Ship_Mobile":"91-8899887xxx",
      "Ship_PostCode":"500002",
      "Ship_Email":"store2@qaenv1.com",
      "CartItems":[  
         {  
            "ProductId":13071204,
            "VariantProductId":0,
            "MRP":0.25,
            "WebPrice":0.25,
            "Quantity":3,
            "description":"7Up Can",
            "SupplierId":"dc21b529-2057-402a-972a-e1ba0c8a08eb",
            "CartReferenceKey":"d2defd3d-a8d3-49cb-9f75-b521cd3f9568",
            "IsFreeProduct":false,
            "PriceCapped":false,
            "TotalCap":0,
            "CappedRefKey":"00000000-0000-0000-0000-000000000000",
            "CatalogpromotionDiscount":0,
            "BundleCartReferenceKey":"00000000-0000-0000-0000-000000000000",
            "IsPrimaryProduct":false,
            "ItemPromotionDiscountAmount":0.025,
            "IsPromotionProduct":false,
            "Por":"",
            "IsDefaultBundleItem":false,
            "ProductImage":"//images.sg.content-cdn.io/cdn//in-resources/dc21b529-2057-402a-972a-e1ba0c8a08eb/Images/ProductImages/Source/7up_showcase-min.png;width=100;height=100;scale=canvas;anchor=bottomcenter",
            "CartPromotionRules":[  
               {  
                  "Description":"Sample description",
                  "DiscountAmount":0.025,
                  "RuleId":33742,
                  "Title":"Sample Rule",
                  "VoucherCode":""
               }
            ],
            "CategoryId":"CU00368302",
            "CategoryName":null,
            "BrandId":"316792",
            "BrandName":"PizzaHut",
            "ParentCartItems":null
         }
      ],
      "Suppliers":[  
         {  
            "SupplierId":"dc21b529-2057-402a-972a-e1ba0c8a08eb",
            "SupplierName":"Testorg13",
            "IsSelected":false,
            "OrderStatus":null
         }
      ],
      "ShippingOptions":[  
         {  
            "SupplierId":"dc21b529-2057-402a-972a-e1ba0c8a08eb",
            "ShippingMode":"12292",
            "ShippingModeId":12292,
            "isselected":true
         }
      ],
      "PaymentOptionsChannel":[  
         {  
            "MerchantId":"dc21b529-2057-402a-972a-e1ba0c8a08eb",
            "PaymentType":"Credit",
            "Paymentoption":"<div style=\"padding-left:30px;\"><img src=\"/images/paymentoptions/Payment_RazorPay.jpg\" style=\"margin-left:4px;\" /><div >You can pay using RazorPay</div></div>",
            "GatewayId":"13084",
            "GatewayTitle":"RazorPAy",
            "PaidAmount":0,
            "EnalbeOTP":false
         },

         {  
            "MerchantId":"dc21b529-2057-402a-972a-e1ba0c8a08eb",
            "PaymentType":"COD",
            "Paymentoption":"COD",
            "GatewayId":"0",
            "GatewayTitle":"COD",
            "PaidAmount":0,
            "EnalbeOTP":false
         }
      ],
      "ErrorCollection":null,
      "GiftMsg":"",
      "DemandedDeliveryDate":"/Date(-2208988800000)/",
      "RemainTotal":0,
      "ShippingZoneType":null,
      "DeliverySlotID":0,
      "FailedProducts":null,
      "PickupFirstName":"James",
      "PickupLastName":"Thomas",
      "PickupEmail":"store2@example.com",
      "PickupMobile":"91-8899887888",
      "LocationId":"0",
      "TaxDetail":[  
         {  
            "TaxCategory":"CGST",
            "TaxRate":"6",
            "TaxAmount":0.015,
            "IsTaxRatePercentage":false,
            "TaxCode":"0",
            "TaxCategoryID":"4542"
         },
         {  
            "TaxCategory":"SGST",
            "TaxRate":"6",
            "TaxAmount":0.0135,
            "IsTaxRatePercentage":false,
            "TaxCode":"0",
            "TaxCategoryID":"4544"
         },
         {  
            "TaxCategory":"IGST",
            "TaxRate":"0",
            "TaxAmount":0,
            "IsTaxRatePercentage":false,
            "TaxCode":"0",
            "TaxCategoryID":"4546"
         }
      ],
      "ComboSuggestion":[  

      ],
      "ConvertedDeals":[  

      ]
   },
   "FailedItems":[  

   ],
   "ErrorCode":0
}

Updates the quantity of a specific item in the cart.

Resource Information
URI /Carts/Update/{merchantId}/{cartReferenceKey}/{new quantity}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Carts/Update/{merchantId}/{cartReferenceKey}/{new quantity}

Additional Header Required

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

Request Query Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant associated to the cart
cartReferenceKey* string Unique reference id of the cart item that you want to update
new quantity* string The new quantity of the current cart item. This will override the existing value

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
SupplierId Unique GUID of the merchant (product supplier)
IsFreeProduct boolean Whether the product is a gift item or deal item available for free

Update Cart Properties

Sample Request

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

Sample POST Request

InputFormat=application/json&InputData={
   "DeliverySlotID":415329,
   "DemandedDeliveryDate":"09-06-2018 15:15:00",
   "ShippingModeId":0,
   "locationID":121212,
   "BillingAddress":{  
      "FirstName":"Tom",
      "LastName":"Sawyer",
      "Street":"MG Road",
      "Street1":"Sham Plaza, Bangalore, India",
      "Country":"IN",
      "State":"KA",
      "City":"23924",
      "CityName":"23924",
      "OtherCityName":null,
      "Phone":"9967819918",
      "Mobile":"9967819918",
      "PIN":"744103",
      "EmailID":"tom.sawyer@example.com",
      "Type":null,
      "AddressType":null,
      "Latitude":11.6233774,
      "Longitude":92.7264828
   },
   "ShippingAddress":{  
      "FirstName":"Tom",
      "LastName":null,
      "Street":"MG Road",
      "Street1":"Sham Plaza, Bangalore, India",
      "Country":"IN",
      "State":"KA",
      "City":"23924",
      "CityName":"23924",
      "OtherCityName":null,
      "Phone":"",
      "Mobile":"9967000000",
      "PIN":"744103",
      "EmailID":"tom.sawyer@example.com",
      "Type":null,
      "AddressType":null,
      "Latitude":11.6233774,
      "Longitude":92.7264828
   },
   "OrderAttributes":[  
      {  
         "EntityFieldID":1,
         "MerchantID":"81e77da2-723b-483d-8c0d-49f800c1e288",
         "EntityFieldName":"phIndiatest",
         "Type":"1",
         "IsPredefined":false,
         "IsMandatory":true,
         "SelectedValue":"test",
         "lstOMSEntityFieldValues":[  
            {  
               "EntityFieldValueID":1,
               "MerchantID":"81e77da2-723b-483d-8c0d-49f800c1e288",
               "EntityFieldID":1,
               "Value":"test",
               "IsSelected":true
            }
         ]
      },
      {  
         "EntityFieldID":2,
         "MerchantID":"00000000-0000-0000-0000-000000000000",
         "EntityFieldName":"channel",
         "Type":"1",
         "IsPredefined":true,
         "IsMandatory":true,
         "SelectedValue":"PWA,android",
         "lstOMSEntityFieldValues":[  
            {  
               "EntityFieldValueID":2,
               "MerchantID":"00000000-0000-0000-0000-000000000000",
               "EntityFieldID":2,
               "Value":"PWA,android",
               "IsSelected":true
            }
         ]
      }
   ],
   "MerchantID":"81e77da2-723b-483d-8c0d-49f800c1e288",
   "IsShippingAddressDifferent":"false",
   "SkipDeliveryAreaValidation":true,
   "SkipShippingModeValidation":false
}

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":"9967810000",
      "LocationId":"22612",
      "TaxDetail":[  

      ],
      "ComboSuggestion":[  

      ],
      "ConvertedDeals":[  

      ]
   },
   "ErrorCode":0
}

Updates existing checkout details such as Add delivery slot, add shipping address, add order attributes, and location id. However, country, state, and city code has to be as per the values specified by the customer before adding items to the cart.

Resource Information

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

Request URL

{host}/developerapi/carts/UpdateCartProperties/{merchantId}

Additional Header Required

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

Request Body Parameters

Parameter Type Description
DeliverySlotID* string The unique id of the delivery slot. Specify a valid id
DemandedDeliveryDate* date-time The customer’s preferred delivery date in MM-DD-YYYY HH:MM:SS format
ShippingModeId int -NA for now-
locationID int The location id of the fulfillment store
BillingAddress obj Specify the billing address of the customer in the respective attributes
ShippingAddress obj Specify the preferred shipping address of the customer in the respective attributes
OrderAttributes obj Provide the details of order attributes that you want to add/update in the parameters explained below
EntityFieldID int Specify the id of the order attribute that you want to update
MerchantID string The unique id (GUID) of the merchant
EntityFieldName string Specify the name of the order attribute that you want to update
Type enum Specify the type of the field area. 1 for single select drop-down box, 2 for radio button, 3 for check-box type
IsPredefined boolean Specify true if the order attribute is predefined in the Control Panel, specify false if free-flow values
IsMandatory boolean Specify true if the order attribute is set as a mandatory field, else specify false
SelectedValue boolean Specify true if the input for the order attribute is mandatory, else specify false
lstOMSEntityFieldValues string For predefined order attribute values (IsPredefined is true) provide values of the attribute as per options configured on Control Panel
EntityFieldValueID string Specify the unique id the order attribute value. Applicable for predefined only attribute names and values (IsPredefined is true)
EntityFieldID string Specify the unique id the order attribute name that you want to input for predefined attribute name and values (IsPredefined is true)
Value string Specify the value of the order attribute that you want to set for the customer. You can use this for free-flow attribute values (IsPredefined is false)
IsSelected boolean Whether the selected attribute value is applicable for the customer or not

Get Cart Items

Retrieves cart items of the user based on the current session.

Sample Request

https://www.martjack.com/developerapi/Carts/cart/81e77da2-723b-483d-8c0d-49f800c1exxx?promotionDetails=true

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":"Tom",
      "Ship_LastName":"Sawyer",
      "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": [],
       "BusinessRuleDescriptionView": [],
       "AppliedPromotionDetailsList": [
           {
               "PromotionId": 40981,
               "PromotionTitle": "user group",
               "VoucherCode": null,
               "PromotionAction": 6,
               "RuleMessage": "",
               "Description": "",
               "DiscountAmount": 18
           }
       ]
   },
   "Token": {
       "AccessToken": "5dp0j3mnzizmldsfb20lfnq5",
       "issued_at": "/Date(1565263998649+0530)/",
       "UserId": "5e9bd7d6-148b-496b-aa14-93a4b1bf662a",
       "IsLoggedInUser": false,
       "MerchantId": "efad5608-a459-449d-87a0-894082c2b6b0"
   },
   "ErrorCode":0
}

Resource Information
URI /Carts/cart/{merchantId}?promotionDetails=true
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Carts/cart/{merchantId}?promotionDetails=true

Additional Header Required

Header Description
accesstoken* Access token of the logged in user to validate the session
languageCode Specify the ISO language code to get cart promotion break-up details in your preferred language. For example, zh for Chinese, id for Indonesian, ar for Arabic. English is the default language.

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
promotionDetails boolean Pass true to retrieve promotion break up details

Get Cart Items (by AccessToken)

Retrieves cart items of the user based on the current session.

Sample Request

https://www.martjack.com/developerapi/Carts/cart/81e77da2-723b-483d-8c0d-49f800c1exxx/fj2vrg1g3bpppsypqn4ynxrt

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":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":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
}

Resource Information
URI /Carts/cart/{merchantId}/{accesstoken}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Carts/cart/{merchantId}/{accesstoken}

Additional Header Required

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

Remove a Cart Item

Removes an item of a specific quantity from the current cart.

Sample Request

https://www.martjack.com/developerapi/Carts/Remove/{MerchantId}/{cartReferneKey}/{quantity}

Sample Response

{

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

Resource Information
URI /Carts/Remove/{MerchantId}/{cartReferneKey}/{quantity}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Carts/Remove/{MerchantId}/{cartReferneKey}/{quantity}

Additional Header Required

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

Request Path Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchant
cartReferenceKey* string Unique reference key of the cart item that you want to remove
quantity* int Quantity of the items that you want to remove

Remove All Cart Items

Sample Request

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

Sample Response

{

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

Removes all items of the current cart. This does not remove shipping address, billing address or location information.

Resource Information
URI /Carts/RemoveAll/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Carts/RemoveAll/{merchantId}

Additional Header Required

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

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant

Clear Cart Items

Removes entire cart details which include cart items, location, billing address and shipping address.

Sample Request

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

Sample Response

{

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

Resource Information
URI /Carts/clear/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Carts/clear/{MerchantId}

Additional Header Required

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

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant

Add Order Attributes

Adds order attributes to the cart items which will be reflected once the order is placed. Order attributes are custom fields of an order.

Sample Request

https://www.martjack.com/developerapi/carts/AddOrderAttributes/98d18d82-ba59-4957-9c92-3f89207a34f6

Sample POST Request

InputFormat=application/json&InputData=[
   {
      "EntityFieldID":1,
      "EntityFieldName":"IsImmediateOrder",
      "Type":"1",
      "IsPredefined":true,
      "IsMandatory":true,
      "SelectedValue":"true",
      "OrderEntityFieldValues":[
         {
            "EntityFieldValueID":1,
            "EntityFieldID":1,
            "Value":"true",
            "IsSelected":true
         }
      ]
   },
   {
      "EntityFieldID":2,
      "EntityFieldName":"channel",
      "Type":"1",
      "IsPredefined":true,
      "IsMandatory":true,
      "SelectedValue":"APP,android",
      "OrderEntityFieldValues":[
         {
            "EntityFieldID":2,
            "EntityFieldValueID":2,
            "Value":"APP,android",
            "IsSelected":true
         }
      ]
   }
]

Sample Response

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

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

Request URL

{host}/developerapi/carts/AddOrderAttributes/{merchantId}

Additional Header Required

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

Request Body Parameters

Parameter Type Description
EntityFieldID* int Unique id of the order attribute
EntityFieldName string Name of the attribute
Type enum Specify the type of the field area. 1 for single select drop-down box, 2 for radio button, 3 for check-box type
IsPredefined boolean Whether the current attribute is predefined (true) or user defined (false)
IsMandatory boolean Whether the current attribute is mandatory (true) or optional (false)
SelectedValue string Value selected for the specified attribute

Update Address

Sample Request

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

Sample POST Request

InputFormat=application/json&InputData={
   "Cart":{
      "BillFirstName":"Tom Sawyer",
      "BillLastName":"Sawyer",
      "BillEmail":"tom.sawyer@example.com",
      "BillMobile":"",
      "BillCountry":"India",
      "BillZip":"",
      "BillCity":"2148",
      "BillCountryCode":"IN",
      "BillOtherCity":"",
      "BillState":"KA",
      "BillAddress":"#103/1, MG Road",
      "BillAddress1":"#31-220, Town Hall Road",
      "BillTelephone":"",
      "BillTelephoneCode":"",
      "BillMobileCode":"",
      "ShipFirstName":"Tom",
      "ShipLastName":"Sawyer",
      "ShipEmail":"tom.sawyer@example.com",
      "ShipTelephone":"1234567899",
      "ShipState":"KA",
      "ShipMobile":"1234567899",
      "ShipCountryCode":"IN",
      "ShipAddress2":"",
      "ShipMobileCode":"",
      "ShipOtherCity":"",
      "ShipAddress1":"",
      "ShipCity":"2148",
      "ShipZip":"",
      "ShipTelephoneCode":"",
      "ShipCountry":"India",
      "SkipDeliveryAreaValidation":"false",
      "IsShippingAddressDifferent":"false"
   }
}

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "Carts": {
        "MerchantId": "81e77da2-723b-483d-8c0d-49f800c1e288",
        "ProductCost": 60.528000000000006,
        "ShippingCost": 12.9,
        "VoucherDiscount": 0,
        "PromotionDiscount": 0,
        "TaxAmount": 0,
        "OrderTotal": 73.428,
        "VoucherCode": "",
        "UserSelectedCurrency": "OMR",
        "Bill_FirstName": "AutoTestNameBillg23fff",
        "Bill_LastName": "AutoTestLastNameBill",
        "Bill_Address1": "AutoTestAddres1Bill",
        "Bill_Address2": "",
        "Bill_CountryCode": "OM",
        "_Bill_StateCode": "OM1",
        "Bill_City": "AL KHUWAIR",
        "Bill_CityCode": "2148",
        "Bill_Telephone": "9967819918",
        "Bill_Mobile": "9967819918",
        "Bill_PostCode": "",
        "Bill_Email": "",
        "Ship_FirstName": "AutoTestNameBillg23fff",
        "Ship_LastName": "AutoTestLastNameBill",
        "Ship_Address1": "AutoTestAddres1Bill",
        "Ship_Address2": "",
        "Ship_CountryCode": "OM",
        "Ship_StateCode": "OM1",
        "Ship_City": "2148",
        "Ship_CityCode": "2148",
        "Ship_OtherCityName": "",
        "Ship_Telephone": "9967819918",
        "Ship_Mobile": "9967819918",
        "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-4f9d97536099",
                "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-49f800c1e288",
                        "CartReferenceKey": "ab59003f-81b5-45ea-8de8-4cd76f9be21e",
                        "TotalCap": 0,
                        "CatalogpromotionDiscount": 0,
                        "BundleCartReferenceKey": "ff462a81-699f-4798-9b73-4f9d97536099",
                        "ItemPromotionDiscountAmount": 0,
                        "IsPrimaryProduct": false,
                        "IsPromotionProduct": false,
                        "VariantsInfo": [],
                        "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-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": "Pizza Hut test",
                "IsSelected": false,
                "OrderStatus": null
            }
        ],
        "ShippingOptions": [
            {
                "SupplierId": "81e77da2-723b-483d-8c0d-49f800c1xxxx",
                "ShippingMode": "12174",
                "ShippingModeId": 12174,
                "isselected": true
            }
        ],
        "PaymentOptionsChannel": [
            {
                "MerchantId": "81e77da2-723b-483d-8c0d-49f800c1e288",
                "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": [],
        "ConvertedDeals": []
    },
    "ErrorCode": 0
}

Updates shipping address and billing address of an order.

Resource Information

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

Request URL

{host}/developerapi/carts/UpdateAddress/{merchantId}

Additional Header Required

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

Request Body Parameters

Parameter Type Description
BillingAddress obj Specify the billing address of the customer in the respective attributes
ShippingAddress obj Specify the preferred shipping address of the customer in the respective attributes
BillMobile string Mobile number of the customer as per the billing address
BillCountry string Full name of the country associated to the billing address
BillZip string ZIP code of the billing address
BillCity string City name of the billing address
BillCountryCode string Alpha-2 code of the country with respect to the billing address. Example: IN (for India), AU (for Australia), and BR (for Brazil)
BillLastName string Last name of the customer as per the billing address
BillState string Full name of the state associated to the billing address
BillAddress string Specify door number, building name, street, area and and other details of the billing address
BillAddress1 string Specify any missing information in the BillAddress. For example, landmark
BillTelephone string Land line number associated to the billing address (without STD code)
BillTelephoneCode string STD code of the land line number
BillMobileCode, ShipLastName,ShipTelephone.. obj Similar to the billing address details, specify the shipping address in respective fields
SkipDeliveryAreaValidation boolean Specify true to validate the delivery location before updating the details. Specify false to ignore shipping area validation
IsShippingAddressDifferent boolean Specify true if shipping address is different from the billing address, specify false if shipping and billing addresses are same. You can just pass billing address details and make this attribute 'false’ to automatically consider billing address as shipping address

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
IsFreeProduct boolean If the item is a gift item and is given for free of cost
PriceCapped float -Deprecated-
TotalCap float -Deprecated-
CappedRefKey string -Deprecated-
SupplierId string Unique GUID of the merchant (product supplier)
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)
GroupId int Unique group id associated to the product. Applicable for bundle or deal products

Apply Voucher to Cart Items

Sample Request

https://www.martjack.com/developerapi/Carts/ApplyVoucher/f48fdd16-92db-4188-854d-1ecd9b62xxxx/SAMPLE123

Sample Response

{  
   "messageCode":"1004",
   "Message":"Discount Voucher SAMPLE123 has been applied successfully",
   "Carts":{  
      "MerchantId":"dc21b529-2057-402a-972a-e1ba0c8a08eb",
      "ProductCost":0.75,
      "ShippingCost":50,
      "VoucherDiscount":10,
      "PromotionDiscount":0.025,
      "TaxAmount":0.03,
      "OrderTotal":50.255,
      "VoucherCode":"",
      "UserSelectedCurrency":"INR",
      "Bill_FirstName":"Smoke",
      "Bill_LastName":"Automation",
      "Bill_Address1":"Hyderabad",
      "Bill_Address2":"Hyderabad",
      "Bill_CountryCode":"IN",
      "_Bill_StateCode":"TG",
      "Bill_City":"Hyderabad",
      "Bill_CityCode":"195",
      "Bill_OtherCityName":"",
      "Bill_Telephone":"-8899887xxx",
      "Bill_Mobile":"91-8899887xxx",
      "Bill_PostCode":"500002",
      "Bill_Email":"store2@example.com",
      "Ship_FirstName":"Smoke",
      "Ship_LastName":"Automation",
      "Ship_Address1":"Hyderabad",
      "Ship_Address2":"Hyderabad",
      "Ship_CountryCode":"IN",
      "Ship_StateCode":"TG",
      "Ship_City":"195",
      "Ship_CityCode":"195",
      "Ship_OtherCityName":"",
      "Ship_Telephone":"-8899887xxx",
      "Ship_Mobile":"91-8899887xxx",
      "Ship_PostCode":"500002",
      "Ship_Email":"store2@qaenv1.com",
      "CartItems":[  
         {  
            "ProductId":13071204,
            "VariantProductId":0,
            "MRP":0.25,
            "WebPrice":0.25,
            "Quantity":3,
            "description":"7Up Can",
            "SupplierId":"dc21b529-2057-402a-972a-e1ba0c8a08eb",
            "CartReferenceKey":"d2defd3d-a8d3-49cb-9f75-b521cd3f9568",
            "IsFreeProduct":false,
            "PriceCapped":false,
            "TotalCap":0,
            "CappedRefKey":"00000000-0000-0000-0000-000000000000",
            "CatalogpromotionDiscount":0,
            "BundleCartReferenceKey":"00000000-0000-0000-0000-000000000000",
            "IsPrimaryProduct":false,
            "ItemPromotionDiscountAmount":0.025,
            "IsPromotionProduct":false,
            "Por":"",
            "IsDefaultBundleItem":false,
            "ProductImage":"//images.sg.content-cdn.io/cdn//in-resources/dc21b529-2057-402a-972a-e1ba0c8a08eb/Images/ProductImages/Source/7up_showcase-min.png;width=100;height=100;scale=canvas;anchor=bottomcenter",
            "CartPromotionRules":[  
               {  
                  "Description":"Sample description",
                  "DiscountAmount":10,
                  "RuleId":33742,
                  "Title":"Sample Rule",
                  "VoucherCode":"SAMPLE123"
               }
            ],
            "CategoryId":"CU00368302",
            "CategoryName":null,
            "BrandId":"316792",
            "BrandName":"PizzaHut",
            "ParentCartItems":null
         }
      ],
      "Suppliers":[  
         {  
            "SupplierId":"dc21b529-2057-402a-972a-e1ba0c8a08eb",
            "SupplierName":"Testorg13",
            "IsSelected":false,
            "OrderStatus":null
         }
      ],
      "ShippingOptions":[  
         {  
            "SupplierId":"dc21b529-2057-402a-972a-e1ba0c8a08eb",
            "ShippingMode":"12292",
            "ShippingModeId":12292,
            "isselected":true
         }
      ],
      "PaymentOptionsChannel":[  
         {  
            "MerchantId":"dc21b529-2057-402a-972a-e1ba0c8a08eb",
            "PaymentType":"Credit",
            "Paymentoption":"<div style=\"padding-left:30px;\"><img src=\"/images/paymentoptions/Payment_RazorPay.jpg\" style=\"margin-left:4px;\" /><div >You can pay using RazorPay</div></div>",
            "GatewayId":"13084",
            "GatewayTitle":"RazorPAy",
            "PaidAmount":0,
            "EnalbeOTP":false
         },

         {  
            "MerchantId":"dc21b529-2057-402a-972a-e1ba0c8a08eb",
            "PaymentType":"COD",
            "Paymentoption":"COD",
            "GatewayId":"0",
            "GatewayTitle":"COD",
            "PaidAmount":0,
            "EnalbeOTP":false
         }
      ],
      "ErrorCollection":null,
      "GiftMsg":"",
      "DemandedDeliveryDate":"/Date(-2208988800000)/",
      "RemainTotal":0,
      "ShippingZoneType":null,
      "DeliverySlotID":0,
      "FailedProducts":null,
      "PickupFirstName":"James",
      "PickupLastName":"Thomas",
      "PickupEmail":"store2@example.com",
      "PickupMobile":"91-8899887888",
      "LocationId":"0",
      "TaxDetail":[  
         {  
            "TaxCategory":"CGST",
            "TaxRate":"6",
            "TaxAmount":0.015,
            "IsTaxRatePercentage":false,
            "TaxCode":"0",
            "TaxCategoryID":"4542"
         },
         {  
            "TaxCategory":"SGST",
            "TaxRate":"6",
            "TaxAmount":0.0135,
            "IsTaxRatePercentage":false,
            "TaxCode":"0",
            "TaxCategoryID":"4544"
         },
         {  
            "TaxCategory":"IGST",
            "TaxRate":"0",
            "TaxAmount":0,
            "IsTaxRatePercentage":false,
            "TaxCode":"0",
            "TaxCategoryID":"4546"
         }
      ],
      "ComboSuggestion":[  

      ],
      "ConvertedDeals":[  

      ]
   },
   "FailedItems":[  

   ],
   "ErrorCode":0
}

Lets you redeem a voucher on the cart items. You can use either a discount voucher or rule based voucher.

Resource Information
URI /Carts/ApplyVoucher/{merchantId}/{voucherCode}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Carts/ApplyVoucher/{merchantId}/{voucherCode}

Additional Header Required

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

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
voucherCode* string The voucher code that you want to apply

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
IsFreeProduct boolean If the item is a gift item and is given for free of cost
PriceCapped float Deprecated
TotalCap float Deprecated
CappedRefKey string Deprecated
SupplierId string Unique GUID of the merchant (supplier of the product)
Por enum The portion of the product for which the voucher is applied. Value: W for whole, R for right, L for left (left, right usually applies for toppings)
GroupId int Determines the bundle group id of the nested cart item. Applicable for bundle products
ComboSuggestion array Product suggestions based on the cart items to increase the basket/cart size

Error Codes

The following tables shows error codes for different validation parameter. For example, mismatch in location, invoice number, user type and so on.

Case Cart Voucher Campaign Voucher
Location 3002
Voucher not applicable for your location {locationId}		 NA
UserType 3006
Invalid Customer type		 3006
Invalid Customer type
Cart condition & action condition 3012
Coupon not applicable		 3009
Minimum Cart amount not reached for this voucher
Inactive 3001
Invalid Coupon Code		 3001
Invalid Coupon Code
CurrentDate > EndDate 3001
Invalid Coupon Code		 3001
Invalid Coupon Code
CurrentDate < StartDate 3001
Invalid Coupon Code		 3008
Expired Coupon Code
USerLimit exceeded 3004
Coupon usage limit for user exceeded		 3004
Coupon usage limit for user exceeded
VoucherLimit exceeded 3005
Coupon usage limit exceeded		 3005
Coupon usage limit exceeded
Vouchercode not exist 3001
Invalid Coupon Code		 NA

Remove Applied Voucher

Sample Request

https://www.martjack.com/developerapi/Carts/RemoveVoucher/f48fdd16-92db-4188-854d-1ecd9b62xxxx/SAMPLE123

Sample Response

{  
   "messageCode":"1004",
   "Message":"Discount Voucher SAMPLE123 has been Removed  successfully",
   "Carts":{  
      "MerchantId":"dc21b529-2057-402a-972a-e1ba0c8a08eb",
      "ProductCost":0.75,
      "ShippingCost":50,
      "VoucherDiscount":10,
      "PromotionDiscount":0.025,
      "TaxAmount":0.03,
      "OrderTotal":50.255,
      "VoucherCode":"",
      "UserSelectedCurrency":"INR",
      "Bill_FirstName":"Smoke",
      "Bill_LastName":"Automation",
      "Bill_Address1":"Hyderabad",
      "Bill_Address2":"Hyderabad",
      "Bill_CountryCode":"IN",
      "_Bill_StateCode":"TG",
      "Bill_City":"Hyderabad",
      "Bill_CityCode":"195",
      "Bill_OtherCityName":"",
      "Bill_Telephone":"-8899887xxx",
      "Bill_Mobile":"91-8899887xxx",
      "Bill_PostCode":"500002",
      "Bill_Email":"store2@example.com",
      "Ship_FirstName":"Smoke",
      "Ship_LastName":"Automation",
      "Ship_Address1":"Hyderabad",
      "Ship_Address2":"Hyderabad",
      "Ship_CountryCode":"IN",
      "Ship_StateCode":"TG",
      "Ship_City":"195",
      "Ship_CityCode":"195",
      "Ship_OtherCityName":"",
      "Ship_Telephone":"-8899887xxx",
      "Ship_Mobile":"91-8899887xxx",
      "Ship_PostCode":"500002",
      "Ship_Email":"store2@qaenv1.com",
      "CartItems":[  
         {  
            "ProductId":13071204,
            "VariantProductId":0,
            "MRP":0.25,
            "WebPrice":0.25,
            "Quantity":3,
            "description":"7Up Can",
            "SupplierId":"dc21b529-2057-402a-972a-e1ba0c8a08eb",
            "CartReferenceKey":"d2defd3d-a8d3-49cb-9f75-b521cd3f9568",
            "IsFreeProduct":false,
            "PriceCapped":false,
            "TotalCap":0,
            "CappedRefKey":"00000000-0000-0000-0000-000000000000",
            "CatalogpromotionDiscount":0,
            "BundleCartReferenceKey":"00000000-0000-0000-0000-000000000000",
            "IsPrimaryProduct":false,
            "ItemPromotionDiscountAmount":0.025,
            "IsPromotionProduct":false,
            "Por":"",
            "IsDefaultBundleItem":false,
            "ProductImage":"//images.sg.content-cdn.io/cdn//in-resources/dc21b529-2057-402a-972a-e1ba0c8a08eb/Images/ProductImages/Source/7up_showcase-min.png;width=100;height=100;scale=canvas;anchor=bottomcenter",
            "CartPromotionRules":[  
               {  
                  "Description":"Sample description",
                  "DiscountAmount":10,
                  "RuleId":33742,
                  "Title":"Sample Rule",
                  "VoucherCode":"SAMPLE123"
               }
            ],
            "CategoryId":"CU00368302",
            "CategoryName":null,
            "BrandId":"316792",
            "BrandName":"PizzaHut",
            "ParentCartItems":null
         }
      ],
      "Suppliers":[  
         {  
            "SupplierId":"dc21b529-2057-402a-972a-e1ba0c8a08eb",
            "SupplierName":"Testorg13",
            "IsSelected":false,
            "OrderStatus":null
         }
      ],
      "ShippingOptions":[  
         {  
            "SupplierId":"dc21b529-2057-402a-972a-e1ba0c8a08eb",
            "ShippingMode":"12292",
            "ShippingModeId":12292,
            "isselected":true
         }
      ],
      "PaymentOptionsChannel":[  
         {  
            "MerchantId":"dc21b529-2057-402a-972a-e1ba0c8a08eb",
            "PaymentType":"Credit",
            "Paymentoption":"<div style=\"padding-left:30px;\"><img src=\"/images/paymentoptions/Payment_RazorPay.jpg\" style=\"margin-left:4px;\" /><div >You can pay using RazorPay</div></div>",
            "GatewayId":"13084",
            "GatewayTitle":"RazorPAy",
            "PaidAmount":0,
            "EnalbeOTP":false
         },

         {  
            "MerchantId":"dc21b529-2057-402a-972a-e1ba0c8a08eb",
            "PaymentType":"COD",
            "Paymentoption":"COD",
            "GatewayId":"0",
            "GatewayTitle":"COD",
            "PaidAmount":0,
            "EnalbeOTP":false
         }
      ],
      "ErrorCollection":null,
      "GiftMsg":"",
      "DemandedDeliveryDate":"/Date(-2208988800000)/",
      "RemainTotal":0,
      "ShippingZoneType":null,
      "DeliverySlotID":0,
      "FailedProducts":null,
      "PickupFirstName":"James",
      "PickupLastName":"Thomas",
      "PickupEmail":"store2@example.com",
      "PickupMobile":"91-8899887888",
      "LocationId":"0",
      "TaxDetail":[  
         {  
            "TaxCategory":"CGST",
            "TaxRate":"6",
            "TaxAmount":0.015,
            "IsTaxRatePercentage":false,
            "TaxCode":"0",
            "TaxCategoryID":"4542"
         },
         {  
            "TaxCategory":"SGST",
            "TaxRate":"6",
            "TaxAmount":0.0135,
            "IsTaxRatePercentage":false,
            "TaxCode":"0",
            "TaxCategoryID":"4544"
         },
         {  
            "TaxCategory":"IGST",
            "TaxRate":"0",
            "TaxAmount":0,
            "IsTaxRatePercentage":false,
            "TaxCode":"0",
            "TaxCategoryID":"4546"
         }
      ],
      "ComboSuggestion":[  

      ],
      "ConvertedDeals":[  

      ]
   },
   "FailedItems":[  

   ],
   "ErrorCode":0
}

Removes an applied voucher from the current cart.

Resource Information
URI /Carts/RemoveVoucher/{merchantId}/{voucherCode}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Carts/RemoveVoucher/{merchantId}/{voucherCode}

Additional Header Required

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

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
voucherCode* string The applied voucher code that you want to remove from 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
ComboSuggestion array Suggestions related deal items based on the items in the cart
ConvertedDeals array The cart items that are converted to deal items automatically based on the items in the cart
Por enum The portion for which the product is applied. Value: W for whole, R for right, L for left (left, right usually applies for toppings)
IsDefaultBundleItem boolean Whether the current item is in the default bundle item (true) or customized bundle item (false)

Get Cart Promotions

Sample Request

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

Sample POST Request

InputFormat=application/json&InputData={
  "locationcode": "btm",
  "deliverymode": "ship",
  "promotiontype": "cart",
  "hasvouchers": "true",
  "fromdate": "2018-09-13",
  "todate": "2018-09-13",
  "activestatus": "true",
  "channeltype": "",
  "totime": "",  
  "externalcouponmapped": "",
  "userid": ""
}

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "EligiblePromotions": [
        {
            "promotionid": 30136,
            "promotionname": "CRMTest",
            "promotionrefcode": "9903",
            "description": "CRMTest",
            "locationcodes": [
                "0"
            ],
            "starttime": "/Date(1526992440000+0530)/",
            "endtime": "/Date(1582997160000+0530)/",
            "repetitive": true,
            "allowfurtherpromotions": true,
            "voucherbased": true,
            "firstactivevouchercode": ""
        },
        {
            "promotionid": 30198,
            "promotionname": "VoucherBasedPromotion",
            "promotionrefcode": "VoucherBasedPromotion",
            "description": "VoucherBasedPromotion",
            "locationcodes": [
                "BTM"
            ],
            "starttime": "/Date(1536175860000+0530)/",
            "endtime": "/Date(1538328600000+0530)/",
            "repetitive": true,
            "allowfurtherpromotions": true,
            "voucherbased": true,
            "firstactivevouchercode": "SmokeAutomation"
        }
    ],
    "ErrorCode": 0
}

Retrieves the list of offers of the merchant based on the input parameters.

Resource Information

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

Request URL

{host}/developerapi/carts/GetAllPromotions/{merchantId}

Additional Header Required

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

Request Body Parameters

Parameter Type Description
locationcode string The location code of the store to fetch offers associated to the specific store
deliverymode enum Filter results (promotions) by delivery mode. Values: ship to get promotions applicable only to online orders, pickup to get promotions on store pickup orders
promotiontype enum Filter results by promotion type. Values: cart for cart items based promotions, catalogue for catalogue based promotions
hasvouchers boolean Specify true to get the list of promotions that have coupon codes, false to get promotions that do not have any coupon codes. You can leave it blank to see both kind of promotions
fromdate date Get promotions available for a specific duration. Pass the duration in MM/DD/YY format in fromdate and todate respectively
todate date Get promotions available for a specific duration. Pass the duration in MM/DD/YY format between fromdate and todate
activestatus boolean Specify true to fetch the list of active promotions only, false to fetch both active and inactive coupons
channeltype string The channel from which the order is placed. Channel types are predefined in promotions in CP. Example values: Amazon, Myntra, Web
externalcouponmapped boolean Specify true to fetch promotions that are mapped to external coupons. For example, CRM coupons
userid string The unique GUID of the customer to fetch the list of promotions available for that specific customer

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
starttime date-time Start date and time of the current promotion
endtime date-time End date and time of the current promotion
repetitive boolean Whether the promotion rules are repeated for each item or not
allowfurtherpromotions boolean Whether further 'Cart Promotions’ is allowed to the cart item (even after applying a promotion)

Get Cart Payment Options

Sample Request

https://www.martjack.com/developerapi/Carts/PaymentOptions/2c7f2299-9129-4131-839f-b80663cec2e2

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "PaymentOptionsChannel": [
        {
            "MerchantId": "2c7f2299-9129-4131-839f-b80663cec2e2",
            "PaymentType": "5678",
            "Paymentoption": "5678",
            "GatewayId": "10957",
            "GatewayTitle": null,
            "PaidAmount": 0,
            "EnalbeOTP": false
        },
        {
            "MerchantId": "2c7f2299-9129-4131-839f-b80663cec2e2",
            "PaymentType": "Credit",
            "Paymentoption": "NETWORKONLINE",
            "GatewayId": "12309",
            "GatewayTitle": "Visa/ Master Card",
            "PaidAmount": 0,
            "EnalbeOTP": false
        },
        {
            "MerchantId": "2c7f2299-9129-4131-839f-b80663cec2e2",
            "PaymentType": "OnlineBankTrans",
            "Paymentoption": "OnlineBankTransfer",
            "GatewayId": "10925",
            "GatewayTitle": "Deposit to our Bank Account",
            "PaidAmount": 0,
            "EnalbeOTP": false
        },
        {
            "MerchantId": "2c7f2299-9129-4131-839f-b80663cec2e2",
            "PaymentType": "ChequeDD",
            "Paymentoption": "ChequeDD",
            "GatewayId": "10924",
            "GatewayTitle": "Send Cheque/DD to us",
            "PaidAmount": 0,
            "EnalbeOTP": false
        },
        {
            "MerchantId": "2c7f2299-9129-4131-839f-b80663cec2e2",
            "PaymentType": "Credit",
            "Paymentoption": "Capillary",
            "GatewayId": "12542",
            "GatewayTitle": "CRM Points",
            "PaidAmount": 0,
            "EnalbeOTP": false
        },
        {
            "MerchantId": "2c7f2299-9129-4131-839f-b80663cec2e2",
            "PaymentType": "Credit",
            "Paymentoption": "NOONPAY",
            "GatewayId": "12617",
            "GatewayTitle": "NoonPay",
            "PaidAmount": 0,
            "EnalbeOTP": false
        },
        {
            "MerchantId": "2c7f2299-9129-4131-839f-b80663cec2e2",
            "PaymentType": "COD",
            "Paymentoption": "COD",
            "GatewayId": "0",
            "GatewayTitle": "Pay Cash On Delivery",
            "PaidAmount": 0,
            "EnalbeOTP": false
        },
        {
            "MerchantId": "2c7f2299-9129-4131-839f-b80663cec2e2",
            "PaymentType": "Credit",
            "Paymentoption": "NeoNetwork",
            "GatewayId": "12659",
            "GatewayTitle": "Visa/ Master Card",
            "PaidAmount": 0,
            "EnalbeOTP": false
        },
        {
            "MerchantId": "2c7f2299-9129-4131-839f-b80663cec2e2",
            "PaymentType": "GV",
            "Paymentoption": "Gift Voucher",
            "GatewayId": null,
            "GatewayTitle": "Gift Voucher",
            "PaidAmount": 0,
            "EnalbeOTP": false
        }
    ],
    "ErrorCode": 0
}

Retrieves all the supported payment options of the current cart.

Resource Information
URI /Carts/PaymentOptions/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Carts/PaymentOptions/{merchantId}

Additional Header Required

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

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
EnalbeOTP boolean Whether OTP based authentication is required for that particular payment option

Update Shipping Mode

Sample Request

https://www.martjack.com/developerapi/Carts/ShippingMode/81e77da2-723b-483d-8c0d-49f800c1e288/2323/Change/false

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "Carts":{  
      "MerchantId":"81e77da2-723b-483d-8c0d-49f800c1e288",
      "ProductCost":60.528000000000006,
      "ShippingCost":12.9,
      "VoucherDiscount":0,
      "PromotionDiscount":0,
      "TaxAmount":0,
      "OrderTotal":73.428,
      "VoucherCode":"",
      "UserSelectedCurrency":"OMR",
      "Bill_FirstName":"AutoTestNameBillg23fff",
      "Bill_LastName":"AutoTestLastNameBill",
      "Bill_Address1":"AutoTestAddres1Bill",
      "Bill_Address2":"",
      "Bill_CountryCode":"OM",
      "_Bill_StateCode":"OM1",
      "Bill_City":"AL KHUWAIR",
      "Bill_CityCode":"2148",
      "Bill_Telephone":"9967819918",
      "Bill_Mobile":"9967819918",
      "Bill_PostCode":"",
      "Bill_Email":"",
      "Ship_FirstName":"AutoTestNameBillg23fff",
      "Ship_LastName":"AutoTestLastNameBill",
      "Ship_Address1":"AutoTestAddres1Bill",
      "Ship_Address2":"",
      "Ship_CountryCode":"OM",
      "Ship_StateCode":"OM1",
      "Ship_City":"2148",
      "Ship_CityCode":"2148",
      "Ship_OtherCityName":"",
      "Ship_Telephone":"9967819918",
      "Ship_Mobile":"9967819918",
      "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-4f9d97536099",
            "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-49f800c1e288",
                  "CartReferenceKey":"ab59003f-81b5-45ea-8de8-4cd76f9be21e",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0,
                  "BundleCartReferenceKey":"ff462a81-699f-4798-9b73-4f9d97536099",
                  "ItemPromotionDiscountAmount":0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  

                  ],
                  "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-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-49f800c11e288",
            "SupplierName":"Pizza Hut test",
            "IsSelected":false,
            "OrderStatus":null
         }
      ],
      "ShippingOptions":[  
         {  
            "SupplierId":"81e77da2-723b-483d-8c0d-49f800c1e288",
            "ShippingMode":"2323",
            "ShippingModeId":2323,
            "isselected":true
         }
      ],
      "PaymentOptionsChannel":[  
         {  
            "MerchantId":"81e77da2-723b-483d-8c0d-49f800c1e288",
            "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":[  

      ],
      "ConvertedDeals":[  

      ]
   },
   "ErrorCode":0
}

Updates shipping mode of the cart for the current customer.

Resource Information
URI /Carts/ShippingMode/{merchantId}/{shippingModeID}/Change/{ispickupshippingMode}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Carts/ShippingMode/{merchantId}/{shippingModeID}/Change/{ispickupshippingMode}

Additional Header Required

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

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
shippingModeID* int Unique id of the new shipment mode
ispickupshippingMode* boolean Specify true for in store pickup, else specify false

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
IsFreeProduct boolean Whether the current item is a gift product that is given for free or along with other product
PriceCapped boolean -NA-
CatalogpromotionDiscount float Catalog promotion discount amount applied on the cart items

Set Delivery Slot

Sample Request

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

Sample POST Request

InputFormat=application/json&InputData={  
   "DeliverySlotId":59849,
   "DeliveryDate":"08-31-2018 09:00:00"
}

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "Carts":{  
      "MerchantId":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
      "ProductCost":1001.0,
      "ShippingCost":0.0,
      "VoucherDiscount":0.0,
      "PromotionDiscount":0.0,
      "TaxAmount":0.0,
      "OrderTotal":1001.0,
      "VoucherCode":"",
      "UserSelectedCurrency":"INR",
      "Bill_FirstName":"Tom",
      "Bill_LastName":"Sawyer",
      "Bill_Address1":"Hanuman tekdi",
      "Bill_Address2":"goregaon",
      "Bill_CountryCode":"IN",
      "_Bill_StateCode":"MH",
      "Bill_City":"Mumbai",
      "Bill_CityCode":"321",
      "Bill_OtherCityName":"Mumbai",
      "Bill_Telephone":"8080537xxx",
      "Bill_Mobile":"8080537xxx",
      "Bill_PostCode":"400063",
      "Bill_Email":"tom@example.com",
      "Ship_FirstName":"Tom",
      "Ship_LastName":"Sawyer",
      "Ship_Address1":"Hanuman tekdi",
      "Ship_Address2":"goregaon",
      "Ship_CountryCode":"IN",
      "Ship_StateCode":"MH",
      "Ship_City":"321",
      "Ship_CityCode":"321",
      "Ship_OtherCityName":"Mumbai",
      "Ship_Telephone":"8080537xxx",
      "Ship_Mobile":"8080537xxx",
      "Ship_PostCode":"400063",
      "Ship_Email":"tom.s@example.com",
      "CartItems":[  
         {  
            "ProductId":12106630,
            "VariantProductId":8652986,
            "MRP":140.0,
            "WebPrice":91.0,
            "Quantity":11.0,
            "description":"Sunday Refined Sunflower Oil",
            "SupplierId":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
            "CartReferenceKey":"79e37f50-0a67-4c9a-b4c7-15947ea0b8f1",
            "PriceCapped":false,
            "IsFreeProduct":false,
            "TotalCap":0,
            "CappedRefKey":"00000000-0000-0000-0000-000000000000",
            "CatalogpromotionDiscount":0.0,
            "BundleCartReferenceKey":"00000000-0000-0000-0000-000000000000",
            "ItemPromotionDiscountAmount":0.0,
            "IsPrimaryProduct":false,
            "IsPromotionProduct":false,
            "VariantsInfo":[  
               {  
                  "PropertyName":"Volume",
                  "Value":"1L Pouch"
               }
            ],
            "Por":"",
            "IsDefaultBundleItem":false,
            "ProductImage":"//images.sg.content-cdn.io/cdn//in-resources/e04386d8-7ca8-4fa3-b8b8-6c606844d257/Images/ProductImages/Source/100053825_H.jpg;width=100;height=100;scale=canvas;anchor=bottomcenter",
            "CartPromotionRules":[  

            ],
            "CategoryId":"CU00328762",
            "CategoryName":null,
            "BrandId":"293130",
            "BrandName":"Sunday",
            "ParentCartItems":null
         }
      ],
      "Suppliers":[  
         {  
            "SupplierId":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
            "SupplierName":"Hypercity Fresh",
            "IsSelected":false,
            "OrderStatus":null
         }
      ],
      "ShippingOptions":[  
         {  
            "SupplierId":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
            "ShippingMode":"11334",
            "ShippingModeId":11334,
            "isselected":true
         }
      ],
      "PaymentOptionsChannel":[  
         {  
            "MerchantId":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
            "PaymentType":"Credit",
            "Paymentoption":"<div style=\"padding-left:30px;\"><img src=\"//storage.sg.content-cdn.io/in-resources/e04386d8-7ca8-4fa3-b8b8-6c606844d257/Stylesheet/images/logo/razor_pay_cc.png\" alt=\"RazorPay - CC\" /></div>\n",
            "GatewayId":"12186",
            "GatewayTitle":"Credit/Debit Card",
            "PaidAmount":0.0,
            "EnalbeOTP":false
         },
         {  
            "MerchantId":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
            "PaymentType":"Credit",
            "Paymentoption":"<div style=\"padding-left:30px;\"><img src=\"//storage.sg.content-cdn.io/in-resources/e04386d8-7ca8-4fa3-b8b8-6c606844d257/Stylesheet/images/logo/razor_pay_netbanking.png\"  alt=\"RazorPay - NetBanking\" /></div>",
            "GatewayId":"12188",
            "GatewayTitle":"Net Banking",
            "PaidAmount":0.0,
            "EnalbeOTP":false
         },
         {  
            "MerchantId":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
            "PaymentType":"Credit",
            "Paymentoption":"<div style=\"padding-left:30px;\"><img alt=\"RazorPay _Wallets\" src=\"//storage.sg.content-cdn.io/in-resources/e04386d8-7ca8-4fa3-b8b8-6c606844d257/Stylesheet/images/logo/razor_pay_wallets1.png\" /></div>\n",
            "GatewayId":"12190",
            "GatewayTitle":"Wallets",
            "PaidAmount":0.0,
            "EnalbeOTP":false
         },
         {  
            "MerchantId":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
            "PaymentType":"Credit",
            "Paymentoption":"<div style=\"padding-left:30px;\"><img alt=\"RazorPay - PayTm\" src=\"//storage.sg.content-cdn.io/in-resources/e04386d8-7ca8-4fa3-b8b8-6c606844d257/Stylesheet/images/logo/razor_pay_paytm.png\" style=\"display:inline-block;\" /></div>",
            "GatewayId":"12192",
            "GatewayTitle":"PAYTM",
            "PaidAmount":0.0,
            "EnalbeOTP":false
         },
         {  
            "MerchantId":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
            "PaymentType":"Credit",
            "Paymentoption":"<div style=\"padding-left:30px;\"><img src=\"/images/paymentoptions/Payment_RazorPay.jpg\" style=\"margin-left:4px;\" /><div >You can pay using PaymentWallet</div></div>",
            "GatewayId":"12516",
            "GatewayTitle":"Wallets",
            "PaidAmount":0.0,
            "EnalbeOTP":false
         },
         {  
            "MerchantId":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
            "PaymentType":"COD",
            "Paymentoption":"COD",
            "GatewayId":"0",
            "GatewayTitle":"COD",
            "PaidAmount":0.0,
            "EnalbeOTP":false
         }
      ],
      "ErrorCollection":null,
      "GiftMsg":"",
      "DemandedDeliveryDate":"2018-11-28T00:00:00",
      "RemainTotal":0.0,
      "ShippingZoneType":null,
      "DeliverySlotID":33494,
      "FailedProducts":null,
      "PickupFirstName":"amit",
      "PickupLastName":"kumar",
      "PickupEmail":"jva@gmail.com",
      "PickupMobile":"8080537377",
      "LocationId":"18360",
      "TaxDetail":[  
         {  
            "TaxCategory":"",
            "TaxRate":"0",
            "TaxAmount":0.0,
            "IsTaxRatePercentage":false,
            "TaxCode":"0",
            "TaxCategoryID":"0"
         }
      ],
      "ComboSuggestion":[  

      ],
      "ConvertedDeals":[  

      ]
   },
   "ErrorCode":0
}

Lets you set delivery slot for the current cart.

Resource Information
URI /Carts/SetDeliverySlot/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Carts/SetDeliverySlot/{merchantId}

Additional Header Required

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

Request Body Parameters

Parameter Type Description
DeliverySlotId* int Unique id of the delivery slot to which you want to set the delivery slot
DeliveryDate* date-time Customer preferred delivery slot

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
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)
ComboSuggestion array Deal item suggestions based on the cart items
ConvertedDeals array The cart items that are converted to deal items

Get Delivery Slots

Sample Request

https://www.martjack.com/developerapi/carts/DeliverySlots/e04386d8-7ca8-4fa3-b8b8-6c606844d257

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "DaySlots":[  
      {  
         "Day":"Today",
         "ETA":0.0,
         "Slots":[  
            {  
               "FormatedSlotRange":"10:00 AM - 01:00 PM",
               "FormatedDate":null,
               "IsDisabled":true,
               "DeliveryDate":"2018-11-28T13:48:39.5872032",
               "DeliverySlotDate":"11/28/2018",
               "DeliverySlotID":33466,
               "MerchantID":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
               "StartTime":"2018-11-20T10:00:00",
               "EndTime":"2018-11-20T13:00:00",
               "LeadTime":120.0,
               "Intervel":0.0,
               "MaxOrders":24.0,
               "Status":true,
               "IsExpress":false
            },
            {  
               "FormatedSlotRange":"01:00 PM - 04:00 PM",
               "FormatedDate":null,
               "IsDisabled":true,
               "DeliveryDate":"2018-11-28T13:48:39.5872032",
               "DeliverySlotDate":"11/28/2018",
               "DeliverySlotID":33480,
               "MerchantID":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
               "StartTime":"2018-11-20T13:00:00",
               "EndTime":"2018-11-20T16:00:00",
               "LeadTime":120.0,
               "Intervel":0.0,
               "MaxOrders":20.0,
               "Status":true,
               "IsExpress":false
            },
            {  
               "FormatedSlotRange":"04:00 PM - 07:00 PM",
               "FormatedDate":null,
               "IsDisabled":false,
               "DeliveryDate":"2018-11-28T13:48:39.5872032",
               "DeliverySlotDate":"11/28/2018",
               "DeliverySlotID":33494,
               "MerchantID":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
               "StartTime":"2018-11-20T16:00:00",
               "EndTime":"2018-11-20T19:00:00",
               "LeadTime":120.0,
               "Intervel":0.0,
               "MaxOrders":24.0,
               "Status":true,
               "IsExpress":false
            },
            {  
               "FormatedSlotRange":"07:00 PM - 10:00 PM",
               "FormatedDate":null,
               "IsDisabled":false,
               "DeliveryDate":"2018-11-28T13:48:39.5872032",
               "DeliverySlotDate":"11/28/2018",
               "DeliverySlotID":36716,
               "MerchantID":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
               "StartTime":"2018-11-20T19:00:00",
               "EndTime":"2018-11-20T22:00:00",
               "LeadTime":120.0,
               "Intervel":0.0,
               "MaxOrders":20.0,
               "Status":true,
               "IsExpress":false
            }
         ],
         "DeliveryDate":"2018-11-28T13:48:39.5872032",
         "DeliverySlotDate":"11282018"
      },
      {  
         "Day":"Tomorrow ",
         "ETA":0.0,
         "Slots":[  
            {  
               "FormatedSlotRange":"10:00 AM - 01:00 PM",
               "FormatedDate":null,
               "IsDisabled":false,
               "DeliveryDate":"2018-11-29T13:48:39.5872032",
               "DeliverySlotDate":"11/29/2018",
               "DeliverySlotID":33468,
               "MerchantID":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
               "StartTime":"2018-11-20T10:00:00",
               "EndTime":"2018-11-20T13:00:00",
               "LeadTime":120.0,
               "Intervel":0.0,
               "MaxOrders":24.0,
               "Status":true,
               "IsExpress":false
            },
            {  
               "FormatedSlotRange":"01:00 PM - 04:00 PM",
               "FormatedDate":null,
               "IsDisabled":false,
               "DeliveryDate":"2018-11-29T13:48:39.5872032",
               "DeliverySlotDate":"11/29/2018",
               "DeliverySlotID":33482,
               "MerchantID":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
               "StartTime":"2018-11-20T13:00:00",
               "EndTime":"2018-11-20T16:00:00",
               "LeadTime":120.0,
               "Intervel":0.0,
               "MaxOrders":20.0,
               "Status":true,
               "IsExpress":false
            },
            {  
               "FormatedSlotRange":"04:00 PM - 07:00 PM",
               "FormatedDate":null,
               "IsDisabled":false,
               "DeliveryDate":"2018-11-29T13:48:39.5872032",
               "DeliverySlotDate":"11/29/2018",
               "DeliverySlotID":33496,
               "MerchantID":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
               "StartTime":"2018-11-20T16:00:00",
               "EndTime":"2018-11-20T19:00:00",
               "LeadTime":120.0,
               "Intervel":0.0,
               "MaxOrders":24.0,
               "Status":true,
               "IsExpress":false
            },
            {  
               "FormatedSlotRange":"07:00 PM - 10:00 PM",
               "FormatedDate":null,
               "IsDisabled":false,
               "DeliveryDate":"2018-11-29T13:48:39.5872032",
               "DeliverySlotDate":"11/29/2018",
               "DeliverySlotID":36718,
               "MerchantID":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
               "StartTime":"2018-11-20T19:00:00",
               "EndTime":"2018-11-20T22:00:00",
               "LeadTime":120.0,
               "Intervel":0.0,
               "MaxOrders":20.0,
               "Status":true,
               "IsExpress":false
            }
         ],
         "DeliveryDate":"2018-11-29T13:48:39.5872032",
         "DeliverySlotDate":"11292018"
      },
      {  
         "Day":"30 Nov, Fri",
         "ETA":0.0,
         "Slots":[  
            {  
               "FormatedSlotRange":"10:00 AM - 01:00 PM",
               "FormatedDate":null,
               "IsDisabled":false,
               "DeliveryDate":"2018-11-30T13:48:39.5872032",
               "DeliverySlotDate":"11/30/2018",
               "DeliverySlotID":33470,
               "MerchantID":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
               "StartTime":"2018-11-20T10:00:00",
               "EndTime":"2018-11-20T13:00:00",
               "LeadTime":120.0,
               "Intervel":0.0,
               "MaxOrders":24.0,
               "Status":true,
               "IsExpress":false
            },
            {  
               "FormatedSlotRange":"01:00 PM - 04:00 PM",
               "FormatedDate":null,
               "IsDisabled":false,
               "DeliveryDate":"2018-11-30T13:48:39.5872032",
               "DeliverySlotDate":"11/30/2018",
               "DeliverySlotID":33484,
               "MerchantID":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
               "StartTime":"2018-11-20T13:00:00",
               "EndTime":"2018-11-20T16:00:00",
               "LeadTime":120.0,
               "Intervel":0.0,
               "MaxOrders":20.0,
               "Status":true,
               "IsExpress":false
            },
            {  
               "FormatedSlotRange":"04:00 PM - 07:00 PM",
               "FormatedDate":null,
               "IsDisabled":false,
               "DeliveryDate":"2018-11-30T13:48:39.5872032",
               "DeliverySlotDate":"11/30/2018",
               "DeliverySlotID":33498,
               "MerchantID":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
               "StartTime":"2018-11-20T16:00:00",
               "EndTime":"2018-11-20T19:00:00",
               "LeadTime":120.0,
               "Intervel":0.0,
               "MaxOrders":24.0,
               "Status":true,
               "IsExpress":false
            },
            {  
               "FormatedSlotRange":"07:00 PM - 10:00 PM",
               "FormatedDate":null,
               "IsDisabled":false,
               "DeliveryDate":"2018-11-30T13:48:39.5872032",
               "DeliverySlotDate":"11/30/2018",
               "DeliverySlotID":33512,
               "MerchantID":"e04386d8-7ca8-4fa3-b8b8-6c606844d257",
               "StartTime":"2018-11-20T19:00:00",
               "EndTime":"2018-11-20T22:00:00",
               "LeadTime":120.0,
               "Intervel":0.0,
               "MaxOrders":20.0,
               "Status":true,
               "IsExpress":false
            }
         ],
         "DeliveryDate":"2018-11-30T13:48:39.5872032",
         "DeliverySlotDate":"11302018"
      }
   ],
   "ErrorCode":0
}

Retrieves all the available delivery slots of the current cart items

Resource Information
URI /Carts/DeliverySlots/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Carts/DeliverySlots/{merchantId}

Additional Header Required

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

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
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)
ComboSuggestion array Suggestions related the deal items based on the items in the cart
ConvertedDeals array The cart items that are converted to deal items

Get Product Recommendations

Sample Request

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

Sample Response

{
    "ProductIds": [
        13067043,
        13067125,
        13067247
    ],
    "messageCode": "1004",
    "Message": "Successful",
    "ErrorCode": 0
}

Retrieves product recommendations based on the cart items.

Resource Information
URI Carts/TargetBlocks/{merchantId}
Response Formats JSON
HTTP Methods GET
Batch Support No
Rate Limited? No
Authentication Yes

Request URL

{host}/developerapi/Carts/TargetBlocks/{merchantId}

Additional Header Required

Header Description
AccessToken* Access token of the current session (you can generate using GET AccessToken API)

Get Common Stores for Cart Items

Retrieves the details of stores in which the stock of a specific cart item is available. You can also search by he available stock quantity.

Sample Request

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

Sample POST Request


MerchantID=f48fdd16-92db-4188-854d-1ecd9b62d066&InputFormat=application/json&InputData=
{
  "products": [
    {
      "ProductId": "0",
      "VariantProductId": "0",
      "ProductSku": "61751356",
      "Quantity": 1
    }
  ],
  "Longitude": "",
  "Latitude": ""
}

Sample Response

{
    "messageCode": "1004",
    "Message": "Locations received",
    "Locations": [
        {
            "DistancefromInputLatLong": 0,
            "ParentLocationID": 0,
            "LocationId": 22880,
            "LocationCode": "PIJ",
            "LocationName": "7-PIJ-Justice Pondok Indah",
            "Address1": "Pondok Indah Mall 2 2nd Floor, 210",
            "Address2": "",
            "City": "25676",
            "CityName": null,
            "Area": "",
            "State": "ID10",
            "StateName": null,
            "Country": "ID",
            "CountryName": null,
            "Pin": "12310",
            "Contact1": "021-75920875",
            "Contact2": "",
            "Description": "",
            "Latitude": -6.26557,
            "Longitude": 106.784,
            "LocationType": null,
            "MerchantId": "f48fdd16-92db-4188-854d-1ecd9b62d066",
            "IsDistributionCenter": true,
            "EmailId": "justice.pon.ind@exampleretail.com",
            "IsParticipateInStock": true,
            "IsDefaultLocation": false,
            "IsOfflinneCheckoutEnabled": false,
            "IsPointOfSale": false,
            "IsOfflineDeals": false,
            "IsInStorePickup": true,
            "Remarks": null,
            "CST": "",
            "VAT": "",
            "TINNo": "",
            "GSTINNO": "",
            "IsReversePickupEnabled": false,
            "IsDefaultLNG_LocationName": true,
            "IsDefaultLNG_Description": true,
            "IsDefaultLNG_Address1": true,
            "StoreTimings": null,
            "HomeDeliveryTimings": null,
            "TakeawayTimings": null
        },
        {
            "DistancefromInputLatLong": 0,
            "ParentLocationID": 0,
            "LocationId": 22888,
            "LocationCode": "KKJ",
            "LocationName": "7-KKJ-Justice Kota Kasablanka  ",
            "Address1": "Level-2, 239A\r\n",
            "Address2": "",
            "City": "25676",
            "CityName": null,
            "Area": "",
            "State": "ID10",
            "StateName": null,
            "Country": "ID",
            "CountryName": null,
            "Pin": "12870",
            "Contact1": "021-29626167",
            "Contact2": "",
            "Description": "",
            "Latitude": -6.22387,
            "Longitude": 106.843,
            "LocationType": null,
            "MerchantId": "f48fdd16-92db-4188-854d-1ecd9b62d066",
            "IsDistributionCenter": true,
            "EmailId": "justice.kot.kas@exampleretail.com",
            "IsParticipateInStock": true,
            "IsDefaultLocation": false,
            "IsOfflinneCheckoutEnabled": false,
            "IsPointOfSale": false,
            "IsOfflineDeals": false,
            "IsInStorePickup": true,
            "Remarks": null,
            "CST": "",
            "VAT": "",
            "TINNo": "",
            "GSTINNO": "",
            "IsReversePickupEnabled": false,
            "IsDefaultLNG_LocationName": true,
            "IsDefaultLNG_Description": true,
            "IsDefaultLNG_Address1": true,
            "StoreTimings": null,
            "HomeDeliveryTimings": null,
            "TakeawayTimings": null
        },
        {
            "DistancefromInputLatLong": 0,
            "ParentLocationID": 0,
            "LocationId": 25687,
            "LocationCode": "LPJ",
            "LocationName": "7-LPJ-Justice Lippo Puri",
            "Address1": "Jl Puri Indah Raya Blok U 1, Puri Indah CBD, Jakarta Barat",
            "Address2": "",
            "City": "",
            "CityName": null,
            "Area": "",
            "State": "ID-JK",
            "StateName": null,
            "Country": "ID",
            "CountryName": null,
            "Pin": "11610",
            "Contact1": "",
            "Contact2": "",
            "Description": "",
            "Latitude": -6.18758,
            "Longitude": 106.739,
            "LocationType": null,
            "MerchantId": "f48fdd16-92db-4188-854d-1ecd9b62d066",
            "IsDistributionCenter": true,
            "EmailId": "justice.lip.pur@examplegroup.com",
            "IsParticipateInStock": true,
            "IsDefaultLocation": false,
            "IsOfflinneCheckoutEnabled": false,
            "IsPointOfSale": false,
            "IsOfflineDeals": false,
            "IsInStorePickup": true,
            "Remarks": null,
            "CST": "",
            "VAT": "",
            "TINNo": "",
            "GSTINNO": "",
            "IsReversePickupEnabled": false,
            "IsDefaultLNG_LocationName": true,
            "IsDefaultLNG_Description": true,
            "IsDefaultLNG_Address1": true,
            "StoreTimings": null,
            "HomeDeliveryTimings": null,
            "TakeawayTimings": null
        }
    ],
    "ErrorCode": 0
}

Resource Information
URI Carts/GetCommonStoresforCartItems/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Carts/GetCommonStoresforCartItems/{merchantId}

Request Body Parameters

Parameter Type Description
ProductId** int Unique id of the product to get the stores stocking that specific product
ProductSKU** string Unique SKU of the product to get the stores stocking that specific product
VariantProductSKU string Unique SKU of the variant product for which you want to fetch available stores. Default value: 0
Quantity int To get stores stocking a specific quantity of the product, specify the stock quantity
Latitude float Get common stores in the specific latitude and longitude
Longitude float Get common stores in the specific latitude and longitude

Get Coupon Suggestions

Suggests coupons applicable on cart items.

Sample Request

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

Sample Response

{
"CouponSuggestions": {
"voucherSuggestions": [
{
"RuleDescription": "",
"NoOfUsesDonePerUser": 0,
"NoOfUsesconfiguredPerVoucher": -1,
"RuleCriteria": [

],
"RuleId": 41825,
"cartDiscountValue": 50,
"EndDate": "/Date(1688127300000+0530)/",
"NoOfUsesConfiguredPerUser": -1,
"NoOfUsesDonePerVoucher": 0,
"isSatisfied": true,
"RuleTitle": "CouponSuggestions1",
"isVoucher": true,
"voucherCode": "CouponSuggestions2"
}
]
},
"Message": "skip",
"messageCode": "skip",
"Token": {
"AccessToken": "skip",
"UserId": "skip",
"IsLoggedInUser": "skip",
"MerchantId": "skip",
"issued_at": "skip"
},
"ErrorCode": "skip"
}

Resource Information
URI /CouponSuggestion/{{merchantid}}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

https://{host}/developerapi/carts/CouponSuggestion/{{merchantid}}

Request Query Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant

Pricelist

Update Pricelist

Sample Request

https://www.martjack.com/developerapi/Pricelist/f48fdd16-92db-4188-854d-1ecd9b62xxxx/ABC/upload

Sample POST Request

MerchantId=0639f7a6-34cc-48b2-9fd9-a80e2ed8xxxx&InputFormat=application/json&InputData={ 
   "pricelistitems":{ 
      "pricelistitem":[ 
         { 
            "sku":"17CASLA1066-GR",
            "variantsku":"101620659",
            "qty":"1",
            "mrp":3891,
            "webprice":1945,
            "tokenprice":972
         },
         { 
            "sku":"17CASLA1066-GR",
            "variantsku":"101620659",
            "qty":"1",
            "mrp":3891,
            "webprice":1945,
            "tokenprice":972
         }
      ]
   }
}

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 price of a SKU or variant SKU in a particular price list.

Resource Information
URI Product/Pricelist/{MerchantId}/{PricelistRefCode}/upload
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Product/Pricelist/{MerchantId}/{PricelistRefCode}/upload

Request Body Parameters

Parameter Type Description
sku* string SKU of the product of a specific location for which you want to update stock and price
variantsku string The variant SKU of the current item
Qty* int The quantity of the item for which you want to update the price
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

Delete Product Slab

Deletes the slab of the product in the pricelist.

Sample Request

https://www.martjack.com/developerapi/Details/Delete/0639f7a6-34cc-48b2-9fd9-a80e2ed8xxxx/3456

Sample POST Request (Raw)

productId=14149215&quantity=7

Sample POST Request (x-www-form-urlencoded Payload)

MerchantId=0639f7a6-34cc-48b2-9fd9-a80e2ed8xxxx&InputFormat=application/json&InputData={
"productId":14149215,
"quantity":7
}

Sample Response

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

Resource Information
URI Product/Pricelist/Details/Delete/{MerchantId}/{PricelistRefCode}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Product/Pricelist/Details/Delete/{MerchantId}/{PricelistRefCode}

Request Path Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchant
PricelistRefCode* string Unique reference code of the pricelist

Request Body Parameters

Parameter Type Description
productid* int Unique id of the product that you want to delete
quantity* int Quantity of items that you want to delete

Get Pricelist

Retrieves all locations for which pricelist is configured.

Sample Request

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

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "PriceListDetails": [
    {
      "Id": 2498,
      "Name": "India",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "UserGroupId": 0,
      "LocationId": 17038,
      "CreatedDate": "/Date(1469171538000+0530)/",
      "Status": true,
      "ReferenceCode": "IND"
    },
    {
      "Id": 2500,
      "Name": "International",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "UserGroupId": 0,
      "LocationId": 17036,
      "CreatedDate": "/Date(1469171604000+0530)/",
      "Status": true,
      "ReferenceCode": "INTL"
    },
    {
      "Id": 2878,
      "Name": "India",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "UserGroupId": 0,
      "LocationId": 17038,
      "CreatedDate": "/Date(1493272531000+0530)/",
      "Status": true,
      "ReferenceCode": "INDFK"
    },
    {
      "Id": 2890,
      "Name": "India",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "UserGroupId": 0,
      "LocationId": 17038,
      "CreatedDate": "/Date(1493368445000+0530)/",
      "Status": true,
      "ReferenceCode": "IndiaFK"
    },
    {
      "Id": 2900,
      "Name": "Telangana",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "UserGroupId": 0,
      "LocationId": 18692,
      "CreatedDate": "/Date(1494482769000+0530)/",
      "Status": false,
      "ReferenceCode": "Test111"
    },
    {
      "Id": 2912,
      "Name": "TestP",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "UserGroupId": 0,
      "LocationId": 17038,
      "CreatedDate": "/Date(1495716987000+0530)/",
      "Status": true,
      "ReferenceCode": "TEtst"
    },
    {
      "Id": 3108,
      "Name": "Delhi",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "UserGroupId": 0,
      "LocationId": 16696,
      "CreatedDate": "/Date(1509702432000+0530)/",
      "Status": true,
      "ReferenceCode": "delhi"
    },
    {
      "Id": 3673,
      "Name": "bang",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "UserGroupId": 0,
      "LocationId": 17430,
      "CreatedDate": "/Date(1547027898000+0530)/",
      "Status": true,
      "ReferenceCode": "bang001"
    },
    {
      "Id": 3757,
      "Name": "bang",
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
      "UserGroupId": 8496,
      "LocationId": 17430,
      "CreatedDate": "/Date(1549448228000+0530)/",
      "Status": true,
      "ReferenceCode": "bang002"
    }
  ],
  "ErrorCode": 0
}

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

Request URL

{host}/developerapi/Pricelist/{merchantId}

Request Path Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchant for which you want to fetch available price lists

Response Parameters

Parameter Type Description
Id int Unique pricelist id
Name string Name of the location
LocationId int Unique id of the location
CreatedDate date Date when the price list is created
Status enum Current status of the price list. Value: true for Active and false for inactive
ReferenceCode string Unique location reference code

Shopping List

Shopping list is a wish list or favorite list of a customer. This resource consists of APIs to add and manage a customer’s wish list.

Add Shopping List

Sample Request

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

Sample POST Request

InputFormat=application/json&InputData={
   "ShoppingList":{
      "UserId":"f4473f55-b6b0-4a4c-8ffa-fc1010abbb1f",
      "ShoppingListName":"AWS1",
      "privacyLevel":"Private",
      "refCode":"123456"

   }
}

Sample Response

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

Creates a shopping list for a specific customer. This just creates a shopping list bucket and does not include any items in it. Use /ShoppingList/list to add items.

Resource Information
URI ShoppingList/add/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/ShoppingList/add/{MerchantId}

Request Parameters

Parameter Type Description
UserId* string The unique user identifier of the customer whose wish list details need to be added
ShoppingListName* string Specify a name for the current wish list
privacyLevel string Specify whether to make the wish list public to make it to everyone or private to make it visible only for you (Value: Pr, Pu). Default value: Pr
refCode string Specify a reference code for your wish list. It is a free flowing text and accepts any string that you pass

Get Shopping List Details

Sample Request

https://www.martjack.com/developerapi/ShoppingList/81e77da2-723b-483d-8c0d-49f800c1exxx/f4473f55-b6b0-4a4c-8ffa-fc1010abxxxx/43700/true

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "ShoppingList": [
        {
            "ShoppingListId": 43787,
            "ShoppingListName": "AWS1",
            "PrivacyLevel": "Pr",
            "UserId": "f4473f55-b6b0-4a4c-8ffa-fc1010abxxxx",
            "MerchantId": "81e77da2-723b-483d-8c0d-49f800c1xxxx",
            "CreatedDate": "/Date(1535913000000+0530)/",
            "ModifiedDate": "/Date(1535913000000+0530)/",
            "UserGroupId": 0,
            "AllowUserToAddItems": true,
            "DisplayinMyAccount": true,
            "CreatedBy": 1,
            "RefCode": "0"
        },
        {
            "ShoppingListId": 31852,
            "ShoppingListName": "MyWishList",
            "PrivacyLevel": "Pr",
            "UserId": "00000000-0000-0000-0000-000000000000",
            "MerchantId": "81e77da2-723b-483d-8c0d-49f800c1xxxx",
            "CreatedDate": "/Date(1457461800000+0530)/",
            "ModifiedDate": "/Date(1457461800000+0530)/",
            "UserGroupId": 0,
            "AllowUserToAddItems": true,
            "DisplayinMyAccount": true,
            "CreatedBy": 0,
            "RefCode": "0"
        }
    ],
    "ErrorCode": 0
}

Retrieves the details of a specific wish list of a customer.

Resource Information
URI ShoppingList/{MerchantId}/{UserId}/{shoppingListId}/{GetDefaultWishlist}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/ShoppingList/{MerchantId}/{UserId}/{shoppinglistId}/{GetDefaultWishlist}

Request Parameters

Parameter Type Description
MerchantId* string The unique id (GUID) of the merchant account from which you want to fetch customer’s wish list
UserId* string The unique user identifier of the customer whose details need to be retrieved
shoppinglistId string The shopping list id that you want to fetch
GetDefaultWishlist boolean Specify true to retrieve default wish list, false to retrieve only the customer’s wish list and not default wish list

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
UserGroupId int Unique user group id associated to the user
AllowUserToAddItems boolean Whether the user is allowed to add products to the shopping lsit
DisplayinMyAccount boolean Whether the shopping list is shown to the end-user
CreatedBy int The value is 1 for the created the shopping list and 0 for merchant has created the shopping list
RefCode string Unique reference code of the specific shopping list

Add Items to a Shopping List

Sample Request

https://www.martjack.com/developerapi/ShoppingList/items/add/81e77da2-723b-483d-8c0d-49f800c1exxx

Sample POST Request

InputFormat=application/json&InputData={
   "ShoppingListView":{
      "UserId":"f4473f55-b6b0-4a4c-8ffa-fc1010abxxxx",
      "merchantId":"81e77da2-723b-483d-8c0d-49f800c1xxxx",
      "Item":{
         "ShoppingListId":"0",
         "ProductId":"12688208",
         "VarProductId":"9727843",
         "Quantity":"1",
         "IsSelected":"False",
         "Status":"A"
      }
   }
}

Sample Response

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

Adds items to an existing wish list of a customer

Resource Information
URI ShoppingList/items/add/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/ShoppingList/items/add/{MerchantId}

Request Body Parameters

Parameter Type Description
UserId* string The unique user identifier of the customer whose wish list details need to be added
merchantId* string The unique id (GUID) of the merchant account in which the customer’s wish list is created
ShoppingListId* int Specify a name for the current wish list
ProductId int The unique product id that you want to add to the wish list
VarProductId int The unique variant product id (if applicable)
Quantity int The quantity of the item that you want to add to the wish list
IsSelected boolean Value: true/false

Get Shopping List Items

Sample Request

https://www.martjack.com/developerapi/ShoppingList/items/81e77da2-723b-483d-8c0d-49f800c1exxx/2345/f4473f55-b6b0-4a4c-8ffa-fc1010abxxxx

Sample Response

{
    "ShoppingListItems": [
        {
            "ProductId": 12688208,
            "VariantProductID": "9727843",
            "ShoppingListId": 31852,
            "ShoppingListItemId": 47465921,
            "Quantity": 1,
            "IsSelected": "False",
            "Items": []
        }
    ],
    "messageCode": "1004",
    "Message": "Successful",
    "ErrorCode": 0
}

Retrieves items of a specific wish list

Resource Information
URI /ShoppingList/Items/{merchantId}/{shoppingListId}/{userId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/ShoppingList/Items/{merchantId}/{shoppingListId}/{userId}

Request Parameters

Parameter Type Description
MerchantId* string The unique id (GUID) of the merchant account from which you want to fetch customer’s wish list
UserId* string The unique user identifier of the customer whose shopping list items need to be retrieved
shoppinglistId int The shopping list id that you want to fetch

Order

An order is a completed purchase request of a customer. This resource consists of APIs related to creating and managing orders of a marketplace, PWA or storefront.

Create Bulk Order (Normal)

Sample Request


http://www.martjack.com/developerapi/Order/BulkOrderCreation

Sample POST Request


MerchantID=81e77da2-723b-483d-8c0d-49f800c1exxx&InputFormat=application/json&InputData{  
   "orders":{  
      "order":[  
         {  
            "orderrefno":2731792,
            "orderdate":"07/26/2018",
            "deliveredon":"07/26/2018",
            "customertype":"Guest User",
            "userid":"tom.sawyer@example.com",
            "orderamountstatus":"NO",
            "ordervalue":9495,
            "orderstatus":"Authorized",
            "orderconfirmationmail":"NO",
            "paymentlinkstatus":"YES",
            "calculateshippingtax":"NO",
            "vouchercode":"",
            "shipfirstname":"Tom",
            "shiplastname":"Sawyer",
            "shipaddress1":"H.no.6-51, plot.31",
            "shipaddress2":"",
            "shipcity":"Hyderabad",
            "shipstate":"Telangana",
            "shipcountry":"India",
            "shipzip":"500062",
            "shiplandline":"8500000000",
            "shipmobile":"8500111111",
            "shipemail":"tom.sawyer@example.com",
            "billfirstname":"Tom",
            "billlastname":"Sawyer",
            "billaddress1":"H.no.6-51, ECIL",
            "billaddress2":"",
            "billcity":"Hyderabad",
            "billstate":"Telangana",
            "billcountry":"India",
            "billzip":"500062",
            "billlandline":"8500000000",
            "billmobile":"8500111111",
            "billemail":"tom.sawyer@example.com",
            "giftmsg":"Many happy returns of the  day from James and family",
            "locationcode":"3835",
            "storelocationcode":"",
            "isselfship":false,
            "channelrefcode":2338,
            "channelorderid":"6068438350",
            "sellerwroxorderid":2731792,
            "deliveryslotcode":"",
            "storelocationcode": "",
            "latitude": "28.7041",
            "longitude": "-77.1025",
            "shippingmode":"",
            "customfields":{  
               "customfield":[  
                  {  
                     "orderrefno":"5",
                     "id":"0",
                     "name":"PaymentDetails",
                     "value":"12345678910"
                  },
                  {  
                     "orderrefno":"5",
                     "id":"0",
                     "name":"PaymentDetails",
                     "value":"COD"
                  }
               ]
            },
            "items":{  
               "item":[  
                  {  
                     "tax":null,
                     "sku":"FS4656",
                     "shippingamount":0,
                     "shippingdiscount":0,
                     "variantsku":null,
                     "qty":1,
                     "unitprice":9495,
                     "orderrefno":2731792,
                     "linediscount":0,
                     "itemcustomfields":{  
                        "itemcustomfield":[  
                           {  
                              "Name":"CustomRefOrderLineID",
                              "Value":"2850981410"
                           }
                        ]
                     }
                  },
                  {  
                     "orderrefno":2731792,
                     "sku":"IN-PZ-VG-VEGGIEITALINO",
                     "variantsku":"",
                     "qty":"1",
                     "unitprice":"0",
                     "shippingamount":"0",
                     "tax":"0",
                     "shippingdiscount":"0",
                     "linediscount":"0",
                     "catalogcode":"P",
                     "bundleparentproduct":"IN-PZ-VG-VEGGIEITALINO",
                     "isdefault":"NO",
                     "portion":"",
                     "deliverymode":"S",
                     "itemcustomfields":{  
                        "itemcustomfield":[  
                           {  
                              "Name":"CustomRefOrderLineID",
                              "Value":"2850981410"
                           }
                        ]
                     }
                  }
               ]
            },
            "payments":{  
               "payment":[  
                  {  
                     "orderrefno":2731792,
                     "checkouttype":"Online Payment",
                     "paymentno":"",
                     "amount":9495,
                     "transaciondate":"07/26/2018",
                     "paymentstatus":"Authorized"
                  }
               ]
            }
         }
      ]
   }
}

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":"2156",
   "ErrorCode":0
}

This API lets you create batch orders. You can also capture vertical specific product attributes such as variants, bundle, and combo details.

Resource Information
URI Order/BulkOrderCreation
Response Formats JSON
Rate Limited? No
Authentication Yes
HTTP Method POST
Batch Support Yes

Request URL

{host}/developerapi/Order/BulkOrderCreation

Request Body Parameters

Parameter Type Description
orderrefno* string Reference number of the order
orderdate* date Ordered date in mm/dd/yyyy or yyyy/mm/dd format
deliveredon date Specify the estimated delivery of the item if applicable for the merchant in mm/dd/yyyy or yyyy/mm/dd or
customertype enum Type of the user as per the Martjack system. Supported Values: Guest User (for all marketplace), Registered User (If registered on Martjack platform)
userid string Registered identifier of the customer used for login. Required when customertype="Registered User"
ordervalue float Net order amount
orderstatus enum Status of the order. Values: Pending, Authorized
orderconfirmationmail enum Specify Yes to send an order confirmation email to the customer, else set No
paymentlinkstatus enum Whether payment link needs to sent to customer (Yes) or not (No). Use only if the Order status is Pending. A link for making the payment will be sent to the customer with all the available payment options
Storelocationcode string Source location of the order from where the order was initiated
calculateshippingtax enum Whether tax or shipping charges should be calculated based on CP Configuration. If Yes it will be calculated based on the CP Configuration rules. Specify No to consider input values from the payload
shipfirstname, shiplastname, shipaddress1 … obj Specify the shipping address and name of the customer in the respective fields
billfirstname, billlastname, billaddress1 … obj Specify the billing address and name of customer in the respective fields
giftmsg string Specify the customer’s preferred personalized message for the recipient (for gift orders)
locationcode string Location code of the order fulfillment location (Generally used for Location specific merchants)
isselfship boolean If the order shipment is handled by marketplace such as Amazon or Flipkart specify False, if the shipment is handled by the merchant itself, set the value to True
channelrefcode string Reference code of the channel from which the order has come from (specific to Sellerworx). A channel is an instance of marketplace. A seller can have multiple channels
channelorderid string Order id as maintained by that specific channel (specific to Sellerworx)
sellerwroxorderid string Order id generated at Sellerworx. Maps Channel order id to Sellerworx order id
items* obj Specify the details of each line-item in item attribute
Payments* obj Specify the payment details and orderrefno of the order in payment. The value of orderrefno at payment level and order level should be same
paymentstatus enum The payment status of the current order. Value: Authorized, Pending
paymentno string The reference number generated for order payment. This is provided by the respective payment gateway
CheckOutType string Type of check out. Values: Online Payment, Cash on Delivery, Bank Transfer, Cheque/DD, Gift Voucher, Net Banking, Payback Points, Wallet
vouchercode string Coupon code applied for the transaction, if any. This is just for viewing purpose and the API does not do any calculation based on the voucher code
customfield Pass this only if you have preconfigured custom fields at the order level
itemcustomfield string Pass line-item level custom field details if available
deliveryslotcode string Pass the delivery slot code if you want to associate a delivery slot with the order
shippingmode string Pass the shipping mode that you want to associate with the order. Note that the API does not validate the provided shipping mode
shippingamount float Pass the shipping charge for the specific item (Order item level)
shippingdiscount int Pass the discount amount availed on the shipping charge (Order item level discount)
linediscount int Pass the line item level discount availed for the order
latitude float Latitudinal distance of the store
longitude float Longitudinal distance of the store

Create Bulk Order (Deal & Bundle)

Sample Request

http://www.martjack.com/developerapi/Order/BulkOrderCreation

Sample POST Request

MerchantID=81e77da2-723b-483d-8c0d-49f800c1exxx&InputFormat=application/json&InputData{  
   "orders":{  
      "order":{  
         "orderrefno":"5455",
         "orderdate":"2018-12-13",
         "customertype":"Guest User",
         "userid":"tom.sawyer@capillarytech.com",
         "orderamountstatus":"Authorized",
         "ordervalue":4.750,
         "orderstatus":"Authorized",
         "orderconfirmationmail":"No",
         "paymentlinkstatus":"NO",
         "calculateshippingtax":"No",
         "vouchercode":"",
         "shipfirstname":"Tom",
         "shiplastname":"Sawyer",
         "shipaddress1":"test",
         "shipaddress2":"test23233",
         "shipcity":"Al Qurain",
         "shipstate":"Kuwait City",
         "shipcountry":"Kuwait",
         "shipzip":"1",
         "shiplandline":"55555555",
         "shipmobile":"55555555",
         "shipemail":"tom.sawyer@capillarytech.com",
         "billfirstname":"Tom",
         "billlastname":"Sawyer",
         "billaddress1":"example address",
         "billaddress2":"example address2",
         "billcity":"Al Qurain",
         "billstate":"Kuwait City",
         "billcountry":"Kuwait",
         "billzip":"1",
         "billlandline":"55555555",
         "billmobile":"55555555",
         "billemail":"tom.sawyer@capillarytech.com",
         "giftmsg":"Happy wedding anniversary",
         "deliveredon":"2018-12-13",
         "locationcode":"SURRA",
         "storelocationcode":"PH Adeliya",
         "isselfship":"NO",
         "channelrefcode":"",
         "channelorderid":"",
         "sellerwroxorderid":"",
         "deliveryslotcode":"",
         "latitude": "28.7041",
         "longitude": "-77.1025",
         "shippingmode":"H",
         "items":{  
            "item":[  
               {  
                  "orderrefno":"5455",
                  "sku":"Dls-130032",
                  "variantsku":"",
                  "qty":1,
                  "unitprice":0,
                  "shippingamount":0,
                  "tax":0,
                  "shippingdiscount":0,
                  "linediscount":0,
                  "catalogcode":"D",
                  "bundleparentproduct":"",
                  "isdefault":"NO",
                  "portion":"",
                  "deliverymode":"H",
                  "bundleitems":{  
                     "item":[  
                        {  
                           "orderrefno":"5455",
                           "sku":"Pz-Chicken-Supreme",
                           "variantsku":"",
                           "qty":1,
                           "unitprice":0,
                           "shippingamount":0,
                           "tax":0,
                           "shippingdiscount":0,
                           "linediscount":0,
                           "catalogcode":"D",
                           "bundleparentproduct":"Dls-130032",
                           "isdefault":"NO",
                           "portion":"",
                           "deliverymode":"H",
                           "bundleitems":{  
                              "item":[  
                                 {  
                                    "orderrefno":"5455",
                                    "sku":"Crt-10",
                                    "variantsku":"Crt-10-102580-Pan-Large",
                                    "qty":1,
                                    "unitprice":4.25,
                                    "shippingamount":0.50,
                                    "tax":0,
                                    "shippingdiscount":0,
                                    "linediscount":0,
                                    "catalogcode":"B",
                                    "bundleparentproduct":"Pz-Chicken-Supreme",
                                    "isdefault":"NO",
                                    "deliverymode":"H",
                                    "portion":"W"
                                 },
                                 {  
                                    "orderrefno":"5455",
                                    "sku":"Mozarella_30",
                                    "variantsku":"Mozarella_30_111100_Large",
                                    "qty":1,
                                    "unitprice":0,
                                    "shippingamount":0,
                                    "tax":0,
                                    "shippingdiscount":0,
                                    "linediscount":0,
                                    "catalogcode":"B",
                                    "bundleparentproduct":"Pz-Chicken-Supreme",
                                    "isdefault":"NO",
                                    "deliverymode":"H",
                                    "portion":"W"
                                 }
                              ]
                           }
                        },
                        {  
                           "orderrefno":"4452",
                           "sku":"Omn-App-GlcBrd",
                           "variantsku":"Omn-App-GlcBrd-2-NCH",
                           "qty":1,
                           "unitprice":0,
                           "shippingamount":0,
                           "tax":0,
                           "shippingdiscount":0,
                           "linediscount":0,
                           "catalogcode":"D",
                           "bundleparentproduct":"OmnDls-FmlyBx",
                           "isdefault":"NO",
                           "portion":"",
                           "deliverymode":"H"
                        }
                     ]
                  }
               }
            ]
         },
         "payments":{  
            "payment":{  
               "orderrefno":"5455",
               "checkouttype":"Cash on Delivery",
               "paymentno":"123",
               "amount":4.750,
               "transaciondate":"2018-12-13",
               "paymentstatus":"Authorized"
            }
         }
      }
   }
}

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":"2156",
   "ErrorCode":0
}

This API lets you create batch orders for deal and bundle products.

Resource Information
URI Order/BulkOrderCreation
Response Formats JSON
Rate Limited? No
Authentication Yes
HTTP Method POST
Batch Support Yes

Request URL

{host}/developerapi/Order/BulkOrderCreation

Request Body Parameters

Parameter Type Description
orderrefno* string Reference number of the order
orderdate* date Ordered date in mm/dd/yyyy or yyyy/mm/dd format
deliveredon date Specify the estimated delivery of the item if applicable for the merchant in mm/dd/yyyy or yyyy/mm/dd format
customertype enum Type of the user as per the Martjack system. Supported Values: Guest User (for all marketplace), Registered User (If registered on Martjack platform)
userid string Registered identifier of the customer used for login. Required when customertype:"Registered User"
ordervalue float Net order amount
orderstatus enum Status of the order. Value: Pending, Authorized
orderconfirmationmail enum Specify Yes to send an order confirmation email to the customer, else set No
paymentlinkstatus enum Whether payment link needs to sent to customer (Yes) or not (No). Use only if the Order status is Pending. A link for making the payment will be sent to the customer with all the available payment options
calculateshippingtax enum Whether tax or shipping charges should be calculated based on CP Configuration. If Yes it will be calculated based on the CP Configuration rules. Specify No to consider input values from the payload
shipfirstname, shiplastname, shipaddress1 … - Specify the customer’s shipping address related information in the respective fields
billfirstname, billlastname, billaddress1 … - Specify the customer’s billing address related information in the respective fields
giftmsg string Specify the customer’s preferred personalized message for the recipient (for gift orders)
storelocationcode string Source location of the order from where the order was initiated
locationcode string Location code of the order fulfillment location (Generally used for Location specific merchants)
isselfship boolean If the order shipment is handled by marketplace such as Amazon or Flipkart specify False, if the shipment is handled by the merchant itself, set the value to True
channelrefcode string Channel from which the order is received (specific to Sellerworx). A channel is an instance of marketplace. A seller can have multiple channels
channelorderid string Order id as maintained by that specific channel (specific to Sellerworx)
sellerwroxorderid string Order id generated at Sellerworx. Maps Channel order id to Sellerworx order id
items* obj Specify the details of each line-item in item attribute
bundleitems obj Details of bundle items
Payments* obj Specify the payment details and orderrefno of the order in the payment object. The value of orderrefno at payment level should be same as that of the order level
paymentstatus enum The payment status of the current order. Value: Authorized, Pending
paymentno string The reference number for order payment provided by the respective payment gateway
CheckOutType string Type of check out. Values: Online Payment, Cash on Delivery, Bank Transfer, Cheque/DD, Gift Voucher, Net Banking, Payback Points, Wallet
vouchercode string Coupon code applied for the transaction if any. This is just for viewing purpose and the API does not do any calculation based on the voucher code
customfield json obj Pass this only if you have preconfigured custom fields at the order level
itemcustomfield json obj Pass line-item level custom field details if available
deliveryslotcode string Pass the delivery slot code if you want to associate a delivery slot with the order
latitude float Latitudinal distance of the store
longitude float Longitudinal distance of the store
shippingmode string Pass the shipping mode that you want to associate with the order. Note that the API does not validate the provided shipping mode
shippingamount float Pass the shipping charge for the specific item (Order item level)
shippingdiscount int Pass the discount amount availed for the order in shipping charge (Order item level discount)
linediscount int Pass the line item level discount availed
catalogcode enum Type of the product category, Value: D for deal, B for bundle
unitprice float Price of a single item
bundleparentproduct string SKU of the parent bundle product
isdefault enum Is the item default for the bundle. Value: Yes, No
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)
deliverymode enum Mode of delivery of the item. Values: H for home delivery, S for store pick-up

Place Order (Single)

Sample Request

http://www.martjack.com/developerapi/Order/PlaceOrder/81e77da2-723b-483d-8c0d-49f800c1exxx

Sample POST Request

MerchantID=81e77da2-723b-483d-8c0d-49f800c1exxx&InputFormat=application/json&InputData{  
   "PaymentOption":"COD",
   "PaymentType":"COD",
   "GateWayId":"0",
   "skipDeliveryAreaValidation":true,
   "ClearCart":true,
   "transaction":true
}

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "OrderCreationResponse":{  
      "OrderID":2744271,
      "ValidationResponse":null
   }
}

Lets you add payment details and submit a transaction. You can use this API for checkout process.

Resource Information
URI /Order/PlaceOrder/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/PlaceOrder/{MerchantId}

Additional Header

Header Description
Access token* The access token generated for the current user session

Request Body Parameters

Parameter Type Description
merchantId* string The unique id (GUID) of the merchant in which you want to place order
PaymentOption* string The name of the payment gateway. Pass only the supported modes configured in the back-end. For example, RazorPay, EBS, OnlineBankTransfer, COD, CreditCard, ChequeDD, Wallet, and eGiftVoucher
paymentType* string The payment type used for the order - OBT (Online bank transfer), TPG (Third party gateway), Credit, GV (Gift voucher) and so on
gatewayId* string Gateway id through which the payment is made
skipDeliveryAreaValidation boolean Specify true to validate delivery location before creating the order, false to ignore validation

Sample Validation Messages

{ { "OrderID":0, "ValidationResponse":[ { "Validator":"CapillaryPGValidator", "CheckoutValidationType":4, "Status":"False", "ValidationMessage":"" } ] }, "ErrorCode":0 }

{ "OrderID":0, "ValidationResponse":[ { "Validator":"DeliveryAreaValidator", "CheckoutValidationType":14, "Status":"False", "ValidationMessage":"" } ] }, "ErrorCode":0 }

{ "OrderID":0, "ValidationResponse":[ { "Validator":"DeliveryModeValidator", "CheckoutValidationType":16, "Status":"False", "ValidationMessage":"" } ] }, "ErrorCode":0 }

{ "OrderID":0, "ValidationResponse":[ { "Validator":"DiscountVoucherValidator", "CheckoutValidationType":7, "Status":"False", "ValidationMessage":"" } ] }, "ErrorCode":0 }

{ "OrderID":0, "ValidationResponse":[ { "Validator":"GiftVoucherValidator", "CheckoutValidationType":7, "Status":"False", "ValidationMessage":"" } ] }, "ErrorCode":0 }

{ "OrderID":0, "ValidationResponse":[ { "Validator":"MerchantTransactionValidator", "CheckoutValidationType":15, "Status":"False", "ValidationMessage":"" } ] }, "ErrorCode":0 }

{ "OrderID":0, "ValidationResponse":[ { "Validator":"OrderAmountValidator", "CheckoutValidationType":9, "Status":"False", "ValidationMessage":"Min/Max/Both" } ] }, "ErrorCode":0 }

{ "OrderID":0, "ValidationResponse":[ { "Validator":"OrderInputValidator", "CheckoutValidationType":0, "Status":"False", "ValidationMessage":"" } ] }, "ErrorCode":0 }

{ "OrderID":0, "ValidationResponse":[ { "Validator":"PartialOrderValidator", "CheckoutValidationType":5, "Status":"False", "ValidationMessage":"" } ] }, "ErrorCode":0 }

{ "OrderID":0, "ValidationResponse":[ { "Validator":"PaymentoptionValidator", "CheckoutValidationType":21, "Status":"False", "ValidationMessage":"" } ] }, "ErrorCode":0 }

{ "OrderID":0, "ValidationResponse":[ { "Validator":"PincodeServiceablityValidator", "CheckoutValidationType":17, "Status":"False", "ValidationMessage":"" } ] }, "ErrorCode":0 }

{ "OrderID":0, "ValidationResponse":[ { "Validator":"ShippingModeValidator", "CheckoutValidationType":16, "Status":"False", "ValidationMessage":"" } ] }, "ErrorCode":0 }

{ "OrderID":0, "ValidationResponse":[ { "Validator":"ShippingAddressValidator", "CheckoutValidationType":18, "Status":"False", "ValidationMessage":"" } ] }, "ErrorCode":0 }

{ "OrderID":0, "ValidationResponse":[ { "Validator":"ShippingValidator", "CheckoutValidationType":1, "Status":"False", "ValidationMessage":"" } ] }, "ErrorCode":0 }

{ "OrderID":0, "ValidationResponse":[ { "Validator":"StockValidator", "CheckoutValidationType":13, "Status":"False", "ValidationMessage":"Failed products" } ] }, "ErrorCode":0 }

{ "OrderID":0, "ValidationResponse":[ { "Validator":"StockValidator", "CheckoutValidationType":2, "Status":"False", "ValidationMessage":"Failed products" } ] }, "ErrorCode":0 }

{ "OrderID":0, "ValidationResponse":[ { "Validator":"StoreTimingsValidator", "CheckoutValidationType":19, "Status":"False", "ValidationMessage":"DeliveryslotNotInStoreTime" } ] }, "ErrorCode":0 }

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
ValidationResponse json obj Response object received from the payment gateway

Authorize Order

Authorizes a pending order (an order with pending payment status) or failed order.

Sample Request

https://www.martjack.com/developerapi/order/Authorize

Sample POST Request (RAW)

MerchantID=fd986588-63df-4d76-9ddd-5d8b984518a5&InputFormat=application/json&InputData={
"AuthorizeOrder":
 {
 "merchantId": "fd986588-63df-4d76-9ddd-5d8b984518a5",
 "OrderId": "7557689",
 "Date": "03/12/2019",
 "Comment":"TestComment",
 "PaymentType": "Credit",
 "BankInstrumentNumber": "12444",
 "BankName": "KOTAK",
 "PGResponse": "ewe23232323232"
 }
}

Sample Response

{
   "Code": "1005",
   "Message": "Order Authorized successfully",
   "ErrorCode": "0",
   "AllocatedItems": "false"
}

Resource Information
URI /order/Authorize
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/order/Authorize

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
OrderID* int Unique id of the order that you want to authorize
Date date Date of authorization
Comment string Specify if you want to provide any comment related to the order authentication
PaymentType* string The type of payment for the order. Only values predefined for the merchant in the back-end are supported. Example: OBT (Online bank transfer), TPG (Third party gateway), Credit, GV (Gift voucher) and so on
bankInstrumentNumber string Instrument number generated for payment clearance
bankName string Name of the bank
PGResponse* string The response received from the payment gateway

Process Transaction

Sample Request

https://www.martjack.com/developerapi/Order/ProcessTransaction/81e77da2-723b-483d-8c0d-49f800c1xxxx

Sample POST Request

MerchantID=81e77da2-723b-483d-8c0d-49f800c1exxx&InputFormat=application/json&InputData{  
   "Transaction":{  
      "OrderID":3146000,
      "ID":"",
      "PaymentType":"TPG",
      "Provider":"RAZORPAY",
      "GatewayID":"10033",
      "CPUserID":"",
      "PaymentDetails":[  
         {  
            "GVCode":"",
            "RespCode":"",
            "RespMessage":"",
            "PointsBurned":"",
            "BankCode":"",
            "BankEMICharges":"",
            "PGReferenceId":"",
            "ChequeRefNo":"",
            "DrawnOn":"",
            "PaidAmount":"",
            "BankName":"",
            "IFSC":""
         }
      ]
   }
}

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "Transaction":{  
      "TransactionID":3157xxx,
      "Amount":40425.0,
      "PaymentMessage":[  
         {  
            "Key":"ProviderAccountID",
            "Value":"rzp_live_1Rvb6UCZhctxxx"
         },
         {  
            "Key":"ProviderOrderID",
            "Value":"{\r\n  \"id\": \"order_Ap0o1g0hKYpxxx\",\r\n  \"entity\": \"order\",\r\n  \"amount\": 40425,\r\n  \"amount_paid\": 0,\r\n  \"amount_due\": 40425,\r\n  \"currency\": \"INR\",\r\n  \"receipt\": \"3146817\",\r\n  \"offer_id\": null,\r\n  \"status\": \"created\",\r\n  \"attempts\": 0,\r\n  \"notes\": {\r\n    \"MJOrderID\": \"3146817\",\r\n    \"StoreID\": \"15648\"\r\n  },\r\n  \"created_at\": 1535043452\r\n}"
         },
         {  
            "Key":null,
            "Value":null
         }
      ]
   },
   "ErrorCode":0
}

Processes pending transactions. When an order other than COD is placed, just an order instance is created and will be in Pending status by default. An order is processed only when the payment details are validated against the transaction. This is not applicable for COD orders.

Resource Information
URI /ProcessTransaction/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/ProcessTransaction/{MerchantId}

Request Body Parameters

Parameter Type Description
OrderID* int The order id that you want to process
ID int The transaction id of the order
PaymentType* string The payment type used for the order. Only values predefined for the merchant in the back-end are supported. OBT (Online bank transfer), TPG (Third party gateway), Credit, GV (Gift voucher) and so on
Provider* string The provider of the payment gateway service
GatewayID* string The respective payment gateway id
CPUserID string Unique CP user id generated by the system
PaymentDetails* json obj Pass the payment details
GVCode string The gift voucher code used for the transaction (if any)
RespCode string The unique response code generated at the payment gateway for the transaction (to our system)
RespMessage string The entire response payload generated at the payment gateway for the transaction (to our system)
PointsBurned int The number of points redeemed for the transaction (if any)

Update Transaction

Updates status of a specific transaction based on the input parameters.

Sample Request

https://www.martjack.com/developerapi/Order/UpdateTransaction/f48fdd16-92db-4188-854d-1ecd9b72d066

Sample POST Request


InputFormat=application/json&InputData={
"Transaction":
  {
    "OrderId":"7448357",
    "PaymentStatus":"A",
    "RespCode":"",
    "CurrencyCode":"",
    "TxnID":"7600793",
    "RespMsg":"",
    "PaymentType":"",
    "DeliverOption":"",
    "GatewayOption":""
  }
}

Sample Response

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

Resource Information
URI /Order/UpdateTransaction/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/UpdateTransaction/{merchantId}

Request Body Parameters

Parameter Type Description
orderId* int Unique id of the order for which you want to update transaction details
paymentStatus enum New status of the current transaction. Values: P for pending, A for authorized, F for failed
respCode string Unique code generated for the transaction from the payment gateway
txnID long Unique id of the specific transaction that you want to update. Required to update a specific transaction of an order
respMsg string Response message received for the transaction from the payment gateway
gVcode string Coupon code used for the order (to update gift voucher transaction )
pointsBurned int Number of points burned for the transaction (to update points based transaction)
bankEMICharges string Monthly EMI charges for the transaction (for transaction through card EMI)
pGReferenceId string Unique id generated for the transaction by the payment gateway

Search Orders

Retrieves orders matching the specified inputs.

Sample Request

https://www.martjack.com/Order/Search/1b3420ce-002f-4f66-bbda-cd0828aa2af8

Sample POST Request

MerchantId=1b3420ce-002f-4f66-bbda-cd0828aa2af8&InputFormat=application/json&InputData={
  "OrderSearch": {
    "Action": "",
    "CheckOutType": "Online Payment",
    "DateFrom": "09/15/2017",
    "DateTo": "09/16/2017",
    "DateType": "",
    "EmailID": "",
    "FristName": "",
    "LastName": "",
    "MobileNo": "8801312595",
    "OrderNo": "",
    "OrderPriceFrom": "",
    "OrderPriceTo": "",
    "OrderStatus": "A",
    "ProductSku": "",
    "store": "all",
    "ShippingCostFrom": "",
    "ShippingCostTo": "",
    "RecordFrom": 0,
    "RecordTo": 2
  }
}

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "Orders":[  
      {  
         "OrderId":5897350,
         "Status":"A",
         "MerchantId":"1b3420ce-002f-4f66-bbda-cd0828aa2af8",
         "UserId":"41f01343-8771-4bdb-b066-5fadd7b6edbe",
         "TotalAmount":200,
         "AmountPayable":200,
         "OrderDate":"/Date(1505501647000+0530)/",
         "PaymentDetails":[  

         ],
         "Rewards":null,
         "ShippingDiscount":0,
         "VoucherDiscount":0,
         "PromotionDiscount":0,
         "GiftMessage":null,
         "Promotions":null,
         "SubStatus":"",
         "OrderAttributes":null,
         "SourceLocationID":null,
         "SourceLocationCode":null,
         "OrderDateLocal":null,
         "AutoUpdateTime":"/Date(1547208085386+0530)/",
         "TimeZone":null
      },
      {  
         "OrderId":5897344,
         "Status":"A",
         "MerchantId":"1b3420ce-002f-4f66-bbda-cd0828aa2af8",
         "UserId":"41f01343-8771-4bdb-b066-5fadd7b6edbe",
         "TotalAmount":200,
         "AmountPayable":200,
         "OrderDate":"/Date(1505501453000+0530)/",
         "PaymentDetails":[  

         ],
         "Rewards":null,
         "ShippingDiscount":0,
         "VoucherDiscount":0,
         "PromotionDiscount":0,
         "GiftMessage":null,
         "Promotions":null,
         "SubStatus":"",
         "OrderAttributes":null,
         "SourceLocationID":null,
         "SourceLocationCode":null,
         "OrderDateLocal":null,
         "AutoUpdateTime":"/Date(1547208085386+0530)/",
         "TimeZone":null
      },
      {  
         "OrderId":5895476,
         "Status":"A",
         "MerchantId":"1b3420ce-002f-4f66-bbda-cd0828aa2af8",
         "UserId":"41f01343-8771-4bdb-b066-5fadd7b6edbe",
         "TotalAmount":200,
         "AmountPayable":200,
         "OrderDate":"/Date(1505456608000+0530)/",
         "PaymentDetails":[  

         ],
         "Rewards":null,
         "ShippingDiscount":0,
         "VoucherDiscount":0,
         "PromotionDiscount":0,
         "GiftMessage":null,
         "Promotions":null,
         "SubStatus":"",
         "OrderAttributes":null,
         "SourceLocationID":null,
         "SourceLocationCode":null,
         "OrderDateLocal":null,
         "AutoUpdateTime":"/Date(1547208085386+0530)/",
         "TimeZone":null
      }
   ],
   "ErrorCode":0
}

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

Request URL

{host}/developerapi/order/Search/{merchantId}

Request Body Parameters

Parameter Type Description
CheckOutType string Type of check out. Values: Online Payment, Cash on Delivery, Bank Transfer, Cheque/DD, Gift Voucher, Net Banking, Payback Points, Wallet
DateFrom date Search orders of a specific duration between DateFrom and DateTo. The duration is considered on the basis of specified DateType'. Pass the date inMM/DD/YYYY` format
DateTo date Search orders of a specific duration between DateFrom and DateTo. The duration is considered on the basis of specified DateType'. Pass the date inMM/DD/YYYY` format
DateType enum Activity of the specified date range. Values: OD for Order Date, SD for Ship Date, RD for Return Date, DD for Delivered Date, DS for Dispatch Date
EmailID string Specify registered email id of a customers to fetch all orders of that customer
FristName string Search orders by customers’ first name. For example, if you specify Tom, it will fetch the list of all orders of customers whose first name is Tom
LastName string Search orders by customers’ last name. For example, if you specify Sawyer, it will fetch the list of all orders of customers whose last name is Sawyer
MobileNo string Search orders of a specific customer by mobile number
OrderNo int Fetch details of a specific order by order number
OrderPriceFrom float Search orders in a specific price range. Specify the price range in OrderPriceFrom and OrderPriceTo
OrderPriceTo float Search orders in a specific price range. Specify the price range in OrderPriceFrom and OrderPriceTo
OrderStatus string Search order by order status P for Pending, A for Authorized
ProductSku string Search orders containing a specific item. Pass the item SKU
store string Search orders of a store. Specify the store code to fetch orders of that specific store, specify all to fetch orders of all stores
ShippingCostFrom float Search orders by shipping cost. Specify the shipping cost range in ShippingCostFrom and ShippingCostTo
ShippingCostTo float Search orders by shipping cost. Specify the shipping cost range in ShippingCostFrom and ShippingCostTo
RecordFrom int Filter the results by record range. Specify the range in RecordFrom and RecordTo. For example, out of 80 results you can prefer to see only records after 30 or between 30-60
RecordTo int Filter the results by record range. Specify the range in RecordFrom and RecordTo. For example, out of 80 results you can prefer to see only records after 30 or between 30-60 prefer to see first 30 records only or records between 30-70

Save Merchant Transaction

Sample Request

https://www.martjack.com/Order/SaveMerchantTransaction/81e77da2-723b-483d-8c0d-49f800c1xxxx

Sample POST Request

MerchantID=81e77da2-723b-483d-8c0d-49f800c1exxx&InputFormat=application/json&InputData{
   "PaymentOption":"OnlineBankTransfer",
   "PaymentType":"OnlineBankTrans",
   "OrderId":1894720,
   "MerchantId":"b7095ff2-12fe-4c18-9b0a-946980d12202",
   "status":"Pending",
   "amount":2088.8
}

Sample Response

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

Saves the current merchant transaction.

Resource Information
URI order/SaveMerchantTransaction/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/order/SaveMerchantTransaction/{merchantId}

Request Body Parameters

Parameter Type Description
PaymentOption* string The name of the payment gateway. For example, RazorPay, EBS, OnlineBankTransfer, COD, CreditCard, ChequeDD, Wallet, and eGiftVoucher
PaymentType* PaymentOption The mode of payment chosen for the transaction. Values could be OBT (Online bank transfer), TPG (Third party gateway), Credit, GV (Gift voucher) and so on
OrderId* int The unique id of the order
MerchantId* PaymentOption The unique id (GUID) of the merchant in which the order is registered
status* enum The status of the current payment. Value: Pending, Authorized
amount* float The amount paid through the current payment type for the transaction

Reorder

Sample Request

https://www.martjack.com/DeveloperAPI/order/ReOrder/98d18d82-ba59-4957-9c92-3f89207a34f6

Sample POST Request

MerchantID=81e77da2-723b-483d-8c0d-49f800c1exxx&InputFormat=application/json&InputData={
   "orderId":3146765,
   "orderItemId":0,
   "userId":"3cdd1838-7028-40c9-b5c2-bef371fexxxx"
}

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "Carts":{  
      "MerchantId":"98d18d82-ba59-4957-9c92-3f89207axxxx",
      "ProductCost":325.0,
      "ShippingCost":0.0,
      "VoucherDiscount":0.0,
      "PromotionDiscount":0.0,
      "TaxAmount":16.25,
      "OrderTotal":341.25,
      "VoucherCode":"",
      "UserSelectedCurrency":"INR",
      "Bill_FirstName":"Tom Sawyer",
      "Bill_LastName":"",
      "Bill_Address1":"",
      "Bill_Address2":"",
      "Bill_CountryCode":"",
      "_Bill_StateCode":"",
      "Bill_City":"Bangalore",
      "Bill_CityCode":"554",
      "Bill_OtherCityName":"",
      "Bill_Telephone":"",
      "Bill_Mobile":"7355000000",
      "Bill_PostCode":"",
      "Bill_Email":"tom.sawyer@example.com",
      "Ship_FirstName":"Tom Sawyer",
      "Ship_LastName":"",
      "Ship_Address1":"",
      "Ship_Address2":"",
      "Ship_CountryCode":"",
      "Ship_StateCode":"",
      "Ship_City":"554",
      "Ship_CityCode":"554",
      "Ship_OtherCityName":"",
      "Ship_Telephone":"",
      "Ship_Mobile":"7355000000",
      "Ship_PostCode":"",
      "Ship_Email":"tom.sawyer@example.com",
      "CartItems":[  
         {  
            "ProductId":8284702,
            "VariantProductId":0,
            "MRP":325.0,
            "WebPrice":0.0,
            "Quantity":1.0,
            "description":"Paneer Soya Supreme",
            "SupplierId":"98d18d82-ba59-4957-9c92-3f89207a34f6",
            "CartReferenceKey":"b1fdc6b5-edc1-4e82-9b5b-ed5358f84202",
            "PriceCapped":false,
            "IsFreeProduct":false,
            "TotalCap":0,
            "CappedRefKey":"00000000-0000-0000-0000-000000000000",
            "CatalogpromotionDiscount":0.0,
            "BundleCartReferenceKey":"00000000-0000-0000-0000-000000000000",
            "BundleCartItems":[  
               {  
                  "ProductId":8284692,
                  "VariantProductId":29085,
                  "MRP":545.0,
                  "WebPrice":325.0,
                  "Quantity":1.0,
                  "description":"Paneer Soya Supreme",
                  "SupplierId":"98d18d82-ba59-4957-9c92-3f89207axxxx",
                  "CartReferenceKey":"d2e73ea4-6e92-4a69-8379-3e5decd6xxxx",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0.0,
                  "BundleCartReferenceKey":"b1fdc6b5-edc1-4e82-9b5b-ed5358f8xxxx",
                  "ItemPromotionDiscountAmount":0.0,
                  "IsPrimaryProduct":true,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Crust",
                        "Value":"Pan"
                     },
                     {  
                        "PropertyName":"Size",
                        "Value":"Personal | Serves 1"
                     }
                  ],
                  "Por":"w",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00216554",
                  "CategoryName":null,
                  "BrandId":"207294",
                  "BrandName":"Capillary",
                  "GroupId":9984
               },
               {  
                  "ProductId":8283286,
                  "VariantProductId":27706,
                  "MRP":70.0,
                  "WebPrice":0.0,
                  "Quantity":1.0,
                  "description":"Paneer",
                  "SupplierId":"98d18d82-ba59-4957-9c92-3f89207axxxx",
                  "CartReferenceKey":"1e1458f2-877d-4148-9f77-7ce3112cxxx",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0.0,
                  "BundleCartReferenceKey":"b1fdc6b5-edc1-4e82-9b5b-ed5358f8xxxx",
                  "ItemPromotionDiscountAmount":0.0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Size",
                        "Value":"Personal | Serves 1"
                     },
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     }
                  ],
                  "Por":"w",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00216550",
                  "CategoryName":null,
                  "BrandId":"207294",
                  "BrandName":"Capillary",
                  "GroupId":9985
               },
               {  
                  "ProductId":8283298,
                  "VariantProductId":27754,
                  "MRP":70.0,
                  "WebPrice":0.0,
                  "Quantity":1.0,
                  "description":"",
                  "SupplierId":"98d18d82-ba59-4957-9c92-3f89207axxxx",
                  "CartReferenceKey":"9a05622e-61f6-47c0-bc71-888db53bxxxx",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0.0,
                  "BundleCartReferenceKey":"b1fdc6b5-edc1-4e82-9b5b-ed5358f8xxxx",
                  "ItemPromotionDiscountAmount":0.0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Size",
                        "Value":"Personal | Serves 1"
                     },
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     }
                  ],
                  "Por":"w",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00216550",
                  "CategoryName":null,
                  "BrandId":"207294",
                  "BrandName":"Capillary",
                  "GroupId":9985
               },
               {  
                  "ProductId":8283304,
                  "VariantProductId":27778,
                  "MRP":70.0,
                  "WebPrice":0.0,
                  "Quantity":1.0,
                  "description":"Red Paprika",
                  "SupplierId":"98d18d82-ba59-4957-9c92-3f89207axxxx",
                  "CartReferenceKey":"7b4ba0bb-e388-4c9a-be26-62a9518bxxxx",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0.0,
                  "BundleCartReferenceKey":"b1fdc6b5-edc1-4e82-9b5b-ed5358f8xxxx",
                  "ItemPromotionDiscountAmount":0.0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Size",
                        "Value":"Personal | Serves 1"
                     },
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     }
                  ],
                  "Por":"w",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00216550",
                  "CategoryName":null,
                  "BrandId":"207294",
                  "BrandName":"Capillary",
                  "GroupId":9985
               },
               {  
                  "ProductId":8284396,
                  "VariantProductId":28734,
                  "MRP":70.0,
                  "WebPrice":0.0,
                  "Quantity":1.0,
                  "description":"Green Capsicum",
                  "SupplierId":"98d18d82-ba59-4957-9c92-3f89207axxxx",
                  "CartReferenceKey":"4e5f0efe-2b24-42bb-a1cd-95c23256xxxx",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0.0,
                  "BundleCartReferenceKey":"b1fdc6b5-edc1-4e82-9b5b-ed5358f8xxxx",
                  "ItemPromotionDiscountAmount":0.0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Size",
                        "Value":"Personal | Serves 1"
                     },
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     }
                  ],
                  "Por":"w",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00216550",
                  "CategoryName":null,
                  "BrandId":"207294",
                  "BrandName":"Capillary",
                  "GroupId":9985
               },
               {  
                  "ProductId":8284687,
                  "VariantProductId":29062,
                  "MRP":70.0,
                  "WebPrice":0.0,
                  "Quantity":1.0,
                  "description":"Masala Soya Chunk",
                  "SupplierId":"98d18d82-ba59-4957-9c92-3f89207axxxx",
                  "CartReferenceKey":"6fafa915-45d2-4c70-a24b-18da4af8xxxx",
                  "TotalCap":0,
                  "CatalogpromotionDiscount":0.0,
                  "BundleCartReferenceKey":"b1fdc6b5-edc1-4e82-9b5b-ed5358f8xxxx",
                  "ItemPromotionDiscountAmount":0.0,
                  "IsPrimaryProduct":false,
                  "IsPromotionProduct":false,
                  "VariantsInfo":[  
                     {  
                        "PropertyName":"Size",
                        "Value":"Personal | Serves 1"
                     },
                     {  
                        "PropertyName":"Strength",
                        "Value":"Regular"
                     }
                  ],
                  "Por":"w",
                  "IsDefaultBundleItem":true,
                  "CartPromotionRules":[  

                  ],
                  "CategoryId":"CU00216550",
                  "CategoryName":null,
                  "BrandId":"207294",
                  "BrandName":"Capillary",
                  "GroupId":9985
               }
            ],
            "ItemPromotionDiscountAmount":0.0,
            "IsPrimaryProduct":false,
            "IsPromotionProduct":false,
            "Por":"",
            "IsDefaultBundleItem":false,
            "ProductImage":"/inc-yum-resources/98d18d82-ba59-4957-9c92-3f89207a34f6/Images/ProductImages/Source/1-aug-new-Paneer-Soya-Supreme.png;width=100;height=100;scale=canvas;anchor=bottomcenter",
            "CartPromotionRules":[  

            ],
            "CategoryId":"CU00216600",
            "CategoryName":"Pizza",
            "BrandId":"207294",
            "BrandName":"Capillary",
            "ParentCartItems":null
         }
      ],
      "Suppliers":[  
         {  
            "SupplierId":"98d18d82-ba59-4957-9c92-3f89207axxxx",
            "SupplierName":"PizzaHut",
            "IsSelected":false,
            "OrderStatus":null
         }
      ],
      "ShippingOptions":[  
         {  
            "SupplierId":"98d18d82-ba59-4957-9c92-3f89207axxxx",
            "ShippingMode":"0",
            "ShippingModeId":0,
            "isselected":true
         }
      ],
      "PaymentOptionsChannel":[  
         {  
            "MerchantId":"98d18d82-ba59-4957-9c92-3f89207axxxx",
            "PaymentType":"COD",
            "Paymentoption":"COD",
            "GatewayId":"0",
            "GatewayTitle":"COD",
            "PaidAmount":0.0,
            "EnalbeOTP":false
         },
         {  
            "MerchantId":"98d18d82-ba59-4957-9c92-3f89207axxxx",
            "PaymentType":"Credit",
            "Paymentoption":"<div style=\"padding-left:30px;\"><img src=\"/images/paymentoptions/Payment_RazorPay.jpg\" style=\"margin-left:4px;\" /><div >You can pay using RazorPay</div"
         }
      ]
   }
}

Adds an existing order items of a customer to the cart.

Resource Information
URI order/ReOrder/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/ReOrder/{merchantId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique merchant id (GUID) in which the order is placed

Request Body Parameters

Parameter Type Description
OrderId* int Existing Order id of the customer that you want to order again
orderItemId int Specify the order item id to reorder a specific item; 0 to consider the entire order items
UserId* string Unique GUID of the customer associated to the order

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
PriceCapped float -Deprecated-
TotalCap - -Deprecated-
CappedRefKey - -Deprecated-
Por 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)
GroupId int Determines the bundle group id of the nested cart item
IsFreeProduct enum Whether the current item is a free gift item. Value: Yes, No

Get Order History

Sample Request

http://www.martjack.com/developerapi/Order/History/81e77da2-723b-483d-8c0d-49f800c1exxx

Sample POST Request

MerchantID=81e77da2-723b-483d-8c0d-49f800c1exxx&InputFormat=application/json&InputData={  
   "UserId":"94b5215f-28d4-44f5-a1db-c47c5e1c9477",
   "FromDate":"02-02-2018 16:08:45",
   "ToDate":"20-02-2018 23:59:45"
}

Sample Response

{  
   "Message":"Successful ",
   "Orders":[  
      {  
         "AmountPayable":106200,
         "BillAddress1":"#103 1st Street SE",
         "BillAddress2":"MG Road",
         "BillCity":"Bangalore",
         "BillCountry":"India",
         "BillEmail":"tom.sawyer@example.com",
         "BillFirstname":"stagging first",
         "BillLastname":"stagging last",
         "BillMobile":"91-9090000000",
         "BillPhone":"91-9090000000",
         "BillZIP":"500001",
         "BillingState":"Karnataka",
         "ConversionFactor":"1",
         "DeliveryOption":"ship",
         "IsGift":false,
         "IsGift":false,
         "LeadTime":"",
         "MerchantId":"2c58c9c6-c9c9-49cf-b424-7acbc4e1xxx",
         "OrderDate":"02-02-2018 16:08:45",
         "OrderId":567282,
         "OrderLineId":null,
         "PaymentDetails":[  
            {  
               "AgentId":"",
               "Amount":"0",
               "Channel":"W",
               "ClientUserAgent":"Mozilla\/5.0 (Windows NT 6.1; rv:16.0) Gecko\/20100101 Firefox\/16.0",
               "CurrencyCode":"INR",
               "GV":"",
               "OrderId":567282,
               "PaymentDate":"1/1/1900",
               "PaymentDetailsId":539740,
               "PaymentOption":"OnlineBankTransfer",
               "PaymentResponse":"{\"TransactionType\":\"TPG\",\"Mode\":\"TPG\",\"Card\":\"xxxxxxxxxxxx\",\"ResponseMessage\":\"{\\\"MID\\\":\\\"CPWHOL99145646120719\\\",\\\"ORDERID\\\":\\\"6979181\\\",\\\"TXNAMOUNT\\\":\\\"7801.00\\\",\\\"CURRENCY\\\":\\\"INR\\\",\\\"TXNID\\\":\\\"70001001203\\\",\\\"BANKTXNID\\\":\\\"1233957\\\",\\\"STATUS\\\":\\\"TXN_SUCCESS\\\",\\\"RESPCODE\\\":\\\"01\\\",\\\"RESPMSG\\\":\\\"Txn Successful.\\\",\\\"TXNDATE\\\":\\\"2018-07-26 18:49:23.0\\\",\\\"GATEWAYNAME\\\":\\\"WALLET\\\",\\\"BANKNAME\\\":\\\"\\\",\\\"PAYMENTMODE\\\":\\\"PPI\\\",\\\"CHECKSUMHASH\\\":\\\"qLXOxRBDS5SHAjZu1xLcQovmM4OLv7kYa93lZO76XqgXR8mHfK7KsxNIEYQA2KgU8B6eXf2ZzWf95k6DoKY34ZQa7S/TvP5gasePQDjS+fA=\\\",\\\"orderID\\\":\\\"6979181\\\"}\"}",
               "PaymentStatus":"",
               "PaymentType":"OBT",
               "PointsBurned":"0",
               "ResponseCode":"N",
               "checkOutGroup":"",
               "clientIP":"183.82.0.171"
            }
         ],
         "PromotionDiscount":0,
         "Rewards":null,
         "ShipAddress1":"#001 Siva Enclave; MG Road",
         "ShipAddress2":"Stagging1 #001",
         "ShipCity":"Bangalore",
         "ShipCountry":"India",
         "ShipEmail":"tom.sawyer@example",
         "ShipFirstname":"stagging first",
         "ShipLastname":"stagging last",
         "ShipMobile":"91-9090909090",
         "ShipOtherCity":"Banglore",
         "ShipPhone":"91-9090000000",
         "ShipState":"Karnataka",
         "ShipZip":"500033",
         "ShippingDiscount":0,
         "Status":"P",
         "SupplierID":"00000000-0000-0000-0000-000000000000",
         "TAXTotal":0,
         "TotalAmount":106200,
         "UserId":"b97b0533-cb6b-4256-8730-26de981b9d02",
         "VocuherDiscount":0,
         "VoucherCode":null,
         "VoucherDiscount":0,
         "cpuserid":"00000000-0000-0000-0000-000000000000",
         "shipdate":null,
         "sku":null
      }
   ],
   "messageCode":"1004"
}

Retrieves order history of a merchant or customer based on the input parameters.

Resource Information
URI Order/History/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/History/{MerchantId}

Request Body Parameters

Parameter Type Description
UserId string The unique GUID of the customer whose details need to be retrieved
FromDate date-time Specify the duration for which you want to fetch the order history in FromDate and ToDate. Supported date format mm-dd-yyyy hh:mm:ss
ToDate date-time Specify the duration (in FromDate and ToDate) for which you want to fetch the order history. Supported date format: mm-dd-yyyy hh:mm:ss
Status enum Filter the search results by order status. Values: P for Pending, F for Cancel, A for Approved)
ShipDateFrom date-time Search orders shipped in a specific duration. Specify the shipped duration in ShipDateFrom and ShipDateTo in mm-dd-yyyy hh:mm:ss. If ShipDateFrom is specified, then you also need to specify ShipDateTo
ShipDateTo date-time FilSearch orders shipped in a specific duration. Specify the shipped duration in ShipDateFrom and ShipDateTo in mm-dd-yyyy hh:mm:ss. If ShipDateFrom is specified, then you also need to specify ShipDateTo
Sku string Fetch orders containing a specific product (SKU). You can also fetch with partial SKU to get the list of orders having SKUs that start with the keyword specified
OrderId int Retrieves the details of a orders with order id starting starting with the specified keyword. For example, if you specify 5550, you will get the list of all orders with order ids starting with 5500. You can also fetch a specific order by passing the complete order id.
FromOrder string The orderId sequence from which you want to fetch orders. For example, if you pass 34000, you will get all orders with orderId greater than or equal to 34000
store string Fetch orders based on the user role. Values: mystore, all, GUID and so on. For example, you can pass the GUID of a supplier to get all orders of the supplier
WithRewards boolean Fetch orders with loyalty rewards. Specify ‘True’ if you require reward/loyalty details. The default value will be ‘False’
LocationId string Order fulfillment location id
OperatorId string The logged in user id (of Anywhere Commerce’s Control Panel).

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
LeadTime int Minimum time period (in minutes) prior to the booking slot when the user is allowed for booking the slot. For example, if 60 minutes and booking slot is from 1 pm to 3 pm, user cannot book this slot anytime after 12 pm

Get Invoice Details

Sample Request

https://www.martjack.com/developerapi/Order/Invoice/f48fdd16-92db-4188-854d-1ecd9b62d067/invoice_hyc-00000576/18340

Sample Response


{
    "messageCode": "1004",
    "Message": "Successful",
    "InvoiceOrders": [
        {
            "OrderId": 7520003,
            "InvoiceDate": "27-Mar-2019",
            "ShipmentID": 5516645,
            "InvoiceNumber": "invoice_hyc-00000576",
            "MerchantId": "f48fdd16-92db-4188-854d-1ecd9b62d067",
            "UserId": "00000000-0000-0000-0000-000000000000",
            "OrderTotalAmount": 549,
            "externalInvoiceNumber": "HYC-123-1234",
            "InvoiceAmount": 549,
            "OrderDate": "27-Mar-2019",
            "OrderRefNumber": "3550",
            "BillFirstname": "Sana",
            "BillLastname": "Ta Minh",
            "BillCountry": "India",
            "BillingState": "Karnataka",
            "BillCity": "Bengaluru",
            "BillEmail": "sah.garj@example.com",
            "BillZIP": "560078",
            "BillPhone": "",
            "BillMobile": "7411982768",
            "BillAddress1": "Yen Lac",
            "BillAddress2": "",
            "BillCityCode": "19761",
            "BillStateCode": "KA",
            "BillCountryCode": "IN",
            "ShipFirstname": "Sana",
            "ShipLastname": "Ta Minh",
            "ShipCountry": "India",
            "ShipState": "Karnataka",
            "ShipCity": "Bengaluru",
            "ShipEmail": "sah.garj@example.com",
            "ShipZip": "560078",
            "ShipPhone": "7411982768",
            "ShipMobile": "7411982768",
            "ShipAddress1": "Yen Lac",
            "ShipAddress2": "Yen Lac",
            "ShipOtherCity": "",
            "ShipCityCode": "19761",
            "ShipStateCode": "KA",
            "ShipCountryCode": "IN",
            "ShipLat": 0,
            "ShipLong": 0,
            "LocationCode": "1001",
            "TaxTotal": 0,
            "ShippingCost": 0,
            "IsGift": false,
            "Rewards": null,
            "PromotionDiscount": 0,
            "DemandedDeliveryDate": "01-Jan-1900",
            "MerchantGSTIN": "",
            "TaxableInvoiceNumber": null,
            "BillofSupplyInvoiceNumber": "invoicebill_hyc-002194",
            "deliveryslot": {
                "StartTime": "12: 00 AM",
                "EndTime": "12:00 AM",
                "DeliverySlotId": null
            },
            "InvoiceLineItem": [
                {
                    "ShipmentItemId": 22091385,
                    "OrderLineId": 26178585,
                    "OrderId": 7520003,
                    "ProductId": 11995626,
                    "VariantProductId": 0,
                    "Quantity": 1,
                    "ShippingCost": 0,
                    "ProductPrice": 549,
                    "PromotionDiscount": 0,
                    "TaxAmount": "0",
                    "DeliveryMode": "H",
                    "VendorId": "00000000-0000-0000-0000-000000000000",
                    "SKU": "100011145",
                    "VariantSku": null,
                    "ProductTitle": "Nestle Milkmaid - 400g Tin",
                    "HSNCode": "04029920",
                    "MRP": "115.000",
                    "CatalogDiscount": 0,
                    "UOM": "Pieces",
                    "AverageWeight": "0",
                    "IsTaxable": "False",
                    "TaxDetails": [],
                    "BatchNo": null,
                    "PickingPrice": 0,
                    "PickListCustomFields": [],
                    "TotalTaxOnDeliveryCharge": 0,
                    "ShipmentCustomFields": null
                }
            ],
            "ShippingStatus": "R"
        }
    ],
    "ErrorCode": 0
}

Retrieves details of a specific invoice.

Resource Information
URI Order/Invoice/{merchantId}/{InvoiceNumber}/{LocationRefCode}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/order/invoice/{merchantid}/{InvoiceNumber}/{LocationRefCode}

Request Path Parameters

Parameter Type Description
merchantid* string The unique id (GUID) of the merchant associated to the order invoice
InvoiceNumber* string The invoice number that you want to fetch
LocationRefCode* string The location code of the order fulfillment store

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
LeadTime int Minimum time period (in minutes) prior to the booking slot when the user is allowed for booking the slot. For example, if 60 minutes and booking slot is 1 pm to 3 pm, user cannot book this slot anytime after 12 pm
ConversionFactor float The currency conversion ratio. Applicable for merchants with multiple currencies
StockAction string Whether the item participates in reduction of stock or not. Value: UpdateStock,Do Not UpdateStock, None
IsBackOrder enum Can the item be ordered even when out of stock. Value: true, or false

Get Order Details

Sample Request

http://www.martjack.com/DeveloperAPI/Order/Details/81e77da2-723b-483d-8c0d-49f800c1xxxx/55783

Sample Response

{  
   "Message":"Successful ",
   "OrderLines":[  
      {  
         "CustomFields":"",
         "Description":"Set of 3 lunch boxes",
         "IsBackOrder":false,
         "IsParentProduct":true,
         "OrderId":55783,
         "OrderLineId":64970,
         "ProductId":524306,
         "ProductPrice":14.43,
         "Quantity":1,
         "ReturnAction":"",
         "ReturnQty":0,
         "ReturnReason":"0",
         "ShippingCost":1.0878,
         "ShippingVoucherDiscount":0,
         "StockAction":"",
         "TotalPromotionDiscount":0,
         "TotalTaxAmount":0,
         "TotalVoucherDiscount":0,
         "VariantMasterProductId":0,
         "VariantProductId":53587
      }
   ],
   "messageCode":"1004"
}

Retrieves details of a specific order.

Resource Information
URI Order/Details/{MerchantId}/{OrderId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Order/Details/{MerchantId}/{OrderId}

Request Parameters

Parameter Type Description
MerchantId* string The unique id (GUID) of the merchant from which you want to fetch order details
OrderId* int The order id 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
VariantMasterProductId int Master product id of the variant product
VariantProductId int Unique id of the variant product

Get Order Information (V2)

Sample Request

https://www.martjack.com/developerapi/Order/V2/81e77da2-723b-483d-8c0d-49f800c1xxxx/3390199

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "Orders": [
        {
            "OrderId": 3390199,
            "Status": "S",
            "MerchantId": "81e77da2-723b-483d-8c0d-49f800c1xxxx",
            "UserId": "7b0873e5-e8ed-45b4-bee8-204489a2axxx",
            "TotalAmount": 3.25,
            "AmountPayable": 3.25,
            "OrderDate": "/Date(1541771716000+0530)/",
            "BillFirstname": "Tom",
            "BillLastname": "Sawyer",
            "BillCountry": "الكويت",
            "BillingState": "حولي",
            "BillCity": "السالمية",
            "BillEmail": "tom.sawyer@example.com",
            "BillZIP": "0",
            "BillPhone": "97175040",
            "BillMobile": "97175040",
            "BillAddress1": "Block 12, Abo Horaira Street",
            "ShipFirstname": "Tom",
            "ShipLastname": "",
            "ShipCountry": "الكويت",
            "ShipState": "حولي",
            "ShipCity": "السالمية",
            "ShipEmail": "tom.sawyer@example.com",
            "ShipZip": "0",
            "ShipPhone": "97175040",
            "ShipMobile": "97175040",
            "ShipAddress1": "",
            "ShipOtherCity": null,
            "DeliveryOption": "pickup",
            "TAXTotal": 0,
            "VoucherCode": "",
            "LeadTime": "",
            "BillAddress2": "",
            "ShipAddress2": "",
            "IsGift": false,
            "SupplierID": "00000000-0000-0000-0000-000000000000",
            "ConversionFactor": "1",
            "cpuserid": "00000000-0000-0000-0000-000000000000",
            "OrderLineId": [
                {
                    "OrderLineId": 21160149,
                    "OrderId": 3390199,
                    "ProductId": 8303029,
                    "VariantProductId": 0,
                    "IsParentProduct": false,
                    "Description": "",
                    "Quantity": 1,
                    "ShippingCost": 0,
                    "ProductPrice": 0,
                    "TotalPromotionDiscount": 0,
                    "ReturnReason": "",
                    "ReturnAction": "",
                    "StockAction": "",
                    "ReturnQty": 0,
                    "IsBackOrder": false,
                    "TotalVoucherDiscount": 0,
                    "TotalTaxAmount": 0,
                    "ShippingVoucherDiscount": 0,
                    "CustomFields": "",
                    "VariantMasterProductId": 0,
                    "LocationCode": "111",
                    "ShippingStatus": "W",
                    "DeliveryMode": "S",
                    "VendorId": "2002cbfe-9adf-42ac-9bfd-8e013fee7gtr",
                    "ItemStatus": "S",
                    "SKU": "Dls-130031",
                    "VariantSku": "",
                    "ProductTitle": "BUY ONE GET ONE FREE- Medium",
                    "BundleProductId": "8303029",
                    "ParentReDetailsId": "0",
                    "IsPrimaryProduct": "false",
                    "Portion": "",
                    "MRP": "0.0000",
                    "TaxDetails": [],
                    "LocationId": 13360,
                    "CategoryId": "CU00215646",
                    "CategoryName": "Deals",
                    "CancelQuantity": 0,
                    "DerivedStatus": "Waiting for Collection - Instore",
                    "DerivedStatusCode": "W",
                    "EstimatedDeliveryTime": "01-Jan-0001 12:00:00 AM",
                    "PromotionIds": null,
                    "SubStatus": ""
                },
                {
                    "OrderLineId": 21160151,
                    "OrderId": 3390199,
                    "ProductId": 8303031,
                    "VariantProductId": 0,
                    "IsParentProduct": false,
                    "Description": "",
                    "Quantity": 1,
                    "ShippingCost": 0,
                    "ProductPrice": 0,
                    "TotalPromotionDiscount": 0,
                    "ReturnReason": "",
                    "ReturnAction": "",
                    "StockAction": "",
                    "ReturnQty": 0,
                    "IsBackOrder": false,
                    "TotalVoucherDiscount": 0,
                    "TotalTaxAmount": 0,
                    "ShippingVoucherDiscount": 0,
                    "CustomFields": "",
                    "VariantMasterProductId": 0,
                    "LocationCode": "111",
                    "ShippingStatus": "W",
                    "DeliveryMode": "S",
                    "VendorId": "81e77da2-723b-483d-8c0d-49f800c1xxxx",
                    "ItemStatus": "S",
                    "SKU": "Pz-New-Spicy-Chicken-Ranch",
                    "VariantSku": "",
                    "ProductTitle": "New Spicy Chicken Ranch",
                    "BundleProductId": "8303029",
                    "ParentReDetailsId": "21160149",
                    "IsPrimaryProduct": "false",
                    "Portion": "W",
                    "MRP": "0.0000",
                    "TaxDetails": [],
                    "LocationId": 13360,
                    "CategoryId": "CU00215656",
                    "CategoryName": "Chicken",
                    "BundleCartReferenceKey": "00b623ee-cc01-4aaf-8b02-69c047fb4c66",
                    "CancelQuantity": 0,
                    "DerivedStatus": "Waiting for Collection - Instore",
                    "DerivedStatusCode": "W",
                    "EstimatedDeliveryTime": "01-Jan-0001 12:00:00 AM",
                    "PromotionIds": null,
                    "SubStatus": ""
                },

            ],
            "PaymentDetails": [
                {
                    "PointsBurned": "0",
                    "AgentId": "",
                    "GV": "",
                    "Channel": "W",
                    "CurrencyCode": "KWD",
                    "PaymentResponse": "",
                    "PaymentStatus": "A",
                    "Amount": "3.2500",
                    "PaymentDate": "11/9/2018 7:25:16 PM",
                    "PaymentType": "COD",
                    "OrderId": 3390199,
                    "PaymentDetailsId": 3395813,
                    "checkOutGroup": "",
                    "PaymentOption": "COD",
                    "clientIP": "",
                    "ResponseCode": "N",
                    "ClientUserAgent": "API"
                }
            ],
            "Rewards": null,
            "ShippingDiscount": 0,
            "VoucherDiscount": 0,
            "PromotionDiscount": 0,
            "OriginalOrderId": "",
            "ReturnOrderId": "",
            "ReferenceNo": "",
            "DemandedDeliveryDate": "09-Nov-2018",
            "deliveryslots": {
                "StartTime": "08:00 PM",
                "EndTime": "08:15 PM",
                "DeliverySlotId": "14136"
            },
            "PickupFirstName": "",
            "PickupLastName": "",
            "PickupEmail": "",
            "PickupMobile": "",
            "Latitude": "0",
            "Longitude": "0",
            "GiftMessage": "جبن زيادة",
            "LanguageCode": "ar",
            "ShipCityCode": "39440",
            "ShipStateCode": "KW13",
            "BillCityCode": "39440",
            "ShipCountryCode": "KW",
            "BillStateCode": "KW13",
            "BillCountryCode": "KW",
            "RefundAmount": "0",
            "ChannelID": "0",
            "IsSelfShip": "False",
            "ChannelOrderID": "0",
            "Promotions": null,
            "SubStatus": "IK",
            "OrderAttributes": [
                {
                    "OrderId": 3390199,
                    "MerchantId": "81e77da2-723b-483d-8c0d-49f800c1xxxx",
                    "AttributeID": 18,
                    "AttributeName": "IsImmediateOrder",
                    "Value": "true"
                },
                {
                    "OrderId": 3390199,
                    "MerchantId": "81e77da2-723b-483d-8c0d-49f800c1xxxx",
                    "AttributeID": 32,
                    "AttributeName": "channelid",
                    "Value": "PWA,android"
                }
            ],
            "SourceLocationID": "13360",
            "SourceLocationCode": "111",
            "OrderDateLocal": null,
            "AutoUpdateTime": "/Date(1541781700000+0530)/"
        }
    ],
    "ErrorCode": 0
}

Retrieves the details of a specific order of a merchant.
URI order/V2/{{MerchantId}}/{orderID}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support Yes

Request URL

{host}/developerapi/order/V2/{MerchantId}/{orderID}

Request Path Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchant associated to the order
orderID* int Order id for which you want to fetch details
V2* string Supported API version

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
IsBackOrder enum Can the item be ordered even when out of stock. Value: true, or false
VariantMasterProductId int Unique id of the master product for the current variant

Get Order Details (by ReferenceNo)

Retrieves the details of a specific order based on the order reference number passed.

Sample Request

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

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "OrderLines": [
    {
      "OrderLineId": 26808837,
      "OrderId": 7804535,
      "ProductId": 14105696,
      "VariantProductId": 10175720,
      "IsParentProduct": true,
      "Description": "Size=10-11 yrs",
      "Quantity": 1,
      "ShippingCost": 0,
      "ProductPrice": 8750,
      "TotalPromotionDiscount": 0,
      "ReturnReason": "0",
      "ReturnAction": "",
      "StockAction": "",
      "ReturnQty": 0,
      "IsBackOrder": false,
      "TotalVoucherDiscount": 0,
      "TotalTaxAmount": 0,
      "ShippingVoucherDiscount": 0,
      "CustomFields": null,
      "VariantMasterProductId": 0,
      "Orderrefreneceno": "order1",
      "CancelQuantity": 0,
      "PromotionIds": null,
      "SubStatus": null,
      "IsFreebie": 0,
      "FreebieParent": null
    },
    {
      "OrderLineId": 26493499,
      "OrderId": 7664867,
      "ProductId": 12973016,
      "VariantProductId": 9929422,
      "IsParentProduct": true,
      "Description": "Size=FREE",
      "Quantity": 1,
      "ShippingCost": 0,
      "ProductPrice": 8750,
      "TotalPromotionDiscount": 0,
      "ReturnReason": "1",
      "ReturnAction": "RP",
      "StockAction": "DS",
      "ReturnQty": 1,
      "IsBackOrder": false,
      "TotalVoucherDiscount": 0,
      "TotalTaxAmount": 0,
      "ShippingVoucherDiscount": 0,
      "CustomFields": null,
      "VariantMasterProductId": 0,
      "Orderrefreneceno": "order1",
      "CancelQuantity": 0,
      "PromotionIds": null,
      "SubStatus": null,
      "IsFreebie": 0,
      "FreebieParent": null
    },
    {
      "OrderLineId": 26105069,
      "OrderId": 7483875,
      "ProductId": 12973016,
      "VariantProductId": 9929422,
      "IsParentProduct": true,
      "Description": "Size=FREE",
      "Quantity": 1,
      "ShippingCost": 0,
      "ProductPrice": 8750,
      "TotalPromotionDiscount": 0,
      "ReturnReason": "0",
      "ReturnAction": "",
      "StockAction": "",
      "ReturnQty": 0,
      "IsBackOrder": false,
      "TotalVoucherDiscount": 0,
      "TotalTaxAmount": 0,
      "ShippingVoucherDiscount": 0,
      "CustomFields": null,
      "VariantMasterProductId": 0,
      "Orderrefreneceno": "order1",
      "CancelQuantity": 0,
      "PromotionIds": null,
      "SubStatus": null,
      "IsFreebie": 0,
      "FreebieParent": null
    },
    {
      "OrderLineId": 25927335,
      "OrderId": 7400925,
      "ProductId": 10997762,
      "VariantProductId": 6740894,
      "IsParentProduct": true,
      "Description": "Colour=Yellow;Size=32",
      "Quantity": 1,
      "ShippingCost": 0,
      "ProductPrice": 8750,
      "TotalPromotionDiscount": 0,
      "ReturnReason": "0",
      "ReturnAction": "",
      "StockAction": "",
      "ReturnQty": 0,
      "IsBackOrder": false,
      "TotalVoucherDiscount": 0,
      "TotalTaxAmount": 0,
      "ShippingVoucherDiscount": 0,
      "CustomFields": null,
      "VariantMasterProductId": 0,
      "Orderrefreneceno": "order1",
      "CancelQuantity": 0,
      "PromotionIds": null,
      "SubStatus": null,
      "IsFreebie": 0,
      "FreebieParent": null
    },
    {
      "OrderLineId": 24075722,
      "OrderId": 6593334,
      "ProductId": 11002174,
      "VariantProductId": 6763842,
      "IsParentProduct": true,
      "Description": "Colour=Orange;Size=32",
      "Quantity": 1,
      "ShippingCost": 0,
      "ProductPrice": 5000,
      "TotalPromotionDiscount": 0,
      "ReturnReason": "0",
      "ReturnAction": "",
      "StockAction": "",
      "ReturnQty": 0,
      "IsBackOrder": false,
      "TotalVoucherDiscount": 0,
      "TotalTaxAmount": 0,
      "ShippingVoucherDiscount": 0,
      "CustomFields": null,
      "VariantMasterProductId": 0,
      "Orderrefreneceno": "order1",
      "CancelQuantity": 0,
      "PromotionIds": null,
      "SubStatus": null,
      "IsFreebie": 0,
      "FreebieParent": null
    }
  ],
  "ErrorCode": 0
}

Resource Information
URI /Order/DetailsByRefCode/{merchantId}/{orderReferenceNo}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Order/DetailsByRefCode/{merchantId}/{orderReferenceNo}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
orderReferenceNo* string Reference number of the order that you want to fetch

Response Parameters

Parameter Type Description
TotalPromotionDiscount float Total promotional discount received for the product
ReturnReason string Reason for returning the item. Applicable for return items. Values:
WID - Wrong item delivered
BAQ - Bad Quality
DLP - Did not like the product
DPR - Defective/Damage product received
RD - Received Damaged DP - Defective Product
II - Incorrect Item received
UW Unwanted Gift
US - Unsuitable
UP - Unlike Photo, TS - Too Small
OT - Other
FD - Fraud
IE - Incorrect Size
PDR - Product is damaged
WPD - Product is not as per website description
CR - Customer Remorse
PWF - Product is not properly functioning
IsBackOrder boolean Whether the item can be ordered even when it is out of stock
ShippingVoucherDiscount float Discount amount, though voucher, availed on the shipment
SubStatus enum Sub status of the order as configured in the CP. For example, RJ for rejected. You can find the order sub-statuses configured on the CP Settings > Application settings > Order settings > Order Substatus
IsFreebie enum Whether the item is a free gift item or not. Value 0 for no, 1 for yes
FreebieParent string Unique id of the freebie parent product

Get Order Lineitem Details

Retrieves the details line items of a specific order.

Sample Request

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

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "OrderLines": [
    {
      "OrderLineId": 24075722,
      "OrderId": 6593334,
      "ProductId": 11002174,
      "VariantProductId": 6763842,
      "IsParentProduct": true,
      "Description": "Colour=Orange;Size=32",
      "Quantity": 1,
      "ShippingCost": 0,
      "ProductPrice": 5000,
      "TotalPromotionDiscount": 0,
      "ReturnReason": "0",
      "ReturnAction": "",
      "StockAction": "",
      "ReturnQty": 0,
      "IsBackOrder": false,
      "TotalVoucherDiscount": 0,
      "TotalTaxAmount": 0,
      "ShippingVoucherDiscount": 0,
      "CustomFields": "",
      "VariantMasterProductId": 0,
      "LocationCode": "OCDEL",
      "DeliveryMode": "H",
      "VendorId": "00000000-0000-0000-0000-000000000000",
      "ItemStatus": "IC",
      "SKU": "RB3196",
      "VariantSku": "RB3196-8903098726550",
      "ProductTitle": "Chanderi Straight Suit Set By Rohit Bal(Colour=Orange;Size=32)",
      "LocationId": 16696,
      "CancelQuantity": 0,
      "PromotionIds": null,
      "SubStatus": null,
      "IsFreebie": 0,
      "FreebieParent": null
    }
  ],
  "ErrorCode": 0
}

Resource Information
URI /Order/LineItem/{merchantId}/{orderLineId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Order/LineItem/{merchantId}/{orderLineId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
orderLineId* int Unique id of the order line item

Response Parameters

Parameter Type Description
TotalPromotionDiscount float Total promotional discount received for the item
ReturnReason string Reason for returning the item. Applicable for return items. Values:
WID - Wrong item delivered
BAQ - Bad Quality
DLP - Did not like the product
DPR - Defective/Damage product received
RD - Received Damaged DP - Defective Product
II - Incorrect Item received
UW Unwanted Gift
US - Unsuitable
UP - Unlike Photo, TS - Too Small
OT - Other
FD - Fraud
IE - Incorrect Size
PDR - Product is damaged
WPD - Product is not as per website description
CR - Customer Remorse
PWF - Product is not properly functioning
IsBackOrder boolean Can the item be ordered even when out of stock
ShippingVoucherDiscount float Discount on shipping through voucher
VendorId string Unique GUID of the supplier of the item
ItemStatus enum Current status of the item. Authorized - A, Return Initiated - RI, Reverse Shipment Initiated - RS, Reverse Shipment Received - RR, Shipment Closed - RC, Shipment Created - S, RTO Initiated - I, RTO Received - O, RTO Lost - L, Others - X, Dispatched - R, In Transit - T, Out for Delivered - U, Delivered - D, RTO Closed - C, Refund - AF, Reverse Shipment Picked - RP, Returned - SR, Cancelled - IC, Failed - F, Partially Cancelled - PC, Pending - P, Picklist Created - PLC, Picklist Completed - PLCL, In Picking - PLIP, Cancelled - Refund Initiated - ICI, Cancelled & Refunded - ICC, Partial Cancelled & Refund Initiated - PCI, Partial Cancelled - Refunded - PCC, RTO - Refunded/Replacement Closed - E, Waiting for Collection - W, At Gate - G.
SubStatus enum Sub status of the as configured in the CP. For example, RJ for rejected. You can find the order sub-statuses configured on the CP Settings > Application settings > Order settings > Order Substatus
IsFreebie enum Whether the item is a free gift item. Value 0, for no and 1 for yes
FreebieParent string Unique freebie id of the parent product (parent product for which the item is free)

Get Order Status

Sample Request

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

Sample Response

{
  "messageCode": "1004",
  "Message": null,
  "ErrorCode": 0,
  "OrderStatus": {
    "OrderId": 7506651,
    "status": "D",
    "subStatus": ""
  }
}

Retrieves current status of an order based on the order id.

Resource Information
URI Order/GetOrderStatus/{MerchantId}/{orderId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/GetOrderStatus/{MerchantId}/{orderId}

Request Path Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchant
orderId* int Order id for which you want to see the current status

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
status enum Current status of an order. Values: P for pending, C for canceled, F failed, A for authorized, S for shipped, D for delivered
SubStatus enum Sub status of the order as configured in the CP. For example, RJ for rejected. You can find all available sub-statuses in CP Settings > Application settings > Order settings > Order Substatus

Cancel Order

Sample Request

https://www.martjack.com/developerapi/Order/Cancel

Sample POST Request

MerchantID=f48fdd16-92db-4188-854d-1ecd9b62d066&InputFormat=application/json&InputData={
   "merchantId":"f48fdd16-92db-4188-854d-1ecd9b62d066",
   "OrderId":"6261090",
   "Comment":"Ordered wrong item",
   "PGResponse":"",
   "OperatorID":"f48fdd16-92db-4188-854d-1ecd9b62d066",
   "DisplayCommentToUser":"false",
   "date":"01/24/2018 4:12:32 PM",
   "CancelReason":"NDA"
}

Sample Response

{
  "messageCode": "1002",
  "Message": "Cancelled successfully"
}

Cancels a specific order of a customer placed on a merchant store. An order can be canceled only if the logged in user has sufficient permission to cancel the order and the order is not shipped at the time of cancellation.

However, you can cancel the order if

Resource Information
URI Order/Cancel
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/Cancel

Request Body Parameters

Parameter Type Description
Merchant Id* string The unique id (GUID) of the merchant associated to the order
OrderId* int Provide the order id that you want to cancel
Date* date-time Date and time when the order is created in MM/DD/YYYY HH:MM:SS AM/PM format
Comment string Specify the customer’s reason for the order cancellation
DisplayCommentToUser boolean Value: True/False. Specify whether to make the custom comment visible (True) or invisible (False) to the end-customer
PGResponse string The response received from the payment gateway
OperatorID string Current user id - It could be store, admin, manager
CancelReason* string Specify the predefined reason code for the order cancellation. Values:
NDA: Order not in delivery Area
ICI: Incorrect Contact information
ODM: Order less than order delivery minimum value
OND: Order not delivered
SLA: SLA expired in Acknowledgment
SLN: SLA expired in New Order
QMA: Order Expired due to Quantity Mismatch from Aggregator
RDA: Retailer did Not allocate items to aggregator
CPR: Cancellation as per customer request
INA: Item Not available/Unsellelable
OPM: Order placed by mistake
DTM: Order delivery Is taking too much time
OEQ: By mistake ordered extra quantity
BFS: Bought it from somewhere else
CSA: I want to change my shipping address
CMP: I want to change my mode of payment
CHA: Product cost Is high compared to another website
SCH: Shipping charges are too high
PNR: Payment not received

Cancel Order Lineitem

Sample Request

https://www.martjack.com/developerapi/Order/CancelItem

Sample POST Request

MerchantID=98d18d82-ba59-4957-9c92-3f89207a3xxx&InputFormat=application/json&InputData={  
   "merchantId":"98d18d82-ba59-4957-9c92-3f89207a3xxx",
   "OrderId":"2658242",
   "Comment":"Test",
   "PGResponse":"",
   "OperatorID":"98d18d82-ba59-4957-9c92-3f89207a3xxx",
   "DisplayCommentToUser":"false",
   "date":"11/08/2017 4:12:32 PM",
   "CancelReason":"NDA",
   "TobeCancelledOrderItems":[  
      {  
         "OrderItemID":8518882,
         "CancelQuantity":1
      }
   ]
}

Sample Response

{
  "messageCode": "1002",
  "Message": "Cancelled successfully"
}

Lets you cancel specific items of an order (partial cancellation). You can cancel an order item only if

Resource Information

Parameter Description
URI Order/CancelItem
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/CancelItem

Request Body Parameters

Parameter Type Description
Merchant Id* string The unique id (GUID) of the merchant in which the order is placed
OrderId* int Provide the order id that you want to cancel
Date* date Date and time when the order is created in MM/DD/YYYY HH:MM:SS AM/PM format
Comment string Specify the customer’s reason for the order cancellation
DisplayCommentToUser boolean Value: True/False. Specify whether to make the comment visible (True) or hidden (False) to the end-customer
PGResponse string The response received from the payment gateway for that specific order
OperatorID string Current CP user id
CancelReason* string Specify the predefined reason code for the order cancellation. Values:
NDA: Order not in delivery Area
ICI: Incorrect Contact information
ODM: Order less than order delivery minimum value
OND: Order not delivered
SLA: SLA expired in Acknowledgment
SLN: SLA expired in New Order
QMA: Order Expired due to Quantity Mismatch from Aggregator
RDA: Retailer did Not allocate items to aggregator
CPR: Cancellation as per customer request
INA: Item Not available/Unsellelable
OPM: Order placed by mistake
DTM: Order delivery Is taking too much time
OEQ: By mistake ordered extra quantity
BFS: Bought it from somewhere else
CSA: I want to change my shipping address
CMP: I want to change my mode of payment
CHA: Product cost Is high compared to another website
SCH: Shipping charges are too high
PNR: Payment not received
TobeCancelledOrderItems obj Specify the items that you want to cancel in OrderItemID and CancelQuantity

Add Order Lineitem

Lets you add an item to an existing order.

Sample Request

https://www.martjack.com/developerapi/Order/AddOrderLineItem/98d18d82-ba59-4957-9c92-3f89207a32d4

Sample POST Request


MerchantID=98d18d82-ba59-4957-9c92-3f89207a32d4&InputFormat=application/json&InputData={  
   "OrderID":6419643,
   "SKU":"Fruits0025",
   "VarientSKU":"Fruits0025-2-New",
   "Quantity":1,
   "LocationCode":"20518",
   "DeliveryMode":"H",
   "ItemAction":1
}

Sample Response

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

Resource Information
URI /Order/AddOrderLineItem/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/AddOrderLineItem/{MerchantId}

Request Body Parameters

Parameter Type Description
OrderID* int Unique id of the order to which you want to add items
SKU* string SKU of the product that you want to add/update
VarientSKU string Variant SKU of the item that you want to add. Required to add variant product
Quantity* int Quantity of the current item (SKU/variantSKU) that you want to add. The value you mention herein will add to the existing quantity but not overrides the existing quantity
LocationCode* int Location code of the item
DeliveryMode* enum Mode of delivery of the current item. Values: H for home delivery, S for store pick-up
ItemAction* enum Specify 1 to add items to the existing list. Only one value is supported currently

Process Return

Sample Request

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

Sample POST Request

InputFormat=application/json&merchantId=f48fdd16-92db-4188-854d-1ecd9b62xxxx&InputData={    
   "OrderId":"6071567",
   "ReturnRequestId":"72380",
   "ReturnChangeAction":{  
      "Substatus":"RA",
      "SubstatusChangeComments":"QC done"
   },
   "returnrequestdetails":[  
      {  
         "ReturnRequestDetailId":"109134",
         "ReturnItemChangeAction":{  
            "Substatus":"RA",
            "SubstatusChangeComments":"QC comment"
         }
      }
   ]
}

Sample Response

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

Lets you process return requests and change the sub-status of the return requests.

For return requests, a brand could configure multiple sub-statuses according to its work-flow.

Resource Information
URI /Order/ProcessReturn/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/ProcessReturn/{MerchantId}

Request Body Parameters

Parameter Type Description
OrderId* int Order ID of the return items
ReturnRequestId int Return Request ID. Leave this blank if you want to just modify the return details
Substatus string Sub-status code of the return request (Preconfigured values only). Leave this blank if you want to just modify the return details
SubstatusChangeComments string Specify the reason for return sub-status change. You can enter up to 50 characters

Update Return Request Status

Lets you update the status of a return request.

Sample Request

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

Sample POST Request

MerchantId=9820eca5-d11f-4df1-9b20-983a45ea9631&InputFormat=application/json&InputData={
   "UpdateReturnRequestStatus":{
      "ReturnRequestID":"820083",
      "Status":"P",
      "OperatorId":"6c57599f-2c43-4c82-806a-e07c3410f5d3"
   }
}

Sample Response

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

Resource Information
URI /Order/UpdateReturnRequestStatus/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/UpdateReturnRequestStatus/{merchantId}

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
ReturnRequestID* int Unique id of the return request that you want to update
Status* enum New status of the return request. Values: Refund Completed - RC, Initiated - I, Received - R, Picked - P, Pending Pickup - S, Closed - C
OperatorId string Unique id of the store operator that is updating the status

Ship Order (Create Shipment)

Sample Request

http://www.martjack.com/DeveloperAPI/Order/Ship

Sample POST Request

MerchantID=fccabc5b-aa81-4346-b536-0fd6bc94c837&InputFormat=application/json&InputData={  
   "shipment":{  
      "OrderId":"7503709",
      "LocationRefCode":"",
      "LogisticsType": "ConfiguredProvider",
      "ShipDate":"2019/11/01",
      "ShipmentType":"normal",
      "CourierName":"test",
      "AWBNumber":"12345",
      "lineitems":[  
         {  
            "OrderLineId":"26147149",
            "Weight":"3",
            "Quantity":"1"
         }
      ],
      "ShipmentTrip":{  
         "RiderID":2,
         "RiderCode":"",
         "TripRefNo":"WRWGG123456",
         "VehicleNumber":"1234",
         "Comments":"Sample comment",
         "Attributes":[  
            {  
               "Name":"Mobile",
               "Value":"9090000000"
            }
         ]
      },
      "MerchantId":"fccabc5b-aa81-4346-b536-0fd6bc94c837"
   }
}

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "Shipments": [
        {
            "LocationId": 0,
            "ShipmentType": null,
            "ReceivedBy": null,
            "DeliveredDate": null,
            "ShipmentId": 5516207,
            "OrderId": 0,
            "ServiceProvider": null,
            "DocketNumber": null,
            "ShippingDate": null
        }
    ],
    "ErrorCode": 0
}

Lets you add shipment details for a specific order.

Resource Information
URI /Order/Ship
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/Ship

Request Body Parameters

Parameter Type Description
MerchantId* string The unique id (GUID) of the merchant in which the order is registered or placed
OrderId* int The order id of the current shipment item
AWBNumber* string The air way bill number generated for the shipment
CourierName* string The courier service used for shipment
LogisticsType enum Specify ConfiguredProvider if the logistic provider is configured for the merchant; else leave it blank. You need to pass the AWBNumber and CourierName if LogisticType is blank. If ConfiguredProvider, AWB number will be considered or assigned as per configured
ShipDate* date The date on which the order is shipped in yyyy/mm/dd format
ShipmentType* enum The type of shipment. Value: Normal for shipments from warehouse to customer, Reverse for return shipments, i.e., customer to warehouse
LocationRefCode* string Location reference code of the order fulfillment store
lineitems* obj The details of each line item. Specify OrderLineId and Quantity
ShipmentTrip obj Provide more details of the shipment in the parameters specified below. Use this only if applicable for the current merchant
RiderID int Specify the rider id as available in the merchant system
RiderCode string Specify the rider code as available in the merchant system
TripRefNo string Specify the trip reference number as per the merchant system
VehicleNumber string Specify the vehicle number of the delivery vehicle
Attributes obj Specify any additional information such as delivery guy’s mobile number

Create Shipment Packages

Sample Request

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

Sample POST Request

InputFormat=application/json&merchantId=f48fdd16-92db-4188-854d-1ecd9b62xxxx&InputData={
  "CreateShipmentPackages": {
    "OrderID": "6402591",
    "ShipmentType": "Normal",
    "AirwayBillNo": "123456",
    "CourierName": "Custom",
    "ShipmentPickupDate": "2018/10/30",
    "LocationCode": "1001",
    "ShipmentPackageInputs": [
    {
            "PackageCode": "FN322",
            "PackingSupplyRefCode": "LOOSE",
            "PackageID": "16",
            "ShipmentPackageItems": [
            {
                    "OrderItemId": "23356065",
                    "Quantity": 1
            },
            {
                    "OrderItemId": "23356068",
                    "Quantity": 1
            }
             ]
    },
    {
            "PackageCode": "NEW44",
            "PackingSupplyRefCode": "HIGH",
            "PackageID": "18",
            "ShipmentPackageItems": [
            {
                    "OrderItemId": "23356080",
                    "Quantity": 2
            },
            {
                    "OrderItemId": "23356088",
                    "Quantity": 1
            }
            ]
    }
       ]
  }
}

Sample Response

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

Creates shipment packages for a specific order.

Resource Information
URI /Order/CreateShipmentPackages/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/CreateShipmentPackages/{MerchantId}

Request Body Parameters

Parameter Type Description
OrderID* int The order id for which you want to create shipment packages
ShipmentType* string Type of shipment. Value: Normal for shipments from warehouse to customer, Reverse for shipments customer to warehouse (return pickup)
AirwayBillNo* string Airway bill number provided by the courier service
CourierName* string Name of the courier service used for shipment
ShipmentPickupDate* date-time Pickup date of the shipment in YYYY/MM/DD format
LocationCode* string Location code of the order fulfillment location (Generally used for Location specific merchants)
PackageCode string Unique code generated for the package
PackingSupplyRefCode string Unique reference code generated for the package while creating
PackageID int Unique id of the package
OrderItemId* int Order line item id of that specific item
Quantity* int Quantity of the current order item

Change Order Sub-status

Lets you modify the sub-status of an order or item to rejected (to trigger the allocation rules again).

Sample Request

https://www.martjack.com/developerapi/Order/ChangeSubStatus/81e77da2-723b-483d-8c0d-49f800c1xxxx/7680905

Sample POST Request

MerchantId=81e77da2-723b-483d-8c0d-49f800c1xxxx&InputFormat=application/json&InputData={
   "ChangeSubStatus":{
      "SubStatus":"",
      "Comment":"Sample comment",
      "OperatorId":"",
      "ItemLevelSubStatus":[
         {
            "OrderLineId":"26529393",
            "SubStatus":"RJ"
         },
         {
            "OrderLineId":"26529395",
            "SubStatus":"RJ"
         },
         {
            "OrderLineId":"26529397",
            "SubStatus":"RJ"
         }
      ]
   }
}

Sample Response

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

Resource Information
URI /Order/ChangeSubStatus/{MerchantId}/{OrderId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/ChangeSubStatus/{MerchantId}/{OrderId}

Request Path Parameters

Parameter Type Description
MerchantId* string Unique GUID of the order
OrderId* int Order id for which you want to update sub-status

Request Body Parameters

Parameter Type Description
OperatorId string Unique id of the staff updating the order substatus.
OrderLineId* int Line item id of the order for which you want to update status
SubStatus* enum New status of the order or order line item as configured in the CP. These can be predefined or user defined. You can either pass it at the order level or line-item. For example, EX for Order Expired, SE for Successful to ERP/POS, RJ for Order Rejected, FE for Failed to ERP/POS, IP for In Progress.

You can find the predefined and user defined sub-statuses in the CP Settings > Application settings > Order settings > Order Substatus comment | string | Any comments for the order sub-status change.

Update Shipment Trip Details

Lets you update the trip details of a specific shipment. For example, you can provide rider details, vehicle number, contact details, tracking URL and so on.

Sample Request

https://www.martjack.com/developerapi/Order/UpdateShipmentTripDetails/81e77da2-723b-483d-8c0d-49f800c1xxxx

Sample POST Request

InputFormat=application/json&InputData={
  "ShipmentId": 123456,
  "RiderId": 0,
  "RiderCode": "PH001",
  "VehicleNumber": "MH01123456",
  "TripRefNo": "123456",
  "Comments": "Shipment is on vehicle for final delivery",
  "OperatorID": "00000000-0000-0000-0000-000000000000",
  "ShipmentTripAttributes": [
    {
      "Name": "Mobile",
      "Value": "6362245119"
    },
    {
      "Name": "Name",
      "Value": "Jane Doe"
    },
    {
      "Name": "Map URL",
      "Value": "www.capillarytech.in"
    }
  ]
}

Sample Response

{
  "messageCode": "1004",
  "Message": "Shipment Trip Information is saved successfully.",
  "ErrorCode": 0
}

Resource Information
URI /Order/UpdateShipmentTripDetails/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/UpdateShipmentTripDetails/{MerchantId}

Request Body Parameters

Parameter Type Description
ShipmentId* int Unique id of the shipment that you want to update
RiderId** int Unique id of the rider who delivers the shipment. Rider ID has to be preconfigured for the merchant. Either RiderId or RiderCode is mandatory
RiderCode** string Unique code of the rider who delivers the shipment. Rider Code has to be preconfigured for the merchant. Either RiderId or RiderCode is mandatory
VehicleNumber string Vehicle number of the delivery vehicle
TripRefNo string Unique trip reference number
Comments string Specify any comments that need to be specified for the shipment
OperatorID string Unique CP user GUID who updates the shipment trip details
ShipmentTripAttributes obj Provide additional details of the shipment in each obj Name-Value (key-value) pairs. You can pass your preferred combination of attribute name and value as applicable

Update Shipment Status

Updates the status of a shipment.

Sample Request

https://www.martjack.com/developerapi/Order/UpdateShipmentStatus/81e77da2-723b-483d-8c0d-49f800c1xxxx

Sample POST Request

InputFormat=application/json&merchantId=81e77da2-723b-483d-8c0d-49f800c1xxxx&InputData={  
   "UpdateShipmentStatus":{  
      "ShipmentId":"2205635",
      "Shippingstatus":"D",
      "ShippingMessage":"Shipment is completed",
      "reason":"done",
      "userId":""
   }
}

Sample Response

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

Resource Information
URI Order/UpdateShipmentStatus/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/UpdateShipmentStatus/{merchantId}

Request Body Parameters

Parameter Type Description
ShipmentId* string Unique id of the shipment that you want to update
Shippingstatus* enum New status of the current shipment. Values: I - RTO initiated, O - RTO Received, L - RTO Lost, X - Others, S - Shipment created, R - Dispatched, T - In transit, U - Out for delivery, D - Delivered, C - RTO Closed, F - Cancelled, E - RTO Refunded/Replacement closed, W - Waiting for Collection (in-store), G - At Gate
ShippingMessage string Message that you want to provide for the shipment
reason string Reason that you want to specify for the shipment update
userId string Unique id of the operator who is updating the status

Get Shipment Packages

Sample Request

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

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "ShipmentPackages": [
    {
    "PackageId": 38,
    "PackageType": "HYC",
    "LWH": "1X1X1",
    "Weight": 10,
    "UOM": "Kgs",
    "PackingSupplyRefCode": "36478"
    },
    {
    "PackageId": 18,
    "PackageType": "test",
    "LWH": "",
    "Weight": 100,
    "UOM": "Gms",
    "PackingSupplyRefCode": "test"
    }
  ],
  "ErrorCode": 0
}

Retrieves all shipment packages of the merchant.

Resource Information
URI /Order/ShipmentPackages/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Order/ShipmentPackages/{merchantId}

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
PackageType string Name of the package supply
PackingSupplyRefCode string Unique reference code generated for the package while creating
UOM string Unit of measurement of the product. Values: ltrs, kgs, gms, pieces

Get Shipment Details

Sample Request

http://www.martjack.com/DeveloperAPI/Order/ShipmentDetails/f48fdd16-92db-4188-854d-1ecd9b62xxxx/5471021

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "Shipments":[  
      {  
         "LocationId":25633,
         "ShipmentType":"Normal",
         "ReceivedBy":"",
         "DeliveredDate":"01-Jan-1900",
         "ShipmentId":5471021,
         "OrderId":7405405,
         "ServiceProvider":"ITOCHU",
         "DocketNumber":"ABC",
         "externalInvoiceNumber": "HYC-123-1234",
         "ShippingDate":"22-Nov-2018",
         "ShippingCharges":"0",
         "ShipmentItems":[  
            {  
               "OrderLineId":25937891,
               "Quantity":2,
               "ShipmentCustomFields":null
            }
         ]
      }
   ],
   "ErrorCode":0
}

Retrieves the details of a specific shipment.

Resource Information
URI /Order/ShipmentDetails/{merchantId}/{shipmentId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/ShipmentDetails/{merchantId}/{shipmentId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
shipmentId* int Unique id of the shipment that you want to retrieve

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
DocketNumber string AWB number of the shipment

Get Order Activity History

Sample Request

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

Sample POST Request

MerchantId=f48fdd16-92db-4188-854d-1ecd9b62xxxx&InputFormat=application/json&InputData={  
   "orderfieldchangehistory":"false",
   "activityhistory":"true",
   "orderids":[  
      3725777,7401027
   ]
}

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "ErrorCode":0,
   "ListOfOrderActivities":[  
      {  
         "OrderID":7401121,
         "OrderFieldChangeHistory":[  

         ],
         "OrderItemFieldChangeHistory":[  

         ],
         "OrderActivityHistory":[  
            {  
               "ConversationLogId":69710993,
               "ConversationDate":"/Date(1542770207000+0530)/",
               "ConversationText":"Order ID: 7401121 has been created successfully. ",
               "RETransactionId":7401121,
               "ConversationType":"SOL",
               "CPUserId":"00000000-0000-0000-0000-000000000000",
               "LogAction":"P",
               "MerchantId":"f48fdd16-92db-4188-854d-1ecd9b62d066",
               "UpdatedDate":"/Date(1542770207000+0530)/"
            },
            {  
               "ConversationLogId":69710995,
               "ConversationDate":"/Date(1542770207000+0530)/",
               "ConversationText":"Payment through 'RAZORPAY' mode has been saved successfully.",
               "RETransactionId":7401121,
               "ConversationType":"SOL",
               "CPUserId":"00000000-0000-0000-0000-000000000000",
               "LogAction":"P",
               "MerchantId":"f48fdd16-92db-4188-854d-1ecd9b62d066",
               "UpdatedDate":"/Date(1542770207000+0530)/"
            },

            {  
               "ConversationLogId":69711003,
               "ConversationDate":"/Date(1542770227000+0530)/",
               "ConversationText":"Inventory for SKU 100140259  has been reduced against the Order ID: 7401121 ",
               "RETransactionId":7401121,
               "ConversationType":"SOL",
               "CPUserId":"00000000-0000-0000-0000-000000000000",
               "LogAction":"A",
               "MerchantId":"f48fdd16-92db-4188-854d-1ecd9b62d066",
               "UpdatedDate":"/Date(1542770227000+0530)/"
            }
         ]
      },
      {  
         "OrderID":7401027,
         "OrderFieldChangeHistory":[  

         ],
         "OrderItemFieldChangeHistory":[  
            {  
               "Status":"A",
               "OrderId":7401027,
               "OrderItemId":25927549,
               "Message":"",
               "LogDateTime":"/Date(1542767189000+0530)/",
               "OldQty":1,
               "NewQty":0,
               "OldPrice":0,
               "NewPrice":0,
               "OldDiscount":0,
               "NewDiscount":0,
               "MerchantId":"f48fdd16-92db-4188-854d-1ecd9b62d066",
               "OldLocationId":0,
               "NewLocationId":18340,
               "OldMRP":0,
               "NewMRP":0
            }
         ],
         "OrderActivityHistory":[  
            {  
               "ConversationLogId":69710055,
               "ConversationDate":"/Date(1542767153000+0530)/",
               "ConversationText":"Order ID: 7401027 has been created successfully. (Processed by -  tom@example.com)",
               "RETransactionId":7401027,
               "ConversationType":"SOL",
               "CPUserId":"5ed51807-e592-4cd2-85fe-34e80ffe0e2a",
               "LogAction":"P",
               "MerchantId":"f48fdd16-92db-4188-854d-1ecd9b62d066",
               "UpdatedDate":"/Date(1542767153000+0530)/"
            },
            {  
               "ConversationLogId":69710063,
               "ConversationDate":"/Date(1542767189000+0530)/",
               "ConversationText":"Payment through COD has been Saved successfully.Remarks:jjh(Processed by -  tom@example.com)",
               "RETransactionId":7401027,
               "ConversationType":"SOL",
               "CPUserId":"5ed51807-e592-4cd2-85fe-34e80ffe0e2a",
               "LogAction":"P",
               "MerchantId":"f48fdd16-92db-4188-854d-1ecd9b62d066",
               "UpdatedDate":"/Date(1542767189000+0530)/"
            },
            {  
               "ConversationLogId":69710065,
               "ConversationDate":"/Date(1542767189000+0530)/",
               "ConversationText":"Inventory for SKU 100152015  has been reduced against the Order ID: 7401027 ",
               "RETransactionId":7401027,
               "ConversationType":"SOL",
               "CPUserId":"00000000-0000-0000-0000-000000000000",
               "LogAction":"A",
               "MerchantId":"f48fdd16-92db-4188-854d-1ecd9b62d066",
               "UpdatedDate":"/Date(1542767189000+0530)/"
            }
         ]
      }
   ]
}

Resource Information
URI /Order/GetOrderActivityHistory/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/GetOrderActivityHistory/{MerchantId}

Request Body Parameters

Parameter Type Description
orderfieldchangehistory boolean Specify true to retrieve the history of change in order or order item attributes. Default value is false
activityhistory boolean Specify true to retrieve activity log of an order such as order authorized, order shipped, and payment authorized
orderids* int Specify the order id(s) that you want to fetch. You can specify multiple order ids separating each by a comma

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
ConversationLogId int Unique id of the activity for internal reference
RETransactionId int Unique Order id for which you want to get activity history
LogAction enum Action associated to the log. For example, P (payment), and S (shipment)
ConversationType - -Deprecated-

Get Order Shipments

Retrieves shipment details of a specific order.

Sample Request

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

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "Shipments": [
    {
      "LocationId": 14856,
      "ShipmentType": "Normal",
      "ReceivedBy": "",
      "DeliveredDate": "26-Feb-2019",
      "ShipmentId": 5516837,
      "OrderId": 7508407,
      "externalInvoiceNumber": "HYC-123-1234",
      "ServiceProvider": "BMSP",
      "DocketNumber": "AWB3399204",
      "ShippingDate": "26-Feb-2019",
      "ShippingCharges": "0",
      "ShipmentItems": [
        {
          "OrderLineId": 26156133,
          "Quantity": 1,
          "ShipmentCustomFields": null
        }
      ],
      "CollectableAmount": "0"
    },
    {
      "LocationId": 14856,
      "ShipmentType": "Normal",
      "ReceivedBy": "",
      "DeliveredDate": "26-Feb-2019",
      "ShipmentId": 5516839,
      "OrderId": 7508407,
      "ServiceProvider": "BNPS",
      "DocketNumber": "awb6385902",
      "ShippingDate": "26-Feb-2019",
      "ShippingCharges": "0",
      "ShipmentItems": [
        {
          "OrderLineId": 26156123,
          "Quantity": 2,
          "ShipmentCustomFields": null
        }
      ],
      "CollectableAmount": "0"
    },
    {
      "LocationId": 14856,
      "ShipmentType": "Normal",
      "ReceivedBy": "",
      "DeliveredDate": "26-Feb-2019",
      "ShipmentId": 5516841,
      "OrderId": 7508407,
      "ServiceProvider": "BMPS",
      "DocketNumber": "AWB9972903",
      "ShippingDate": "26-Feb-2019",
      "ShippingCharges": "0",
      "ShipmentItems": [
        {
          "OrderLineId": 26156131,
          "Quantity": 2,
          "ShipmentCustomFields": null
        }
      ],
      "CollectableAmount": "0"
    },
    {
      "LocationId": 14856,
      "ShipmentType": "Normal",
      "ReceivedBy": "",
      "DeliveredDate": "26-Feb-2019",
      "ShipmentId": 5516843,
      "OrderId": 7508407,
      "ServiceProvider": "BMPS",
      "DocketNumber": "AWB77920023",
      "ShippingDate": "26-Feb-2019",
      "ShippingCharges": "0",
      "ShipmentItems": [
        {
          "OrderLineId": 26156129,
          "Quantity": 2,
          "ShipmentCustomFields": null
        }
      ],
      "CollectableAmount": "0"
    }
  ],
  "ErrorCode": 0
}

Resource Information
URI /Order/{merchantId}/{orderId}/Shipments
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Order/{merchantId}/{orderId}/Shipments

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
orderId* int Unique id of the order for which you want to fetch shipments

Response Parameters

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

Parameter Type Description
ShipmentType enum Type of shipment. Value: Normal for shipments from warehouse to customer, Reverse for shipments from customer to warehouse
ReceivedBy string Customer who received the shipment
ServiceProvider string Name of the logistic provider
CollectableAmount int Amount to be collected from the receiver (used for COD orders)

Get Shipments

Sample Request

https://www.martjack.com/developerapi/Order/getshipments/389d3f1a-8c9a-41bd-9b3a-e6c2f031527d/6564132

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "Shipments": [{
        "LocationId": 18576,
        "ShipmentType": "normal",
        "ReceivedBy": "",
        "DeliveredDate": "01-Jan-1900",
        "ShipmentId": 4908822,
        "OrderId": 6564132,
        "ServiceProvider": null,
        "DocketNumber": null,
        "ShippingDate": "15-Apr-2018",
        "ReferenceNumber": "",
        "ShippingCharges": "0",
        "ShipmentItems": [{
            "ShipmentId": "4908822",
            "OrderLineId": 23995066,
            "Quantity": 1,
            "ShippingDetailsID": "20734158",
            "ShipmentCustomFields": null
        }],
        "CourierName": "",
        "AWBNumber": "",
        "ShippingStatus": "S",
        "StatusUpdatedDate": "15-Apr-2018",
        "UseMailBoxAddress": "False",
        "DeliveryMode": "H",
        "VerificationMethod": "",
        "VerificationValue": "",
        "Remarks": "",
        "ProviderCode": "",
        "CMSID": "0",
        "Width": "0",
        "Length": "0",
        "Height": "0",
        "Weight": "0.00",
        "ReturnRequestId": "0",
        "InvoiceNumber": "00001320",
        "InvoiceAmount": "9995",
        "externalInvoiceNumber": "HYC-123-1234",
        "CollectableAmount": "0",
        "IslabelReady": "False",
        "LogisticID": "",
        "LogisticResponse1": ""
    }],
    "ErrorCode": 0
}

Retrieves shipment details of a specific order

Resource Information
URI Order/getshipments/{merchantId}/{orderID}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Order/getshipments/{merchantId}/{orderID}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
orderID* int Unique id the order for which you want to track shipment 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
UseMailBoxAddress boolean Whether the user’s mail address of the location is used or not
VerificationMethod string Verification type used for item delivery or return pick-up. Currently we support OTP
VerificationValue string Value of the specified VerificationMethod

Get Shipment History

Sample Request

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

Sample POST Request

MerchantId=81e77da2-723b-483d-8c0d-49f800c1exxx&InputFormat=application/json&InputData={
  "CreatedDateTo": "2018-12-17",
  "ShippingStatus": "S,R,D",
  "CreatedDateFrom": "2018-12-17"
}

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "ShipmentIds":{  
      "OrderID":[  
         7499817,
         7499777,
         7499599,
         7498383,
         7497987
      ],
      "ShipmentID":[  
         5515529,
         5515515,
         5515339,
         5514925,
         5513479
      ]
   },
   "ErrorCode":0
}

Retrieves shipment ids and order ids of the merchant based on the input parameters.

Resource Information
URI Order/GetShipmentHistory/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/GetShipmentHistory/{merchantId}

Request Body Parameters

Parameter Type Description
CreatedDateFrom date Get shipments created in a specific duration. Specify the duration in CreatedDateFrom and CreatedDateTo
CreatedDateTo date Get shipments created in a specific duration. Specify the preferred duration in CreatedDateFrom and CreatedDateTo
ShippingStatus enum Get shipments of a specific shipment status(s). You can pass multiple values separated by comma. Values: I - RTO initiated, O - RTO Received, L - RTO Lost, X - Others, S - Shipment created, R - Dispatched, T - In transit, U - Out for delivery, D - Delivered, C - RTO Closed, F - Canceled, E - RTO Refunded/Replacement closed, W - Waiting for Collection (in-store), G - At Gate

Update Shipment Courier Details

Updates courier details of a specific shipment.

Sample Request

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

Sample POST Request

MerchantId=9820eca5-d11f-4df1-9b20-983a45ea9631&InputFormat=application/json&InputData={
"Shipment": {
"ShipmentId": "4230982",
"MerchantId": "9820eca5-d11f-4df1-9b20-983a45ea9631",
"UserId": "00000000-0000-0000-0000-000000000000",
"AWBNumber": "1234567890",
"IslabelReady": "false",
"ProviderId": "FedEx",
"externalInvoiceNumber": "HYC-123-1234"
}
}

Sample Response

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

Resource Information
URI /Order/UpdateShipmentCourierDetails/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/UpdateShipmentCourierDetails/{merchantId}

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
shipmentId long New shipment id that you want to update with
aWBNumber string New AWB number that you want to update with
islabelReady enum Specify true only if the merchant uses invoice or dispatch note and the the label is ready, else specify false. You will get an option to download the shipment label as PDF if available
userId string Logged in user id of the CP who is updating shipment details
providerId int Unique id of the shipment provider
externalInvoiceNumber string Specify the invoice number of the shipment
dispatchLabelContentType

Calculate Tax (Normal Product)

Calculates tax amount for a product on the basis of source and destination location.

Sample Request

https://www.martjack.com/developerapi/Order/CalculateTax/dc21b529-2057-402a-972a-e1ba0c8a08eb

Sample POST Request

MerchantID=dc21b529-2057-402a-972a-e1ba0c8a08eb&InputFormat=application/json&InputData={
   "SourceLocationCode":"108",
   "SourceLocationId":"",
   "SourceCityName":"New Delhi",
   "SourceCityCode":"26352",
   "SourceCountryName":"INDIA",
   "SourceCountryCode":"IN",
   "SourceStateName":"Delhi",
   "SourceStateCode":"DL",
   "ShipCityName":"New Delhi",
   "ShipCityCode":"26352",
   "ShipCountryName":"INDIA",
   "ShipCountryCode":"IN",
   "ShipStateName":"Delhi",
   "ShipStateCode":"DL",
   "Items":[
      {
         "SKU":"IN-DR-Pepsi",
         "VarientSKU":"0",
         "Quantity":1,
         "DeliveryMode":"H",
         "UnitPrice":57
      }
   ]
}

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "ProductTaxDetails": {
        "TotalTaxAmount": 2.85,
        "Items": [
            {
                "Sku": "IN-DR-Pepsi",
                "VariantSku": null,
                "Quantity": "1",
                "UnitPrice": 57,
                "TotalTaxAmount": 2.85,
                "DeliveryMode": "H",
                "BundleItem": null,
                "TaxDetails": [
                    {
                        "TaxCategory": "C-GST",
                        "TaxAmount": 1.425,
                        "TaxCodeId": "35868",
                        "IsTaxOnShipping": false,
                        "IsPercentage": true
                    },
                    {
                        "TaxCategory": "S-GST",
                        "TaxAmount": 1.425,
                        "TaxCodeId": "35868",
                        "IsTaxOnShipping": false,
                        "IsPercentage": true
                    }
                ]
            }
        ]
    },
    "ErrorCode": 0
}

Resource Information
URI Order/CalculateTax/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/CalculateTax/{merchantId}

Request Body Parameters

Parameter Type Description
MerchantID* string Unique GUID of the merchant
SourceLocationCode int Location code of the order fulfillment location (Generally used for Location specific merchants)
SourceLocationId int Unique location id of the product
SourceCityName string City name of the product location
SourceCityCode string Unique city code of the product location
SourceCountryName string Country name of the product location
SourceCountryCode string Alpha-2 code of the country of the product location . Example: IN (for India), AU (for Australia), and BR (for Brazil)
SourceStateName string State name of the product location
SourceStateCode string State code of the product location
ShipCityName string City name of the product delivery location
ShipCityCode string Unique city code of the product delivery location
ShipCountryName string Country name of the product delivery location
ShipCountryCode string Alpha-2 code of the country of the product delivery location. Example: IN (for India), AU (for Australia), and BR (for Brazil)
ShipStateName string State name of the product delivery location
ShipStateCode string State code of the product delivery location
SKU* string SKU of the product for which you want to calculate tax (Required for variant product)
VarientSKU string SKU of the variant product for which you want to calculate tax
Quantity* int Number of items for which you want to calculate tax
DeliveryMode* enum Mode of delivery of the current item. Values: H for home delivery, S for store pick-up
UnitPrice* float Price of a single item

Sample Response Parameters

Parameter Type Description
BundleItem json obj Applicable for bundle products
TaxCategory string Category of tax
TaxCodeId int Unique id of the tax code
IsTaxOnShipping boolean Whether tax is applied on shipping charges
IsPercentage boolean If true, tax rate is calculated on the percentage of the price and false for flat amount tax

Calculate Tax (Bundle Product)

Calculates tax (amount) for a product on the basis of source and destination location.

Sample Request

https://www.martjack.com/developerapi/Order/CalculateTax/dc21b529-2057-402a-972a-e1ba0c8a08eb

Sample POST Request

MerchantID=dc21b529-2057-402a-972a-e1ba0c8a08eb&InputFormat=application/json&InputData={
   "SourceLocationCode":"108",
   "SourceLocationId":"",
   "SourceCityName":"New Delhi",
   "SourceCityCode":"26352",
   "SourceCountryName":"INDIA",
   "SourceCountryCode":"IN",
   "SourceStateName":"Delhi",
   "SourceStateCode":"DL",
   "ShipCityName":"New Delhi",
   "ShipCityCode":"26352",
   "ShipCountryName":"INDIA",
   "ShipCountryCode":"IN",
   "ShipStateName":"Delhi",
   "ShipStateCode":"DL",
   "Items":[
      {
         "SKU":"IN-PZ-VG-TANDOORIPANEER",
         "VarientSKU":"0",
         "Quantity":1,
         "DeliveryMode":"H",
         "UnitPrice":0,
         "BundleItem":[
            {
               "SKU":"IN-Crt-Tndripnr",
               "VarientSKU":"IN-Crt-Tndripnr-Pan-Mdm",
               "Quantity":1,
               "DeliveryMode":"H",
               "UnitPrice":"515"
            }
         ]
      }
   ]
}

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "ProductTaxDetails": {
        "TotalTaxAmount": 25.75,
        "Items": [
            {
                "Sku": "IN-PZ-VG-TANDOORIPANEER",
                "VariantSku": null,
                "Quantity": "1",
                "UnitPrice": 0,
                "TotalTaxAmount": 0,
                "DeliveryMode": "H",
                "BundleItem": [
                    {
                        "Sku": "IN-Crt-Tndripnr",
                        "VariantSku": null,
                        "Quantity": "1",
                        "UnitPrice": 515,
                        "TotalTaxAmount": 25.75,
                        "DeliveryMode": "H",
                        "BundleItem": null,
                        "TaxDetails": [
                            {
                                "TaxCategory": "C-GST",
                                "TaxAmount": 12.875,
                                "TaxCodeId": "35868",
                                "IsTaxOnShipping": false,
                                "IsPercentage": true
                            },
                            {
                                "TaxCategory": "S-GST",
                                "TaxAmount": 12.875,
                                "TaxCodeId": "35868",
                                "IsTaxOnShipping": false,
                                "IsPercentage": true
                            }
                        ]
                    }
                ],
                "TaxDetails": [
                    {
                        "TaxCategory": "C-GST",
                        "TaxAmount": 0,
                        "TaxCodeId": "35868",
                        "IsTaxOnShipping": false,
                        "IsPercentage": true
                    },
                    {
                        "TaxCategory": "S-GST",
                        "TaxAmount": 0,
                        "TaxCodeId": "35868",
                        "IsTaxOnShipping": false,
                        "IsPercentage": true
                    }
                ]
            }
        ]
    },
    "ErrorCode": 0
}

Resource Information
URI Order/CalculateTax/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/CalculateTax/{merchantId}

Request Body Parameters

Parameter Type Description
MerchantID* string Unique GUID of the merchant
SourceLocationCode int Location code of the product
SourceLocationId int Unique location id of the product
SourceCityName string City name of the product location
SourceCityCode string Unique city code of the product location
SourceCountryName string Country name of the product location
SourceCountryCode string Alpha-2 code of the country of the product location. Example: IN (for India), AU (for Australia), and BR (for Brazil)
SourceStateName string State name of the product location
SourceStateCode string State code of the product location
ShipCityName string City name of the product delivery location
ShipCityCode string Unique city code of the product delivery location
ShipCountryName string Country name of the product delivery location
ShipCountryCode string Alpha-2 code of the country of the product delivery location. Example: IN (for India), AU (for Australia), and BR (for Brazil)
ShipStateName string State name of the product delivery location
ShipStateCode string State code of the product delivery location
BundleItem obj Details of the bundle product
SKU* string SKU of the product for which you want to calculate tax (Required for variant product)
VarientSKU string SKU of the variant product for which you want to calculate tax
Quantity* int Number of the items for which you want to calculate tax
DeliveryMode* enum Mode of delivery of the current item. Values: H for home delivery, S for store pick-up
UnitPrice* float Price of a single item

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
TaxCategory string Category of tax
TaxCodeId int Unique id of the tax code
IsTaxOnShipping boolean Whether tax is applied on shipping charges
IsPercentage boolean If true, tax rate is calculated on the percentage of the price and false flat amount tax

Balance Enquiry

Retrieves the wallet balance of a customer of a specific service. For example, balance of loyalty card, RazorPay and so on.

Sample Request

https://www.martjack.com/developerapi/Order/BalanceEnquiry/81e77da2-723b-483d-8c0d-49f800c1xxxx

Sample POST Request

{
   "merchantId": "276f9496-0e5c-4465-b9ce-784514788ae9",
   "Provider": "RazorPayWallet",
   "GatewayId": "34",
   "UserId": "0d7ded82-fcf4-4931-9216-32a9cb85864e",
   "CardNumber": "",
   "CardPin": ""
}

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "BalanceEnquiryResponseView":{  
      "Status":"1",
      "Balance":"200",
      "Code":"103",
      "Message":""
   }
}

Resource Information
URI Order/BalanceEnquiry/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/BalanceEnquiry/{merchantId}

Request Body Parameters

Parameter Type Description
provider* string Service provider for which you want to fetch the wallet balance. Example: RazorPayWallet
userId* string Unique GUID of the user for which you want to fetch the wallet balance

Update Order Custom Attribute Values

Lets you update values of custom attributes of an order.

Sample Request

developerapi/Order/UpdateOrderCustomAttributesValues/1b3420ce-002f-4f66-bbda-cd0828aa2af8

Sample POST Request

MerchantId=1b3420ce-002f-4f66-bbda-cd0828aa2af8&InputFormat=application/json&InputData=
{
   "Orders":[{

      "OrderID":"8283199",
     "OrderItems":
     [

     {
     "OrderLineID":"51796945",
     "OrderItemCustomFieldValues":[{"test":"254.1"}]
}
]
}
   ]
}

Sample Response

{
    "isupdated": true,
    "messageCode": "1004",
    "Message": "All orderItem custom fields updated",
    "updateOrderCustomResponses": [
        {
            "OrderID": 8283199,
            "isupdated": false,
            "Message": null,
            "updateOrderItemCustomResponses": [
                {
                    "OrderLineID": 51796945,
                    "isupdated": true,
                    "Message": "All orderitem custom fields are updated for the above OrderLineID"
                }
            ]
        }
    ]
}

Resource Information
URI Order/UpdateOrderCustomAttributesValues/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/Order/UpdateOrderCustomAttributesValues/{merchantId}

Request Body Parameters

Parameter Type Description
OrderID int Order id for which you want to update custom field values.
OrderLineID int Order line item id for which you want to update custom field values.
OrderItemCustomFieldValues obj Pass the attribute names that you want to update with the new attribute values as key:value pairs.

Update Order Reference

Updates external reference number of an order.

Sample Request

https://www.martjack.com/developerapi/Order/UpdateOrderReference/81e77da2-723b-483d-8c0d-49f800c1xxxx

Sample POST Request

InputFormat=application/json&merchantId=81e77da2-723b-483d-8c0d-49f800c1xxxx&InputData={
    "OrderId":"4091391",
    "ReferenceNo":"11751201"
}

Sample Response

{  
   "messageCode":"1004",
   "Message":"Order Reference =11751201-success has been applied successfully",
   "ErrorCode":0
}

Resource Information
URI Order/UpdateOrderReference/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/UpdateOrderReference/{merchantId}

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
orderID* string Order id for which you want to update reference number
referenceNumber* string Preferred reference number for the order

Create Return Request

Lets you create a new return request - A request made by a customer to return partial or complete items of an order that are delivered.

Sample Request

https://www.martjack.com/developerapi/DeveloperAPI/Order/CreateReturnRequest/fc93a3a8-f69b-444c-8b76-9848de9338d0

Sample POST Request


MerchantID=fc93a3a8-f69b-444c-8b76-9848de9338d0&InputFormat=application/json&InputData={
  "ReturnRequest": {
    "MerchantId": "e04386d8-7ca8-4fa3-b8b8-6c606844d257",
    "OrderId": "6102899",
    "Comments": "Return Order",
    "Source": "2",
    "Status": "I",
    "RequestType": "CU",
    "RefundStatus": "A",
    "PaymentMode": "",
    "BankName": "",
    "IFSCCOde": "",
    "AccountNumber": "",
    "AccountName": "",
    "BranchName": "",
    "FirstName": "Tom",
    "Address1": "A-501, symphony towers, new link road",
    "CountryCode": "IN",
    "CountryName": "India",
    "StateCode": "OR",
    "StateName": "Odisha",
    "CityCode": "60",
    "CityName": "Bhubaneshwar",
    "OtherCity": "",
    "PostCode": "751018",
    "Email": "tom.sawyer@capillarytech.com",
    "TelephoneCode": "1",
    "Telephone": "",
    "MobileCode": "91",
    "Mobile": "9005657048",
    "RefundAmount": "0",
    "RefundedAmount": "0",
    "ConfirmedRefundAmount": "0",
    "IsSelfShip": "",
    "ShipmentId": "4437188",
    "ReturnRequestShipmentDetails": {
      "CourierName": "Test",
      "AirWayBillNo": "123456"
    },
    "ReturnRequestDetails": {
      "Sku": "101432375",
      "Reason": "OT",
      "SuggestedReturnAction": "RF",
      "ReturnQty": "1",
      "IsReceived": "False",
      "ReceivedQty": "0",
      "CreatedDate": "11-21-2017",
      "RefundAmount": "0",
      "ConfirmedRefundAmount": "0"
    },
    {
      "Sku": "201001-1000",
      "Reason": "BAQ",
      "SuggestedReturnAction": "RF",
      "ReturnQty": "1",
      "IsReceived": "False",
      "ReceivedQty": "0",
      "CreatedDate": "11-21-2017",
      "RefundAmount": "0",
      "ConfirmedRefundAmount": "0"
    }
  }
}

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "ReturnRequestDetail": {
    "ReturnRequestId": 22931,
    "CustomMessage": "Return Request has been generated for the order : 5257435Return Request ID :22931"
  }
}

Resource Information
URI /DeveloperAPI/Order/CreateReturnRequest/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/DeveloperAPI/Order/CreateReturnRequest/{merchantId}

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
OrderId* int Unique order id for which you want to create return request
Comments string Any comment related to the return request
Source enum Source from which the return request is made. Values: 1, 2, 3, 4, 5. Example, 1 stands for storefront
Status enum Current status of the return request. Values: I for initiated, C for closed
RequestType enum Type of the return request. R for return to origin (RTO) C for customer return and CU for Return created due to item cancellation
RefundStatus enum Current status of the refund, I for refund initiated, A for refund approved
PaymentMode string Mode of refund. Values: NEFT Cheque/DD, Credit Card, eVoucher
BankName string Bank name to which the refund will be made(for refund through NEFT payment)
IFSCCOde string IFSC code of the specified bank (for refund through NEFT payment)
AccountNumber string Account number to which the return amount needs to be refunded (for refund through NEFT payment)
AccountName string Name of the customer account as per the specified bank (for refund through NEFT payment)
BranchName string Branch name of the specified account (for refund through NEFT payment)
FirstName string First name of the customer associated to the order
Address1 string Complete shipping address of the customer
CountryCode string Alpha-2 code of the country of the shipment address. Example: IN (for India), AU (for Australia), and BR (for Brazil)
CountryName string Name of the country of the shipment address
StateCode string State code of the shipment location
StateName string Name of the state as per the shipping address
CityCode string Unique city code of the product shipment location
CityName string City name of the product shipment location
PostCode string ZIP Code of the shipment location
Email string Registered email id of the customer
TelephoneCode string Land line number area code
Telephone string Land line number of the customer excluding the country code
MobileCode string Country code for the mobile number
Mobile string Mobile number of the customer excluding country code
RefundAmount float Total amount to be refunded to the customer (once the item return is initiated)
RefundedAmount float Actual amount refunded to the customer
ConfirmedRefundAmount float Refund amount confirmed by the staff (at the warehouse)
IsSelfShip enum Specify Yes if the user will ship the return package to the merchant, No if the merchant has to pickup the package from the user
ShipmentId int Unique id of the return shipment
ReturnRequestShipmentDetails obj Details of each return item
CourierName string Name of the courier service chosen for return shipment
AirWayBillNo string Airway bill number of the return shipment
ReturnRequestDetails obj Details of return shipment
Sku string Unique SKU of each return item
Reason string Return reason code. Values:
WID - Wrong item delivered
BAQ - Bad Quality
DLP - Did not like the product
DPR - Defective/Damage product received
RD - Received Damaged DP - Defective Product
II - Incorrect Item received
UW Unwanted Gift
US - Unsuitable
UP - Unlike Photo, TS - Too Small
OT - Other
FD - Fraud
IE - Incorrect Size
PDR - Product is damaged
WPD - Product is not as per website description
CR - Customer Remorse
PWF - Product is not properly functioning
SuggestedReturnAction string Reason for item return
ReturnQty* int Return quantity of the current item initiated by the customer
IsReceived* boolean Whether the current item is received at the warehouse or not
ReceivedQty** int Quantity of the current item received at the warehouse
CreatedDate* date Date when the return request is created in MM-DD-YYYY format

Search Return Requests

Returns the order ids that are returned based on the input parameters.

Sample Request

https://www.martjack.com/developerapi/Order/GetReturnRequestHistory/81e77da2-723b-483d-8c0d-49f800c1xxxx

Sample POST Request

MerchantId=fc93a3a8-f69b-444c-8b76-9848de9338d0&InputFormat=application/json&InputData={
    "FromDate":"2018-12-06",
    "ToDate":"2018-12-06"
}

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "ReturnRequestIds":{  
      "ReturnRequest":[  
         236285,
         236279,
         236267,
         236265,
         236263,
         236261,
         236259,
         236257,
         236251,
         236233,
         236189,
         236185,
         236147,
         236141,
         236131,
         236095,
         236089,
         235855,
         235853,
         235849,
         235847,
         235843
      ]
   },
   "ErrorCode":0
}

Resource Information
URI Order/GetReturnRequestHistory/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/GetReturnRequestHistory/{merchantId}

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
fromDate date Duration for which you want to fetch return orders (fromDate - toDate)
toDate date Duration for which you want to fetch return orders (fromDate - toDate)
refundStatus string Status of the refund. Value: I for refund initiated, C for refund complete
status string Status of the return. Value: RC for Refund completed, I for initiated, R received, P for picked up, S pending pickup, C closed
orderId int Unique id of the order
paymentMode string Fetch return orders by mode of payment(refund). Values: NEFT Cheque/DD, Credit Card, eVoucher

Get Return Request Details (by RequestId)

Retrieves the details of a specific return request based on the return request id passed.

Sample Request

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

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "ReturnRequest": {
    "ReturnRequestId": 211003,
    "MerchantId": "f48fdd16-92db-4188-854d-1ecd9b62d066",
    "ShipmentId": 5392397,
    "OrderId": 7238823,
    "InvoiceNumber": "invoice_hyc-00000460",
    "DateInitiated": "08-Oct-2018 07:45:12 AM",
    "DateReceived": "08-Oct-2018 07:47:27 AM",
    "BillOfSupplyCreditNoteNumber": "",
    "TaxableCreditNoteNumber": "HYCCNTV_009741",
    "Source": "2",
    "RequestStatus": "C",
    "RequestType": "C",
    "RefundStatus": "C",
    "RefundedAmount": 113.66,
    "ConfirmedRefundAmount": 113.66,
    "IncludeShippingCost": "False",
    "IsSelfShip": "False",
    "ReturnRequestDetail": [
      {
        "ReturnRequestDetailId": 330945,
        "ReturnRequestId": 211003,
        "OrderItemId": 25601069,
        "SuggestedReturnAction": "RF",
        "Reason": "BAQ",
        "ReturnQty": "1",
        "IsReceived": "True",
        "ReceivedQty": "1",
        "MRP": 114,
        "ProductPrice": 113.66,
        "PromotionDiscount": 0,
        "UOM": "Pieces",
        "AverageWeight": 0,
        "IsTaxable": "True",
        "TaxDetails": [
          {
            "TaxCategory": "SGST",
            "TaxRate": "9",
            "TaxAmount": 8.66,
            "IsTaxRatePercentage": true,
            "TaxCode": "SGI18",
            "TaxCategoryID": "3580"
          },
          {
            "TaxCategory": "CGST",
            "TaxRate": "9",
            "TaxAmount": 8.66,
            "IsTaxRatePercentage": true,
            "TaxCode": "CGI18",
            "TaxCategoryID": "3578"
          }
        ],
        "RefundAmount": 113.66,
        "ConfirmedRefundAmount": 113.66,
        "SKU": "100011145",
        "VariantSKU": null,
        "ProductID": 11995626,
        "VariantProductID": 0,
        "ProductTitle": "Nestle Milkmaid - 400g Tin",
        "SubStatus": "'",
        "SubStatusComments": "'"
      }
    ],
    "RequestedPaymentMode": {
      "PaymentMode": "GV",
      "BankName": "",
      "BranchName": "",
      "IFSCCOde": "",
      "AccountNumber": "",
      "AccountName": "",
      "CityName": ""
    },
    "ReturnRequestPayments": [
      {
        "ReturnRequestId": 211003,
        "PaymentDate": "08-Oct-2018 12:00:00 AM",
        "PaymentMode": "GV",
        "ReferenceNumber": "ref444333",
        "Amount": "113.66",
        "Remarks": "test333",
        "BankName": null,
        "IFSCCOde": null,
        "AccountNumber": "",
        "AccountName": "",
        "BranchName": null
      }
    ],
    "PickupDetails": {
      "Address1": "kandavali malad west",
      "Address2": "",
      "CountryCode": "IN",
      "CountryName": "India",
      "StateCode": "MH",
      "StateName": "Maharashtra",
      "CityCode": "554",
      "CityName": "",
      "PostCode": "400064",
      "Email": "",
      "FirstName": "Vijay ",
      "LastName": "",
      "Mobile": "91-9885296960"
    },
    "SubStatus": "",
    "SubStatusComments": ""
  },
  "ErrorCode": 0
}

Resource Information
URI Order/GetReturnRequest/{merchantId}/{returnRequestId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Order/GetReturnRequest/{merchantId}/{returnRequestId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
returnRequestId* int Unique id of the return request 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
BillOfSupplyCreditNoteNumber string Credit note is generated for a customer returned item received at the merchant warehouse. Non-taxable items will have “Bill of supply Credit note number”
TaxableCreditNoteNumber string Credit note is generated for any customer returned item received to merchant warehouse. Taxable Items will have this “Taxable credit note number”
Source int values from 1-5. Source from which the return request is made. Example, 1 stands for storefront
RequestStatus enum Current status of the return request. Values: I for initiated, C for closed
RequestType enum Type of the return request. R for return to origin (RTO) C for customer return and CU for Return created due to item cancellation
RefundStatus enum Current status of the refund. Values: I for initiated, C for closed
IncludeShippingCost enum The value will be Yes if the shipping cost is included in the return item, No if shipping cost is not included
IsSelfShip enum The value will be ‘Yesif the user will ship the return package to the merchant,No`, if the merchant has to pickup the package from the user
SubStatus string The sub-status code of the return request

Get Return Request (by Order ID)

Returns all return request details of a specific order.

Sample Request

https://www.martjack.com/developerapi/Order/GetReturnRequestByOrderID/9403244b-2231-4550-ae96-2dbb5d0c1694/6758025

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "ReturnRequests": [
    {
      "ReturnRequestId": 201782,
      "MerchantId": "9403244b-2231-4550-ae96-2dbb5d0c1694",
      "ShipmentId": 0,
      "OrderId": 7124734,
      "InvoiceNumber": "",
      "DateInitiated": "10-Sep-2018 12:34:26 PM",
      "DateReceived": "10-Sep-2018 12:34:26 PM",
      "BillOfSupplyCreditNoteNumber": "",
      "TaxableCreditNoteNumber": "",
      "Source": "2",
      "RequestStatus": "R",
      "RequestType": "CU",
      "RefundStatus": "I",
      "RefundedAmount": 0,
      "ConfirmedRefundAmount": 1019,
      "IncludeShippingCost": "False",
      "IsSelfShip": "False",
      "ReturnRequestDetail": [
        {
          "ReturnRequestDetailId": 317918,
          "ReturnRequestId": 201782,
          "OrderItemId": 25364654,
          "SuggestedReturnAction": "RF",
          "Reason": "NDA",
          "ReturnQty": "1",
          "IsReceived": "True",
          "ReceivedQty": "1",
          "MRP": 1695.000,
          "ProductPrice": 1019,
          "PromotionDiscount": 0,
          "UOM": "Pieces",
          "AverageWeight": 0,
          "IsTaxable": "False",
          "TaxDetails": [

          ],
          "RefundAmount": 1019,
          "ConfirmedRefundAmount": 1019,
          "SKU": "103694029",
          "VariantSKU": null,
          "ProductID": 13133426,
          "VariantProductID": 0,
          "ProductTitle": "USHA STEAM IRON TEFLON3713",
          "SubStatus": "'",
          "SubStatusComments": "'"
        }
      ],
      "RequestedPaymentMode": {
        "PaymentMode": "",
        "BankName": "",
        "BranchName": "",
        "IFSCCOde": "",
        "AccountNumber": "",
        "AccountName": "",
        "CityName": ""
      },
      "ReturnRequestPayments": [
        {
          "ReturnRequestId": 201782,
          "PaymentDate": "19-Sep-2018 10:51:44 AM",
          "PaymentMode": "PAYTM",
          "ReferenceNumber": "20180919111212801300168654405302427",
          "Amount": "1,019",
          "Remarks": "Refund request was raised for this transaction. But it is pending state.",
          "BankName": null,
          "IFSCCOde": null,
          "AccountNumber": "",
          "AccountName": "",
          "BranchName": null
        }
      ],
      "PickupDetails": {
        "Address1": "",
        "Address2": "",
        "CountryCode": "",
        "CountryName": "",
        "StateCode": "",
        "StateName": "",
        "CityCode": "",
        "CityName": "",
        "PostCode": "",
        "Email": "",
        "FirstName": "",
        "LastName": "",
        "Mobile": ""
      },
      "SubStatus": "",
      "SubStatusComments": ""
    }
  ],
  "ErrorCode": 0
}

Resource Information
URI /Order/GetReturnRequestByOrderID/{MerchantId}/{OrderId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Order/GetReturnRequestByOrderID/{MerchantId}/{OrderId}

Request Path Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchant
OrderId* int Unique order id for which you want to fetch return request details

Response Parameters

Parameter Type Description
BillOfSupplyCreditNoteNumber string Credit note is generated for a customer returned item that is received at the merchant warehouse. Non-taxable items will have “Bill of supply Credit note number”
TaxableCreditNoteNumber string Credit note is generated for a customer returned item that is received at the merchant warehouse. Taxable Items will have “Taxable credit note number”
Source int Source from which the return request is made. values from 1-5. Example, 1 stands for storefront
RequestStatus enum Current status of the return request. Values: I for initiated, C for closed
RequestType enum Type of the return request. Values: R for return to origin (RTO) C for customer return and CU for Return created due to item cancellation
RefundStatus enum Current status of the refund. Values: I for initiated, C for closed
IncludeShippingCost enum Yes if the shipping cost is included in the return item, No if shipping cost is not included
IsSelfShip enum ‘Yesif the user will ship the return package to the merchant,No` if the merchant has to pickup the package from the user
SubStatus string The sub-status code of the return request

Edit Order Lineitem Price

Lets you modify the price of an existing order item.

Sample Request

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

Sample POST Request


MerchantID=81e77da2-723b-483d-8c0d-49f800c1exxx&InputFormat=application/json&InputData=[  
   {  
      "OrderID":7504015,
      "OrderItemID":"26147611",
      "Price":"1250",
      "MRP":"2600",
      "ConsiderCurrentPriceandMRP":"False",
      "ReasonForPriceOverride":"check price override"
   }
]

Sample Response

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

Resource Information
URI /Order/EditOrderLineItem/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/EditOrderLineItem/{MerchantId}

Request Body Parameters

Parameter Type Description
OrderID* int Unique id of the order for which you want to update an item price
OrderItemID int Unique id of the order item that you want to update
Price float New price of the order item
MRP float New maximum retail price of the order item
ConsiderCurrentPriceandMRP boolean Specify False to use the new prices specified, True to consider the prices as per the CP
ReasonForPriceOverride string Specify the reason for updating the order item price

Get Document

Generates either a dispatch or invoice document.

Sample Request

https://www.martjack.com/developerapi/Order/GetDocument/81e77da2-723b-483d-8c0d-49f800c1exxx/7752817/invoice/invoice_hyc-00000571

Response: You will see an option to download the document.

Resource Information
URI /Order/GetDocument/{MerchantId}/{OrderId}/{objectType}/{objectValue}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Order/GetDocument/{MerchantId}/{OrderId}/{objectType}/{objectValue}

Request Path Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchant
orderId* int Order id for which you want to generate the required document
objectType* enum Specify Invoice to generate invoice of the order, Shipment to get the dispatch document of the order
objectValue* string Specify invoice id or shipment id that you want to fetch based on the objectType passed

Add Manifest

Adds shipping manifest details for multiple shipments.

Sample Request

https://www.martjack.com/developerapi/Order/AddManifest/{merchantId}

Sample POST Request

MerchantId=89d3f1a-8c9a-41bd-9b3a-e6c2f031527d&InputFormat=application/json&InputData={
   "MerchantId":"389d3f1a-8c9a-41bd-9b3a-e6c2f031527d",
   "ShippingProvider":"eKart",
   "UserId":"00000000-0000-0000-0000-000000000000",
   "LocationId":"18584",
   "ChannelId":"32",
   "items":[
      {
         "shipmentId":"6123456"
      },
      {
         "shipmentId":"2123456"
      },
      {
         "shipmentId":"9123456"
      }
   ],
   "TripId":"TRIP-7935"
}

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "ManifestIds": {
    "ManifestId": 149069,
    "ManifestMessages": [
      {
        "ShipmentID": 6123456,
        "Message": "Success"
      },
      {
        "ShipmentID": 2123456,
        "Message": "Success"
      },
      {
        "ShipmentID": 9123456,
        "Message": "No record found"
      }
    ],
    "ErrorMessages": null
  },
  "ErrorCode": 0
}

Resource Information
URI /Order/AddManifest/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/AddManifest/{merchantId}

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
ShippingProvider* string Name of the shipping service
UserId string Unique GUID of the current user that updates the manifest details
LocationId int Unique location id of the shipment
LocationCode string Unique location code of the shipment
ChannelId* int Channel id of the marketplace
shipmentId* long Unique id of each shipment
TripId string Unique id of the shipment trip. A trip is a shipment containing multiple orders assigned to a delivery associate which need to be delivered to end customers. Each trip will have a unique trip id

Update Manifest Status

Lets you update the status of a manifest.

Sample Request

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

Sample POST Request

InputFormat=application/json&InputData={
   "Status":"Closed",
   "ManifestId":"149057"
}

Sample Response

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

Resource Information
URI /Order/UpdateManifest/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/UpdateManifest/{merchantId}

Request Body Parameters

Parameter Type Description
ManifestId* int Unique id of the manifest that you want to update
status enum New status of the manifest. Values: Created, Closed
tripId string Unique id of the shipment trip. A trip is a shipment containing multiple orders assigned to a delivery associate which need to be delivered to end customers. Each trip will have a unique trip id

Get Manifest Details

Retrieves the details of a specific shipping manifest.

Sample Request

https://www.martjack.com/DeveloperAPI/Order/GetManifest/81e77da2-723b-483d-8c0d-49f800c1exxx/138931

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "Manifests": [
    {
      "ManifestId": 138931,
      "ManifestNo": "00005604",
      "NoOfItems": 1,
      "LocationId": 14908,
      "LocName": "Holisol Delhi",
      "ShippingProvider": "FedEx",
      "CreatedDate": "/Date(1549889694000+0530)/"
    }
  ],
  "ErrorCode": 0
}

Resource Information
URI /Order/GetManifest/{MerchantId}/{ManifestId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Order/GetManifest/{MerchantId}/{ManifestId}

Request Path Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchant
ManifestId* int Unique id of the shipping manifest for which you want to fetch details

Get Advance Tax Voucher

Retrieves Advance Tax Voucher (ATV) details of a specific order.

Sample Request

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

Sample Response


{
  "messageCode": "1004",
  "Message": "Successful",
  "TaxVouchers": [
    {
      "TaxVoucherNumber": "atv_biba/001052",
      "OrderId": 7704209,
      "BillFirstname": "Tom",
      "LocationCode": null,
      "BillLastname": null,
      "VoucherItems": [
        {
          "OrderLineId": 26578947,
          "sku": "AFROFUSION10302",
          "VariantSku": "AFROFUSION10302-8903098887787",
          "ProductPrice": 599,
          "HSNCode": "62114210",
          "Qty": 1,
          "MRP": 999,
          "TaxDetails": [
            {
              "TaxCategory": "CGST",
              "TaxRate": "2.5",
              "TaxAmount": 15.72,
              "IsTaxRatePercentage": true,
              "TaxCode": "GST_TEST"
            },
            {
              "TaxCategory": "SGST",
              "TaxRate": "2.5",
              "TaxAmount": 15.72,
              "IsTaxRatePercentage": true,
              "TaxCode": "GST_TEST"
            }
          ],
          "UOM": "Pieces",
          "BuyingWeight": 0
        }
      ],
      "BillCountry": "India",
      "BillingState": "Telangana",
      "GSTBillingStateUTCode": "36",
      "BillCity": "Hyderabad",
      "BillEmail": "tom.sawyer@caapillarytech.com",
      "BillZIP": "500033",
      "BillPhone": "",
      "BillMobile": "9422996500",
      "BillAddress1": "sample address",
      "ShipFirstname": "Tom",
      "ShipLastname": "Sawyer",
      "ShipCountry": "India",
      "ShipState": "Telangana",
      "GSTShipStateUTCode": "36",
      "ShipCity": "Hyderabad",
      "ShipEmail": "tom.sawyer@caapillarytech.com",
      "ShipZip": "500033",
      "ShipPhone": "",
      "ShipMobile": "9422000000",
      "ShipAddress1": "sample address1",
      "ShipOtherCity": ""
    }
  ],
  "ErrorCode": 0
}

Resource Information
URI /Order/TaxVoucher/{merchantId}/{orderId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Order/TaxVoucher/{merchantId}/{orderId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
orderId* int Unique id of the order for which you want to fetch advanced tax 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
TaxVoucherNumber string Advance tax voucher number (as generated through the Document Series in Advanced Settings)
LocationCode int Location code of the order fulfillment location (Generally used for Location specific merchants)
OrderLineId int Unique id of the order line item
HSNCode string The HSN code is the ‘Harmonized System Nomenclature code number’ that is required for GST. The 'HSN code’ is shown at item level
TaxCategory string Category of the current tax. For example: STT, VAT, GST, and CST
IsTaxRatePercentage enum True for percentage based tax rates and false for flat rate tax
TaxCode string Unique tax code that you want to associate to the product. Tax code should be configured in the CP first to associate to products.
UOM string Unit of measurement of the current item
BuyingWeight float Weight of the current item if UOM is kgs or gms

Searches leads based on the input parameters.

Sample Request

https://www.martjack.com/developerapi/Order/LeadSearch/fc93a3a8-f69b-444c-8b76-9848de9338d0

Sample POST Request

MerchantId=fc93a3a8-f69b-444c-8b76-9848de9338d0&InputFormat=application/json&InputData={ 
    "fromDate": "03-15-2019", 
    "toDate": "03-28-2019", 
    "status": "P", 
    "leadId": "12345",
    "userName": "jane.doe@gmail.com", 
    "mobileNumber": "9999991234", 
    "sKU": "123456", 
    "firstName": "jane",     
    "lastName": "done", 
    "locationIds": "371,372", 
    "callForActionId": ""     
}

Sample Response


{
  "messageCode": "1004",
  "Message": "Successful",
  "Leads": [
    {
      "LeadId": 771559,
      "UserId": "00000000-0000-0000-0000-000000000000",
      "TotalAmount": 0.0,
      "Status": "P",
      "LeadDate": "2019-03-27T12:21:45",
      "FirstName": "Tom Sawyer",
      "Email": "tom.sawyer@example.com",
      "MobileNumber": "",
      "Address": null,
      "City": "",
      "State": null,
      "Country": null,
      "ZipCode": null,
      "TAXTotal": 0.0,
      "CustomDescription": "First Name:Tom,Last Name:Sawyer,Email Address:skanda676@gmail.com,Country Code:,Mobile Number:551133160,Date of Birth:08/29/1989,Nationality:India,Anniversary:02/10/2019,Gender:Male,Emirate:Dubai,Occupation:Private_Corporate,Status:Married,Children:No,Address:3904| Capillary technologies| One Lake Plaza\r\nJLT Cluster T\r\nJumeirah Lake towers,Please select your offer preference/s:Select All,Skin Care,Hair Care,Personal Care,Baby and Mother,Nutrition,Medical Equipments,Rehab,First Aid and SupportPO Box:,",
      "CheckOutId": 7134,
      "UpLoadedFiles": "",
      "LeadLines": [
        {
          "LeadLineId": 754073,
          "LeadId": 771559,
          "ProductId": 0,
          "VariantProductId": 0,
          "IsParentProduct": false,
          "Description": "",
          "Quantity": 0.0,
          "ProductPrice": 0.0,
          "_locationid": 0
        }
      ]
    },
    {
      "LeadId": 771421,
      "UserId": "00000000-0000-0000-0000-000000000000",
      "TotalAmount": 0.0,
      "Status": "P",
      "LeadDate": "2019-03-27T08:40:47",
      "FirstName": "James Diyas",
      "Email": "james.diyas@example.com",
      "MobileNumber": "",
      "Address": null,
      "City": "",
      "State": null,
      "Country": null,
      "ZipCode": null,
      "TAXTotal": 0.0,
      "CustomDescription": "First Name:James,Last Name:Diyas,Email Address:noelinedias@gmail.com,Country Code:,Mobile Number:504929486,Date of Birth:26/12/1960,Nationality:Sri Lanka,Anniversary:28/05/1988,Gender:Female,Emirate:Abu_Dhabi,Occupation:Private_Corporate,Status:Married,Children:Yes,Address:Hamdan street Abu dhabi,Please select your offer preference/s:NutritionPO Box:3658,",
      "CheckOutId": 7134,
      "UpLoadedFiles": "",
      "LeadLines": [
        {
          "LeadLineId": 753935,
          "LeadId": 771421,
          "ProductId": 0,
          "VariantProductId": 0,
          "IsParentProduct": false,
          "Description": "",
          "Quantity": 0.0,
          "ProductPrice": 0.0,
          "_locationid": 0
        }
      ]
    }
  ]
}

Resource Information
URI /Order/LeadSearch/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/LeadSearch/{merchantId}

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
fromDate date Search leads created in a specific duration. Specify the date-range in fromDate and toDate (in MM-DD-YYYY format)
toDate date Search leads created in a specific duration. Specify the date-range in fromDate and toDate (in MM-DD-YYYY format)
status enum Search by current lead status. Values: P - Uninitiated, I - Initiated, R - Rejected, C - Converted
leadId int Specify unique id of the lead that you want to fetch
userName string Search leads by a customer’s username (email id)
mobileNumber string Search leads by a customer’s mobile number
SKU string Specify the SKU of the product for which you want to see generated leads
firstName string Search leads by customer’s first name
lastName string Search leads by customer’s last name
locationIds string Fetch leads of your preferred locations. You can pass multiple location ids separating each by a comma (,)
callForActionId string Unique id associated to the call-for-action for leads. For example, Call for actions could be Get-a-Call, Reserve Product & Visit Store, Proforma Invoice, and Get-a-Call

Edit Shipping/Billing Address

Lets you modify billing and shipping address of an order before one of the order items is dispatched. Once the item is dispatched, you cannot modify the address.

Sample Request

Sample POST Request

Sample Response

Resource Information
URI /Order/edit/address/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/edit/address/{merchantId}

Request Body Parameters

Parameter Datatype Description

Get Available Delivery Slots

Retrieves the available delivery slot details for a given date range, location, and delivery mode.

Sample Request

Sample POST Request

Sample Response

Resource Information
URI /Order/AvailableDeliverySlots/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Order/AvailableDeliverySlots/{merchantId}

Request Body Parameters

Parameter Datatype Description
deliveryMode enum Get available delivery slots by delivery mode. Values: H for home delivery, S for takeaway. Leave it blank to get slots of both modes.
fromDate* date Get delivery slots for a specific duration. Pass the duration in fromDate and toDate in YYYY-MM-DD format.
locationId int Get available slots for a specific location. If this is left blank, you will get available slots for all location IDs.
toDate* date Get delivery slots for a specific duration. Pass the duration in fromDate and toDate in YYYY-MM-DD format.

Cancel Return

Lets you cancel a return request by return request ID.

Sample Request

https://ecom.capillary.in/developerAPI/Order/CancelReturn/81e77da2-723b-483d-8c0d-49f800c1exxx/963807

Sample Response

# If order in initiated stage
{
    "messageCode": "1004",
    "Message": "Return request has been cancelled successfully",
    "ErrorCode": 0
}

Sample Response

# If order not in initiated stage
{
  "messageCode": "1027",
  "Message": "Cancellation of Merchant pickup returns is allowed only in Initiated stage",
  "ErrorCode": 0
}

Resource Information
URI /Order/CancelReturn/{merchantId}/{returnRequestid}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST (No body required)
Batch Support No

Request URL

{host}/developerapi/Order/AvailableDeliverySlots/{merchantId}

Request Query Parameters

Parameter Datatype Description
merchantId* string Unique GUID of the merchant
returnRequestId* int Unique id of the return request to cancel.

Picklist

Picklist is a document that contains the list of order items to be picked up from inventory for further processing. Picklist is maintained by shippers with large inventory or multiple orders. This resource provides all APIs related creating and managing picklist.

Create Picklist

Lets you create order picklist for a specific location.

Sample Request

https://www.martjack.com/developerapi/Pricelist/createPicklist/fd986588-63df-4d76-9ddd-5d8b984518a5

Sample POST Request

MerchantId=fd986588-63df-4d76-9ddd-5d8b984518a5&InputFormat=application/json&InputData={
"PicklistCreate": {
"PickerName": "Test",
"LoginUserID": "fd986588-63df-4d76-9ddd-5d8b984518a5",
"CreatedBy": "Test",
"ZoneID": 0,
"PickerID": "c70640f3-6a9f-471d-aeac-895089846e0f",
"LocationId": "26191",
"DeliverySlotID": 0,
"MerchantId": "fd986588-63df-4d76-9ddd-5d8b984518a5",
"DeliveryDate": "2018/04/27",
"PicklistOperatorID": "00000000-0000-0000-0000-000000000000",
"PicklistCreateOrderDetails": [{
"PicklistCreateItemDetails": [{
"ChildProductId": "0",
"IsBundleParentProduct": "False",
"LocationId": "26191",
"Quantity": "1",
"ProductId": "14497553",
"OrderItemID": "28141571"
}],
"OrderId": "7676691"
}],
"PicklistName": "test"
}
}

Sample Response

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

Resource Information
URI /picklist/createPicklist/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

https://{host}/developerapi/picklist/createPicklist/{merchantId}

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
PickerName string Specify a name for the picklist
LoginUserID string Unique GUID of the current logged in user
CreatedBy string Name of the operator who is creating the picklist
ZoneID int Unique id of the zone. Default value is 0
PickerID* string Unique picker id assigned to the picklist
LocationId* int Unique id of the order fulfillment location
DeliverySlotID int Unique id of the delivery slot. Specify a valid id
DeliveryDate date Specify the estimated delivery date of the items of the picklist in YYYY/MM/DD format
PicklistOperatorID string Unique GUID of the picklist operator
ChildProductId int Unique id of the variant product or child product of the bundle
IsBundleParentProduct boolean Whether the item is a parent product of a bundle
Quantity int Quantity of the current item that you want to add
ProductId int Unique id of the parent product
OrderItemID int Unique order line-item id of the current product
OrderId* int Order id associated to the current item
PicklistName string Specify a name for the current picklist

Confirm Picklist

Lets you update picklist of an order item.

Sample Request

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

Sample POST Request


MerchantID=81e77da2-723b-483d-8c0d-49f800c1exxx&InputFormat=application/json&InputData={ 
  "PickListOrderLines": {
    "PickListOrderLine": [
      {
        "picklistOrderDetailId": "3236041",
        "PickListItemStatus": "C",
        "PickListId": "173273",
        "UserId": "f48fdd16-92db-4188-854d-1ecd9b62d066",
        "Weight": "1",
        "ActualPrice": "30",
        "isVariance": true
      } 
    ]
  }   
}

Sample Response


{
   "Code": "1007",
   "Message": "Updated Successfully",
   "ErrorCode": "0",
   "AllocatedItems": "false"
}

Resource Information
URI /PickList/ConfirmPicklist/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/PickList/ConfirmPicklistItems/{MerchantId}

Request Body Parameters

Parameter Type Description
picklistOrderDetailId* int Unique picklist id of the item
PickListItemStatus* enum The status of the current item. F for found, N for not found, C for cancel. If no value is passed, not found is considered as the default value
PickListId* int Unique id of the picklist
UserId* string Unique GUID of the user associated to the order item
Weight int Weight of the item
ActualPrice float Net price of the item. The item price can be changed if isVariance is set to true
isVariance* boolean Whether there is change in the price of the current item while creating picklist. If there is a difference, the item price can be changed by passing the ActualPrice of the item

Process Picklist

Sample Request

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

Sample POST Request

MerchantId=f48fdd16-92db-4188-854d-1ecd9b62d066&InputFormat=application/json&InputData={  
   "Picklist":{  
      "MerchantID":"f48fdd16-92db-4188-854d-1ecd9b62d066",
      "PicklistID":"168695",
      "SubStatus":"QC",
      "PicklistOperatorID":"f48fdd16-92db-4188-854d-1ecd9b62d066",
      "Comments":"please start QC",
      "ConfirmPicking":1,
      "ProcessPicklistItemDetails":[  
         {  
            "OrderPickListDetailId":"3113505",
            "RetransactionID":"7504189",
            "PicklistID":"168695",
            "RedetailsID":"27148501",
            "SubStatus":"QC",
            "PicklistOperatorID":"f48fdd16-92db-4188-854d-1ecd9b62d066",
            "Comments":"QC started for item",
            "BatchNo":"123",
            "PickListItemStatus":"F",
            "Weight":1,
            "PickingPrice":40,
            "IsVariance":1,
            "ActualPrice":1060,
            "PicklistCustomFields":[  

            ]
         },
          {  
            "OrderPickListDetailId":"3113507",
            "RetransactionID":"7504189",
            "PicklistID":"168695",
            "RedetailsID":"27148501",
            "SubStatus":"QC",
            "PicklistOperatorID":"f48fdd16-92db-4188-854d-1ecd9b62d066",
            "Comments":"QC started for item",
            "BatchNo":"123",
            "PickListItemStatus":"N",
            "Weight":2,
            "PickingPrice":50,
            "IsVariance":1,
            "ActualPrice":1060,
            "PicklistCustomFields":[  

            ]
         },
          {  
            "OrderPickListDetailId":"3113509",
            "RetransactionID":"7504189",
            "PicklistID":"168695",
            "RedetailsID":"27148501",
            "SubStatus":"QC",
            "PicklistOperatorID":"f48fdd16-92db-4188-854d-1ecd9b62d066",
            "Comments":"QC started for item",
            "BatchNo":"123",
            "PickListItemStatus":"C",
            "Weight":3,
            "PickingPrice":60,
            "IsVariance":1,
            "ActualPrice":1060,
            "PicklistCustomFields":[  

            ]
         }
      ]
   }
}

Sample Response

{
   "Code": "1004",
   "Message": "Successful",
   "ErrorCode": "0",
   "AllocatedItems": "false"
}

Process the picklist once created from verification to confirmation.

Resource Information
URI /PickList/ProcessPicklist/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/PickList/ProcessPicklist/{MerchantId}

Request Body Parameters

Parameter Type Description
MerchantID* string Unique GUID of the merchant
PickListId* int Unique id of the picklist
SubStatus* enum Unique 2 character code of the sub-status of the picklist or picklist item. Values are as per configured in the CP for that merchant
PicklistOperatorID* string Unique id of the staff that confirms the picklist
Comments string Any comments related to the picklist at the request level/item level
ConfirmPicking* enum Specify 1 to confirm pick up, 0 if not confirmed. The default value is ‘0’
OrderPickListDetailId* int Unique internal reference id generated for each picklist item
RetransactionID* int Order id of the item for which you want to update picklist
PicklistID* int Unique id of the picklist
RedetailsID* int Unique item id as in the REtransaction table
PicklistOperatorID string Unique id of the operator
PickListItemStatus enum The status of the current item. Values: F for found, N for not found, C for cancel. If no value is passed, not found is considered as the default value
Weight int Weight of the item if applicable
ActualPrice float Net price of the item. The item price can be changed if isVariance is set to true
isVariance* boolean Whether there is change in the price of the current item when picklist is created. If there is a price difference, the item price can be changed by passing the ActualPrice of the item
PickingPrice* int Additional price charged for packing (if applicable). For example, in restaurants additional charge will be levied on takeaway orders for packing
PicklistCustomFields obj Picklist level custom field details - key and value pairs

Get Picklist Summary

Retrieves the details of a specific picklist.

Sample Request

https://www.martjack.com/developerapi/PickList/GetPickListSummary/f48fdd16-92db-4188-854d-1ecd9b62e546/168891

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "PickList": {
    "PickListId": 168891,
    "PickListName": "FabTest",
    "PickListCode": "PK168890",
    "MerchantId": "f48fdd16-92db-4188-854d-1ecd9b62e546",
    "PickerName": "Tim James",
    "PickListStatus": "Completed",
    "CreatedBy": "tim.james@capillarytech.com",
    "CreatedOn": "/Date(1549867811000+0530)/",
    "ModifiedOn": "1/1/0001 12:00:00 AM",
    "ModifiedBy": null,
    "LocationId": 18340,
    "PickListOrder": [
      {
        "ChannelId": 0,
        "OrderPickListId": 1586811,
        "PickListId": 168891,
        "PickListOrderItems": [
          {
            "ProductTitle": "Onion Red",
            "ProductSKU": "100556",
            "VariantSKU": "100556-1kg",
            "CategoryCode": "CU00373956",
            "PickListCode": null,
            "BarCodes": [
              {
                "BarCode": "100556-123"
              },
              {
                "BarCode": "100556-1kg"
              }
            ],
            "CategoryName": "MID",
            "ProductCost": 0,
            "variantDescription": "Weight=1000gm",
            "MRP": 1009,
            "CurrencyCode": null,
            "UOM": "Gms",
            "OrderPickListDetailId": 3114155,
            "PickListId": 168891,
            "OrderId": 7506553,
            "OrderLineId": 26152287,
            "ProductId": 14106036,
            "ChildProductId": 10178766,
            "Quantity": 1,
            "PickQuantity": 0,
            "OrderItemPickStatus": "N",
            "LocationID": 18340,
            "ShelveCode": "",
            "IsHold": "False",
            "Weight": 1000,
            "variantattributevalue": null,
            "PicklistOperatorID": "00000000-0000-0000-0000-000000000000",
            "SubStatus": "",
            "Comments": ""
          },
          {
            "ProductTitle": "Onion Red",
            "ProductSKU": "100556",
            "VariantSKU": "100556-1kg",
            "CategoryCode": "CU00373956",
            "PickListCode": null,
            "BarCodes": [
              {
                "BarCode": "100556-123"
              },
              {
                "BarCode": "100556-1kg"
              }
            ],
            "CategoryName": "MID",
            "ProductCost": 0,
            "variantDescription": "Weight=1000gm",
            "MRP": 1009,
            "CurrencyCode": null,
            "UOM": "Gms",
            "OrderPickListDetailId": 3114157,
            "PickListId": 168891,
            "OrderId": 7506553,
            "OrderLineId": 26152287,
            "ProductId": 14106036,
            "ChildProductId": 10178766,
            "Quantity": 1,
            "PickQuantity": 0,
            "OrderItemPickStatus": "N",
            "LocationID": 18340,
            "ShelveCode": "",
            "IsHold": "False",
            "Weight": 1000,
            "variantattributevalue": null,
            "PicklistOperatorID": "00000000-0000-0000-0000-000000000000",
            "SubStatus": "",
            "Comments": ""
          },
          {
            "ProductTitle": "Go Buttermilk - Masala Chaas Ginger & Jeera",
            "ProductSKU": "1000681",
            "VariantSKU": "101101241",
            "CategoryCode": "CU00333530",
            "PickListCode": null,
            "BarCodes": [
              {
                "BarCode": "101101241"
              },
              {
                "BarCode": "8906001028352"
              }
            ],
            "CategoryName": "Flavoured Milk",
            "ProductCost": 0,
            "variantDescription": "Volume=1L Tetra Pack",
            "MRP": 50,
            "CurrencyCode": null,
            "UOM": "Pieces",
            "OrderPickListDetailId": 3114159,
            "PickListId": 168891,
            "OrderId": 7506553,
            "OrderLineId": 26152289,
            "ProductId": 12322046,
            "ChildProductId": 9076978,
            "Quantity": 1,
            "PickQuantity": 0,
            "OrderItemPickStatus": "N",
            "LocationID": 18340,
            "ShelveCode": "",
            "IsHold": "False",
            "Weight": 0,
            "variantattributevalue": null,
            "PicklistOperatorID": "00000000-0000-0000-0000-000000000000",
            "SubStatus": "",
            "Comments": ""
          },
          {
            "ProductTitle": "Go Buttermilk - Masala Chaas Ginger & Jeera",
            "ProductSKU": "1000681",
            "VariantSKU": "101101241",
            "CategoryCode": "CU00333530",
            "PickListCode": null,
            "BarCodes": [
              {
                "BarCode": "101101241"
              },
              {
                "BarCode": "8906001028352"
              }
            ],
            "CategoryName": "Flavoured Milk",
            "ProductCost": 0,
            "variantDescription": "Volume=1L Tetra Pack",
            "MRP": 50,
            "CurrencyCode": null,
            "UOM": "Pieces",
            "OrderPickListDetailId": 3114161,
            "PickListId": 168891,
            "OrderId": 7506553,
            "OrderLineId": 26152289,
            "ProductId": 12322046,
            "ChildProductId": 9076978,
            "Quantity": 1,
            "PickQuantity": 0,
            "OrderItemPickStatus": "N",
            "LocationID": 18340,
            "ShelveCode": "",
            "IsHold": "False",
            "Weight": 0,
            "variantattributevalue": null,
            "PicklistOperatorID": "00000000-0000-0000-0000-000000000000",
            "SubStatus": "",
            "Comments": ""
          }
        ],
        "Status": "PICKING",
        "TotalAmount": 2118,
        "TotalNoOfItems": 4,
        "channelName": null
      }
    ],
    "PicklistOperatorID": "00000000-0000-0000-0000-000000000000",
    "SubStatus": "",
    "Comments": ""
  },
  "ErrorCode": 0
}

Resource Information
URI /PickList/GetPickListSummary/{MerchantId}/{pickListId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/PickList/GetPickListSummary/{MerchantId}/{pickListId}

Request Body Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchant
pickListId* int Unique id of the picklist to fetch the summary

Get PickLists of a Merchant

Lets you fetch picklists of the merchant based on the input parameters. By default, the details of the picklists of the last one week will be retrieved.

Sample Request

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

Sample POST Request


MerchantID=f48fdd16-92db-4188-854d-1ecd9b62d066&InputFormat=application/json&InputData=
{
"Createdon":"2019-02-13",
"PickListCode": "",
"status": ""
}

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "PickLists": [
    {
      "PickListId": 176599,
      "PickListName": "FabTest",
      "PickListCode": "PK176598",
      "MerchantId": "f48fdd16-92db-4188-854d-1ecd9b62d066",
      "PickerName": "James",
      "PickListStatus": "Completed",
      "CreatedBy": "james@example.com",
      "CreatedOn": "/Date(1550023525000+0530)/",
      "ModifiedOn": "2/13/2019 7:35:48 AM",
      "ModifiedBy": "2/13/2019 7:35:48 AM",
      "LocationId": 18340,
      "PicklistOperatorID": "00000000-0000-0000-0000-000000000000",
      "SubStatus": "",
      "Comments": ""
    },
    {
      "PickListId": 176597,
      "PickListName": "FabTest",
      "PickListCode": "PK176596",
      "MerchantId": "f48fdd16-92db-4188-854d-1ecd9b62d066",
      "PickerName": "James",
      "PickListStatus": "Completed",
      "CreatedBy": "james@example.com",
      "CreatedOn": "/Date(1550023438000+0530)/",
      "ModifiedOn": "2/13/2019 7:34:25 AM",
      "ModifiedBy": "2/13/2019 7:34:25 AM",
      "LocationId": 18340,
      "PicklistOperatorID": "00000000-0000-0000-0000-000000000000",
      "SubStatus": "",
      "Comments": ""
    },
    {
      "PickListId": 176565,
      "PickListName": "FabTest",
      "PickListCode": "PK176564",
      "MerchantId": "f48fdd16-92db-4188-854d-1ecd9b62d066",
      "PickerName": "Malad Picker1",
      "PickListStatus": "Created",
      "CreatedBy": "tom.sawyer@capillarytech.com",
      "CreatedOn": "/Date(1550020430000+0530)/",
      "ModifiedOn": "2/13/2019 6:43:50 AM",
      "ModifiedBy": "2/13/2019 6:43:50 AM",
      "LocationId": 18340,
      "PicklistOperatorID": "00000000-0000-0000-0000-000000000000",
      "SubStatus": "",
      "Comments": ""
    }
  ],
  "ErrorCode": 0
}

Resource Information
URI /PickList/GetPickLists/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/PickList/GetPickLists/{MerchantId}

Request Body Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchant
status string Fetch picklists by status. Values: Created, In Picking (in progress), Completed or Picked (picked up)
picklistCode string Unique code of the picklist to fetch details by picklist code
createdOn date Fetch picklists created on a specific date. Pass the date in MM/DD/YYYY format
locationId int Fetch picklists of a specific location by location id
searchFromDate date Get picklists created on and after a specific date. Pass the date in MM/DD/YYYY format
searchSku string Fetch picklists consisting a specific SKU.
pageNumber int If results are too long and displayed in multiple pages, specify the page number to see the picklist of that particular page
pageSize int Specify the number of results to be shown per page
pickerId string Picker id assigned to the picklist
picklistOperatorID string Fetch picklists of a specific operator. Pass the unique GUID of the operator
subStatusCode enum Unique 2 character code of the picklist item sub-status. Values are as per configured in the CP
channelId string Channel id of the marketplace to get the picklists of that specific channel

Get PickList with Order Info

Retrieves details of a picklist along with the order details based on the input parameters.

Sample Request

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

Sample POST Request


MerchantID=f48fdd16-92db-4188-854d-1ecd9b62d066&InputFormat=application/json&InputData={
"Createdon":"2019-02-13",
"PickListCode": "",
"status": ""

}

Sample Response

{
   "messageCode":"1004",
   "Message":"Successful",
   "PickerPickLists":[
      {
         "PickListId":176599,
         "PickListName":"FabTest",
         "PickListCode":"PK176598",
         "MerchantId":"f48fdd16-92db-4188-854d-1ecd9b62d066",
         "PickerName":"s animesh",
         "PickListStatus":"Completed",
         "CreatedBy":"hyctest@martjack.com",
         "CreatedOn":"2/13/2019 7:35:25 AM",
         "ModifiedOn":"1/1/0001 12:00:00 AM",
         "ModifiedBy":null,
         "LocationId":18340,
         "PickListOrder":[
            {
               "DeliveryOption":"ship",
               "DeliverySlotEndTime":"9:30 PM",
               "DeliverySlotID":33380,
               "DeliverySlotStartTime":"7:00 PM",
               "DemandedDeliveryDate":"13-Feb-2019",
               "OrderDate":"2/13/2019 7:29:54 AM",
               "OrderPickListId":1648637,
               "PickListId":176599,
               "PickListOrderItems":[
                  {
                     "BarCodes":[
                        {
                           "BarCode":"100556-123"
                        },
                        {
                           "BarCode":"100556-1kg"
                        }
                     ],
                     "CategoryCode":"CU00373956",
                     "CategoryName":"MID",
                     "ChildProductId":10178766,
                     "Comments":"",
                     "CurrencyCode":null,
                     "CustomFieldValues":null,
                     "IsHold":"False",
                     "LocationCode":"1001",
                     "LocationID":18340,
                     "MRP":1009,
                     "OrderId":7752939,
                     "OrderItemPickStatus":"N",
                     "OrderLineId":26696085,
                     "OrderPickListDetailId":3313945,
                     "PickListCode":null,
                     "PickListId":176599,
                     "PickQuantity":0,
                     "PicklistOperatorID":"00000000-0000-0000-0000-000000000000",
                     "ProductCost":1009,
                     "ProductId":14106036,
                     "ProductSKU":"100556",
                     "ProductTitle":"Onion Red",
                     "Quantity":1,
                     "ShelveCode":"",
                     "SubStatus":"",
                     "UOM":"Gms",
                     "VariantSKU":"100556-1kg",
                     "Weight":1000,
                     "variantDescription":"Weight=1000gm",
                     "variantattributevalue":null
                  },
                  {
                     "BarCodes":[
                        {
                           "BarCode":"100556-123"
                        },
                        {
                           "BarCode":"100556-1kg"
                        }
                     ],
                     "CategoryCode":"CU00373956",
                     "CategoryName":"MID",
                     "ChildProductId":10178766,
                     "Comments":"",
                     "CurrencyCode":null,
                     "CustomFieldValues":null,
                     "IsHold":"False",
                     "LocationCode":"1001",
                     "LocationID":18340,
                     "MRP":1009,
                     "OrderId":7752939,
                     "OrderItemPickStatus":"N",
                     "OrderLineId":26696085,
                     "OrderPickListDetailId":3313947,
                     "PickListCode":null,
                     "PickListId":176599,
                     "PickQuantity":0,
                     "PicklistOperatorID":"00000000-0000-0000-0000-000000000000",
                     "ProductCost":1009,
                     "ProductId":14106036,
                     "ProductSKU":"100556",
                     "ProductTitle":"Onion Red",
                     "Quantity":1,
                     "ShelveCode":"",
                     "SubStatus":"",
                     "UOM":"Gms",
                     "VariantSKU":"100556-1kg",
                     "Weight":1000,
                     "variantDescription":"Weight=1000gm",
                     "variantattributevalue":null
                  }
               ],
               "Status":"PICKED",
               "TotalAmount":2018,
               "TotalNoOfItems":2,
               "channelId":0,
               "channelName":null
            }
         ],
         "PicklistOperatorID":"00000000-0000-0000-0000-000000000000",
         "SubStatus":"",
         "Comments":""
      },
      {
         "PickListId":176597,
         "PickListName":"FabTest",
         "PickListCode":"PK176596",
         "MerchantId":"f48fdd16-92db-4188-854d-1ecd9b62d066",
         "PickerName":"s animesh",
         "PickListStatus":"Completed",
         "CreatedBy":"hyctest@martjack.com",
         "CreatedOn":"2/13/2019 7:33:58 AM",
         "ModifiedOn":"1/1/0001 12:00:00 AM",
         "ModifiedBy":null,
         "LocationId":18340,
         "PickListOrder":[
            {
               "DeliveryOption":"ship",
               "DeliverySlotEndTime":"9:30 PM",
               "DeliverySlotID":33380,
               "DeliverySlotStartTime":"7:00 PM",
               "DemandedDeliveryDate":"13-Feb-2019",
               "OrderDate":"2/13/2019 7:29:52 AM",
               "OrderPickListId":1648635,
               "PickListId":176597,
               "PickListOrderItems":[
                  {
                     "BarCodes":[
                        {
                           "BarCode":"100556-123"
                        },
                        {
                           "BarCode":"100556-1kg"
                        }
                     ],
                     "CategoryCode":"CU00373956",
                     "CategoryName":"MID",
                     "ChildProductId":10178766,
                     "Comments":"",
                     "CurrencyCode":null,
                     "CustomFieldValues":null,
                     "IsHold":"False",
                     "LocationCode":"1001",
                     "LocationID":18340,
                     "MRP":1009,
                     "OrderId":7752937,
                     "OrderItemPickStatus":"N",
                     "OrderLineId":26696083,
                     "OrderPickListDetailId":3313941,
                     "PickListCode":null,
                     "PickListId":176597,
                     "PickQuantity":0,
                     "PicklistOperatorID":"00000000-0000-0000-0000-000000000000",
                     "ProductCost":1009,
                     "ProductId":14106036,
                     "ProductSKU":"100556",
                     "ProductTitle":"Onion Red",
                     "Quantity":1,
                     "ShelveCode":"",
                     "SubStatus":"",
                     "UOM":"Gms",
                     "VariantSKU":"100556-1kg",
                     "Weight":1000,
                     "variantDescription":"Weight=1000gm",
                     "variantattributevalue":null
                  },
                  {
                     "BarCodes":[
                        {
                           "BarCode":"100556-123"
                        },
                        {
                           "BarCode":"100556-1kg"
                        }
                     ],
                     "CategoryCode":"CU00373956",
                     "CategoryName":"MID",
                     "ChildProductId":10178766,
                     "Comments":"",
                     "CurrencyCode":null,
                     "CustomFieldValues":null,
                     "IsHold":"False",
                     "LocationCode":"1001",
                     "LocationID":18340,
                     "MRP":1009,
                     "OrderId":7752937,
                     "OrderItemPickStatus":"F",
                     "OrderLineId":26696083,
                     "OrderPickListDetailId":3313943,
                     "PickListCode":null,
                     "PickListId":176597,
                     "PickQuantity":0,
                     "PicklistOperatorID":"00000000-0000-0000-0000-000000000000",
                     "ProductCost":1009,
                     "ProductId":14106036,
                     "ProductSKU":"100556",
                     "ProductTitle":"Onion Red",
                     "Quantity":1,
                     "ShelveCode":"",
                     "SubStatus":"",
                     "UOM":"Gms",
                     "VariantSKU":"100556-1kg",
                     "Weight":1000,
                     "variantDescription":"Weight=1000gm",
                     "variantattributevalue":null
                  }
               ],
               "Status":"PICKED",
               "TotalAmount":2018,
               "TotalNoOfItems":2,
               "channelId":0,
               "channelName":null
            }
         ],
         "PicklistOperatorID":"00000000-0000-0000-0000-000000000000",
         "SubStatus":"",
         "Comments":""
      }
   ]
}

Resource Information
URI /PickList/GetPickListswithOrdersInfo/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/PickList/GetPickListswithOrdersInfo/{MerchantId}

Request Body Parameters

Parameter Type Description
MerchantId string Unique GUID of the merchant
status string Fetch picklists by status. Values: Created, In Picking (in progress), Completed or Picked (picked up)
picklistCode string Specify the unique picklist code to fetch
createdOn date Fetch picklists created on a specific date. Pass the date in MM/DD/YYYY format
locationId int Fetch picklist of a specific location. Pass the location id
searchFromDate date Get picklists created on and after a specific date. Pass the date in MM/DD/YYYY format
searchSku string Fetch picklists containing a specific SKU
pageNumber int If the results are too long and appear in multiple pages, you can specify a page number to see the results on that particular page
pageSize int Specify the number of results to be shown per page
pickerId string Picker id assigned to the picklist
picklistOperatorID string Fetch picklists of a specific operator. Pass the unique GUID of the operator
subStatusCode enum Unique 2 character code of the picklist item sub-status. Values are as per configured in the CP
channelId string Channel id of the marketplace to get picklists of that specific channel

Get PickList Items

Retrieves items of a specific picklist by item status.

Sample Request

https://www.martjack.com/developerapi/PickList/GetPickListItems/f48fdd16-92db-4188-854d-1ecd9b62d066/168917/P

Sample Response

{
   "Code": "1004",
   "Message": "Successful",
   "ErrorCode": "0",
   "PickListOrderItems": [
      {
         "ProductTitle": "Blue Straight Cotton Jacket",
         "ProductSKU": "WINTERW12140BLU",
         "VariantSKU": "8907319139341",
         "CategoryCode": "CU00302566",
         "PickListCode": "PK168916",
         "CategoryName": "Jackets",
         "ProductCost": "0",
         "variantDescription": "Size=34",
         "MRP": "2599.0000",
         "UOM": "Pieces",
         "OrderPickListDetailId": "3114191",
         "PickListId": "168917",
         "OrderId": "7507597",
         "OrderLineId": "26154847",
         "ProductId": "11481094",
         "ChildProductId": "7800898",
         "Quantity": "1",
         "PickQuantity": "0",
         "OrderItemPickStatus": "A",
         "LocationID": "0",
         "ShelveCode": [],
         "IsHold": "False",
         "Weight": "0",
         "BarCodes": [],
         "PicklistOperatorID": "00000000-0000-0000-0000-000000000000",
         "SubStatus": [],
         "Comments": []
      },
      {
         "ProductTitle": "Blue Straight Cotton Jacket",
         "ProductSKU": "WINTERW12140BLU",
         "VariantSKU": "8907319139341",
         "CategoryCode": "CU00302566",
         "PickListCode": "PK168916",
         "CategoryName": "Jackets",
         "ProductCost": "0",
         "variantDescription": "Size=34",
         "MRP": "2599.0000",
         "UOM": "Pieces",
         "OrderPickListDetailId": "3114193",
         "PickListId": "168917",
         "OrderId": "7507597",
         "OrderLineId": "26154847",
         "ProductId": "11481094",
         "ChildProductId": "7800898",
         "Quantity": "1",
         "PickQuantity": "0",
         "OrderItemPickStatus": "A",
         "LocationID": "0",
         "ShelveCode": [],
         "IsHold": "False",
         "Weight": "0",
         "BarCodes": [],
         "PicklistOperatorID": "00000000-0000-0000-0000-000000000000",
         "SubStatus": [],
         "Comments": []
      },
      {
         "ProductTitle": "Blue Straight Cotton Jacket",
         "ProductSKU": "WINTERW12140BLU",
         "VariantSKU": "8907319139334",
         "CategoryCode": "CU00302566",
         "PickListCode": "PK168916",
         "CategoryName": "Jackets",
         "ProductCost": "0",
         "variantDescription": "Size=32",
         "MRP": "2599.0000",
         "UOM": "Pieces",
         "OrderPickListDetailId": "3114195",
         "PickListId": "168917",
         "OrderId": "7507597",
         "OrderLineId": "26154849",
         "ProductId": "11481094",
         "ChildProductId": "7800896",
         "Quantity": "1",
         "PickQuantity": "0",
         "OrderItemPickStatus": "A",
         "LocationID": "0",
         "ShelveCode": [],
         "IsHold": "False",
         "Weight": "0",
         "BarCodes": [],
         "PicklistOperatorID": "00000000-0000-0000-0000-000000000000",
         "SubStatus": [],
         "Comments": []
      },
      {
         "ProductTitle": "Blue Straight Cotton Jacket",
         "ProductSKU": "WINTERW12140BLU",
         "VariantSKU": "8907319139334",
         "CategoryCode": "CU00302566",
         "PickListCode": "PK168916",
         "CategoryName": "Jackets",
         "ProductCost": "0",
         "variantDescription": "Size=32",
         "MRP": "2599.0000",
         "UOM": "Pieces",
         "OrderPickListDetailId": "3114197",
         "PickListId": "168917",
         "OrderId": "7507597",
         "OrderLineId": "26154849",
         "ProductId": "11481094",
         "ChildProductId": "7800896",
         "Quantity": "1",
         "PickQuantity": "0",
         "OrderItemPickStatus": "A",
         "LocationID": "0",
         "ShelveCode": [],
         "IsHold": "False",
         "Weight": "0",
         "BarCodes": [],
         "PicklistOperatorID": "00000000-0000-0000-0000-000000000000",
         "SubStatus": [],
         "Comments": []
      },
      {
         "ProductTitle": "Blue Straight Poly Cotton Kurta",
         "ProductSKU": "WINTERW13282AW17BLU",
         "VariantSKU": "8907319271133",
         "CategoryCode": "CU00302566",
         "PickListCode": "PK168916",
         "CategoryName": "Jackets",
         "ProductCost": "0",
         "variantDescription": "Size=M",
         "MRP": "4995.0000",
         "UOM": "Pieces",
         "OrderPickListDetailId": "3114199",
         "PickListId": "168917",
         "OrderId": "7507597",
         "OrderLineId": "26154851",
         "ProductId": "12407946",
         "ChildProductId": "9186262",
         "Quantity": "1",
         "PickQuantity": "0",
         "OrderItemPickStatus": "A",
         "LocationID": "0",
         "ShelveCode": [],
         "IsHold": "False",
         "Weight": "0",
         "BarCodes": [],
         "PicklistOperatorID": "00000000-0000-0000-0000-000000000000",
         "SubStatus": [],
         "Comments": []
      },
      {
         "ProductTitle": "Blue Straight Poly Cotton Kurta",
         "ProductSKU": "WINTERW13282AW17BLU",
         "VariantSKU": "8907319271133",
         "CategoryCode": "CU00302566",
         "PickListCode": "PK168916",
         "CategoryName": "Jackets",
         "ProductCost": "0",
         "variantDescription": "Size=M",
         "MRP": "4995.0000",
         "UOM": "Pieces",
         "OrderPickListDetailId": "3114201",
         "PickListId": "168917",
         "OrderId": "7507597",
         "OrderLineId": "26154851",
         "ProductId": "12407946",
         "ChildProductId": "9186262",
         "Quantity": "1",
         "PickQuantity": "0",
         "OrderItemPickStatus": "A",
         "LocationID": "0",
         "ShelveCode": [],
         "IsHold": "False",
         "Weight": "0",
         "BarCodes": [],
         "PicklistOperatorID": "00000000-0000-0000-0000-000000000000",
         "SubStatus": [],
         "Comments": []
      }
   ],
   "AllocatedItems": "false"
}

Resource Information
URI /PickList/GetPickListItems/{MerchantId}/{pickListId}/{orderItemStatus}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/PickList/GetPickListItems/{MerchantId}/{pickListId}/{orderItemStatus}

Request Path Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchant
pickListId* int Unique id of the picklist to see the picklist items
orderItemStatus* string Get picklist items by item status. Values: P for Pending, F for Found, N for Not Found, R for Removed, C for Canceled

Get Substitutes of Picklist Item

Retrieves the list of alternative products of a specific picklist item by product id.

Substitutes are the product alternatives used during pickup in case of unavailability or insufficient quantity of actual product.

Sample Request

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

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "SubstituteViews": [
        {
            "Merchantid": "9820eca5-d11f-4df1-9b20-983a45ea9631",
            "ProductId": 11989616,
            "VariantProductId": 0,
            "ProductSKU": "101356308",
            "VariantSKU": "",
            "ProductTitle": "Pepsi Mini Can-150 ml",
            "Sequence": 1,
            "UOM": "Pieces",
            "BuyingWeight": 0,
            "ProductImage": "http://images.sg.content-cdn.io/cdn/in-resources/f48fdd16-92db-4188-854d-1ecd9b62d066/Images/ProductImages/Source/No-image.jpg"
        }
    ],
    "ErrorCode": 0
}

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

Request URL

{host}/developerapi/PickList/GetItemsubstitutes/{merchantId}/{productId}

Request Path Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchant
ProductId* int Unique product id for which you want to fetch substitutes

Store

Store is a physical location in which a merchant operates business. This resource consists of APIs related to accessing store details.

Get Supported Countries

Sample Request

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

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "Country":[  
      {  
         "CountryName":"AFGHANISTAN",
         "CountryCode":"AF",
         "PhoneCode":"93"
      },
      {  
         "CountryName":"ALAND ISLANDS",
         "CountryCode":"AX",
         "PhoneCode":"358"
      },
      {  
         "CountryName":"ALBANIA",
         "CountryCode":"AL",
         "PhoneCode":"355"
      },
      {  
         "CountryName":"ALGERIA",
         "CountryCode":"DZ",
         "PhoneCode":"213"
      },
      {  
         "CountryName":"AMERICAN SAMOA",
         "CountryCode":"AS",
         "PhoneCode":"1684"
      },
      {  
         "CountryName":"ANDORRA",
         "CountryCode":"AD",
         "PhoneCode":"376"
      },
      {  
         "CountryName":"ANGOLA",
         "CountryCode":"AO",
         "PhoneCode":"244"
      },
      {  
         "CountryName":"ANGUILLA",
         "CountryCode":"AI",
         "PhoneCode":"1264"
      },
      {  
         "CountryName":"ANTARCTICA",
         "CountryCode":"AQ",
         "PhoneCode":"672"
      },
      {  
         "CountryName":"ANTIGUA AND BARBUDA",
         "CountryCode":"AG",
         "PhoneCode":"1268"
      },
      {  
         "CountryName":"ARGENTINA",
         "CountryCode":"AR",
         "PhoneCode":"54"
      },
      {  
         "CountryName":"ARMENIA",
         "CountryCode":"AM",
         "PhoneCode":"7"
      },
      {  
         "CountryName":"ARUBA",
         "CountryCode":"AW",
         "PhoneCode":"297"
      },
      {  
         "CountryName":"AUSTRALIA",
         "CountryCode":"AU",
         "PhoneCode":"61"
      },
      {  
         "CountryName":"AUSTRIA",
         "CountryCode":"AT",
         "PhoneCode":"43"
      },
      {  
         "CountryName":"AZERBAIDJAN",
         "CountryCode":"AZ",
         "PhoneCode":"0"
      },
      {  
         "CountryName":"BAHAMAS",
         "CountryCode":"BS",
         "PhoneCode":"1242"
      },
      {  
         "CountryName":"BAHRAIN",
         "CountryCode":"BH",
         "PhoneCode":"973"
      },
      {  
         "CountryName":"BANGLADESH",
         "CountryCode":"BD",
         "PhoneCode":"88"
      },
      {  
         "CountryName":"BARBADOS",
         "CountryCode":"BB",
         "PhoneCode":"1246"
      },
      {  
         "CountryName":"BELARUS",
         "CountryCode":"BY",
         "PhoneCode":"375"
      },
      {  
         "CountryName":"BELGIUM",
         "CountryCode":"BE",
         "PhoneCode":"32"
      },
      {  
         "CountryName":"BELIZE",
         "CountryCode":"BZ",
         "PhoneCode":"501"
      },
      {  
         "CountryName":"BENIN",
         "CountryCode":"BJ",
         "PhoneCode":"229"
      },
      {  
         "CountryName":"BERMUDA",
         "CountryCode":"BM",
         "PhoneCode":"1441"
      },
      {  
         "CountryName":"BHUTAN",
         "CountryCode":"BT",
         "PhoneCode":"975"
      },
      {  
         "CountryName":"BOLIVIA",
         "CountryCode":"BO",
         "PhoneCode":"591"
      },
      {  
         "CountryName":"BONAIRE, SINT EUSTATIUS AND SABA",
         "CountryCode":"BQ",
         "PhoneCode":"599"
      },
      {  
         "CountryName":"BOSNIA-HERZEGOVINA",
         "CountryCode":"BA",
         "PhoneCode":"387"
      },
      {  
         "CountryName":"BOTSWANA",
         "CountryCode":"BW",
         "PhoneCode":"267"
      },
      {  
         "CountryName":"BOUVET ISLAND",
         "CountryCode":"BV",
         "PhoneCode":"0"
      },
      {  
         "CountryName":"BRAZIL",
         "CountryCode":"BR",
         "PhoneCode":"55"
      },
      {  
         "CountryName":"BRITISH INDIAN OCEAN TERRITOR",
         "CountryCode":"IO",
         "PhoneCode":"0"
      },
      {  
         "CountryName":"BRUNEI DARUSSALAM",
         "CountryCode":"BN",
         "PhoneCode":"673"
      },
      {  
         "CountryName":"BULGARIA",
         "CountryCode":"BG",
         "PhoneCode":"359"
      },
      {  
         "CountryName":"BURKINA FASO",
         "CountryCode":"BF",
         "PhoneCode":"226"
      },
      {  
         "CountryName":"COCOS ISLANDS",
         "CountryCode":"CC",
         "PhoneCode":"672"
      },
      {  
         "CountryName":"COOK ISLANDS",
         "CountryCode":"CK",
         "PhoneCode":"682"
      },
      {  
         "CountryName":"COSTA RICA",
         "CountryCode":"CR",
         "PhoneCode":"506"
      },
      {  
         "CountryName":"CROATIA",
         "CountryCode":"HR",
         "PhoneCode":"385"
      },
      {  
         "CountryName":"CUBA",
         "CountryCode":"CU",
         "PhoneCode":"53"
      },
      {  
         "CountryName":"CURACAO",
         "CountryCode":"CW",
         "PhoneCode":"599"
      },
      {  
         "CountryName":"EQUATORIAL GUINEA",
         "CountryCode":"GQ",
         "PhoneCode":"240"
      },
      {  
         "CountryName":"ERITREA",
         "CountryCode":"ER",
         "PhoneCode":"291"
      },
      {  
         "CountryName":"ESTONIA",
         "CountryCode":"EE",
         "PhoneCode":"372"
      },
      {  
         "CountryName":"ETHIOPIA",
         "CountryCode":"ET",
         "PhoneCode":"251"
      },
      {  
         "CountryName":"FALKLAND ISLANDS",
         "CountryCode":"FK",
         "PhoneCode":"500"
      },
      {  
         "CountryName":"FAROE ISLANDS",
         "CountryCode":"FO",
         "PhoneCode":"298"
      },
      {  
         "CountryName":"FIJI",
         "CountryCode":"FJ",
         "PhoneCode":"679"
      },
      {  
         "CountryName":"FINLAND",
         "CountryCode":"FI",
         "PhoneCode":"358"
      },
      {  
         "CountryName":"FORMER CZECHOSLOVAKIA",
         "CountryCode":"CS",
         "PhoneCode":"421"
      },


      {  
         "CountryName":"ZIMBABWE",
         "CountryCode":"ZW",
         "PhoneCode":"263"
      }
   ],
   "ErrorCode":0
}

Retrieves all the countries (with country code and phone code) supported for the merchant.

Resource Information
URI /Store/Countries/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Store/Countries/{MerchantId}

Request Parameter

Attribute Description
merchantId* The unique id (GUID) of the merchant for which you want to see supported countries

Get Cities

Sample Request

https://www.martjack.com/developerapi/Store/Cities/81e77da2-723b-483d-8c0d-49f800c1exxx/KA

{  
   "messageCode":"1004",
   "Message":"Successful",
   "City":[  
      {  
         "CityId":32,
         "CityName":"Bangalore",
         "DefautPinCode":"560001",
         "StateCode":"KA"
      },
      {  
         "CityId":44,
         "CityName":"Belgaum",
         "DefautPinCode":"590001",
         "StateCode":"KA"
      },
      {  
         "CityId":45,
         "CityName":"Bellary",
         "DefautPinCode":"583101",
         "StateCode":"KA"
      },
      {  
         "CityId":48,
         "CityName":"Bhadravathi",
         "DefautPinCode":"",
         "StateCode":"KA"
      },
      {  
         "CityId":62,
         "CityName":"Bidadi",
         "DefautPinCode":"",
         "StateCode":"KA"
      },
      {  
         "CityId":63,
         "CityName":"Bidar",
         "DefautPinCode":"585226",
         "StateCode":"KA"
      },
      {  
         "CityId":65,
         "CityName":"Bijappur",
         "DefautPinCode":"",
         "StateCode":"KA"
      },
      {  
         "CityId":82,
         "CityName":"Chamaraj Nagar",
         "DefautPinCode":"",
         "StateCode":"KA"
      },
      {  
         "CityId":87,
         "CityName":"Channapatna",
         "DefautPinCode":"",
         "StateCode":"KA"
      },
      {  
         "CityId":92,
         "CityName":"Chickmagalur",
         "DefautPinCode":"573132",
         "StateCode":"KA"
      },
      {  
         "CityId":94,
         "CityName":"Chikballapur",
         "DefautPinCode":"",
         "StateCode":"KA"
      },
      {  
         "CityId":99,
         "CityName":"Chitradurga",
         "DefautPinCode":"572143",
         "StateCode":"KA"
      },
      {  
         "CityId":111,
         "CityName":"Davangare",
         "DefautPinCode":"577001",
         "StateCode":"KA"
      },
      {  
         "CityId":119,
         "CityName":"Dharwad",
         "DefautPinCode":"580001",
         "StateCode":"KA"
      },
      {  
         "CityId":124,
         "CityName":"Dinahata",
         "DefautPinCode":"",
         "StateCode":"KA"
      },
      {  
         "CityId":126,
         "CityName":"Dodballapur",
         "DefautPinCode":"",
         "StateCode":"KA"
      },

      {  
         "CityId":217,
         "CityName":"Jigani",
         "DefautPinCode":"",
         "StateCode":"KA"
      },
      {  
         "CityId":256,
         "CityName":"Kolar",
         "DefautPinCode":"561206",
         "StateCode":"KA"
      },
      {  
         "CityId":260,
         "CityName":"Koppal",
         "DefautPinCode":"583226",
         "StateCode":"KA"
      },
      {  
         "CityId":271,
         "CityName":"Kumarapatnam",
         "DefautPinCode":"",
         "StateCode":"KA"
      },
      {  
         "CityId":277,
         "CityName":"Kushalnagar",
         "DefautPinCode":"",
         "StateCode":"KA"
      },
      {  
         "CityId":491,
         "CityName":"Tiptur",
         "DefautPinCode":"",
         "StateCode":"KA"
      },
      {  
         "CityId":510,
         "CityName":"Tumkur",
         "DefautPinCode":"561202",
         "StateCode":"KA"
      },

      {  
         "CityId":18409,
         "CityName":"Gadag",
         "DefautPinCode":"582101",
         "StateCode":"KA"
      },
      {  
         "CityId":18743,
         "CityName":"Yantrapura",
         "DefautPinCode":"577602",
         "StateCode":"KA"
      },
      {  
         "CityId":18767,
         "CityName":"Bagalkot",
         "DefautPinCode":"587101",
         "StateCode":"KA"
      },
      {  
         "CityId":18911,
         "CityName":"Dakshina Kannada",
         "DefautPinCode":"574141",
         "StateCode":"KA"
      },
      {  
         "CityId":19066,
         "CityName":"Hospet Patel Nagar",
         "DefautPinCode":"583202",
         "StateCode":"KA"
      },
      {  
         "CityId":19070,
         "CityName":"Kodagu",
         "DefautPinCode":"571201",
         "StateCode":"KA"
      },
      {  
         "CityId":19078,
         "CityName":"Uttara Kannada",
         "DefautPinCode":"581121",
         "StateCode":"KA"
      },
      {  
         "CityId":19132,
         "CityName":"Ramanagar",
         "DefautPinCode":"561201",
         "StateCode":"KA"
      },
      {  
         "CityId":19761,
         "CityName":"Bengaluru",
         "DefautPinCode":"560001",
         "StateCode":"KA"
      },
      {  
         "CityId":19943,
         "CityName":"DANDELI",
         "DefautPinCode":"",
         "StateCode":"KA"
      },
      {  
         "CityId":19945,
         "CityName":"HARIHAR",
         "DefautPinCode":"",
         "StateCode":"KA"
      },
      {  
         "CityId":19947,
         "CityName":"JAMKHANDI",
         "DefautPinCode":"",
         "StateCode":"KA"
      },
      {  
         "CityId":20383,
         "CityName":"KUNIGAL",
         "DefautPinCode":"",
         "StateCode":"KA"
      }
   ],
   "ErrorCode":0
}

Retrieves all the supported cities of a specific state for the merchant.

Resource Information
URI /Store/Cities/{MerchantId}/{StateCode}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Store/Cities/{MerchantId}/{StateCode}

Request Parameter

Attribute Description
merchantId* The unique id (GUID) of the merchant for which you want to see the supported cities
StateCode* The state code for which you want to see the supported cities list

Get Cities by State Code

Retrieves all the available cities of a specific state based on the state code passed.

Sample Request

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

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "City": [
        {
            "CityId": 83,
            "CityName": "Chandigarh",
            "DefautPinCode": "160001",
            "StateCode": "CH1"
        }
    ],
    "ErrorCode": 0
}

Resource Information
URI /Store/Cities/{merchantId}/{statecode}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Store/Cities/{merchantId}/{statecode}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
statecode* string Specify the state code for which you want to fetch cities

Get Country Details

Retrieves the details of a specific country of the merchant based on the country code passed.

Sample Request

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

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "Country": [
        {
            "CountryName": "India",
            "CountryCode": "IN",
            "PhoneCode": null
        }
    ],
    "ErrorCode": 0
}

Resource Information
URI /Store/Countries/{merchantid}/{countrycode}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Store/Countries/{merchantid}/{countrycode}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
countrycode* string Specify a valid country code of the merchant that you want to fetch

Get Store Information

Retrieves the details of the store of the current merchant.

Sample Request

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

Sample Response

{
   "messageCode":"1004",
   "Message":"Successful",
   "Store":{
      "MerchantId":"f48fdd16-92db-4188-854d-1ecd9b62d066",
      "ChildrenPlayArea":false,
      "HomeDelivery":false,
      "GiftPacking":false,
      "ValetParking":false,
      "OwnParking":false,
      "ATM":false,
      "DistanceAir":"",
      "DistanceRly":"",
      "DistanceBus":"",
      "Landmark1":"",
      "Landmark2":"",
      "ContactPerson":"Vijay--",
      "PhysicalStoreName":"Saamag Retail Pvt Ltd",
      "PhysicalStoreAdd":"Hyderabad",
      "StoreStreet":"GachiBowli",
      "StoreCity":"195",
      "StorePinCode":"500032",
      "StoreState":"TG",
      "StoreCountry":"IN",
      "StPhoneNo":"09885296960",
      "cellphone":"91-9885296960",
      "StoreDescription":"<p class=\"MsoNormal\" style=\"line-height: 12pt;\"><span style=\"font-size: small;\"><span style=\"font-family: Arial;\"><span style=\"color: rgb(255, 0, 255);\">hyctest Store Hyderabad</span>, is among the leading ones in to the business of <span style=\"color: rgb(255, 0, 255);\">XXX </span>for the last few years. We<span style=\"color: black;\"> offer a broad and varied range of products and services to our customers.</span>All the products offered are according to International standards of quality, comfort and value. </span></span></p>  <p class=\"MsoNormal\" style=\"line-height: 12pt;\"><span style=\"font-size: small;\"><span style=\"font-family: Arial;\">Strict quality checks at every processing stage have enabled us to provide our customers with the best of our products at affordable prices.</span></span></p>",
      "EmailId":"vijay.yandam@capillarytech.com",
      "BusinessType":"BC00114",
      "OtherCityName":"",
      "City":{
         "CityId":0,
         "CityName":"Hyderabad"
      },
      "State":{
         "StateName":"Telangana"
      }
   },
   "ErrorCode":0
}

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

Request URL

{host}/developerapi/Store/Information/{merchantId}

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
ChildrenPlayArea boolean Whether the store has children play area or not
GiftPacking boolean Whether gift packing is available for items purchased at the store
PhysicalStoreAdd string Address of the physical store

Get State Details

Retrieves the details of a specific state based on the state code passed.

Sample Request

https://www.martjack.com/developerapi/Store/State/{merchantId}/{stateCode}

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "State": [
        {
            "StateName": "Chandigarh",
            "CountryCode": "IN",
            "StateCode": "CH1",
            "USPSCode": ""
        }
    ],
    "ErrorCode": 0
}

Resource Information
URI /Store/State/{merchantId}/{stateCode}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Store/State/{merchantId}/{stateCode}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
stateCode* string State code for which you want to fetch details

Get States of a Country

Retrieves the details all available states in a country for the specific merchant.

Sample Request

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

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "State": [
        {
            "StateName": "Andhra Pradesh",
            "CountryCode": "IN",
            "StateCode": "AP",
            "USPSCode": ""
        },
        {
            "StateName": "Arunachal Pradesh",
            "CountryCode": "IN",
            "StateCode": "AR",
            "USPSCode": ""
        },
        {
            "StateName": "Daman And Diu",
            "CountryCode": "IN",
            "StateCode": "DD",
            "USPSCode": ""
        },
        {
            "StateName": "Goa",
            "CountryCode": "IN",
            "StateCode": "GA",
            "USPSCode": ""
        },
        {
            "StateName": "Gujarat",
            "CountryCode": "IN",
            "StateCode": "GJ",
            "USPSCode": ""
        },

        {
            "StateName": "Jammu And Kashmir",
            "CountryCode": "IN",
            "StateCode": "JK",
            "USPSCode": ""
        },
        {
            "StateName": "Jharkhand",
            "CountryCode": "IN",
            "StateCode": "JH",
            "USPSCode": ""
        },
        {
            "StateName": "Karnataka",
            "CountryCode": "IN",
            "StateCode": "KA",
            "USPSCode": ""
        },
        {
            "StateName": "Kerala",
            "CountryCode": "IN",
            "StateCode": "KL",
            "USPSCode": ""
        },
        {
            "StateName": "Lakshadweep",
            "CountryCode": "IN",
            "StateCode": "LD",
            "USPSCode": ""
        },
        {
            "StateName": "Madhya Pradesh",
            "CountryCode": "IN",
            "StateCode": "MP",
            "USPSCode": ""
        },
        {
            "StateName": "Maharashtra",
            "CountryCode": "IN",
            "StateCode": "MH",
            "USPSCode": ""
        },
        {
            "StateName": "Manipur",
            "CountryCode": "IN",
            "StateCode": "MN",
            "USPSCode": ""
        },
        {
            "StateName": "Meghalaya",
            "CountryCode": "IN",
            "StateCode": "ML",
            "USPSCode": ""
        },
        {
            "StateName": "Mizoram",
            "CountryCode": "IN",
            "StateCode": "MZ",
            "USPSCode": ""
        },
        {
            "StateName": "Nagaland",
            "CountryCode": "IN",
            "StateCode": "NL",
            "USPSCode": ""
        },
        {
            "StateName": "Odisha",
            "CountryCode": "IN",
            "StateCode": "OR",
            "USPSCode": ""
        },
        {
            "StateName": "Orissa",
            "CountryCode": "IN",
            "StateCode": "OR400",
            "USPSCode": ""
        },
        {
            "StateName": "Tamil Nadu",
            "CountryCode": "IN",
            "StateCode": "TN",
            "USPSCode": ""
        },
        {
            "StateName": "Telangana",
            "CountryCode": "IN",
            "StateCode": "TG",
            "USPSCode": ""
        },
        {
            "StateName": "West Bengal",
            "CountryCode": "IN",
            "StateCode": "WB",
            "USPSCode": ""
        }
    ],
    "ErrorCode": 0
}

Resource Information
URI /Store/States/{merchantId}/{Countrycode}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Store/States/{merchantId}/{Countrycode}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
Countrycode* string Country code for which you want to fetch available states

Get Channel Information

Retrieves the details of a specific channel based on the channel id or channel code passed.

Sample Request

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

Sample Response


{
    "messageCode": "1004",
    "Message": "Successful",
    "ChannelDetails": [
        {
            "APPID": "0",
            "AppName": null,
            "ChannelID": "3404",
            "ChannelName": "APIChannelRefCode",
            "ChannelRefCode": "Auto227332",
            "ChannelType": "Web",
            "ChannelTypeID": "1",
            "MerchantID": "f48fdd16-92db-4188-854d-1ecd9b62d066",
            "UserID": "68bb81e1-e7be-4bbc-bffd-afeb9ad041c0"
        }
    ],
    "ErrorCode": 0
}

Resource Information
URI /Store/getchannelinfo/{merchantid}/{channelid or channelcode}/{channelrefcode}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Store/getchannelinfo/{merchantid}/{channelid}

OR

{host}/developerapi/Store/getchannelinfo/{merchantid}/{channelcode}

OR

{host}/developerapi/Store/getchannelinfo/{merchantid}/0/{channelrefcode}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
channelid** int Specify the unique id of the channel that you want to fetch. Either pass channelid or channelcode but not both
channelcode** string Specify the unique channel code that you want to fetch. Either pass channelid or channelcode but not both
channelrefcode** string Specify the unique reference code of the channel that you want to fetch. Pass channelid as 0 if you use channelrefcode as mentioned in the Request URL

Update Channel (Archive)

Archives a specific channel of the merchant based on the channel reference code passed.

Sample Request

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

Sample Response

{
    "messageCode": "1004",
    "Message": "Channel updated successfully",
    "ErrorCode": 0
}

Resource Information
URI /Store/UpdateChannel/{merchantid}/{channelrefcode}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Store/UpdateChannel/{merchantid}/{channelrefcode}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
channelrefcode* string Unique reference code of the channel that you want to archive

Get Vendor Details

Retrieves the details of a specific vendor of the merchant based on the vendor id passed.

Sample Request

https://www.martjack.com/developerapi/Store/GetVendorDetails/164b706c-a357-42d2-98ef-ec51e23e297b/ecbeec1b-8317-4e04-b9ef-42fb80fe4bf3

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "VendorDetails": [
        {
            "MerchantId": "164b706c-a357-42d2-98ef-ec51e23e297b",
            "VendorId": "ecbeec1b-8317-4e04-b9ef-42fb80fe4bf3",
            "VendorName": "MJ Enterprise PVt Ltd",
            "ContactPerson": "Jim Martin",
            "Address": "26-1, KC Road",
            "ZipCode": "560028",
            "Country": "IN",
            "State": "",
            "City": "195",
            "value": "",
            "Mobile": "91-7842700000",
            "Fax": "",
            "Email": "jim8@mjent.com",
            "Active": true,
            "SupplierEmailConfiguration": false,
            "IsDropShipping": false,
            "OrderReturn": false,
            "Availability": true,
            "VendorReferenceCode": "MJE234",
            "RequestState": null,
            "EnableEmailNotification": false
        }
    ],
    "ErrorCode": 0
}

Resource Information
URI /Store/GetVendorDetails/{merchantId}/{vendorId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Store/GetVendorDetails/{merchantId}/{vendorId}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
vendorId* string Unique GUID of the vendor that you want to fetch

Location

Location is a determination of the place where a product is available or shipped from. It could be a physical store or just a warehouse. This resource contains APIs related to accessing and managing store/warehouse location details.

Store Delivery Area Mapping

Sample Request

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

Sample POST Request

InputFormat=application/json&MerchantId=f48fdd16-92db-4188-854d-1ecd9b62e234&ETAfor=ALL&InputData={
   "StoreDeliveryAreaMappings":{
      "StoreDeliveryAreaMapping":[
         {
            "LocationRefCode":"Hyd001",
            "DeliveryType":"H",
            "AreaRefCode":"12146",
            "Operation":"remove"
         },
         {
            "LocationRefCode":"Hyd001",
            "DeliveryType":"H",
            "AreaRefCode":"12146",
            "Operation":"add"
         }
      ]
   }
}

Sample Response

{
   "messageCode": "1004",
   "Message": "Successful",
   "FailedStoreDeliveryAreaMapping": [
       {
           "LocationRefCode": null,
           "DeliveryType": null,
           "AreaRefCode": null,
           "Operation": null,
           "ErrorMessage": null
       }
   ],
   "ErrorCode": 0
}

Maps a store location to a delivery area

Resource Information
URI /Location/StoreDeliveryAreaMapping/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Location/StoreDeliveryAreaMapping/{MerchantId}

Request Body Parameters

Parameter Datatype Description
LocationRefCode string The location reference code that you want to map to a delivery area
DeliveryType string The type of delivery of the location. Value: H if the type is Home delivery, S for store pickup, N if the store supports both pickup and delivery
AreaRefCode string Delivery area reference code that you want to assign
Operation string Specify add to add delivery area to a location, remove to delete the delivery area from a location

Update Store Location

Sample Request

https://www.martjack.com/developerapi/Location/UpdateLocation/f48fdd16-92db-4188-854d-1ecd9b62xxxx/12146

Sample PATCH Request

[
   {
      "op":"replace",
      "path":"/IsParticipateInStock",
      "value":"true"
   },
   {
      "op":"replace",
      "path":"/ReasonCode",
      "value":"TR"
   },
   {
      "op":"replace",
      "path":"/isInStorePickup",
      "value":"true"
   },
   {
      "op":"replace",
      "path":"/LocationName",
      "value":"Chennai"
   },
   {
      "op":"replace",
      "path":"/Contact1",
      "value":"9008000000"
   },
   {
      "op":"replace",
      "path":"/Address1",
      "value":"Near Silky Board1"
   }
]

Sample Response

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

Updates location of a specific store

Resource Information
URI /Location/UpdateLocation/{MerchantId}/{LocationrefCode}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods PATCH
Batch Support No

Request URL

{host}/developerapi/Location/UpdateLocation/{MerchantId}/{LocationrefCode}

Header Modification Required

Pass content-type as application/json-patch+json

Request Body Parameters

Parameter Datatype Description
op* string Specify replace to update the existing information
path string Path of the key
value string New value of the current path

Update Store Timings

Sample Request

https://www.martjack.com/developerapi/Location/UpdateStoreTimings/f48fdd16-92db-4188-854d-1ecd9b62xxxx/OCDEL

Sample POST Request

InputFormat=application/json&MerchantId=f48fdd16-92db-4188-854d-1ecd9b62e234&ETAfor=ALL&InputData={  
   "LocationOpenandCloseTimings":{  
      "DelveryMode":"H",
      "OpenLeadTime":"1",
      "CloseLeadTime":"10",
      "WeekDayId":"0",
      "OnTime":"11:10:10",
      "OffTime":"22:11:11",
      "userId":"f48fdd16-92db-4188-854d-1ecd9b62d066"
   }
}

Sample Response

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

Updates the operation timings of a store location.

Resource Information
URI /Location/UpdateStoreTimings/{MerchantId}/{Locationrefcode}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support Yes

Request URL

{host}/developerapi/Location/UpdateStoreTimings/{MerchantId}/{Locationrefcode}

Request Path Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchant for which you want to update location timings
Locationrefcode* string The reference code of the location for which you want to update timings

Request Body Parameters

Parameter Type Description
DelveryMode enum Specify the mode of delivery for the location. S for store pick up and H for home delivery, L for store
OpenLeadTime int The maximum possible delay (in minutes) in the store open time (on-time)
CloseLeadTime int The maximum possible delay (in minutes) in the store close time (off-time)
WeekDayId int Specify for which day of the week the current timing is configured. Supported values: 0, 1, 2, 3, 4, 5, 6. Where 0 for Sunday and 6 for Saturday (Multiple values not supported)
OnTime time Store open time in HH:MM:SS format
OffTime time Store close time in HH:MM:SS format
userId string CP user id who is updating the store timing

Search Locations

Sample Request

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

Sample POST Request (RAW TEXT)

zipcode=500090&deliveryarea=hyderabad&deliveryareaid=16696&outputfield=additional,deliveryarea

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "Locations": [
    {
      "DistancefromInputLatLong": 0,
      "ParentLocationID": 0,
      "LocationId": 16696,
      "LocationCode": "OCDEL",
      "LocationName": "Holisol Delhi",
      "Address1": "Holisol Logistics Pvt. Ltd, Plot No. #434/2, Phirni Road (Budh Bazar Road), Mundka New Delhi - 110041\r\n",
      "Address2": "",
      "City": "19759",
      "CityName": null,
      "Area": "",
      "State": "DL",
      "StateName": null,
      "Country": "IN",
      "CountryName": null,
      "Pin": "110019",
      "Contact1": "91-9266604xxx",
      "Contact2": "",
      "Description": "Holisol Warehouse",
      "Latitude": 28.6826,
      "Longitude": 77.022,
      "LocationType": null,
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45eaxxxx",
      "IsDistributionCenter": true,
      "EmailId": "customercare@example.com",
      "IsParticipateInStock": true,
      "IsDefaultLocation": true,
      "IsOfflinneCheckoutEnabled": false,
      "IsPointOfSale": true,
      "IsOfflineDeals": false,
      "IsInStorePickup": true,
      "Remarks": null,
      "CST": "HOLDCST",
      "VAT": "HOLDVAT",
      "TINNo": "HOLDTIN",
      "GSTINNO": "HOLDGSTIN",
      "IsReversePickupEnabled": true,
      "IsDefaultLNG_LocationName": false,
      "IsDefaultLNG_Description": false,
      "IsDefaultLNG_Address1": false,
      "StoreTimings": null,
      "HomeDeliveryTimings": null,
      "TakeawayTimings": null
    },
    {
      "DistancefromInputLatLong": 0,
      "ParentLocationID": 0,
      "LocationId": 17430,
      "LocationCode": "OCBLR",
      "LocationName": "Holisol Bangalore",
      "Address1": "Holisol logistics Pvt Ltd - BIBA Apparels Pvt Ltd ,C/O Garuda Polyflex Foods Pvt. Ltd.No.11, Bommasandra Jigani Link Road, Anekal Taluk,Bangalore",
      "Address2": "",
      "City": "32",
      "CityName": null,
      "Area": "",
      "State": "KA",
      "StateName": null,
      "Country": "IN",
      "CountryName": null,
      "Pin": "560105",
      "Contact1": "011-39585715",
      "Contact2": "",
      "Description": "Holisol Warehouse Bangalore",
      "Latitude": 12.8032,
      "Longitude": 77.661,
      "LocationType": null,
      "MerchantId": "9820eca5-d11f-4df1-9b20-983a45eaxxxx",
      "IsDistributionCenter": true,
      "EmailId": "test@example.com",
      "IsParticipateInStock": true,
      "IsDefaultLocation": false,
      "IsOfflinneCheckoutEnabled": false,
      "IsPointOfSale": true,
      "IsOfflineDeals": false,
      "IsInStorePickup": true,
      "Remarks": null,
      "CST": "",
      "VAT": "",
      "TINNo": "",
      "GSTINNO": "",
      "IsReversePickupEnabled": false,
      "IsDefaultLNG_LocationName": false,
      "IsDefaultLNG_Description": false,
      "IsDefaultLNG_Address1": false,
      "StoreTimings": null,
      "HomeDeliveryTimings": null,
      "TakeawayTimings": null
    }
  ],
  "ErrorCode": 0
}

Retrieves locations of a specific delivery area.

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

Request URL

{host}/developerapi/Location/{MerchantId}/Search

Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant

Request Body Parameters

Parameter Type Description
zipcode* string Area PIN code that you want to fetch. Example value: 110019
deliveryarea* string Name of the delivery area. Example: Karnataka
deliveryareaId* int Unique id of the delivery area. Example: 234
outputfield enum Pass additional to include additional details in the response, deliveryarea to include delivery areas in the response

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
DistancefromInputLatLong float Distance of the location from the latitude and longitude. Available only if latitude and longitude are set for the location
IsParticipateInStock boolean Whether the location is participating in stock. The location appears on the storefront only if this is set to true
IsOfflinneCheckoutEnabled boolean Whether offline ordering is available for the location
IsOfflineDeals boolean Whether promotions are applied offline for the location

Search Delivery Areas

Fetches delivery areas of a specific city.

Sample Request

https://www.martjack.com/developerapi/Location/7c778337-4652-4944-934f-09e0fe5606d3/SearchDeliveryAreas

Sample POST Request (RAW)

cityid=36618

Sample Response

{
   "messageCode":"1004",
   "Message":"Successful",
   "DeliveryAreas":[
      {
         "DeliveryAreaID":431864,
         "DeliveryAreaName":"UYGARKENT",
         "AreaType":"CT",
         "MerchantID":"7c778337-4652-4944-934f-09e0fe5606d3",
         "IsArchive":false,
         "DeliveryRefCode":"UYGARKENT",
         "AreaTypeIDs":"36618,"
      },
      {
         "DeliveryAreaID":431866,
         "DeliveryAreaName":"TRİO PARK ÇORLU",
         "AreaType":"CT",
         "MerchantID":"7c778337-4652-4944-934f-09e0fe5606d3",
         "IsArchive":false,
         "DeliveryRefCode":"TRİO PARK ÇORLU",
         "AreaTypeIDs":"36618,"
      },
      {
         "DeliveryAreaID":431868,
         "DeliveryAreaName":"TİCARET VE SANAYİ ODASI İ.Ö.O",
         "AreaType":"CT",
         "MerchantID":"7c778337-4652-4944-934f-09e0fe5606d3",
         "IsArchive":false,
         "DeliveryRefCode":"TİCARET VE SANAYİ ODASI İ.Ö.O",
         "AreaTypeIDs":"36618,"
      }
   ],
   "ErrorCode":0
}

Resource Information
URI /Location/{merchantid}/SearchDeliveryAreas
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Location/{merchantid}/SearchDeliveryAreas

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
cityid* int Unique city id for which you want to fetch delivery locations

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
DeliveryAreaID int Unique id of the delivery area
DeliveryAreaName string Name of the respective delivery area
AreaType enum cn for delivery type country, ct for city, and st for state
IsArchive boolean Whether the delivery area is active or archived
AreaTypeIDs string

Get Location Information

Sample Request

https://www.martjack.com/developerapi/Location/Information/f48fdd16-92db-4188-854d-1ecd9b62xxxx/18340

Sample Response

{  
   "messageCode":"1004",
   "Message":"Successful",
   "Location":{  
      "DistancefromInputLatLong":0,
      "ParentLocationID":0,
      "LocationId":18340,
      "LocationCode":"1001",
      "LocationName":"Example Mumbai Store",
      "Address1":"Capillary Retail India Ltd.Malad Link Road, Malad West, Mumbai",
      "Address2":"",
      "City":"321",
      "CityName":"Mumbai",
      "Area":"",
      "State":"MH",
      "StateName":"Maharashtra",
      "Country":"IN",
      "CountryName":"India",
      "Pin":"400064",
      "Contact1":"91-9090900000",
      "Contact2":"",
      "Description":"",
      "Latitude":0,
      "Longitude":0,
      "LocationType":null,
      "MerchantId":"f48fdd16-92db-4188-854d-1ecd9b62xxxx",
      "IsDistributionCenter":true,
      "EmailId":"care@example.com",
      "IsParticipateInStock":false,
      "IsDefaultLocation":true,
      "IsOfflinneCheckoutEnabled":true,
      "IsPointOfSale":true,
      "IsOfflineDeals":true,
      "IsInStorePickup":true,
      "Remarks":null,
      "CST":"",
      "VAT":"",
      "TINNo":"",
      "GSTINNO":"GST_HYC_1001",
      "IsReversePickupEnabled":true,
      "IsDefaultLNG_LocationName":false,
      "IsDefaultLNG_Description":false,
      "IsDefaultLNG_Address1":false,
      "AdditionalDetails":[  
         {  
            "Key":"LocationId",
            "Value":"18340"
         },
         {  
            "Key":"IsDispatchEnable",
            "Value":"False"
         },
         {  
            "Key":"StoreAuthKey",
            "Value":""
         },
         {  
            "Key":"LastSeen",
            "Value":"1/1/2000 12:00:00 PM"
         },
         {  
            "Key":"StoreOnTime",
            "Value":"00:00:00"
         },
         {  
            "Key":"StoreOffTime",
            "Value":"00:00:00"
         },
         {  
            "Key":"Lastlogout",
            "Value":"1/1/2000 12:00:00 PM"
         },
         {  
            "Key":"VendorId",
            "Value":"00000000-0000-0000-0000-000000000000"
         },
         {  
            "Key":"lastloginafterStoreOn",
            "Value":"1/1/2000 12:00:00 PM"
         },
         {  
            "Key":"isEnablePromotion",
            "Value":"False"
         },
         {  
            "Key":"isEnablePrivatelabel",
            "Value":"False"
         },
         {  
            "Key":"MaxPromotionPerDay",
            "Value":"0"
         },
         {  
            "Key":"isDineIn",
            "Value":"False"
         },
         {  
            "Key":"LocationPrefix",
            "Value":""
         },
         {  
            "Key":"EnableReversePickup",
            "Value":"False"
         },
         {  
            "Key":"AdvanceTaxPrefix",
            "Value":""
         },
         {  
            "Key":"isKDS",
            "Value":"False"
         },
         {  
            "Key":"isDriverTracking",
            "Value":"False"
         },
         {  
            "Key":"isStoreManagerApp",
            "Value":"False"
         },
         {  
            "Key":"JDECode",
            "Value":""
         },
         {  
            "Key":"ChamsId",
            "Value":""
         },
         {  
            "Key":"TechnologyCode",
            "Value":""
         },
         {  
            "Key":"HomeDeliveryETA",
            "Value":"{\"StartTime\":\"30\",\"EndTime\":\"0\",\"ETAType\":0,\"ETAUnits\":\"Min\"}"
         },
         {  
            "Key":"TakeAwayETA",
            "Value":"{\"StartTime\":\"20\",\"EndTime\":\"0\",\"ETAType\":0,\"ETAUnits\":\"Min\"}"
         },
         {  
            "Key":"PickupPointsETA",
            "Value":"{\"StartTime\":\"10\",\"EndTime\":\"0\",\"ETAType\":0,\"ETAUnits\":\"Min\"}"
         }
      ],
      "DeliveryModes":[  
         {  
            "Mode":"Home Delivery",
            "State":"False",
            "ReasonCode":"OR"
         },
         {  
            "Mode":"Takeaway",
            "State":"True",
            "ReasonCode":""
         },
         {  
            "Mode":"Pickup Timings",
            "State":"False",
            "ReasonCode":""
         }
      ],
      "StoreTimings":[  
         {  
            "CloseLeadTime":10,
            "Deliverymode":"L",
            "ID":5224,
            "Locationid":18340,
            "OffTime":"03:00:00",
            "OnTime":"00:00:00",
            "OpenLeadTime":10,
            "WeekDayId":0
         },
         {  
            "CloseLeadTime":10,
            "Deliverymode":"L",
            "ID":9442,
            "Locationid":18340,
            "OffTime":"03:00:00",
            "OnTime":"00:00:00",
            "OpenLeadTime":10,
            "WeekDayId":1
         },
         {  
            "CloseLeadTime":10,
            "Deliverymode":"L",
            "ID":9444,
            "Locationid":18340,
            "OffTime":"03:00:00",
            "OnTime":"00:00:00",
            "OpenLeadTime":10,
            "WeekDayId":2
         },
         {  
            "CloseLeadTime":10,
            "Deliverymode":"L",
            "ID":9538,
            "Locationid":18340,
            "OffTime":"03:00:00",
            "OnTime":"00:00:00",
            "OpenLeadTime":10,
            "WeekDayId":3
         },
         {  
            "CloseLeadTime":10,
            "Deliverymode":"L",
            "ID":9540,
            "Locationid":18340,
            "OffTime":"03:00:00",
            "OnTime":"00:00:00",
            "OpenLeadTime":10,
            "WeekDayId":4
         },
         {  
            "CloseLeadTime":10,
            "Deliverymode":"L",
            "ID":9542,
            "Locationid":18340,
            "OffTime":"03:00:00",
            "OnTime":"00:00:00",
            "OpenLeadTime":10,
            "WeekDayId":5
         },
         {  
            "CloseLeadTime":10,
            "Deliverymode":"L",
            "ID":5236,
            "Locationid":18340,
            "OffTime":"03:00:00",
            "OnTime":"00:00:00",
            "OpenLeadTime":10,
            "WeekDayId":6
         }
      ],
      "HomeDeliveryTimings":[  
         {  
            "CloseLeadTime":55,
            "Deliverymode":"H",
            "ID":5196,
            "Locationid":0,
            "OffTime":"23:59:00",
            "OnTime":"05:00:00",
            "OpenLeadTime":55,
            "WeekDayId":0
         },
         {  
            "CloseLeadTime":55,
            "Deliverymode":"H",
            "ID":9446,
            "Locationid":0,
            "OffTime":"23:59:00",
            "OnTime":"05:00:00",
            "OpenLeadTime":55,
            "WeekDayId":1
         },
         {  
            "CloseLeadTime":55,
            "Deliverymode":"H",
            "ID":9558,
            "Locationid":0,
            "OffTime":"23:59:00",
            "OnTime":"05:00:00",
            "OpenLeadTime":55,
            "WeekDayId":2
         },
         {  
            "CloseLeadTime":55,
            "Deliverymode":"H",
            "ID":9560,
            "Locationid":0,
            "OffTime":"23:59:00",
            "OnTime":"05:00:00",
            "OpenLeadTime":55,
            "WeekDayId":3
         },
         {  
            "CloseLeadTime":55,
            "Deliverymode":"H",
            "ID":9562,
            "Locationid":0,
            "OffTime":"23:59:00",
            "OnTime":"05:00:00",
            "OpenLeadTime":55,
            "WeekDayId":4
         },
         {  
            "CloseLeadTime":55,
            "Deliverymode":"H",
            "ID":5206,
            "Locationid":0,
            "OffTime":"23:59:00",
            "OnTime":"05:00:00",
            "OpenLeadTime":55,
            "WeekDayId":5
         },
         {  
            "CloseLeadTime":55,
            "Deliverymode":"H",
            "ID":5208,
            "Locationid":0,
            "OffTime":"23:59:00",
            "OnTime":"05:00:00",
            "OpenLeadTime":55,
            "WeekDayId":6
         }
      ],
      "TakeawayTimings":[  
         {  
            "CloseLeadTime":1,
            "Deliverymode":"S",
            "ID":5210,
            "Locationid":0,
            "OffTime":"23:59:00",
            "OnTime":"00:00:00",
            "OpenLeadTime":1,
            "WeekDayId":0
         },
         {  
            "CloseLeadTime":1,
            "Deliverymode":"S",
            "ID":9448,
            "Locationid":0,
            "OffTime":"23:59:00",
            "OnTime":"00:00:00",
            "OpenLeadTime":1,
            "WeekDayId":1
         },
         {  
            "CloseLeadTime":1,
            "Deliverymode":"S",
            "ID":9592,
            "Locationid":0,
            "OffTime":"23:59:00",
            "OnTime":"00:00:00",
            "OpenLeadTime":1,
            "WeekDayId":2
         },
         {  
            "CloseLeadTime":1,
            "Deliverymode":"S",
            "ID":9594,
            "Locationid":0,
            "OffTime":"23:59:00",
            "OnTime":"00:00:00",
            "OpenLeadTime":1,
            "WeekDayId":3
         },
         {  
            "CloseLeadTime":1,
            "Deliverymode":"S",
            "ID":9596,
            "Locationid":0,
            "OffTime":"23:59:00",
            "OnTime":"00:00:00",
            "OpenLeadTime":1,
            "WeekDayId":4
         },
         {  
            "CloseLeadTime":1,
            "Deliverymode":"S",
            "ID":5220,
            "Locationid":0,
            "OffTime":"23:59:00",
            "OnTime":"00:00:00",
            "OpenLeadTime":1,
            "WeekDayId":5
         },
         {  
            "CloseLeadTime":1,
            "Deliverymode":"S",
            "ID":5222,
            "Locationid":0,
            "OffTime":"23:59:00",
            "OnTime":"00:00:00",
            "OpenLeadTime":1,
            "WeekDayId":6
         }
      ]
   },
   "ErrorCode":0
}

Retrieves the details of a specific store location such as parent location, address, contact details, recent activities, supported delivery modes, and business hours.

Resource Information
URI /Location/Information/{MerchantId}/{{LocationId}}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Location/Information/{MerchantId}/{{LocationId}}

Request Parameters

Parameter Type Description
MerchantId* string The unique id (GUID) of the merchant for which you want to fetch location details
LocationId* int Location id for which you want to see the 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
DistancefromInputLatLong float Distance of the location from latitude and longitude. Available only if latitude and longitude are set for the location
IsParticipateInStock boolean Whether the location is participating in stock. The location appears on the storefront only if this is set to true
IsOfflinneCheckoutEnabled boolean Whether offline ordering is available for the location. For example, orders placed through phone calls are offline orders.
IsDefaultLNG_LocationName boolean Whether the language is the default language of the current location or not
IsReversePickupEnabled boolean Whether reverse pickup is applicable for the product in case of returns

Get Delivery Cities

Sample Request

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

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "DeliveryCities": [
    {
      "DeliveryAreaID": 2654,
      "DeliveryCityID": 32,
      "DeliveryCityName": "Bangalore"
    },
    {
      "DeliveryAreaID": 2824,
      "DeliveryCityID": 195,
      "DeliveryCityName": "Hyderabad"
    },
    {
      "DeliveryAreaID": 3226,
      "DeliveryCityID": 241,
      "DeliveryCityName": "Karimnagar"
    },
    {
      "DeliveryAreaID": 3004,
      "DeliveryCityID": 250,
      "DeliveryCityName": "Khammam"
    },
    {
      "DeliveryAreaID": 2824,
      "DeliveryCityID": 263,
      "DeliveryCityName": "Kothagudem"
    }
  ],
  "ErrorCode": 0
}

Retrieves all the delivery cities configured for the merchant including the details such as city id, city name, and delivery area id.

Resource Information
URI /Location/{MerchantId}/GetCities
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Location/{MerchantId}/GetCities

Request Path Parameters

Parameter Type Description
MerchantId* string The unique id (GUID) of the merchant for which you want to fetch location details

Add Delivery Area

Adds delivery areas to a city, state or country.

Sample Request

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

Sample POST Request (RAW)

MerchantId=f48fdd16-92db-4188-854d-1ecd9b62d066&pincodes=500090&deliveryAreaName=hyderabad&areaType=cn&isArchive=false&deliveryRefCode=hyd&areaTypeIDs=36618

Sample Response


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

Resource Information
URI /Location/AddDeliveryArea/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Location/AddDeliveryArea/{merchantId}

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
pincodes string PIN codes that you want to associate to the delivery area. Specify each PIN code separating with comma
deliveryAreaName string Name of the delivery area without space
areaType enum Type of delivery area. Value: cn for country, ct for city, st for state
areaTypeIDs string
isArchive boolean Specify false to make the delivery area active
deliveryAreaID int Unique id of the delivery area

Get Delivery Areas

Sample Request

https://www.martjack.com/developerapi/Location/DeliveryAreas/9820eca5-d11f-4df1-9b20-983a45eaxxxx/12343

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "DeliveryAreas": [
    {
      "DeliveryAreaID": 3746,
      "DeliveryAreaName": "Holisol_Delhi",
      "AreaType": "ST",
      "MerchantID": "9820eca5-d11f-4df1-9b20-983a45eaxxxx",
      "IsArchive": false,
      "DeliveryRefCode": "Holisol_Del",
      "AreaTypeIDs": null
    },
    {
      "DeliveryAreaID": 2498,
      "DeliveryAreaName": "jammu and kashmir",
      "AreaType": "ST",
      "MerchantID": "9820eca5-d11f-4df1-9b20-983a45eaxxxx",
      "IsArchive": false,
      "DeliveryRefCode": "J & K",
      "AreaTypeIDs": null
    },
    {
      "DeliveryAreaID": 2500,
      "DeliveryAreaName": "Haryana",
      "AreaType": "ST",
      "MerchantID": "9820eca5-d11f-4df1-9b20-983a45eaxxxx",
      "IsArchive": false,
      "DeliveryRefCode": "haryana",
      "AreaTypeIDs": null
    },

    {
      "DeliveryAreaID": 2516,
      "DeliveryAreaName": "Uttar pradesh",
      "AreaType": "ST",
      "MerchantID": "9820eca5-d11f-4df1-9b20-983a45eaxxxx",
      "IsArchive": false,
      "DeliveryRefCode": "UP",
      "AreaTypeIDs": null
    },
    {
      "DeliveryAreaID": 2520,
      "DeliveryAreaName": "uttarakhand",
      "AreaType": "ST",
      "MerchantID": "9820eca5-d11f-4df1-9b20-983a45eaxxxx",
      "IsArchive": false,
      "DeliveryRefCode": "uttarakhand",
      "AreaTypeIDs": null
    },
    {
      "DeliveryAreaID": 2524,
      "DeliveryAreaName": "himachal pradesh",
      "AreaType": "ST",
      "MerchantID": "9820eca5-d11f-4df1-9b20-983a45eaxxxx",
      "IsArchive": false,
      "DeliveryRefCode": "HP",
      "AreaTypeIDs": null
    },

    {
      "Pincodes": [
        "500032",
        "500055"
      ],
      "DeliveryAreaID": 2502,
      "DeliveryAreaName": "Telangana",
      "AreaType": "ST",
      "MerchantID": "9820eca5-d11f-4df1-9b20-983a45eaxxxx",
      "IsArchive": false,
      "DeliveryRefCode": "TS",
      "AreaTypeIDs": null
    },
    {
      "Pincodes": [
        "560029",
        "560076"
      ],
      "DeliveryAreaID": 2506,
      "DeliveryAreaName": "Karnataka",
      "AreaType": "ST",
      "MerchantID": "9820eca5-d11f-4df1-9b20-983a45eaxxxx",
      "IsArchive": false,
      "DeliveryRefCode": "KA",
      "AreaTypeIDs": null
    }
  ],
  "ErrorCode": 0
}

Retrieves delivery areas of a specific location.

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

Request URL

{host}/developerapi/Location/DeliveryAreas/{merchantId}/{locationId}

Request Path Parameters

Parameter Type Description
MerchantId* string The unique id (GUID) of the merchant for which you want to fetch location details
locationId* int Unique id of the location for which you want to get delivery areas

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
DistancefromInputLatLong float Distance of the location from latitude and longitude. Available only if latitude and longitude are set for the location
IsParticipateInStock boolean Whether the location is participating in stock. The location appears on the storefront only if this is set to true
AdditionalDetails json obj Details of custom fields configured for the location

Get Location Information

Sample Request

https://www.martjack.com/developerapi/Location/Information/9820eca5-d11f-4df1-9b20-983a45eaxxxx/16696

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "Location": {
    "DistancefromInputLatLong": 0,
    "ParentLocationID": 0,
    "LocationId": 16696,
    "LocationCode": "OCDEL",
    "LocationName": "Holisol Delhi",
    "Address1": "Holisol Logistics Pvt. Ltd, Plot No. #434/2, Phirni Road (Budh Bazar Road), Mundka New Delhi - 110041\r\n",
    "Address2": "",
    "City": "19759",
    "CityName": "New Delhi",
    "Area": "",
    "State": "DL",
    "StateName": "Delhi",
    "Country": "IN",
    "CountryName": "India",
    "Pin": "110019",
    "Contact1": "91-9266604xxx",
    "Contact2": "",
    "Description": "Holisol Warehouse",
    "Latitude": 28.6826,
    "Longitude": 77.022,
    "LocationType": null,
    "MerchantId": "9820eca5-d11f-4df1-9b20-983a45eaxxxx",
    "IsDistributionCenter": true,
    "EmailId": "customercare@example.com",
    "IsParticipateInStock": true,
    "IsDefaultLocation": true,
    "IsOfflinneCheckoutEnabled": false,
    "IsPointOfSale": true,
    "IsOfflineDeals": false,
    "IsInStorePickup": true,
    "Remarks": null,
    "CST": "HOLDCST",
    "VAT": "HOLVAT",
    "TINNo": "HOLTIN",
    "GSTINNO": "HOLGSTIN",
    "IsReversePickupEnabled": true,
    "IsDefaultLNG_LocationName": false,
    "IsDefaultLNG_Description": false,
    "IsDefaultLNG_Address1": false,
    "AdditionalDetails": [
      {
        "Key": "LocationId",
        "Value": "16696"
      },
      {
        "Key": "IsDispatchEnable",
        "Value": "False"
      },
      {
        "Key": "StoreAuthKey",
        "Value": ""
      },
      {
        "Key": "LastSeen",
        "Value": "1/1/2000 12:00:00 PM"
      },
      {
        "Key": "StoreOnTime",
        "Value": "00:00:00"
      },
      {
        "Key": "StoreOffTime",
        "Value": "00:00:00"
      },
      {
        "Key": "Lastlogout",
        "Value": "1/1/2000 12:00:00 PM"
      },
      {
        "Key": "VendorId",
        "Value": "00000000-0000-0000-0000-000000000000"
      },
      {
        "Key": "lastloginafterStoreOn",
        "Value": "1/1/2000 12:00:00 PM"
      },
      {
        "Key": "isEnablePromotion",
        "Value": "False"
      },
      {
        "Key": "isEnablePrivatelabel",
        "Value": "False"
      },
      {
        "Key": "MaxPromotionPerDay",
        "Value": "0"
      },
      {
        "Key": "isDineIn",
        "Value": "False"
      },
      {
        "Key": "LocationPrefix",
        "Value": "HD"
      },
      {
        "Key": "EnableReversePickup",
        "Value": "False"
      },
      {
        "Key": "AdvanceTaxPrefix",
        "Value": "HOLDATV"
      },
      {
        "Key": "isKDS",
        "Value": "False"
      },
      {
        "Key": "isDriverTracking",
        "Value": "False"
      },
      {
        "Key": "isStoreManagerApp",
        "Value": "False"
      },
      {
        "Key": "JDECode",
        "Value": ""
      },
      {
        "Key": "ChamsId",
        "Value": ""
      },
      {
        "Key": "TechnologyCode",
        "Value": ""
      },
      {
        "Key": "HomeDeliveryETA",
        "Value": "{\"StartTime\":\"01\",\"EndTime\":\"0\",\"ETAType\":0,\"ETAUnits\":\"HOURS\"}"
      },
      {
        "Key": "TakeAwayETA",
        "Value": "{\"StartTime\":\"0\",\"EndTime\":\"0\",\"ETAType\":0,\"ETAUnits\":\"MIN\"}"
      },
      {
        "Key": "PickupPointsETA",
        "Value": "{\"StartTime\":\"0\",\"EndTime\":\"0\",\"ETAType\":0,\"ETAUnits\":\"MIN\"}"
      }
    ],
    "DeliveryModes": [
      {
        "Mode": "Home Delivery Timings",
        "State": "False",
        "ReasonCode": ""
      }
    ],
    "StoreTimings": [
      {
        "CloseLeadTime": 0,
        "Deliverymode": "L",
        "ID": 9388,
        "Locationid": 16696,
        "OffTime": "23:00:00",
        "OnTime": "00:00:00",
        "OpenLeadTime": 0,
        "WeekDayId": 0
      },
      {
        "CloseLeadTime": 0,
        "Deliverymode": "L",
        "ID": 9390,
        "Locationid": 16696,
        "OffTime": "23:00:00",
        "OnTime": "00:00:00",
        "OpenLeadTime": 0,
        "WeekDayId": 1
      },
      {
        "CloseLeadTime": 0,
        "Deliverymode": "L",
        "ID": 9392,
        "Locationid": 16696,
        "OffTime": "23:00:00",
        "OnTime": "00:00:00",
        "OpenLeadTime": 0,
        "WeekDayId": 2
      },
      {
        "CloseLeadTime": 0,
        "Deliverymode": "L",
        "ID": 9394,
        "Locationid": 16696,
        "OffTime": "23:00:00",
        "OnTime": "00:00:00",
        "OpenLeadTime": 0,
        "WeekDayId": 3
      },
      {
        "CloseLeadTime": 0,
        "Deliverymode": "L",
        "ID": 9396,
        "Locationid": 16696,
        "OffTime": "23:00:00",
        "OnTime": "00:00:00",
        "OpenLeadTime": 0,
        "WeekDayId": 4
      },
      {
        "CloseLeadTime": 0,
        "Deliverymode": "L",
        "ID": 9398,
        "Locationid": 16696,
        "OffTime": "23:00:00",
        "OnTime": "00:00:00",
        "OpenLeadTime": 0,
        "WeekDayId": 5
      },
      {
        "CloseLeadTime": 0,
        "Deliverymode": "L",
        "ID": 9400,
        "Locationid": 16696,
        "OffTime": "23:00:00",
        "OnTime": "00:00:00",
        "OpenLeadTime": 0,
        "WeekDayId": 6
      }
    ],
    "HomeDeliveryTimings": [
      {
        "CloseLeadTime": 10,
        "Deliverymode": "H",
        "ID": 20588,
        "Locationid": 0,
        "OffTime": "17:00:00",
        "OnTime": "12:00:00",
        "OpenLeadTime": 1,
        "WeekDayId": 1
      }
    ],
    "TakeawayTimings": []
  },
  "ErrorCode": 0
}

Retrieves the details of a specific location.

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

Request URL

{host}/developerapi/Location/Information/{merchantId}/{locationId}

Request Path Parameters

Parameter Type Description
MerchantId* string The unique id (GUID) of the merchant
locationId* int Unique id of the location 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
DistancefromInputLatLong float Distance of the location from latitude and longitude. Available only if latitude and longitude are set for the location
AdditionalDetails json obj Details of custom fields configured for the location
IsParticipateInStock boolean Whether the location is participating in stock. The location appears on the storefront only if this is set to true
IsOfflinneCheckoutEnabled boolean Whether offline ordering is available for the location
IsDefaultLNG_LocationName boolean Whether the language is default language of the location or not

Get Reason Codes

Sample Request

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

Sample Response

{
  "messageCode": "1004",
  "Message": "Successful",
  "ReasonCodes": [
    {
      "Description": "Operational Reasons",
      "ReasonCode": "OR"
    },
    {
      "Description": "Technical Reasons",
      "ReasonCode": "TR"
    }
  ],
  "ErrorCode": 0
}

Retrieves configured reason codes for updating delivery modes of a store - open for available and close for unavailable. For example, you need to pass the specific reason code while updating the availability of a delivery mode of a store such as home delivery, or in-store pickup.

Resource Information
URI /Location/ReasonCodes/{merchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Location/ReasonCodes/{merchantId}

Request Parameters

Parameter Type Description
MerchantId* string The unique id (GUID) of the merchant

Update Order ETA

Sample Request

https://www.martjack.com/developerapi/Location/UpdateLocationETA/f48fdd16-92db-4188-854d-1ecd9b62e234/ALL

Sample POST Request

InputFormat=application/json&MerchantId=f48fdd16-92db-4188-854d-1ecd9b62e234&ETAfor=ALL&InputData={  
   "LocationCode":"110",
   "HomeDeliveryETA":{  
      "StartTime":"10",
      "EndTime":"20",
      "ETAType":0,
      "ETAUnits":"Min"
   },
   "TakeAwayETA":{  
      "StartTime":"10",
      "EndTime":"50",
      "ETAType":0,
      "ETAUnits":"Min"
   },
   "PickupPointsETA":{  
      "StartTime":"10",
      "EndTime":"30",
      "ETAType":0,
      "ETAUnits":"Min"
   }
}

Sample Response

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

Lets you add or update order ETA (Estimated Time of Arrival) for a location including the type of delivery location with location code.

Resource Information
URI /Location/UpdateLocationETA/{merchantId}/{OrderDeliveryType}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Location/UpdateLocationETA/{merchantId}/{OrderDeliveryType}

Request Query Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
OrderDeliveryType enum Type of order delivery. Supported values: H for Home Delivery, T for Takeaway, P for store pickup, and ALL if all types are supported

Request Body Parameters

Parameter Type Description
LocationCode* string Location code for which you want to update order ETA
HomeDeliveryETA* obj Updates ETA for home delivery orders
TakeAwayETA obj Updated ETA for take away orders
PickupPointsETA obj Updates ETA for store pick up orders
StartTime* string Estimated minimum delivery time as per the selected ETA units
EndTime* string Estimated maximum delivery time as per the selected ETA units
ETAType* enum Specify 0 for a fixed ETA. For example 2 days from the ordered date.
Specify 1 for ETA within a specified period from the ordered date. For example, 5-7 days
ETAUnits* enum Preferred unit for time - minutes, hours, or days. Value: Min, Hours, Days

Get Location ETA

Sample Request

https://www.martjack.com/developerapi/Location/Information/f48fdd16-92db-4188-854d-1ecd9b62e234/110/ALL

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "ErrorCode": 0,
    "LocationETA": {
        "HomeDeliveryETA": {
            "ETAType": 1,
            "ETAUnits": "MIN",
            "EndTime": "20",
            "StartTime": "10"
        },
        "LocationCode": "BTM",
        "PickupPointsEta": {
            "ETAType": 1,
            "ETAUnits": "MIN",
            "EndTime": "30",
            "StartTime": "15"
        },
        "TakeAwayETA": {
            "ETAType": 0,
            "ETAUnits": "MIN",
            "EndTime": "0",
            "StartTime": "45"
        }
    }
}

Retrieves Estimated Time of Arrival (ETA) of an order for a specific location and the type of location delivery with location code.

Resource Information
URI /Location/Information/{merchantId}/{LocationCode}/{OrderDeliveryType}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Location/Information/{merchantId}/{LocationCode}/{OrderDeliveryType}

Request Query Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
LocationCode* string Location code for which you want to fetch order ETA details
OrderDeliveryType* string Specific order type for which you want to fetch ETA. Values H for HomeDelivery, T for TakeAway, P for Pickup, ALL for all types

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
ETAType enum Specifies whether a fixed ETA or not. 0 for a fixed ETA and 1 for ETA between StartTime and EndTime
ETAUnits enum The unit of measurement of time for the ETA for StartTime and EndTime. It could be Min (for minutes), Hours, or Days

Get Delivery Area PINCodes & Area Details

Retrieves the details of delivery areas along with PINCodes based on the input parameters.

Sample Request

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

Sample POST Request (RAW)


MerchantId=f48fdd16-92db-4188-854d-1ecd9b62d066&countryid=IN&stateid=HR&cityid=58&pincodes=500090&deliveryareaid=1231

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "DeliveryAreas": [
        {
            "Pincodes": [
                "400062",
                "400064",
                "400068",
                "400072",
                "400092"
            ],
            "DeliveryAreaID": 3088,
            "DeliveryAreaName": "Mumbai",
            "AreaType": "State",
            "MerchantID": "f48fdd16-92db-4188-854d-1ecd9b62d066",
            "IsArchive": false,
            "DeliveryRefCode": "mumbai",
            "AreaTypeIDs": null
        }
]
}

Resource Information
URI /Location/{MerchantId}/SearchDeliveryPincodes
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods POST
Batch Support No

Request URL

{host}/developerapi/Location/{MerchantId}/SearchDeliveryPincodes

Request Body Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
countryid string Alpha-2 code of the country for which you want to fetch delivery areas. Example: IN (for India), AU (for Australia), and BR (for Brazil)
stateid string Fetch delivery areas by State code. For example, KA for Karnataka, AR for Arunachal Pradesh, TS for Telangana
cityid int Fetch delivery areas by city id. Pass the unique id of the city
pincodes string Fetch delivery areas by area pincodes
deliveryareaid string Specify the delivery area id to fetch the details of that specific delivery area

Get Location Log

Retrieves logs of the merchant for a specific location.

Sample Request

https://www.martjack.com/developerapi/Location/Log/f48fdd16-92db-4188-854d-1ecd9b62d066/1001/02-02-2018/01-01-2019

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "StoreLog": [
        {
            "locationname": "Sample Mumbai store1",
            "locationcode": "1001",
            "logtype": "StoreTime",
            "logdetails": "Home Delivery Timings",
            "logdetailsvalue": "",
            "logdatetime": "11/20/2018 6:29:14 PM",
            "user": "hypertown@cj_test.com",
            "reasoncode": "",
            "weekdayid": "0",
            "weekdayname": "Sunday",
            "starttime": "17:00:00",
            "endtime": "02:30:00",
            "startleadtime": "30",
            "endleadtime": "30"
        },
        {
            "locationname": "Sample Mumbai store1",
            "locationcode": "1001",
            "logtype": "StoreTime",
            "logdetails": "Home Delivery Timings",
            "logdetailsvalue": "",
            "logdatetime": "11/20/2018 5:57:45 PM",
            "user": "hypertown@cj_test.com",
            "reasoncode": "",
            "weekdayid": "0",
            "weekdayname": "Sunday",
            "starttime": "17:00:00",
            "endtime": "02:30:00",
            "startleadtime": "30",
            "endleadtime": "30"
        }
]
}

Resource Information
URI /Location/Log/{merchantId}/{locationCode}/{fromDate}/{toDate}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Location/Log/{merchantId}/{locationCode}/{fromDate}/{toDate}

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
locationCode* string Location code for which you want to see the logistics
fromDate* date Specify the duration for which you want to see the log in fromDate and toDate. Specify the date in MM-DD-YYYY format
toDate* date Specify the duration for which you want to see the log in fromDate and toDate. Specify the date in MM-DD-YYYY format

Merchant

Merchant is an entry associated with the Capillary that runs their business on the Capillary Anywhere Commerce Platform. This resource lets Capillary Admin users manage merchant accounts in different countries as per needed.

Merchant users can use the resource to access their Blob server and merchant details.

Get Signed URL

https://www.martjack.com/developerapi/Merchant/GetSignedUrl/{MerchantId}

Sample Response

{
   "Code": "1004",
   "Message": "Successful",
   "ErrorCode": "0",
   "Url": "http://martjackstorage.blob.care.windows.net/test-resources/f48fdd16-92db-4188-854d-1ecd9b62xxxx/temp/Upload/Data?sv=2012-02-12&sr=c&si=mypolicy&sig=pT4Fy6iQ0vuX%2BDUGoBSHt4imVcWO2Cq51Ob88n%2FaM4A%3D",
   "AllocatedItems": "false"
}

Provides authentication to the Merchant to access the Blob server.

Resource Information
URI Merchant/GetSignedUrl/{MerchantId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Merchant/GetSignedUrl/{MerchantId}

Category

Category is a group used to organize products. Products are categorized in a tree structure based on any parameters such as product types.

Get Category Information

Retrieves the details of a specific category.

Sample Request

https://www.martjack.com/developerapi/Category/Information/98d18d82-ba59-4957-9c92-3f89207a34f6/CU00216534

Sample Response


{
    "messageCode": "1004",
    "Message": "Successful",
    "Category": {
        "CategoryId": "CU00216534",
        "CategoryName": "Desserts",
        "ParentCategoryId": "CU00216530",
        "Lineage": "/CU00216530/CU00216534/",
        "Depth": 1,
        "IsLeaf": true,
        "ReferenceCode": "CU00216534",
        "ProductCount": 2
    },
    "ErrorCode": 0
}

Resource Information
URI /Category/Information/{MerchantId}/{CategoryId}
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Category/Information/{MerchantId}/{CategoryId}

Request Body Parameters

Parameter Type Description
MerchantId* string Unique GUID of the merchant
CategoryId* string Unique id of the category to fetch details

Get Variant Properties

Retrieves all the variant properties associated to a specific category.

Sample Request

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

Sample Response

{
    "messageCode": "1004",
    "Message": "Successful",
    "ErrorCode": 0,
    "VariantProperties": [
        {
            "VariantId": 13068,
            "VariantPropertyName": "Weight",
            "MulticolumnDisplay": null,
            "Rank": 1,
            "DataType": "String",
            "NoOfColumn": 1,
            "PropertyCode": "",
            "isDisplaySwatch": false,
            "VariantImageType": 0,
            "Description": "",
            "VariantPropertyValues": [
                {
                    "VariantPropertyValueId": 326232,
                    "VariantPropertyId": 13068,
                    "VariantValue": "1000gm",
                    "Rank": 50087,
                    "ImageName": "",
                    "Description": ""
                }
            ]
        }
    ]
}

Resource Information
URI /Category/{MerchantId}/{cateogryId}/variantproperties
Rate Limited? No
Authentication Yes
Response Formats JSON
HTTP Methods GET
Batch Support No

Request URL

{host}/developerapi/Category/{MerchantId}/{cateogryId}/variantproperties

Request Path Parameters

Parameter Type Description
merchantId* string Unique GUID of the merchant
cateogryId* string Unique category id for which you want to fetch variant properties

Response Codes

The following are different success and error codes pertaining to the Anywhere Commerce APIs:

Code Meaning
429 Rate limit exceeded
440 Session expired
500 Server error
1000 Unhandled exception. Please contact support desk
1001 Order canceled already
1002 Order canceled successfully
1003 Authentication failed. This could be due either due to invalid token, social login authentication failed, or API authentication failed
1004 Successful
1005 Order authorized
1006 Order ID is not available
1007 Updated successfully
1008 Update failed
1009 No record found
1011 Order is not ready for shipping
1012 Username is required
1013 Voucher name is required
1014 Voucher already exists
1015 Invalid campaign ID
1016 Invalid input
1017 User does not exist
1018 Data update added to the task queue. You can view the status of the update in the Control Panel. An email will be sent to the merchant’s registered email ID after the task is completed.
1019 Data update added to the task queue. You can view the status of update using ‘GetProductInformation’
1020 No common shipping
1021 Warning
1022 Products not available
1023 Invalid city. Please select a valid address
1024 PIN code is not serviceable for the selected location
1025 PIN code not serviceable for the given address
1027 Update failed
1028 Invalid page number
1030 Authorization failed.
1031 Your account approval is still in process. You cannot access your account until approved.
1032 Your account has been locked because of multiple failed login attempts. Please contact customer support.
1033 Invalid inputs provided. Please provide correct input
1034 Product is added already
1035 Shipment created already
1036 No default self return found
1037 Your account has been locked because of multiple failed login attempts. To reactivate your account, email the support team. If you try with wrong passwords for 9 consecutive times, your account will be locked.
1038 Invalid OTP
1039 Your password has been expired or on the verge of expiry due to multiple attempts. This occurs when you try with the wrong password continuously for the 7th and 8th time. To prevent your account from being locked, reset the password using Forgot Password.
1040 Invalid password. Please enter correct password. If you enter wrong password for 6 consecutive times, you need to reset your password.
1041 No user account exists with the provided details.
1042 Your account has not been activated yet. Please try later.
1043 Order is already authorized.
1044 Invalid delivery slot.
1045 Invalid merchant ID.
1046 Invalid location ID
5001 Invalid user information
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
6220 Invalid ETA start/end time
6221 Invalid ETA range
6222 Invalid ETA units
6223 Invalid end range
6224 End date is greater than start date
6225 Invalid ETA details
6226 No location code passed
6227 Invalid location
6228 Invalid ETA
json