MarketTime Public API

https://publicapi.markettime.com/swagger-ui/
Admin
MarketTime Public API is a comprehensive RESTful API for managing sales operations, including...
Tokens:4,462
Snippets:10
Trust Score:8.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### GET /mtpublic/api/v1/{whoAmI}/customers/{whoseInfoDoIWantToGet}

Source: https://publicapi.markettime.com/swagger-ui/index.html

Retrieve detailed information for a specific customer.

```APIDOC
## GET /mtpublic/api/v1/{whoAmI}/customers/{whoseInfoDoIWantToGet}

### Description
Get Customer Details.

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/customers/{whoseInfoDoIWantToGet}

### Parameters
#### Path Parameters
- **whoAmI** (string) - Required - The identifier for the current user or context.
- **whoseInfoDoIWantToGet** (string) - Required - The identifier of the customer to retrieve.
```

--------------------------------

### PUT /mtpublic/api/v1/{whoAmI}/bulk-import/customers

Source: https://publicapi.markettime.com/swagger-ui/index.html

Perform a bulk import of a list of customers.

```APIDOC
## PUT /mtpublic/api/v1/{whoAmI}/bulk-import/customers

### Description
Bulk Import List of Customers.

### Method
PUT

### Endpoint
/mtpublic/api/v1/{whoAmI}/bulk-import/customers

### Parameters
#### Path Parameters
- **whoAmI** (string) - Required - The identifier for the current user or context.
```

--------------------------------

### POST /mtpublic/api/v1/{whoAmI}/divisions

Source: https://publicapi.markettime.com/swagger-ui/index.html

Create a new RepGroup division.

```APIDOC
## POST /mtpublic/api/v1/{whoAmI}/divisions

### Description
Create a new RepGroup division.

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/divisions

### Parameters
#### Path Parameters
- **whoAmI** (string) - Required - The identifier for the current user or context.
```

--------------------------------

### Version API

Source: https://publicapi.markettime.com/swagger-ui/index.html

Endpoint to retrieve the current version of the API.

```APIDOC
## GET /mtpublic/api/v1/version

### Description
Get Version

### Method
GET

### Endpoint
/mtpublic/api/v1/version
```

--------------------------------

### Item API Endpoints

Source: https://publicapi.markettime.com/swagger-ui/index.html

Endpoints for retrieving and managing item information, including details, pricing, inventory, and images.

```APIDOC
## GET /mtpublic/api/v1/{whoAmI}/items

### Description
Get List of Items

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/items

## GET /mtpublic/api/v1/{whoAmI}/items/{itemID}

### Description
Get List of Items by ItemID

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/items/{itemID}

## GET /mtpublic/api/v1/{whoAmI}/items/pricing

### Description
Get List of Item Pricing Detail

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/items/pricing

## GET /mtpublic/api/v1/{whoAmI}/items/pricing/{itemID}

### Description
Get Item Pricing Detail

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/items/pricing/{itemID}

## GET /mtpublic/api/v1/{whoAmI}/items/priceCodes

### Description
Get List of Item PriceCodes Details

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/items/priceCodes

## GET /mtpublic/api/v1/{whoAmI}/items/priceCodes/{itemID}

### Description
Get List of Item PriceCode Detail

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/items/priceCodes/{itemID}

## GET /mtpublic/api/v1/{whoAmI}/items/inventory

### Description
Get List of Item Inventory Detail

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/items/inventory

## GET /mtpublic/api/v1/{whoAmI}/items/inventory/{itemID}

### Description
Get Item Inventory Detail

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/items/inventory/{itemID}

## GET /mtpublic/api/v1/{whoAmI}/items/images

### Description
Get List of Item Images

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/items/images

## GET /mtpublic/api/v1/{whoAmI}/items/images/{itemID}

### Description
Get Item Image

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/items/images/{itemID}

## GET /mtpublic/api/v1/{whoAmI}/items/categories/{itemID}

### Description
Get List of Item Categories

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/items/categories/{itemID}

## POST /mtpublic/api/v1/{whoAmI}/items

### Description
Create New Item

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/items

## POST /mtpublic/api/v1/{whoAmI}/items/{itemID}/itemcategory

### Description
Create New Item Category

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/items/{itemID}/itemcategory

## POST /mtpublic/api/v1/{whoAmI}/items/import

### Description
Import Items for Company

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/items/import

## POST /mtpublic/api/v1/{whoAmI}/items/get

### Description
Get List of Items, with Optional Query Filters

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/items/get

## PUT /mtpublic/api/v1/{whoAmI}/items/{whatItemDoIWantToUpdate}

### Description
Update Item

### Method
PUT

### Endpoint
/mtpublic/api/v1/{whoAmI}/items/{whatItemDoIWantToUpdate}

## PUT /mtpublic/api/v1/{whoAmI}/items/volumePricing/upsert

### Description
Insert or Update Item Volume Pricing

### Method
PUT

### Endpoint
/mtpublic/api/v1/{whoAmI}/items/volumePricing/upsert

## PUT /mtpublic/api/v1/{whoAmI}/items/upsert

### Description
Insert or Update Item

### Method
PUT

### Endpoint
/mtpublic/api/v1/{whoAmI}/items/upsert

## PUT /mtpublic/api/v1/{whoAmI}/items/priceCode/upsert

### Description
Insert or Update Item PriceCode

### Method
PUT

### Endpoint
/mtpublic/api/v1/{whoAmI}/items/priceCode/upsert
```

