Arcadier

SDK Documentation

Find our SDK documentation of PHP and Node JS here.

PHP SDK

Initialising

The required libraries can be downloaded to your directory using composer. Contact us to receive the composer command to download the SDK resource files.
Find the .env file in the following directory created: “vendor\arcadier\arcadier-php\src” and replace the variables with the relevant values:

Remember to load the SDK by including the following line in all your PHP scripts:

Relevant values

CLIENT_ID = ""
CLIENT_SECRET = ""
DOMAIN = ""
PROTOCOL = ""

PHP scripts

require "vendor\arcadier\arcadier-php\src\api.php";
$sdk = new ApiSdk(); #this variable does not have to be $sdk, but in this documentation, it will be used throughout

Update Marketplace Info

POST /api/v2/marketplaces/

$updated_mp

$data = [
   'CustomFields' => [
        [
            'Code' => 'string', //the custom field code of an existing custom field
            'Values' => [
                'string' //the value to store. Data type depends on what was configured when the custom field was created.
            ]
        ]
    ]
];

$updated_mp = $sdk->updateMarketplaceInfo($data);
echo $updated_mp;

Authentication and SSO

Single Sign On

POST /api/v2/sso

Arguments:

$exUserId- (Required) The user’s ID from the external platform (string)
$userEmail- (Optional) This will be registered as the new user’s notification email

POST /api/v2/sso

$sso_user = $sdk->ssoToken($exUserId, $userEmail);
$user_ID = $sso_user['AccessToken']['UserId'];

echo $sso_user;

Log In/Get Admin Token

POST /token

Get Admin Token:

$admin_token = $sdk->AdminToken();
echo $admin_token;

Log a user in:

$user = $sdk->LogIn($username, $password); //arguments: the log in credentials of the user
echo $user;

User Accounts

Get A User’s details

GET /api/v2/users/{userID}

Arguments:

$id- (Required) User GUID (string)
$includes- (Optional) Takes the following values (string):

"addresses"

GET /api/v2/users/{userID}

$userInfo = $sdk->getUserInfo($id, $include);
echo $userInfo;

Get All Buyers

GET /api/v2/admins/{adminID}/users/?role=buyer

Arguments:

$keywords - (Optional) Search all merchants having a certain keyword in their details (name/e-mail). (string)
$pageSize- (Optional) The number of results in one response. (integer)
$pageNumber- (Optional) Depending on pageSize and the total number of results, specifying this will display different sets of results. (integer)

GET /api/v2/admins/{adminID}/users/?role=buyer

$buyerList = $sdk->getAllBuyers($keywordsParam = null, $pageSize = null, $pageNumber = null);
echo $buyerList['Records'];

Get All Merchants

GET /api/v2/admins/{adminID}/users/?role=merchant

Arguments:

$keywords - (Optional) Search all merchants having a certain keyword in their details (name/e-mail). (string)
$pageSize- (Optional) The number of results in one response. (integer)
$pageNumber- (Optional) Depending on pageSize and the total number of results, specifying this will display different sets of results. (integer)

Get All Users

GET /api/v2/admins/{adminID}/api/v2/admins/{adminID}/users/?role=buyer

Arguments:

$keywords - (Optional) Search all merchants having a certain keyword in their details (name/e-mail). (string)
$pageSize- (Optional) The number of results in one response. (integer)
$pageNumber- (Optional) Depending on pageSize and the total number of results, specifying this will display different sets of results. (integer)

GET /api/v2/admins/{adminID}/users/?role=buyer

$userList = $sdk->getAllUsers($keywordsParam = null, $pageSize = null, $pageNumber = null);
echo $userList['Records'];

Create Buyer Account

POST api/v2/accounts/register

$data = [
  'Email' => 'string', //email format
  'Password' => 'string', //at least 6 characters long
  'ConfirmPassword' => 'string' //repeat 'Password' field
];
$newUser = $sdk->registerUser($data);
echo $newUser;

Update User information

POST /api/v2/users/{userID}

Arguments:

$id - (Required) User GUID (string)
$data- (Optional) If omitted, user will be unaffected.

PUT /api/v2/users/{userID}

$updatedUser = $sdk->updateUserInfo($id, $data);
echo $updatedUser;

$data

$data = [
    'Email' => 'string', 
    'FirstName' => 'string',
    'LastName' => 'string',
    'DisplayName' => 'string',
    'Description' => 'string',
    'PhoneNumber' => '',
     'Media' => [
        [
            'MediaUrl' => 'string' //URL of image
        ]
    ],
    'CustomFields' => [
        [
            'Code' => 'string',
            'Name' => 'string',
            'DataFieldType' => 'string',
            'Values' => [
                'string'
            ]
        ]
    ],
    'TimeZone' => 'string',
    'Active' => true,
    'Enabled' => true,
    'Visible' => true       
];

Upgrade User Role

POST /api/v2/admins/{adminID}/users/{userID}/roles/{role}

Arguments:

$id - (Required) User GUID (string)
$role - (Required) Takes one of the following values (string)
- “merchant”
- “Admin”

PUT /api/v2/admins/{adminID}/users/{userID}/roles/{role}

$newRole = $sdk->upgradeUserRole($id, $role);
echo $newRole;

Delete User

DELETE /api/v2/admins/{adminID}/users/{userID}

Arguments:

$id - (Required) User GUID (string)

DELETE /api/v2/admins/{adminID}/users/{userID}

$deletedUser = $sdk->deleteUser($id);
echo $deletedUser;

Get Password Reset Token

POST /api/v2/admins/{adminID}/password

$data = [
    'UserID': 'string', //User GUID of user to reset password for
    'Action': 'token'
];
$result = $sdk->$resetPassword($data);
echo $result['Token'];

Update Password

POST /api/v2/users/{userID}/password

Arguments:

$userId - (Required) User GUID (string)
$data- (Required)

$data

$data = [
  'OldPassword' => 'string', //not required if resetting password
  'Password' => 'string',
  'ConfirmPassword' => 'string',
  'ResetPasswordToken' => 'string' //Obtained from Password reset API. Required if resetting password
];

$userId = "d78635hd-h7s5-k987-u4fd-333f-hd52kf6shn76";

$updatePassword = $sdk->updatePassword($data, $userId);
echo $updatePassword['Result'];

Addresses

Get User Address

GET /api/v2/users/{userID}/addresses/{addressID} is mapped to getUserAddress($id, $addressID)

Arguments:

$id - (Required) User GUID (string)
$addressID - (Optional) Address GUID (string). Ommitting it will return all addresses of that user.

Create User Address

POST /api/v2/users/{userID}/addresses is mapped to createUserAddress($id, $data)

Arguments:

$id - (Required) User GUID (string)
$data - (Required)

$data

