Skip to content
/
Get a list of Channels fo...

INSPIRE Public Rest API Documentation. Copyright 2025 Fulfillment WMS. All rights reserved. (1.0)

OpenAPI documentation for API and Auth Rest Services

Detailed API Documentation
Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Proprietary
Languages
Servers
Mock server
https://apidocs.fulfillmentwms.com/_mock/openapi

Dock Appointment Scheduling Service

Dock Appointment Scheduling Services

Operations

Import Service

Services related to importing data

Operations

Reporting, Insights and Metrics Service

Services related to Reporting, Insights and Metrics

Operations

Inventory Service

Services related to Inventory

Operations

Invoice for 3PL Billing Service

Services related to viewing Invoices for 3PL Billing

Operations

Lists Service

Services related to Querying Lists of Objects

Operations

Get a list of Carriers for an Account

Request

Get a list of Carriers for an Account

Security
Authorization
Path
accountIdstring(uuid)required
Query
aliasstring

Search by alies

Default ""
namestring

Search by alias

Default ""
curl -i -X GET \
  'https://apidocs.fulfillmentwms.com/_mock/openapi/v1/api/pub/lists/accounts/{accountId}/carriers/query' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Ok

Bodyapplication/jsonArray [
idstring(uuid)
account_idstring(uuid)
enabledboolean
aliasstring
typestring
Enum"SMALLPARCEL""LTL""FTL""OCEAN""AIR""RAIL"
subtypestring
Enum"FedEx""UPS""USPS""OnTrac""DHL"
package_typestring
service_levelstring
transit_lane_idstring(uuid)
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
    "enabled": true,
    "alias": "string",
    "type": "SMALLPARCEL",
    "subtype": "FedEx",
    "package_type": "string",
    "service_level": "string",
    "transit_lane_id": "392e3c4b-6df9-4d45-9105-e53677d7bf64"
  }
]

Get a list of Channels for an Account

Request

Get a list of Channels for an Account

Security
Authorization
Path
accountIdstring(uuid)required
Query
namestring

Search by name

Default ""
curl -i -X GET \
  'https://apidocs.fulfillmentwms.com/_mock/openapi/v1/api/pub/lists/accounts/{accountId}/channels/query' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Ok

Bodyapplication/jsonArray [
idstring(uuid)
createdbystring
createdonstring(date-time)
modifiedonstring(date-time)
enabledboolean
nodeleteboolean
namestring
descriptionstring
notesstring
tmplt_idstring(uuid)
account_idstring(uuid)
tmpltobject(ChannelTmpltSecureType)
accountobject(AccountAccountSecureType)
channel_facilityobject(ChannelFacilitySecureType)
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "createdby": "string",
    "createdon": "2019-08-24T14:15:22Z",
    "modifiedon": "2019-08-24T14:15:22Z",
    "enabled": true,
    "nodelete": true,
    "name": "string",
    "description": "string",
    "notes": "string",
    "tmplt_id": "0cf10b77-feef-4821-ab9d-66698af376f5",
    "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
    "tmplt": { … },
    "account": { … },
    "channel_facility": { … }
  }
]

Get a list of Customers for an Account

Request

Get a list of Customers for an Account

Security
Authorization
Path
accountIdstring(uuid)required
Query
namestring

Search by name

Default ""
curl -i -X GET \
  'https://apidocs.fulfillmentwms.com/_mock/openapi/v1/api/pub/lists/accounts/{accountId}/customers/query' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Ok

Bodyapplication/jsonArray [
idstring(uuid)
ncodeinteger(int32)
createdbystring
createdonstring(date-time)
modifiedonstring(date-time)
accountidstring
nodeleteboolean
typestring
Enum"ACCOUNT""SHIPTO""CARRIER""SUPPLIER""BILLTO""CONTACT""INVOICETO""PURCHASEDBY"
namestring
descriptionstring
notesstring
saddr1string
saddr2string
saddr3string
saddr4string
scitystring
sstateprovincestring
spostalcodestring
scountrystring
maddr1string
maddr2string
maddr3string
maddr4string
mcitystring
mstateprovincestring
mpostalcodestring
mcountrystring
contact_namestring
contact_phonestring
contact_emailstring
inv_contact_namestring
inv_contact_phonestring
inv_contact_emailstring
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "ncode": 0,
    "createdby": "string",
    "createdon": "2019-08-24T14:15:22Z",
    "modifiedon": "2019-08-24T14:15:22Z",
    "accountid": "string",
    "nodelete": true,
    "type": "ACCOUNT",
    "name": "string",
    "description": "string",
    "notes": "string",
    "saddr1": "string",
    "saddr2": "string",
    "saddr3": "string",
    "saddr4": "string",
    "scity": "string",
    "sstateprovince": "string",
    "spostalcode": "string",
    "scountry": "string",
    "maddr1": "string",
    "maddr2": "string",
    "maddr3": "string",
    "maddr4": "string",
    "mcity": "string",
    "mstateprovince": "string",
    "mpostalcode": "string",
    "mcountry": "string",
    "contact_name": "string",
    "contact_phone": "string",
    "contact_email": "string",
    "inv_contact_name": "string",
    "inv_contact_phone": "string",
    "inv_contact_email": "string"
  }
]

Mobile Tasks Service

Services related to Mobile Tasks

Operations

Receiving Order Service

Services related to Receiving Orders

Operations

Shipping Order Service

Services related to Shipping Orders

Operations

Work/Project Order Service

Services related to Work/Project Orders

Operations

Authentication Service

Services related to authentication

Operations