--------------------------------

### Orders API Endpoints

Source: https://publicapi.markettime.com/swagger-ui/index.html

Endpoints for managing order information, including tracking, details, creation, and updates.

```APIDOC
## GET /mtpublic/api/v1/{whoAmI}/orders/{orderId}/trackingdetails/get

### Description
Get List of Order Shipment Details

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/orders/{orderId}/trackingdetails/get

## GET /mtpublic/api/v1/{whoAmI}/orders/orderdetails

### Description
Get List of Order Details

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/orders/orderdetails

## GET /mtpublic/api/v1/{whoAmI}/orders/orderdetails/{detailID}

### Description
Get Order Detail

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/orders/orderdetails/{detailID}

## POST /mtpublic/api/v1/{whoAmI}/orders

### Description
Create New Order

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/orders

## POST /mtpublic/api/v1/{whoAmI}/orders/{whatOrderInfoToGet}/orderChangesHistory/get

### Description
Get Order Changes History for an Order, with Optional Query Filters

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/orders/{whatOrderInfoToGet}/orderChangesHistory/get

## POST /mtpublic/api/v1/{whoAmI}/orders/{orderId}/trackingdetails

### Description
Create New Order Shipment

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/orders/{orderId}/trackingdetails

## POST /mtpublic/api/v1/{whoAmI}/orders/get

### Description
Get List of Orders, with Optional Query Filters

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/orders/get

## PUT /mtpublic/api/v1/{whoAmI}/orders/{whatOrderDoIWantToUpdate}

### Description
Update Order

### Method
PUT

### Endpoint
/mtpublic/api/v1/{whoAmI}/orders/{whatOrderDoIWantToUpdate}

## PUT /mtpublic/api/v1/{whoAmI}/orders/{orderID}/orderdetails/upsert

### Description
Upsert Order Details

### Method
PUT

### Endpoint
/mtpublic/api/v1/{whoAmI}/orders/{orderID}/orderdetails/upsert

## PUT /mtpublic/api/v1/{whoAmI}/orders/trackingdetails/{trackingDetailID}

### Description
Update Order Shipment

### Method
PUT

### Endpoint
/mtpublic/api/v1/{whoAmI}/orders/trackingdetails/{trackingDetailID}
```

--------------------------------

### Documents API

Source: https://publicapi.markettime.com/swagger-ui/index.html

Endpoints for managing and downloading documents, including uploads and catalog operations.

```APIDOC
## GET /mtpublic/api/v1/{whoAmI}/documents/{documentID}/download

### Description
Download Single Document

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/documents/{documentID}/download
```

```APIDOC
## POST /mtpublic/api/v1/{whoAmI}/documents/get

### Description
Get List of Documents, with Optional Query Filters

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/documents/get
```