$data = [
    'Name' => 'string',
    'Line1' => 'string',
    'Line2' => 'string',
    'PostCode' => 'string',
    'Latitude' => 'string',
    'Longitude' => 'string',
    'Delivery' => true,
    'Pickup' => true,
    'SpecialInstructions' => 'string',
    'State' => 'string',
    'City' => 'string',
    'Country' => 'string', //required
    'CountryCode' => 'string' //required
];

Update User Address

POST /api/v2/users/{userID}/addresses/{addressID} is mapped to updateUserAddress($id, $addressID, $data)

Arguments:

$id - (Required) User GUID (string)
$addressID - (Required) Address GUID (string)
$data - (Required)

$data

$data = [
    'Name' => 'string',
    'Line1' => 'string',
    'Line2' => 'string',
    'PostCode' => 'string',
    'Latitude' => 'string',
    'Longitude' => 'string',
    'Delivery' => true,
    'Pickup' => true,
    'SpecialInstructions' => 'string',
    'State' => 'string',
    'City' => 'string',
    'Country' => 'string', //required
    'CountryCode' => 'string' //required
];

Delete User Address

DELETE /api/v2/users/{userID}/addresses/{addressID} is mapped to deleteUserAddress($id, $addressID)

Arguments:

$id - (Required) User GUID (string)
$addressID - (Optional) Address GUID (string). Ommitting it will return all addresses of that user.

Items

Get Item Information

GET /api/v2/items/{itemID} is mapped to getItemInfo($id)

Arguments:

$id - (Required) Item GUID (string)

Get All Items

GET /api/v2/items is mapped to getAllItems($pageSize = null, $pageNumber = null);

Arguments:

$pageSize - (Optional) The number of results in one response. (integer)
$pageNumber - (Optional) Depending on pageSize and the total number of results, specifying this will display different sets of results. (integer)

get all items

$item_list = $sdk->getAllItems();
echo $item_list['Records']; //The actual array of items is in the "Records" field of the JSON response

Search for an item

POST /api/v2/items is mapped to searchItems($data);

Search filters are passed to the function as an object:

Search for an item

$data = [
    'keywords' => 'string', //keyword in item name, description, or custom field
    'pagesize' => 'string', //number of results
    'Categories' =>[
        'string' //Category GUID
    ],
    'sellerID' => 'string', //merchant GUID
    'customFields' => 'string', 
	'tax' => 'string',
	'minPrice' => 0,
	'maxPrice' => 0,
	'minRating' => 0,
	'maxRating' => 0,
	'startDate' => 'unix_time',
	'endDate' => 'unix_time',
	'createdStartDate' => 'unix_time',
	'createdEndDate' => 'unix_time',
	'updatedStartDate' => 'unix_time',
	'updatedEndDate' => 'unix_time'
];

$response = $sdk->getAllItemsJsonFiltering($data);
$results = $response['Records']; //The actual array of matching items is in the "Records" field of the JSON response

Create Item

POST /api/v2/merchants/{merchantID}/items is mapped to createItem($data, $merchantId)

Arguments:

$merchantId- (Required) Merchant GUID (string)
$data- Item details (Object)

$data

$data = [
    'SKU' => 'string',
    'Name' => 'string', //required
    'BuyerDescription' => 'string', //required
    'SellerDescription' => 'string', //required
    'Price' => 0, //required
    'PriceUnit' => 'string', //required
    'StockLimited' => true, //required
    'StockQuantity' => 0, //can be ommitted if StockLimited is set to false
    'IsVisibleToCustomer' => true,
    'Active' => true,
    'IsAvailable' => true,
    'CurrencyCode' => 'string', //required
    'Categories' => [
        [
            'ID' => 'string' //Category GUID. Required
        ]
    ],
    'ShippingMethods' => [ 
        [
            'ID' => 'string' //Shipping method GUID
        ]
    ],
    'PickupAddresses' => [
        [
            'ID' => 'string' //Address GUID
        ]
    ],
    'Media' => [
        [
            'MediaUrl' => 'string' //URL of image. Required
        ]
    ],
    'Tags' => [
        'string'
    ],
    'CustomFields' => [
        [
            'Code' => 'string', //Custom field code
            'Values' => [
                'string'
            ]
        ]
    ],
    'HasChildItems' => false,
    'ChildItems' => [ //this whole object can be omitted if HasChildItems is set to false
        [
            'Variants' => [
                [
                    'Name' => 'string',
                    'GroupName' => 'string2'
                ]
            ],
            'SKU' => 'string',
            'Name' => 'string',
            'BuyerDescription' => 'string',
            'SellerDescription' => 'string',
            'Price' => 0,
            'PriceUnit' => 'string',
            'StockLimited' => true,
            'StockQuantity' => 0,
            'IsVisibleToCustomer' => true,
            'Active' => true,
            'IsAvailable' => true,
            'CurrencyCode' => 'string',
            'Categories' => [
                [
                    'ID' => 'string'
                ]
            ],
            'ShippingMethods' => [
                [
                    'ID' => 'string'
                ]
            ],
            'PickupAddresses' => [
                [
                    'ID' => 'string'
                ]
            ],
            'Media' => [
                [
                    'MediaUrl' => 'string'
                ]
            ],
            'Tags' => [
                'string'
            ]
        ]
    ]
]

Create Listing/Booking

POST /api/v2/merchants/{merchantID}/items is mapped to createItem($data, $merchantId)

Arguments:

$merchantId - (Required) Merchant GUID (string)
$data - Item details (Object)

Documentation and $data details can be found here here

Fields similar to Create Item have the same requirement.

$data

