MarketTime API Documentation
Welcome to the MarketTime API Documentation. Thank you for your interest in learning about the MarketTime API!
Introduction:
MarketTime offers a suite of APIs that empower developers to efficiently and securely move data in and out of the MarketTime application. The APIs allow developers to read and write user data, interoperate with other systems and platforms, and serve to extend the platform's built-in features. The APIs enable numerous use cases for Brands and Sales Agencies, and provide endpoints for all key data elements contained in the MarketTime platform, including: Orders, Items, Item Images, Invoices, Customers, Salespeople, Manufacturers, and Sales Agencies This documentation provides comprehensive information about how to use the MarketTime APIs effectively and integrate them seamlessly into your applications.
Getting Started:
To get started, you’ll need an API key, which you can obtain by contacting MarketTime here. Once you have your API key, you can explore the various endpoints and functionality offered by the API.
Domain Name: https://api.reptimeqa.com/
MarketTime API List
For Importing Items for manufacturers :
POST/reptime/public/api/retailers/import/items/{brandID}
| Name | Description |
brandID *required string (path) | manufacturerID Ex:M1 generated by Markettime |
importedItems *required object (body) | Pass list of Item Import as request example in model (refer below response example for more details) Click here for Example |
replace string (query) | replace Y removes all the current items existing in the account and adds the current ones. And replace N only updates the item if it already exists in the DB |
replaceSCS *required string (query) | replaceSCS Y removes all the existing style color size values of an item and adds the current SCS details for an item. And replaceSCS N only updates the existing SCS details Default value : N |
rtBarcode *required string (query) | rtBarcode Y generates the UPC3 code of an item and updates it. N keeps the old one if there is a value already exists if not generates the new one Default value : N |
x-api-key string (header) | add x-api-key of manufacturer |
| Code | Description |
200 | OK Click here for Example |
201 | Created |
401 | Unauthorized |
Importing Item Images for a Manufacturer:
POST/import/manufacturers/{companyID}/items/image
| Name | Description |
Brief Information (Help Tips) | Utilize this API to mass import images for an approved manufacturer. |
companyID *required string (path) | manufacturerID Ex:M1 generated by Markettime |
Item Images *required object (body) | Object of ItemImages Click here for Example |
x-api-key string (header) | add x-api-key of manufacturer |
| Code | Description |
200 | OK |
201 | Created |
401 | Unauthorized |
For updating Item inventory details like NextAvailableDate,IsAvailable and QtyAvailable :
POST/reptime/public/api/import/manufacturers/{companyID}/inventory
| Name | Description |
companyID *required string (path) | companyID generated by Markettime |
inventoryUpdate *required object (body) | pass Array of objects shown in the example Click here for Example |
x-api-key string (header) | add x-api-key of company |
| Code | Description |
200 | OK Click here for Example |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
For updating Manufacturer order status & RepGroup Order Status :
POST/reptime/public/api/import/{companyID}/orders/{orderID}/status/update
| Name | Description |
companyID *required string (path) | Add companyID of manufacturer and repgroup generated by Markettime Ex. M1 or R1 |
orderID *required string (path) | Add orderID of order i,e publicID or externalID of order |
status string (body) | Add repgroup/manufacturer order status Ex. For a repgroup, a valid status is one of the following (case insensitive): - Cancelled - Complete - Confirmed - Invoiced - Open - Paid - Quote - Rep Paid - Transmitted For manufacturer,a valid status is one of the following (case insensitive): - Backorder - Cancelled - Complete - Modified - On Hold - Open - Pending - Processed - Received - Shipped |
x-api-key string (header) | Add x-api-key of company |
| Code | Description |
200 | OK Click here for Example |
400 | Bad Request |
401 | Unauthorized |
For updating Manufacturer order notes :
POST/reptime/public/api/import/{companyID}/orders/{orderID}/mfrnotes
| Name | Description |
companyID *required string (path) | Add companyID for updating manufacturer notes |
orderID *required string (path) | Add orderID of order i,e publicID or externalID of order |
notes string (body) | Add manufacturer notes for order Ex. order has been received. |
x-api-key string (header) | Add x-api-key of company |
| Code | Description |
200 | OK Click here for Example |
400 | Bad Request |
401 | Unauthorized |
For retrieving orders based on the status of orders :
GET/reptime/public/api/orders/export/{companyID}/status/{orderStatus}
| Name | Description |
companyID *required string (path) | Add companyID generated by Markettime Ex.M1,R1 and B1 |
orderStatus *required string (path) | Add order status like (case insensitive): - Cancelled - Complete - Confirmed - Invoiced - Open - Paid - Quote - Rep Paid - Transmitted - Backorder - Cancelled - Complete - Modified - On Hold - Open - Pending - Processed - Received - Shipped |
sendNotification boolean (query) | Add True/False, True to send notification mail to assigned salesperson and orderwriter of order |
updateStatus boolean (query) | Add True/False, update the status of order Ex. It will update if manufacturer order status from OPEN to RECEIVED and also send notification if sendNotification is set TRUE Default Value : true |
x-api-key string (header) | Add x-api-key of company |
| Code | Description |
200 | OK Click here for Example |
400 | Bad Request |
401 | Unauthorized |
Get number of open or new orders :
GET/reptime/public/api/orders/export/{companyID}/count
| Name | Description |
companyID *required string (path) | Add companyID (ex. M1, R1 or B1) generated by Markettime. |
x-api-key string (header) | Add x-api-key of company |
| Code | Description |
200 | OK Click here for Example |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Get all orders of OPEN Status :
GET/reptime/public/api/orders/export/{companyID}/open
| Name | Description |
companyID *required string (path) | Add companyID (ex. M1 or R1) generated by Markettime. |
x-api-key string (header) | Add x-api-key of company |
| Code | Description |
200 | OK Click here for Example |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Get Salesperson Listing by Sales Agency ID:
GET/reptime/public/api/salsepeople/{manufacturerID}/{repgroupID}
| Name | Description |
Brief Information (Help Tips) | Utilize this API to retrieve list of salespeople in the approved sales agency. |
manufacturerID *required string (path) | manufacturerID Ex:M1 generated by Markettime |
repGroupID *required string (path) | repGroupID Ex:R1 generated by Markettime |
x-api-key string (header) | add x-api-key of manufacturer |
| Code | Description |
200 | OK Click here for Example |
201 | Created |
401 | Unauthorized |
To update the customer information for particular repgroup like accountNumber, mim reorder amount, shipToAccountNumber :
POST/reptime/public/api/retailers/import/retailerManufacturer/{companyID}
| Name | Description |
companyID *required string (path) | Add company ID (ex. M1) generated by Markettime |
repGroupRetailerManufacturer object (body) | add RepGroupRetailerManufacturer object Click here for Example |
x-api-key string (header) | Add x-api-key of companyID |
| Code | Description |
200 | OK Click here for Example |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
For updating Order tracking details like trackinglink,shippingMethodForTracking and sentTrackingNumber :
POST/reptime/public/api/import/{companyID}/order/{orderID}/invoice/trackingdetail/update
| Name | Description |
brandID *required string (path) | add manufacturerID Ex.M1 generated by Markettime |
orderID *required string (path) | Add orderID of order i,e externalID of order |
order *required object (body) | Add order detail Click here for Example |
x-api-key string (header) | Add x-api-key of company |
| Code | Description |
200 | OK Click here for Example |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
For Importing invoice & commission :
POST/reptime/public/api/import/{repGroupID}/{manufacturerID}/invoices
| Name | Description |
commissionsImport object (body) | pass list of commission import Click here for Example |
manufacturerID *required string (path) | Add manufacturerID ex:M1 |
repGroupID *required string (path) | Add repGroupID ex:R1 |
| Code | Description |
200 | OK Click here for Example |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
For updating the status of the order :
POST/reptime/public/api/import/{companyID}/orders/{orderID}/status/update
| Name | Description |
companyID *required string (path) | Add companyID generated by Markettime Ex.M1,R1 and B1 |
orderID *required string (path) | Add orderID of order i,e externalID of order |
status *required (body) | Pass order status which you want to change for particular order string |
x-api-key string (header) | add x-api-key of manufacturer |
| Code | Description |
200 | Return true if record updated successfully and return false if record not updated successfully Click here for Example |
201 | Created |
401 | Unauthorized |
For getting the count of the retailers :
GET/reptime/public/api/retailers/export/{manufacturerID}/new/count
| Name | Description |
manufacturerID *required string (path) | manufacturerID Ex:M1 generated by Markettime |
x-api-key string (header) | add x-api-key of manufacturer |
| Code | Description |
200 | Return count of retailers Click here for Example |
201 | Created |
401 | Unauthorized |
For getting the list of the retailers :
GET/reptime/public/api/retailers/export/{manufacturerID}/new
| Name | Description |
manufacturerID *required string (path) | manufacturerID Ex:M1 generated by Markettime |
x-api-key string (header) | add x-api-key of manufacturer |
| Code | Description |
200 | Return count of retailers Click here for Example |
201 | Created |
401 | Unauthorized |
To update the tracking details of the order :
POST/reptime/public/api/import/{brandID}/order/{orderID}/trackingdetail/update
| Name | Description |
order *required object (body) | add Order object Click here for Example |
brandID *required string (path) | add manufacturerID Ex.M1 generated by Markettime |
orderID *required string (path) | Add orderID of order i,e externalID of order |
| Code | Description |
200 | OK Click here for Example |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Updating Billing & Shipping Account Numbers (with ability to add NEW retailers)
POST/reptime/public/api/retailers/import/repGroupRetailerManufacturer/{manufacturerID}/{repGroupID}
| Name | Description |
Brief Information (Help Tips) | Utilize this API to add or update the retailer Billing or Shipping Account Numbers based on the Billing (Name, Address, Zip) OR based on the Shipping Information (Name, Address, Zip). This API only updates these BillTo and ShipTo Account Number fields, if the retailer is not found the system will automatically add the retailer and apply the respective account numbers. |
manufacturerID *required string (path) | manufacturerID Ex:M1 generated by Markettime |
repGroupID *required string (path) | repGroupID Ex:R1 generated by Markettime |
retailerImportLegacy *required object (body) | pass list of retailers request example in model (refer below response example for more details) Click here for Examplename: BillToName of retailer(Mandatory In case if ShipToName & ZipCode are missing) address1: BillToAddress#1 of the retailer (Optional, But helpful for precise search) address2: BillToAddress#2 for retailer city: add city of retailers state: enter state of retailers zip: enter billToZip of retailers is required(Mandatory In case if SipToName & ShipToZipCode are missing) country: enter country of retailers shipName: enter shipToName of retailers is required(Mandatory**) shipAddress1: enter shipAddress1 of retailers is required (Optional, But helpful for precise search) shipCity: enter shipCity of retailers shipState: enter shipState of retailers shipZip: enter shipZip of retailers is required(Mandatory**) shipCountry: enter shipCountry of retailers accountNumber: enter bill to account of retailers (Mandatory) shipToAccountNumber: enter ship to account of retailers (Mandatory) |
x-api-key string (header) | add x-api-key of manufacturer |
| Code | Description |
200 | OK Click here for Exampleerror: returns the list of retailers which are not imported with error message (i,e if it returns empty list all retailers are imported successfully) |
401 | invaid apikey or manufacturerID |
400 | repGroupID or manufacturerID not found |
For Importing Item Images for an item pass List of item image object
POST/import/manufacturers/{companyID}/items/imagesUpload
| Name | Description |
companyID *required string (path) | manufacturerID Ex:M1 generated by Markettime |
Item Images *required object (body) | List of ItemImages Object Click here for Example |
x-api-key string (header) | add x-api-key of manufacturer |
| Code | Description |
200 | OK |
201 | Created |
401 | Unauthorized |