```APIDOC
## POST /mtpublic/api/v1/{whoAmI}/documents/catalog/uploadPageImage

### Description
Upload Image for PDF File

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/documents/catalog/uploadPageImage
```

```APIDOC
## POST /mtpublic/api/v1/{whoAmI}/documents/catalog/uploadPDF

### Description
Upload PDF File to the Catalog

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/documents/catalog/uploadPDF
```

```APIDOC
## POST /mtpublic/api/v1/{whoAmI}/documents/catalog/publish

### Description
Publish Catalog

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/documents/catalog/publish
```

```APIDOC
## POST /mtpublic/api/v1/{whoAmI}/documents/catalog/create

### Description
Create S3 Folder for Catalog

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/documents/catalog/create
```

```APIDOC
## POST /mtpublic/api/v1/{whoAmI}/documents/catalog/createPDFFromImages

### Description
Create PDF from Images

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/documents/catalog/createPDFFromImages
```

```APIDOC
## POST /mtpublic/api/v1/{whoAmI}/documents/catalog/createHotspots

### Description
Create Hotspots in Catalog PDF

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/documents/catalog/createHotspots
```

--------------------------------

### Manufacturer API Endpoints

Source: https://publicapi.markettime.com/swagger-ui/index.html

Endpoints for retrieving and managing manufacturer information, including details, territories, and pricing.

```APIDOC
## GET /mtpublic/api/v1/{whoAmI}/manufacturers

### Description
Get List of Manufacturers

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/manufacturers

## GET /mtpublic/api/v1/{whoAmI}/manufacturers/{whoseInfoDoIWantToGet}

### Description
Get Manufacturer Details

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/manufacturers/{whoseInfoDoIWantToGet}

## GET /mtpublic/api/v1/{whoAmI}/manufacturers/{whoseInfoDoIWantToGet}/territories

### Description
Get List of RepGroup Manufacturer Territory with Division by ManufacturerID

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/manufacturers/{whoseInfoDoIWantToGet}/territories

## GET /mtpublic/api/v1/{whoAmI}/manufacturers/{whoseInfoDoIWantToGet}/pricecodes

### Description
Get List of Manufacturers PriceCodes

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/manufacturers/{whoseInfoDoIWantToGet}/pricecodes

## GET /mtpublic/api/v1/{whoAmI}/manufacturers/{whoseInfoDoIWantToGet}/paymentterms

### Description
Get List of Manufacturers Payment Terms

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/manufacturers/{whoseInfoDoIWantToGet}/paymentterms

## GET /mtpublic/api/v1/{whoAmI}/manufacturers/{whoseInfoDoIWantToGet}/paymentgateways

### Description
Get List of Manufacturers Payment Gateways

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/manufacturers/{whoseInfoDoIWantToGet}/paymentgateways

## GET /mtpublic/api/v1/{whoAmI}/manufacturers/{whoseInfoDoIWantToGet}/itemcategories

### Description
Get List of Manufacturers Item Categories

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/manufacturers/{whoseInfoDoIWantToGet}/itemcategories

## GET /mtpublic/api/v1/{whoAmI}/manufacturers/{whoseInfoDoIWantToGet}/categories

### Description
Get List of Manufacturers Categories

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/manufacturers/{whoseInfoDoIWantToGet}/categories

## GET /mtpublic/api/v1/{whoAmI}/manufacturers/territories

### Description
Get List of RepGroup Manufacturer Territory with Division

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/manufacturers/territories

## GET /mtpublic/api/v1/{whoAmI}/manufacturers/shippingMethods

### Description
Get List of Manufacturers Shipping Methods

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/manufacturers/shippingMethods

## POST /mtpublic/api/v1/{whoAmI}/manufacturers

### Description
Create New Manufacturer

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/manufacturers

## POST /mtpublic/api/v1/{whoAmI}/manufacturers/pricecode/upsert

### Description
Insert or Update Manufacturer Price Code

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/manufacturers/pricecode/upsert

## POST /mtpublic/api/v1/{whoAmI}/manufacturers/get

### Description
Get list of Manufacturers, with Optional Query Filters

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/manufacturers/get

## POST /mtpublic/api/v1/{whoAmI}/manufacturers/category

### Description
Create New Manufacturer Category

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/manufacturers/category

## PUT /mtpublic/api/v1/{whoAmI}/manufacturers/{whoseInfoDoIWantToUpdate}

### Description
Update Manufacturer

### Method
PUT

### Endpoint
/mtpublic/api/v1/{whoAmI}/manufacturers/{whoseInfoDoIWantToUpdate}
```