$data = [
    'SKU' => 'string',
    'Name' => 'string',
    'BuyerDescription' => 'string',
    'SellerDescription' => 'string',
    'Price' => 0,
    'PriceUnit' => 'string',
    'StockLimited' => true,
    'StockQuantity' => 0,
    'IsVisibleToCustomer' => true,
    'Active' => true,
    'IsAvailable' => true,
    'CurrencyCode' => 'string',
    'InstantBuy' => true,
    'Negotiation' => false,
    'Categories' => [
        [
            'ID' => 'string'
        ]
    ],
    'ShippingMethods' => [
        [
            'ID' => 'string'
        ]
    ],
    'PickupAddresses' => [
        [
            'ID' => 'string'
        ]
    ],
    'Media' => [
        [
            'MediaUrl' => 'string'
        ]
    ],
    'Tags' => [
        'string'
    ],
    'CustomFields' => [
        [
            'Code' => 'string',
            'Values' => [
                'string'
            ]
        ]
    ],
    'Scheduler' => [
        'TimeZoneOffset' => -12.00,
        'TimeZoneID' => 1,
        'AllDay' => false,
        'Overnight' => false,
        'StartDateTime' => 1584748800,
        'EndDateTime' => 1587427200,
        'OpeningHours' => [
        	[
        		'Day' => 1,
        		'StartTime' => '08:00:00',
        		'EndTime' => '21:00:00',
        		'IsRestDay' => false
        	],
        	[
        		'Day' => 2,
        		'StartTime' => '08:00:00',
        		'EndTime' => '21:00:00',
        		'IsRestDay' => false
        	],
        	[
        		'Day' => 3,
        		'StartTime' => '08:00:00',
        		'EndTime' => '21:00:00',
        		'IsRestDay' => false
        	],
        	[
        		'Day' => 4,
        		'StartTime' => '08:00:00',
        		'EndTime' => '21:00:00',
        		'IsRestDay' => false
        	],
        	[
        		'Day' => 5,
        		'StartTime' => '08:00:00',
        		'EndTime' => '21:00:00',
        		'IsRestDay' => true
        	],
        	[
        		'Day' => 6,
        		'StartTime' => '18:00:00',
        		'EndTime' => '23:00:00',
        		'IsRestDay' => true
        	],
        	[
        		'Day' => 7,
        		'StartTime' => '08:00:00',
        		'EndTime' => '22:00:00',
        		'IsRestDay' => true
        	]
        ],
        'Unavailables' => [
        	[
        		'StartDateTime' => 1585094400,
        		'EndDateTime' => 1585180800,
        		'Reason' => 'My Birthday',
        		'Active' => true
        	],
        	[
        		'StartDateTime' => 1587081600,
        		'EndDateTime' => 1587222000,
        		'Reason' => 'Your Birthday',
        		'Active' => true
        	]
        ]
    ],
    'HasChildItems' => true,
    'ChildItems' => [
        [
            'Variants' => [
                [
                    'Name' => 'string',
                    'GroupName' => 'string2'
                ]
            ],
            'SKU' => 'string',
            'Name' => 'string',
            'BuyerDescription' => 'string',
            'SellerDescription' => 'string',
            'Price' => 0,
            'PriceUnit' => 'string',
            'StockLimited' => true,
            'StockQuantity' => 0,
            'IsVisibleToCustomer' => true,
            'Active' => true,
            'IsAvailable' => true,
            'CurrencyCode' => 'string',
            'Categories' => [
                [
                    'ID' => 'string'
                ]
            ],
            'ShippingMethods' => [
                [
                    'ID' => 'string'
                ]
            ],
            'PickupAddresses' => [
                [
                    'ID' => 'string'
                ]
            ],
            'Media' => [
                [
                    'MediaUrl' => 'string'
                ]
            ],
            'Tags' => [
                'string'
            ]
        ]
    ]
]

Edit Item/Listing/Booking

PUT /api/v2/merchants/{merchantID}/items/{itemID} is mapped to editItem($data, $merchantId, $itemId)

Arguments:

$merchantId - (Required) Merchant GUID (string)
$itemId - (Required) Item GUID (string)
$data - Item details (Object)

Documentation and $data details can be found here here

Delete Item/Listing/Booking

DELETE /api/v2/merchants/{merchantID}/items/{itemID} is mapped to deleteItem($merchantId, $itemId)

Arguments:

$merchantId - (Required) Merchant GUID (string)
$itemId - (Required) Item GUID (string)

Tag Item/Listing/Booking

POST /api/v2/merchants/{merchantID}/items/{itemID}/tags is mapped to tagItem($data, $merchantId, $itemId)

Arguments:

$merchantId - (Required) Merchant GUID (string)
$itemId - (Required) Item GUID (string)
$data - Item details (Array of strings)

Tag item

$data = [
    'string',
    'string'
];

$tag_new_item = $sdk->tagItem($data, $merchantId, $itemId);
echo $tag_new_item;

Get Item Tags

GET /api/v2/tags is mapped to getItemTags($pageSize = null, $pageNumber = null)

Arguments:

$pageSize - (Optional) The number of results in one response. (integer)
$pageNumber - (Optional) Depending on pageSize and the total number of results, specifying this will display different sets of results. (integer)

More about pagination here

Get item tags

$get_tags = $sdk->getItemTags();
echo $get_tags;

Delete Item Tags

DELETE /api/v2/tags is mapped to deleteTags($data)

Delete item tag

$data = [
    'string_1',
    'string_2'
];

$deleted_tags = $sdk->deleteTags($data);
echo $deleted_tags;

Cart

Get Buyer's Cart

GET /api/v2/users/{buyerID}/carts

Arguments:

$buyerId - (Required) The buyer’s GUID (string)

Get buyer cart

$cart = $sdk->getCart($buyerId);
echo $cart['Records'];

Add Item to Cart

POST /api/v2/users/{buyerID}/carts

Arguments:

$buyerId - (Required) The buyer’s GUID (string)
$ data : ```php $data = [ ‘ItemDetail’=> [ ‘ID’=> ‘00000000-0000-0000-0000-000000000000’ // Required. String. Item GUID. If an item has child items, this will be the child item GUID. ], ‘Quantity’=> 0, //integer. Required ‘CartItemType’=> ‘delivery’, //optional ‘ShippingMethod’=> [ ‘ID’=> ‘00000000-0000-0000-0000-000000000000’ //optional. Shipping Method GUID ] ];

$cart = $sdk->addToCart($data, $buyerId); echo $cart;

Add item to cart

---

### Edit Item in Cart
**PUT ``/api/v2/users/{buyerID}/carts/{cart-item-ID}``**

Arguments:
* `$buyerId` - *(Required)* The buyer's GUID (string)'=
* `$cartItemId` - *(Required)* The Cart Item ID obtained from the response of **Add item to Cart** API
* `$data`:
```php
$data = [
    'ItemDetail'=> [
        'ID'=> '00000000-0000-0000-0000-000000000000' // Required. String. Item GUID. If an item has child items, this will be the child item GUID.
    ],
    'Quantity'=> 0, //integer. Required
    'CartItemType'=> 'delivery', //optional
    'ShippingMethod'=> [
        'ID'=> '00000000-0000-0000-0000-000000000000' //optional. Shipping Method GUID 
    ]
];

$cart = $sdk->updateCartItem($data, $buyerId, $cartItemId);
echo $cart;

Delete Item from Cart

DELETE /api/v2/users/{buyerID}/carts/{cart-item-ID}

Arguments:

$buyerId - (Required) The buyer’s GUID (string)
$cartItemId - (Required) The Cart Item ID obtained from the response of Add item to Cart API

$cart

$cart = $sdk->deleteCartItem($buyerId, $cartItemId);
echo $cart;

Orders

Get Order by Order GUID

GET /api/v2/users/{merchantID}/orders/{orderID}

Arguments:

$id - (Required) The order GUID (string)
$userId - (Required) Can be either the Admin GUID or the merchant GUID of the the merchant who owns the order.

$orderinfo

$orderInfo = $sdk->getOrder($id, $userId);
echo $orderInfo;

Get All Orders of a merchant

GET /api/v2/users/{merchantID}/orders/{orderID}

Arguments:

$merchantId - (Required) The merchant GUID (string)
$pageSize - (Optional) The number of results in one response. (integer)
$pageNumber- (O ptional) Depending on pageSize and the total number of results, specifying this will display different sets of results. (integer)

$orderList

$orderList = $sdk->getOrderHistory($merchantId, $pageSize, $pageNumber);
echo $orderList;

Get All Orders within an Invoice

GET /api/v2/merchants/{merchantID}/transactions/{invoiceID}

Arguments:

$merchantId - (Required) The merchant GUID (string)
$invoiceId - (Required) The invoice number (string)

$orderList

$orderList = $sdk->getOrderInfoByInvoiceId($merchantId, $invoiceId);
echo $orderList;

Update An Order

POST /api/v2/merchants/{merchantID}/orders/{orderID}

Arguments:

$merchantId - the GUID of the merchant who is the owner of the order. This can also be the Admin GUID (string)
$orderId - The order GUID (string)
$data

Field Definitions for $data can be foundhere.

Update an order

$data = [
    'FulfilmentStatus'=> 'string',
    'PaymentStatus'=> 'string',
    'Balance'=> 0,
    'DeliveryToAddress'=> [
        'ID'=> '00000000-0000-0000-0000-000000000000'
    ],
    'CartItemType'=> 'string',
    'Freight'=> 0,
    'DiscountAmount'=> 0,
    'Surcharge'=> 0,
    'CustomFields'=> [
        [
            'Code'=> 'string',
            'Values'=> [
            	'string'
            ]
        ]
    ]
];

$updated_order = $sdk->editOrder($merchantId, $orderId, $data)
echo $updated_order;

Edit Several Orders’ Details

POST /api/v2/admins/{adminID}/orders

Field Definitions for $data can be found here.

Edit several orders' details

$data = [
    [ //order #1
        'ID' => '00000000-0000-0000-0000-000000000000',
        'FulfilmentStatus'=> 'string',
        'PaymentStatus'=> 'string',
        'Balance'=> 0,
        'DeliveryToAddress'=> [
            'ID'=> '00000000-0000-0000-0000-000000000000'
        ],
        'CartItemType'=> 'string',
        'Freight'=> 0,
        'DiscountAmount'=> 0,
        'Surcharge'=> 0,
        'CustomFields'=> [
            [
                'Code'=> 'string',
                'Values'=> [
                    'string'
                ]
            ]
        ]
    ],
    [ //order #2
        'ID' => '00000000-0000-0000-0000-000000000000',
        'FulfilmentStatus'=> 'string',
        'PaymentStatus'=> 'string',
        'Balance'=> 0,
        'DeliveryToAddress'=> [
            'ID'=> '00000000-0000-0000-0000-000000000000'
        ],
        'CartItemType'=> 'string',
        'Freight'=> 0,
        'DiscountAmount'=> 0,
        'Surcharge'=> 0,
        'CustomFields'=> [
            [
                'Code'=> 'string',
                'Values'=> [
                    'string'
                ]
            ]
        ]
    ]
];

$updated_orders = $sdk->updateOrders($data)
echo $updated_orders;

Transactions & Invoices

Get Transaction Info by Invoice number

GET /api/v2/admins/{adminID}/transactions/{invoiceID}

Arguments:

$invoiceNo - (Required) The invoice number (string)

$transac_info

$transac_info = $sdk->getTransactionInfo($invoiceNo);
echo $transac_info;

Get all Transactions of marketplace

GET /api/v2/admins/{adminID}/transactions is mapped to Transactions.getTransactions(pageSize, pageNumber, keywords, startDate, endDate)

Arguments:

pageSize - The number of results in one response. (integer)
pageNumber - Depending on pageSize and the total number of results, specifying this will display different sets of results. (integer)
keywords - (Optional) Search term as keyword to find within transactions.
startDate - (Optional) The lower limit of the time at which you want to start filtering. (integer - Unix timestamp)
endDate - (Optional) The upper limit of the time at which you want to end filetering. (integer - Unix timestamp)

transactions

var transactions = await client.Transactions.getTransactions(pageSize, pageNumber, keywords, startDate, endDate);
console.log(transactions);

Get all Transactions of a Buyer

GET /api/v2/users/{buyerID}/transactions

Arguments:

$buyerId - (Required) The buyer GUID (string)

$transactions['Records']

$transactions = $sdk->getBuyerTransactions($buyerId);
echo $transactions['Records'];

Update Seeral Transaction Details

PUT /api/v2/admins/{adminID}/invoices/{invoiceID}

Arguments:

$invoiceNo - the invoice number of the invoice to be updated
$data

Field Definitions for $data can be found here.

$updated_transaction

$data = [
  [
    'Payee' => [
      'ID' => '00000000-0000-0000-0000-000000000000'
    ],
    'Order' => [
      'ID' => '00000000-0000-0000-0000-000000000000'
    ],
    'Total' => 0,
    'Fee' => 0,
    'Status' => 'string',
    'Refunded' => false,
    'RefundedRef' => 'string',
    'GatewayPayKey' => 'string',
    'GatewayTransactionID' => 'string',
    'GatewayStatus' => 'string',
    'GatewayTimeStamp' => 'string',
    'GatewayRef' => 'string',
    'GatewayCorrelationId' => 'string',
    'GatewaySenderId' => 'string',
    'GatewaySenderRef' => 'string',
    'GatewayReceiverId' => 'string',
    'GatewayReceiverRef' => 'string',
    'Gateway' => [
      'Code' => 'string'
    ],
    'DateTimePaid' => 0
  ]
];
$updated_transaction = $sdk->updateTransaction($invoiceNo, $data);
echo $updated_transaction;

Custom Tables

Get Custom Table Contents

GET api/v2/plugins/{packageID}/custom-tables/{custom-table-name}/

Arguments:

$packageId - (Required) The Plug-In ID (string)
$tableName - (Required) The table name (string)

$custom_table['Records']

$custom_table = $sdk->getCustomTable($packageId, $tableName);
echo $custom_table['Records'];

Create Row

POST /api/v2/plugins/{packageID}/custom-tables/{custom-table-name}/rows

Arguments:

$packageId - (Required) The Plug-In ID (string)
$tableName - (Required) The table name (string)

$new_row

$data = [
    `{column-name1}` => `string`, // data type depends on what was configured during custom table creation
    `{column-name2}` => 0
];

$new_row = $sdk->createRowEntry($packageId, $tableName, $data);
echo $new_row;