--------------------------------

### Payments API

Source: https://publicapi.markettime.com/swagger-ui/index.html

Endpoints for managing payment transactions, including processing, refunds, and receipt downloads.

```APIDOC
## GET /mtpublic/api/v1/{whoAmI}/payments/{chargeID}/receipt

### Description
Download Process Payment Receipt

### Method
GET

### Endpoint
/mtpublic/api/v1/{whoAmI}/payments/{chargeID}/receipt
```

```APIDOC
## POST /mtpublic/api/v1/{whoAmI}/payments/scheduleProcessPayment

### Description
Process Schedule Transaction

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/payments/scheduleProcessPayment
```

```APIDOC
## POST /mtpublic/api/v1/{whoAmI}/payments/requestPaymentUpdate

### Description
Process Request Payment Update

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/payments/requestPaymentUpdate
```

```APIDOC
## POST /mtpublic/api/v1/{whoAmI}/payments/refund

### Description
Process Payment Refund

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/payments/refund
```

```APIDOC
## POST /mtpublic/api/v1/{whoAmI}/payments/processPayment

### Description
Process Normal Transaction

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/payments/processPayment
```

```APIDOC
## POST /mtpublic/api/v1/{whoAmI}/payments/preAuthProcessPayment

### Description
Process pre auth for a third-party payment gateway

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/payments/preAuthProcessPayment
```

```APIDOC
## POST /mtpublic/api/v1/{whoAmI}/payments/preAuthCapturePayment

### Description
Capture payment of an existing pre auth

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/payments/preAuthCapturePayment
```

--------------------------------

### Salesperson API Endpoints

Source: https://publicapi.markettime.com/swagger-ui/index.html

Endpoints related to managing salesperson data, including creation, retrieval, and updates.

```APIDOC
## POST /mtpublic/api/v1/{whoAmI}/salespersons/manufacturers

### Description
Create New RepGroup Salesperson Manufacturers

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/salespersons/manufacturers

## POST /mtpublic/api/v1/{whoAmI}/salespersons

### Description
Create New Salesperson

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/salespersons

## POST /mtpublic/api/v1/{whoAmI}/salespersons/{whoseInfoDoIWantToGet}/territorydivisions/get

### Description
Get List of Salesperson Territory Divisions, with Optional Query Filters

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/salespersons/{whoseInfoDoIWantToGet}/territorydivisions/get

## POST /mtpublic/api/v1/{whoAmI}/salespersons/{whoseInfoDoIWantToGet}/territory/get

### Description
Get List of Salesperson Territories, with Optional Query Filters

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/salespersons/{whoseInfoDoIWantToGet}/territory/get

## POST /mtpublic/api/v1/{whoAmI}/salespersons/manufacturers/get

### Description
Get List of RepGroup Salesperson Manufacturers, with Optional Query Filters

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/salespersons/manufacturers/get

## POST /mtpublic/api/v1/{whoAmI}/salespersons/get

### Description
Get List of Salespersons, with Optional Query Filters

### Method
POST

### Endpoint
/mtpublic/api/v1/{whoAmI}/salespersons/get

## PUT /mtpublic/api/v1/{whoAmI}/salespersons/{whoseInfoDoIWantToUpdate}

### Description
Update Salesperson

### Method
PUT

### Endpoint
/mtpublic/api/v1/{whoAmI}/salespersons/{whoseInfoDoIWantToUpdate}

## PUT /mtpublic/api/v1/{whoAmI}/salespersons/manufacturers

### Description
Update RepGroup Salesperson Manufacturers

### Method
PUT

### Endpoint
/mtpublic/api/v1/{whoAmI}/salespersons/manufacturers
```
Tokens:
Raw