Update Row

PUT /api/v2/plugins/{packageID}/custom-tables/{custom-table-name}/rows/{rowId}

Arguments:

$packageId - (Required) The Plug-In ID (string)
$tableName - (Required) The table name (string)
$rowId - (Required) The ID of the row (string)

$update_row

$data = [
    "{column-name1}": "string", // data type depends on what was configured during custom table creation
    "{column-name2}": 0
];

$updated_row = $sdk->editRowEntry($packageId, $tableName, $rowId, $data);
echo $update_row;

Delete Row

DELETE /api/v2/plugins/{packageID}/custom-tables/{custom-table-name}/rows/{rowId}

Arguments:

$packageId - (Required) The Plug-In ID (string)
$tableName - (Required) The table name (string)
$rowId - (Required) The ID of the row (string)

$deleted_row

$deleted_row = $sdk->deleteRowEntry($packageId, $tableName, $rowId);
echo $deleted_row;

Event Triggers

Get Event Triggers

$event_trigger_list

$event_trigger_list = $sdk->getEventTriggers();
echo $event_trigger_list;

Create Event Trigger

POST /api/v2/event-triggers/

Field definitions:

'Uri' - The URL of the webhook to send the payload to.
'Filters' => [] - Array of names of the events which act as trigger. More details here
'Description' - Short description of the event trigger
'IsPaused' - (Boolean) Halts the triggering of this event to the specified URI. This does not delete the event trigger.
'Headers' => [] - Array of headers paramaters you wish to send with the payload to the webhook server.

$new_event_trigger

$data = [
    'Uri' => 'string',  //required
    'Filters' => [      //required
        'string', 
        'string'
    ],
    'Description' => 'string',
    'IsPaused' => false,
    'Headers' => [
        'Authorization' => 'string',
        'CustomHeader' => 'string',
        'Alice' => 'Bob'
    ]
];

$new_event_trigger = $sdk->addEventTrigger($data);
echo $new_event_trigger;

Edit Event Trigger

PUT /api/v2/event-triggers/{event_trigger_ID}

Arguments:

$eventTriggerId - the ID of the event trigger obtained after creating it (string)
$data

Field definitions:

'Uri' - The URL of the webhook to send the payload to.
'Filters' => [] - Array of names of the events which act as trigger. More details here
'Description' - Short description of the event trigger
'IsPaused' - (Boolean) Halts the triggering of this event to the specified URI. This does not delete the event trigger.
'Headers' => [] - Array of headers paramaters you wish to send with the payload to the webhook server.

$edit_event_trigger

$data = [
    'Uri' => 'string',  //required
    'Filters' => [      //required
        'string', 
        'string'
    ],
    'Description' => 'string',
    'IsPaused' => false,
    'Headers' => [
        'Authorization' => 'string',
        'CustomHeader' => 'string',
        'Alice' => 'Bob'
    ]
];

$edit_event_trigger = $sdk->updateEventTrigger($eventTriggerId, $data);
echo $edit_event_trigger;

Delete Event Trigger

DELETE /api/v2/event-triggers/{event_trigger_ID}

Arguments:

$eventTriggerId - the ID of the event trigger obtained after creating it (string)

$delete_event_trigger

$delete_event_trigger = $sdk->removeEventTrigger($eventTriggerId);
echo $delete_event_trigger;

E-Mail

Send Email

POST /api/v2/admins/{adminID}/emails

Arguments:

$from - The sender's email (string)
$to - The recipient's email (string)
$html - Stringified HTML content of the email
$subject - The subject of the email (string)

$sendEmail

$data= [
    'From' => 'string',
    'To' => 'string',
    'Body' => 'Your email content. It can be in plaintext or in HTML',
    'Subject' => 'string'
];

$sendEmail = $sdk->sendEmail($from, $to, $html, $subject);
echo $sendEmail;

Send Email for Invoice number

POST /api/v2/emails

Arguments:

$invoiceno - The invoice number (string)

$sendEmail

$sendEmail = $sdk->sendEmailAfterGeneratingInvoice($invoiceNo);
echo $sendEmail;

Static

Get Fulfilment Statuses

GET /api/v2/static/fulfilment-statuses

$fulfilment_statuses['Records']

$fulfilment_statuses = $sdk->getFulfilmentStatuses();
echo $fulfilment_statuses['Records'];

Get Currencies

GET /api/v2/static/currencies

$currencies['Records']

$currencies = $sdk->getCurrencies();
echo $currencies['Records'];

Get Countries

GET /api/v2/static/countries

$countries['Records']

$countries = $sdk->getCountries();
echo $countries['Records'];

Get Order Statuses

GET /api/v2/static/order-statuses

$order_statuses['Records']

$order_statuses = $sdk->getOrderStatuses();
echo $order_statuses['Records'];

Get Payment Statuses

GET /api/v2/static/payment-statuses

$payment_statuses['Records']

$payment_statuses = $sdk->getPaymentStatuses();
echo $payment_statuses['Records'];

Get TimeZones

GET /api/v2/static/timezones

$timezones['Records']

$timezones = $sdk->getTimezones();
echo $timezones['Records'];

Get Category Hierarchy

GET /api/v2/categories/hierarchy

$category_hierarchy

$category_hierarchy = $sdk->getCategoriesWithHierarchy();
echo $category_hierarchy;

Create a Category

POST /api/v2/admins/{adminID}/categories

Field definitions:

'Name' - Name of the category
'Description' - Short Description of the category
'SortOrder' - Rank in which it will appear on category lists
'Media' => [ 'MediaUrl'] - The URL of the image to be set for the category
'ParentCategoryID' - The GUID of the category which will be the parent of this new category. Omit this field if the category is going to be a parent/main category
'Level' - Parent Categories have a level of 0. subsequent levels of child categories have higher levels.

$new_category

$data = [
    'Name' => 'string', //required
    'Description' => 'string',
    'SortOrder' => 0,
    'Media' => [ //required
        [
            'MediaUrl' => 'string'
        ]
    ],
    'ParentCategoryID' => '00000000-0000-0000-0000-000000000000',
    'Level' => 0
];

$new_category = $sdk->createCategory($data);
echo $new_category;

Edit a Category

PUT /api/v2/admins/{adminID}/categories/{categoryID}

Arguments:

$categoryId - the category GUID of the category to edit
$data

Field definitions:

'Name' - Name of the category
'Description' - Short Description of the category
'SortOrder' - Rank in which it will appear on category lists
'Media' => [ 'MediaUrl'] - The URL of the image to be set for the category
'ParentCategoryID' - The GUID of the category which will be the parent of this new category. Omit this field if the category is going to be a parent/main category
'Level' - Parent Categories have a level of 0. subsequent levels of child categories have higher levels.

$edited_category

$data = [
    'Name' => 'string', 
    'Description' => 'string',
    'SortOrder' => 0,
    'Media' => [ 
        [
            'MediaUrl' => 'string'
        ]
    ],
    'ParentCategoryID' => '00000000-0000-0000-0000-000000000000',
    'Level' => 0
];

$edited_category = $sdk->updateCategory($categoryId, $data);
echo $edited_category;

Sort Categories

PUT /api/v2/admins/{adminID}/categories

$sorted_list

$data = [
    "Category GUID #1", //string
    "Category GUID #2",
    "Category GUID #3"
];

$sorted_list = $sdk->sortCategories($data);
echo $sorted_list;

Delete a Category

DELETE /api/v2/admins/{adminID}/categories/{categoryID}

Arguments:

$categoryId - the category GUID of the category to edit

$deleted_category

$deleted_category = $sdk->deleteCategory($categoryId);
echo $deleted_category;

Marketplace

Get Marketplace Info

GET /api/v2/marketplaces/

$mp

$mp = $sdk->getMarketplaceInfo();
echo $mp;

Customize/Shorten URL

POST /api/v2/rewrite-rules

Field definitions:

'Key' - The custom URL slug
'Value' - The default URL slug to replace

$res

$data = [
    'Key' => 'string',
    'Value' => 'string'
];

$res = $sdk->customiseURL($data)
echo $res;

Custom Fields

Get Custom Field Definitions

GET /api/v2/admins/{adminID}/custom-field-definitions/

$cf['Records']

$cf = $sdk->getCustomFields()
echo $cf['Records'];

Get Custom Fields of a Plug-In

GET /api/v2/packages/{packageID}/custom-field-definitions

Arguments:

$packageId - The ID of the Plug-In (string)

$plugin_cf

$plugin_cf = $sdk->getPluginCustomFields($packageId);
echo $plugin_cf;

Create A Custom Field

POST /api/v2/admins/{adminID}/custom-field-definitions

Field Definitions for $data: All the field definitions for this request can be found here

$new_cf

$data = [
  'Name' => 'string',
  'IsMandatory' => true,
  'SortOrder' => 0,
  'DataInputType' => 'string',
  'DataRegex' => 'string',
  'MinValue' => 0,
  'MaxValue' => 0,
  'ReferenceTable' => 'string',
  'DataFieldType' => 'string',
  'IsSearchable' => true,
  'IsSensitive' => true,
  'Active' => true,
  'Options' => [
    [
      'Name' => 'string'
    ]
  ]
];

$new_cf = $sdk->createCustomField($data);
echo $new_cf;

Edit A Custom Field

PUT /api/v2/admins/{adminID}/custom-field-definitions/{customfield-code}

Arguments:

$code - The custom field code obtained after creating it/getting its definition

Field Definitions for $data: All the field definitions for this request can be found here

$updated_cf

$data = [
  'Name' => 'string',
  'IsMandatory' => true,
  'SortOrder' => 0,
  'DataInputType' => 'string',
  'DataRegex' => 'string',
  'MinValue' => 0,
  'MaxValue' => 0,
  'ReferenceTable' => 'string',
  'DataFieldType' => 'string',
  'IsSearchable' => true,
  'IsSensitive' => true,
  'Active' => true,
  'Options' => [
    [
      'Name' => 'string'
    ]
  ]
];

$updated_cf = $sdk->updateCustomField($code, $data)
echo $updated_cf;

Delete A Custom Field

DELETE /api/v2/admins/{adminID}/custom-field-definitions/{custom-field-code}

Arguments:

$code - The custom field code obtained after creating it/getting its definition

$deleted_cf

$deleted_cf = $sdk->deleteCustomField($code);
echo $deleted_cf;

Shipping/Delivery Methods

Get Shipping Methods

GET /api/v2/merchants/{merchantID}/shipping-methods/

$shipping_methods

$shipping_methods = $sdk->getShippingMethods($merchantId);
echo $shipping_methods;

Get Delivery Rates (Weight/Price)

GET /api/v2/merchants/{adminID}/shipping-methods/

$delivery_rates

$delivery_rates = $sdk->getDeliveryRates();
echo $delivery_rates;

Create Shipping Method/Delivery Rate

POST /api/v2/merchants/{merchantID}/shipping-methods

Arguments:

$merchantId - The merchant's GUID (string)
$data

Field definitions:

'Courier' - The shipping method name
'Price' and 'CombinedPrice' Detailed explanations of how to use these 2 fields together is explained here
'CurrencyCode' - The currency in which the shipping method operates, eg: USD or SGD
'Description' - Short description of the shipping method.

$new_shipping

$data = [
	'Courier' => 'string',
	'Price' => 0, //required
	'CombinedPrice' => 0, 
	'CurrencyCode' => 'string', //required
	'Description' => 'string'
];
$new_shipping = $sdk->createShippingMethod($merchantId, $data);
echo $new_shipping;

Edit Shipping Method/Delivery Rate

PUT /api/v2/merchants/{merchantID}/shipping-methods/{shippingmethodID}

Arguments:

$merchantId - The merchant's GUID (string)
$shippingMethodId - The shipping GUID to be edited (string)
$data

Field definitions:

'Courier' - The shipping method name
'Price' and 'CombinedPrice' Detailed explanations of how to use these 2 fields together is explained here
'CurrencyCode' - The currency in which the shipping method operates, eg: USD or SGD
'Description' - Short description of the shipping method.

$edited_shipping

$data = [
	'Courier' => 'string',
	'Price' => 0, //required
	'CombinedPrice' => 0, 
	'CurrencyCode' => 'string', //required
	'Description' => 'string'
];
$edited_shipping = $sdk->updateShippingMethod($merchantId, $shippingMethodId, $data)
echo $edited_shipping;

Delete Shipping Method/Delivery Rate

DELETE /api/v2/merchants/{merchantID}/shipping-methods/{shippingmethodID}

Arguments:

$merchantId - The merchant's GUID (string)
$shippingMethodId - The shipping GUID to be deleted (string)

$deleted_shipping

$deleted_shipping = $sdk->deleteShippingMethod($merchantId, $shippingMethodId);
echo $deleted_shipping;

Checkout

Generate Invoice and Order Details from cart

POST /api/v2/users/{buyerID}/invoices/carts

Arguments:

$buyerID - The BUyer's GUID (string)
$data

Field Definitions in $data: the difference between an "item ID" and a "cart item ID" is explained here

$generate_details

$data = [
    'Cart Item ID #1', //the cart item ID
    'Cart Item ID #2',
    'Cart Item ID #3'
];

$generate_details = $sdk->generateInvoice($buyerId, $data);
echo $generate_details;

Node.Js SDK

Initialising

To download the required libraries to your node-modules directory, contact us to receive the command line to execute in Node.

Create a directory for your web app's scripts. In this directory, create a config.js files containing your marketplace's credentials

Remember to load the SDK and the config.js in all your scripts. For example, if you create a directory for all your scripts, then import them using the following lines at the top of your files

Marketplace's Credentials

module.exports = {
    client:{
        apiBaseUrl: "",  //your marketplace domain
        protocol: "", //your marketplace current SSL protocol
        clientId: "", 
        clientSecret: "",
    }
}

Load SDK

const ArcadierClient = require("path-to-sdk/sdk"); //loads the SDK resources
const config = require("./config.js"); //loads the config to autenticate usage of Arcadier"s APIs

Addresses

Get User Address

GET /api/v2/users/{userID}/addresses/{addressID} is mapped to Addresses.getUserAddresses(userId)

Arguments:

userId - (Required) User GUID (string)

addresses

var addresses = await client.Addresses.getUserAddresses(userId);
console.log(addresses);

Create User Address

POST /api/v2/users/{userID}/addresses is mapped to Addresses.createAddress(userId, body)

Arguments:

userId - (Required) User GUID (string)
body - (Required)

newAddress

var body = {
    "Name": "string",
    "Line1": "string",
    "Line2": "string",
    "PostCode": "string",
    "Latitude": "string",
    "Longitude": "string",
    "Delivery": true,
    "Pickup": true,
    "SpecialInstructions": "string",
    "State": "string",
    "City": "string",
    "Country": "string", //required
    "CountryCode": "string" //required
};

var newAddress = await client.Addresses.createAddress(userId, body);
console.log(newAddress);

Delete User Address

DELETE /api/v2/users/{userID}/addresses/{addressID} is mapped to Addresses.deleteAddress(userId, addressId)

Arguments:

userId - (Required) User GUID (string)
addressId - (Optional) Address GUID (string). Ommitting it will return all addresses of that user.

deletedAddress

var deletedAddress = await client.Addresses.deleteAddress(userId, addressId);
console.log(deletedAddress);

Items

Get Item Information

GET /api/v2/items/{itemID} is mapped to Items.getItemDetails(itemId)

Arguments:

itemId - (Required) Item GUID (string)

itemDetails

var itemDetails = await client.Items.getItemDetails(itemId);
console.log(itemDetails);

Get All Items

GET /api/v2/items is mapped to Items.getAllItems(pageSize, pageNumber)

Arguments:

pageSize - (Optional) The number of results in one response. (integer)
pageNumber - (Optional) Depending on pageSize and the total number of results, specifying this will display different sets of results. (integer)

item_list

var item_list = await client.Items.getAllItems(pageSize, pageNumber);
console.log(item_list);

Search for an item

POST /api/v2/items is mapped to Items.searchItems(body)

Search filters are passed to the function as an object:

response

var body = {
    "keywords" : "string", //keyword in item name, description, or custom field
    "pagesize" : "string", //number of results
    "sellerID" : "string", //merchant GUID
    "customFields" : "string", 
    "minPrice" : 0,
    "maxPrice" : 0,
    "createdStartDate" : "unix_time",
    "createdEndDate" : "unix_time",
    "updatedStartDate" : "unix_time",
    "updatedEndDate" : "unix_time"
};

var response = await client.Items.searchItems(body);
console.log(response) //The actual array of matching items is in the "Records" field of the JSON response

Create Item

POST /api/v2/merchants/{merchantID}/items is mapped to Items.createItem(body)

new_item

var body = {
    "merchantId": "string" //required - the merchat GUID
    "SKU" : "string",
    "Name" : "string", //required
    "BuyerDescription" : "string", //required
    "SellerDescription" : "string", //required
    "Price" : 0, //required
    "PriceUnit" : "string", //required
    "StockLimited" : true, //required
    "StockQuantity" : 0, //can be ommitted if StockLimited is set to false
    "IsVisibleToCustomer" : true,
    "Active" : true,
    "IsAvailable" : true,
    "CurrencyCode" : "string", //required
    "Categories" : [
        {
            "ID" : "string" //Category GUID. Required
        }
    ],
    "ShippingMethods" : [
        {
            "ID" : "string" //Shipping method GUID
        }
    ],
    
    "Media" : [
        {
            "MediaUrl" : "string" //URL of image. Required
        }
    ],
    "Tags" : [
        "string"
    ],
    "CustomFields" : [
        {
            "Code" : "string", //Custom field code
            "Values" : [
                "string"
            ]
        }
    ],
    "HasChildItems" : false,
    "ChildItems" : [ //this whole object can be omitted if HasChildItems is set to false
        {
            "Variants" : [
                {
                    "Name" : "string",
                    "GroupName" : "string2"
                }
            ],
            "SKU" : "string",
            "Name" : "string",
            "BuyerDescription" : "string",
            "SellerDescription" : "string",
            "Price" : 0,
            "PriceUnit" : "string",
            "StockLimited" : true,
            "StockQuantity" : 0,
            "IsVisibleToCustomer" : true,
            "Active" : true,
            "IsAvailable" : true,
            "CurrencyCode" : "string",
            "Categories" : [
                {
                    "ID" : "string"
                }
            ],
            "ShippingMethods" : [
                {
                    "ID" : "string"
                }
            ],
            
            "Media" : [
                {
                    "MediaUrl" : "string"
                }
            ],
            "Tags" : [
                "string"
            ]
        }
    ]
};

var new_item = await client.Items.createItem(body);
console.log(new_item);

Edit Item

PUT /api/v2/merchants/{merchantID}/items/{itemID} is mapped to Items.EditNewItem(body)

Documentation and body details can be found here.

edit_item

var body = {
    "merchantId": "string" //required - the merchat GUID
    "SKU" : "string",
    "Name" : "string", //required
    "BuyerDescription" : "string", //required
    "SellerDescription" : "string", //required
    "Price" : 0, //required
    "PriceUnit" : "string", //required
    "StockLimited" : true, //required
    "StockQuantity" : 0, //can be ommitted if StockLimited is set to false
    "IsVisibleToCustomer" : true,
    "Active" : true,
    "IsAvailable" : true,
    "CurrencyCode" : "string", //required
    "Categories" : [
        {
            "ID" : "string" //Category GUID. Required
        }
    ],
    "ShippingMethods" : [
        {
            "ID" : "string" //Shipping method GUID
        }
    ],
    
    "Media" : [
        {
            "MediaUrl" : "string" //URL of image. Required
        }
    ],
    "Tags" : [
        "string"
    ],
    "CustomFields" : [
        {
            "Code" : "string", //Custom field code
            "Values" : [
                "string"
            ]
        }
    ],
    "HasChildItems" : false,
    "ChildItems" : [ //this whole object can be omitted if HasChildItems is set to false
        {
            "Variants" : [
                {
                    "Name" : "string",
                    "GroupName" : "string2"
                }
            ],
            "SKU" : "string",
            "Name" : "string",
            "BuyerDescription" : "string",
            "SellerDescription" : "string",
            "Price" : 0,
            "PriceUnit" : "string",
            "StockLimited" : true,
            "StockQuantity" : 0,
            "IsVisibleToCustomer" : true,
            "Active" : true,
            "IsAvailable" : true,
            "CurrencyCode" : "string",
            "Categories" : [
                {
                    "ID" : "string"
                }
            ],
            "ShippingMethods" : [
                {
                    "ID" : "string"
                }
            ],
            
            "Media" : [
                {
                    "MediaUrl" : "string"
                }
            ],
            "Tags" : [
                "string"
            ]
        }
    ]
};

var edit_item = await client.Items.EditNewItem(body);
console.log(edit_item);

Delete Item

DELETE /api/v2/merchants/{merchantID}/items/{itemID} is mapped to Items.deleteItem(body)

delete_item

var body = {
    "merchantId": "string" //merchantGUID
    "itemId": "string" //itemGUID
};

var delete_item = await client.Items.deleteItem(body);
console.log(delete_item);

Carts

Get Buyer's Cart

GET /api/v2/users/{buyerID}/carts is mapped to Carts.getCarts(body)

cart

var body = {
    "userId": "string", //user GUID
    "pageSize": 0,
    "pageNumber": 0
};

var cart = await client.Carts.getCarts(body);
console.log(cart);

Add Item to Cart

POST /api/v2/users/{buyerID}/carts is mapped to Carts.addItem(body)

cart

var body = {
    "userId": "string", //user GUID
    "itemId": "string", //item GUID
    "quantity": 0, //amount of the item to add to cart
    "discount": 0 //discount amount to apply to the total of the cart
};

var cart = await client.Carts.addItem(body);
console.log(cart);

Edit Item in Cart

PUT /api/v2/users/{buyerID}/carts/{cart-item-ID} is mapped to Carts.editCart(body)

edited_cart

body = {
    "itemID": "string", //item GUID
    "userID": "string", //userGUID
    "cartID": "string", //cart itemID
    "quantity": 0,
    "discount": 0,
    "cartItemType": "delivery",
    "shippingMethodId": "string"
};

var edited_cart = await client.Carts.editCart(body);
console.log(edited_cart);

Delete Item from Cart

DELETE /api/v2/users/{buyerID}/carts/{cart-item-ID} is mapped to Carts.deleteItem(body)

delete_cart_item

var body = {
    "userId": "string", //user GUID
    "cartId": "string" //cart item GUID
};

var delete_cart_item = await client.Carts.deleteItem(body);
console.log(delete_cart_item);

Orders

Get Order by Order GUID

GET /api/v2/users/{merchantID}/orders/{orderID} is mapped to Orders.getOrderDetails

orderInfo

var body = {
    "userId": "string" //user GUID
    "orderId": "string" //order GUID
};

var orderInfo = await client.Orders.getOrderDetails(body);
console.log(orderInfo);

Get All Orders of a merchant

GET /api/v2/merchants/{merchantID}/transactions is mapped to Orders.getHistory(body)

orderList

var body = {
    "userId": "string" //user GUID
    "keyword": "string" //keyword to search within the order
    "pageSize": 0,
    "pageNumber": 0,
    "orderStatus": "string" //the order's status
    "supplier": "string" //merchant ID of the orders
    "startDate": 0,
    "endDate": 0
};

var orderList = await client.Orders.getHistory(body);
console.log(orderList);

Get All Orders within an Invoice

GET /api/v2/merchants/{merchantID}/transactions/{invoiceID} is mapped to Orders.getHistoryDetail

orderList

var body = {
    "merchantId": "string" //merchant GUID
    "invoiceNo": "string" //invoice number
};

var orderList = await client.Orders.getHistoryDetail(body);
console.log(orderList);

Transactions

Get all Transactions of marketplace

GET /api/v2/admins/{adminID}/transactions is mapped to Transactions.getTransactions(pageSize, pageNumber, keywords, startDate, endDate)

Arguments:

pageSize - (Optional) The number of results in one response. (integer)
pageNumber - (Optional) Depending on pageSize and the total number of results, specifying this will display different sets of results. (integer)
keywords - (Optional) Search term as keyword to find within transactions.
startDate - (Optional) The lower limit of the time at which you want to start filtering. (integer - Unix timestamp)
endDate - (Optional) The upper limit of the time at which you want to end filetering. (integer - Unix timestamp)

transactions

var transactions = await client.Transactions.getTransactions(pageSize, pageNumber, keywords, startDate, endDate);
console.log(transactions);

Custom Tables

Get Custom Table Contents

GET api/v2/plugins/{packageID}/custom-tables/{custom-table-name}/ is mapped to CustomTables.getCustomTableContents(body)

custom_table

var body = {
    "pluginId": "string", //The Plug-In ID 
    "tableName": "string" //The table name
};

var custom_table = await client.CustomTables.getCustomTableContents(body);
console.log(custom_table);

Create Row

POST /api/v2/plugins/{packageID}/custom-tables/{custom-table-name}/rows is mapped to CustomTables.createCustomTableRow(body)

new_row

var body = {
    "pluginId": "string", //The Plug-In ID 
    "tableName": "string" //The table name
    "request": {
        "column-name-1": "string",
        "column-name-2": "string"
    }
};

var new_row = await client.CustomTables.createCustomTableRow(body);
console.log(new_row);

Update Row

PUT /api/v2/plugins/{packageID}/custom-tables/{custom-table-name}/rows/{rowId} is mapped to CustomTables.updateCustomTableRow(body)

update_row

var body = {
    "pluginId": "string", //The Plug-In ID 
    "tableName": "string", //The table name
    "rowID": "string",
    "request": {
        "column-name-1": "string",
        "column-name-2": "string"
    }
};

var updated_row = await client.CustomTables.updateCustomTableRow(body);
console.log(update_row);

Delete Row

DELETE /api/v2/plugins/{packageID}/custom-tables/{custom-table-name}/rows/{rowId} is mapped to CustomTables.deleteCustomTableRow(body)

deleted_row

var body = {
    "pluginId": "string", //The Plug-In ID 
    "tableName": "string", //The table name
    "rowID": "string"
};

var deleted_row = await client.CustomTables.deleteCustomTableRow(body);
console.log(deleted_row);

Marketplace

Get Marketplace Info

GET /api/v2/marketplaces/ is mapped to Marketplaces.getMarketplaceInfo()

mp

var mp = await client.Marketplaces.getMarketplaceInfo();
console.log(mp);