The Orders API from MyCarrier — 5 operation(s) for orders.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/mycarrier-orders-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Mycarrier Orders API
x-refined-note:
- x-logo differs across the merged source definitions and was not carried
version: '1.0'
description: 'Operations tagged Orders across 2 of this provider''s published API definitions: mycarrier-order-public-api-openapi.json, mycarrier-public-api-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://order-public-api.api.mycarriertms.com
- description: Production
url: https://api.mycarriertms.com
tags:
- name: Orders
paths:
/api/Orders:
post:
tags:
- Orders
summary: Create or Modify Orders
description: Create a new order or update existing by Reference ID
operationId: UploadOrder
parameters:
- name: X-MC-Meta-customerDeviceName
in: header
description: Connector device name (optional connector metadata)
- name: X-MC-Meta-customerInternalRecordId
in: header
description: Connector internal record id (optional connector metadata)
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Requests.UploadOrder.OrderUploadRequest'
application/json:
schema:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Requests.UploadOrder.OrderUploadRequest'
application/*+json:
schema:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Requests.UploadOrder.OrderUploadRequest'
responses:
'200':
description: Request was successfully added to the processing queue
content:
application/json:
schema:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Responses.Result'
'400':
description: Request has missing/invalid values
content:
application/json:
schema:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Responses.Result'
'401':
description: Unauthorized. The username or password provided is incorrect
security:
- {}
servers:
- url: https://order-public-api.api.mycarriertms.com
/api/Orders/{referenceId}:
delete:
tags:
- Orders
summary: Delete Order
description: Delete an order by Reference ID
operationId: DeleteOrder
parameters:
- name: referenceId
in: path
description: Reference ID
required: true
schema:
type: string
responses:
'200':
description: Request was successfully added to the processing queue
content:
application/json:
schema:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Responses.Result'
'400':
description: Request has missing/invalid values
content:
application/json:
schema:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Responses.Result'
'401':
description: Unauthorized. The username or password provided is incorrect
security:
- {}
servers:
- url: https://order-public-api.api.mycarriertms.com
/api/Orders/referenceId/{referenceId}:
get:
tags:
- Orders
summary: Get Order by reference id
description: Get an order by Reference Id
operationId: Order
parameters:
- name: referenceId
in: path
description: Reference Id
required: true
schema:
type: string
responses:
'200':
description: Request was successfully executed
content:
application/json:
schema:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Responses.Models.Order'
'400':
description: Request has missing/invalid values
'401':
description: Unauthorized. The username or password provided is incorrect
'404':
description: Resource not found
security:
- {}
servers:
- url: https://order-public-api.api.mycarriertms.com
/api/v1/orders:
post:
description: Create a new order or update existing by Reference ID
operationId: UploadOrder
parameters:
- in: header
name: Authorization
schema:
type: string
- in: header
name: Content-Type
schema:
type: string
- in: header
name: Environment
schema:
type: string
- in: header
name: X-Mc-Api-Key
schema:
type: string
- description: Connector device name (optional connector metadata)
in: header
name: X-Mc-Meta-Customerdevicename
schema:
type: string
- description: Connector internal record id (optional connector metadata)
in: header
name: X-Mc-Meta-Customerinternalrecordid
schema:
type: string
requestBody:
content:
application/*+json:
schema:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Requests.UploadOrder.OrderUploadRequest'
application/json:
schema:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Requests.UploadOrder.OrderUploadRequest'
application/json-patch+json:
schema:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Requests.UploadOrder.OrderUploadRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Responses.Result'
description: Request was successfully added to the processing queue
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Responses.Result'
description: Request has missing/invalid values
'401':
description: Unauthorized. The username or password provided is incorrect
'500':
description: Internal Server Error
security: []
summary: Create or Modify Orders
tags:
- Orders
servers:
- description: Production
url: https://api.mycarriertms.com
/api/v1/orders/referenceId/{referenceId}:
delete:
description: Delete an order by Reference ID
operationId: DeleteOrder
parameters:
- in: header
name: Authorization
schema:
type: string
- in: header
name: Content-Type
schema:
type: string
- in: header
name: Environment
schema:
type: string
- in: header
name: X-Mc-Api-Key
schema:
type: string
- description: Reference ID
in: path
name: referenceId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Responses.Result'
description: Request was successfully added to the processing queue
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Responses.Result'
description: Request has missing/invalid values
'401':
description: Unauthorized. The username or password provided is incorrect
'500':
description: Internal Server Error
security: []
summary: Delete Order
tags:
- Orders
get:
description: Get an order by Reference Id
operationId: Order
parameters:
- in: header
name: Authorization
schema:
type: string
- in: header
name: Content-Type
schema:
type: string
- in: header
name: Environment
schema:
type: string
- in: header
name: X-Mc-Api-Key
schema:
type: string
- description: Reference Id
in: path
name: referenceId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Responses.Models.Order'
description: Request was successfully executed
'400':
description: Request has missing/invalid values
'401':
description: Unauthorized. The username or password provided is incorrect
'404':
description: Resource not found
'500':
description: Internal Server Error
security: []
summary: Get Order by reference id
tags:
- Orders
servers:
- description: Production
url: https://api.mycarriertms.com
components:
schemas:
MC.Order.Client.Contracts.Responses.Result:
type: object
properties:
isSuccess:
type: boolean
description: Determines if the operation was successful
errorMessages:
type: array
items:
type: string
description: List of error messages
additionalProperties: false
MC.Order.Client.Contracts.Responses.Models.StatusLog:
type: object
properties:
type:
type:
- string
- 'null'
description: Type of the message
message:
type:
- string
- 'null'
description: Message text
additionalProperties: false
MC.Order.Client.Contracts.Requests.UploadOrder.OriginStop:
type: object
properties:
companyName:
maxLength: 64
type: string
description: An optional string to be used in the absence of a locationId value that specifies the name of the company at the origin stop
example: MyCarrier TMS
streetLine1:
maxLength: 64
type: string
description: An optional string to be used in the absence of a locationId value that specifies the primary street address information at the origin stop
example: 598 Virginia Street
streetLine2:
maxLength: 64
type: string
description: An optional string to be used in the absence of a locationId value that specifies the secondary street address information at the origin stop
example: Apartment 123
city:
maxLength: 32
type: string
description: An optional string to be used in the absence of a locationId value that specifies the city at the origin stop
example: River Grove
state:
type: string
description: 'Enum (USA): AL, AK, AZ, AR, CA, CO, CT, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY.<br />Enum (CAN): AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT.<br />An optional string to be used in the absence of a locationId value that specifies a two letter abbreviation of the State or Province at the origin stop'
example: IL
zip:
maxLength: 10
type: string
description: An optional string to be used in the absence of a locationId value that specifies the Postal code at the origin stop
example: '60171'
country:
enum:
- USA
- CAN
type: string
description: Abbreviation of country (using ISO 3166 standards)
default: USA
locationType:
enum:
- Business
- Residential
- Trade Show
- Airport
- Camp
- Church
- Construction Site
- Country Club
- Fair/Amusement/Park
- Farm
- Government Site
- Grocery Warehouse
- Hospital
- Hotel
- Limited Access
- Military Installation
- Mine Site
- Native American Reservation
- Nursing Home
- Pier
- Prison
- Resort
- School
- Self-Storage
- Utility Site
type: string
description: An optional string to be used in the absence of a locationId value that specifies the type of location at the origin stop for identification of limited access locations
default: Business
contactFirstName:
maxLength: 32
type: string
description: An optional string to be used in the absence of a locationId value that specifies the first name of the origin stop contact. May be required for some shipments
example: Jane
contactLastName:
maxLength: 32
type: string
description: An optional string to be used in the absence of a locationId value that specifies the last name of the origin stop contact. May be required for some shipments
example: Wright
contactEmail:
maxLength: 64
type: string
description: An optional string to be used in the absence of a locationId value that specifies the email address of the origin stop contact. May be required for some shipments
example: jane.wright@test.com
contactPhone:
maxLength: 15
type: string
description: An optional non-formatted string to be used in the absence of a locationId value that specifies the telephone number of the origin stop contact. May be required for some shipments
example: (555) 555-1234
ext:
maxLength: 5
type: string
description: An optional numeric only string to be used in the absence of a locationId value that specifies the telephone extension of the origin stop contact if applicable
example: '30'
readyTime:
type: string
description: An optional formatted string to be used in the absence of a locationId value that specifies the time of day local to the origin stop that the origin stop is open to pickups in HH:mm AM or HH:mm PM format
example: 9:00 AM
closeTime:
type: string
description: An optional formatted string to be used in the absence of a locationId value that specifies the time of day local to the origin stop that the origin stop is closed to pickups in HH:mm AM or HH:mm PM format
example: 4:00 PM
instructions:
maxLength: 100
type: string
description: An optional string to be used in the absence of a locationId value that specifies any additional instructions for pickup at the origin stop
example: Some instruction notes
locationID:
maxLength: 64
type: string
description: An optional unique string identifier that can be used to specify a origin stop location that is already saved in the MyCarrier platform
example: My origin locationId
additionalProperties: false
MC.Order.Client.Contracts.Requests.UploadOrder.OrderUploadRequest:
type: object
properties:
orders:
type: array
items:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Requests.UploadOrder.Order'
description: The order(s) payload
additionalProperties: false
MC.Order.Client.Contracts.Responses.Models.EventHistory:
type: object
properties:
status:
type:
- string
- 'null'
description: Order status
dateTime:
type: string
description: Date and time
format: date-time
logs:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Responses.Models.StatusLog'
description: Info messages
additionalProperties: false
MC.Order.Client.Contracts.Requests.UploadOrder.BillingStop:
type: object
properties:
companyName:
maxLength: 64
type: string
description: An optional string to be used in the absence of a locationId value that specifies the name of the company at the destination stop
example: MyCarrier TMS
streetLine1:
maxLength: 64
type: string
description: An optional string to be used in the absence of a locationId value that specifies the primary street address information at the destination stop
example: 598 Virginia Street
streetLine2:
maxLength: 64
type: string
description: An optional string to be used in the absence of a locationId value that specifies the secondary street address information at the destination stop
example: Apartment 123
city:
maxLength: 32
type: string
description: An optional string to be used in the absence of a locationId value that specifies the city at the destination stop
example: River Grove
state:
type: string
description: 'Enum (USA): AL, AK, AZ, AR, CA, CO, CT, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY.<br />Enum (CAN): AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT.<br />An optional string to be used in the absence of a locationId value that specifies a two letter abbreviation of the State or Province at the destination stop'
example: IL
zip:
maxLength: 10
type: string
description: An optional string to be used in the absence of a locationId value that specifies the Postal code at the destination stop
example: '60171'
country:
enum:
- USA
- CAN
type: string
description: Abbreviation of country (using ISO 3166 standards)
default: USA
locationID:
maxLength: 64
type: string
description: An optional unique string identifier that can be used to specify a destination stop location that is already saved in the MyCarrier platform
example: My billing locationId
contactFirstName:
maxLength: 32
type: string
description: An optional string to be used in the absence of a locationId value that specifies the first name of the destination stop contact. May be required for some shipments
example: Jane
contactLastName:
maxLength: 32
type: string
description: An optional string to be used in the absence of a locationId value that specifies the last name of the destination stop contact. May be required for some shipments
example: Wright
contactEmail:
maxLength: 64
type: string
description: An optional string to be used in the absence of a locationId value that specifies the email address of the destination stop contact. May be required for some shipments
example: jane.wright@test.com
contactPhone:
maxLength: 15
type: string
description: An optional non-formatted string to be used in the absence of a locationId value that specifies the telephone number of the destination stop contact. May be required for some shipments
example: (555) 555-1234
locationType:
type:
- string
- 'null'
ext:
type:
- string
- 'null'
readyTime:
type:
- string
- 'null'
closeTime:
type:
- string
- 'null'
instructions:
type:
- string
- 'null'
additionalProperties: false
MC.Order.Client.Contracts.Requests.UploadOrder.Order:
required:
- quoteReferenceID
type: object
properties:
quoteReferenceID:
maxLength: 32
minLength: 1
required:
- quoteReferenceID
type: string
description: A unique identifier that can be used to correlate orders between your source system and the MyCarrier platform
example: Jun-25-2023 432 Rr
serviceType:
enum:
- LTL
type: string
description: A string enumeration that specifies the mode of freight an order will use to quote and dispatch
default: LTL
pickupDate:
type: string
description: A string representation of the date the order should be picked up using MM/dd/YYYY format
default: Current Date
example: 06/25/2023
paymentDirection:
enum:
- Prepaid
- Inbound Collect
- Third Party
- Outbound Collect
type: string
description: A string enumeration that specifies the type of payment this order will use to quote and dispatch
default: Prepaid
carrier:
enum:
- AACT
- ABFS
- AGCE
- ANCF
- AVRT
- BRTC
- BTVP
- BTYT
- CCYQ
- CEVA
- CLNI
- CMFC
- CRVG
- CTBV
- CTII
- CTIIP
- CXIT
- DAFG
- DAYR
- DCHA
- DBDE
- DHRN
- DLDS
- DOLR
- DPHE
- DTST
- DUBL
- DYLT
- EDXI
- EFWW
- EMRG
- EXLA
- FCSY
- FFRT
- FLOK
- FRZF
- FTSC
- FWDN
- FXFD
- FXFE
- FXFR
- GRVE
- GTJN
- HLNF
- HMES
- HRCF
- HWEP
- JPXS
- KUTZ
- LAXV
- LOADS
- MANI
- MGUL
- MIDW
- MIHD
- MOLO
- MONC
- MTJG
- MTVL
- NEMF
- NMTF
- NOPK
- NPME
- OAKH
- ODFL
- OVLD
- PAAF
- PANA
- PENS
- PFEG
- PITD
- PMLI
- POGL
- POLT
- PTWT
- PYLE
- RDFS
- RDWY
- RETL
- RISG
- RIST
- RLCA
- RUDE
- RXIC
- RXO
- SAIA
- SEFL
- SMTL
- STDF
- SUON
- TAXA
- TDTW
- TOTL
- TTFY
- TFIN
- UGFP
- UPGF
- UPPD
- USRD
- UTPA
- VSXP
- WARD
- WAYD
- WAYF
- WLON
- XGSI
- XPOL
type: string
description: An optional string enumeration that specifies the carrier this order will use to quote and dispatch
example: ABFS
carrierService:
enum:
- Standard
- Morning Guaranteed
- Afternoon Guaranteed
type: string
description: An optional string enumeration that specifies the level of service that this order will use to quote and dispatch
default: Standard
specialInstructions:
maxLength: 300
type: string
description: 'Default: Will use the customer settings default special instructions property if set in the customer settings and not specified in the order request object otherwise will be an empty string <br />An optional string message to include in the order that will be sent to the carrier(s) when quoting and dispatching'
example: Further Inspection Required
emergencyContactPersonName:
maxLength: 70
type: string
description: An optional string that specified the full name of the emergency contact if the order contains hazardous materials
example: James Doe
emergencyContactPhone:
maxLength: 15
type: string
description: An optional string that specifies the phone number of the emergency contact if the order contains hazardous materials
example: (555) 555-5555
readyToDispatch:
enum:
- 'YES'
- 'NO'
- 'TRUE'
- 'FALSE'
- Y
- N
- T
- F
- '1'
- '0'
type: string
description: An optional string to be used to proceed with automatic dispatch
default: 'NO'
example: 'Yes'
timeCreated:
type: string
description: An optional string that specifies the date and time an order was created in the source system
example: 06/25/2023 9:00 AM
isVicsBol:
enum:
- 'YES'
- 'NO'
- 'TRUE'
- 'FALSE'
- Y
- N
- T
- F
- '1'
- '0'
type: string
description: An optional string enumeration that specifies if the order should create a standard Bill of Lading or a VICs Bill of Lading when the order is dispatched
default: 'NO'
example: 'Yes'
vicsBolPrefix:
maxLength: 11
type: string
description: An optional string to be used in conjunction with isVicsBol that specifies the prefix to include when generating a VICs Bill of Lading number when an order is dispatched
example: 058645621
proNumber:
type: string
description: An optional string to be used when not utilizing auto-pro/pre-pro functionality to specify the Pro number when an order is dispatched
example: '5968175596'
cargoValue:
type: string
description: 'An optional string to add cargo value to a shipment. Use Whole Numbers (no decimals). Max Value: $250,000'
example: '1234'
transitDays:
type: string
description: An optional string represents the duration (in days) that the freight will be in transit. This parameter will be taken into account during the carrier selection process.
example: '2'
accountNumber:
type: string
description: An optional string represents Bill-To Account Number.
example: CNN75
references:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Requests.UploadOrder.References'
originAccessorials:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Requests.UploadOrder.OriginAccessorials'
destinationAccessorials:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Requests.UploadOrder.DestinationAccessorials'
originStop:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Requests.UploadOrder.OriginStop'
destinationStop:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Requests.UploadOrder.DestinationStop'
billingStop:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Requests.UploadOrder.BillingStop'
quoteUnits:
type: array
items:
$ref: '#/components/schemas/MC.Order.Client.Contracts.Requests.UploadOrder.Unit'
description: A non-optional array of objects that specifies the one or more handling units of different types with different commodities a order contains when an order is quoted or dispatched
additionalProperties: false
MC.Order.Client.Contracts.Requests.UploadOrder.DestinationStop:
type: object
properties:
companyName:
maxLength: 64
type: string
description: An optional string to be used in the absence of a locationId value that specifies the name of the company at the destination stop
example: MyCarrier TMS
streetLine1:
maxLength: 64
type: string
description: An optional string to be used in the absence of a locationId value that specifies the primary street address information at the destination stop
example: 598 Virginia Street
streetLine2:
maxLength: 64
type: string
description: An optional string to be used in the absence of a locationId value that specifies the secondary street address information at the destination stop
example: Apartment 123
city:
maxLength: 32
type: string
description: An optional string to be used in the absence of a locationId value that specifies the city at the destination stop
example: River Grove
state:
type: string
description: 'Enum (USA): AL, AK, AZ, AR, CA, CO, CT, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY.<br />Enum (CAN): AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT.<br />An optional string to be used in the absence of a locationId value that specifies a two letter abbreviation of the State or Province at the destination stop'
example: IL
zip:
maxLength: 10
type: string
description: An optional string to be used in the absence of a locationId value that specifies the Postal code at the destination stop
example: '60171'
country:
enum:
- USA
- CAN
type: string
description: Abbreviation of country (using ISO 3166 standards)
default: USA
locationType:
enum:
- Business
- Residential
- Trade Show
- Airport
- Camp
- Church
- Construction Site
- Country Club
- Fair/Amusement/Park
- Farm
- Government Site
- Grocery Warehouse
- Hospital
- Hotel
- Limited Access
- Military Installation
- Mine Site
- Native American Reservation
- Nursing Home
- Pier
- Prison
- Resort
- School
- Self-Storage
- Utility Site
type: string
description: An optional string to be used in the absence of a locationId value that specifies the type of location at the destination stop for identification of limited access locations
default: Business
contactFirstName:
maxLength: 32
type: string
description: An optional string to be used in the absence of a locationId value that specifies the first name of the destination stop contact. May be required for some shipments
example: Jane
contactLastName:
maxLength: 32
type: string
description: An optional string to be used in the absence of a locationId value that specifies the last name of the destination stop contact. May be required for some shipments
example: Wright
contactEmail:
maxLength: 64
type: string
description: An optional string to be used in the absence of a locationId value that specifies the email address of the destination stop contact. May be required for some shipments
example: jane.wright@test.com
contactPhone:
maxLength: 15
type: string
description: An optional non-formatted string to be used in the absence of a locationId value that specifies the telephone number of the destination stop contact. May be required for some shipments
example: (555) 555-1234
ext:
maxLength: 4
type: string
description: An optional numeric only string to be used in the absence of a locationId value that specifies the telephone extension of the destination stop contact if applicable
example: '30'
readyTime:
type: string
description: An optional formatted string to be used in the absence of a locationId value that specifies the time of day local to the destination stop that the destination stop is open to pickups in HH:mm AM or HH:mm PM format
example: 9:00 AM
closeTime:
type: string
description: An optional formatted string to be
# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mycarrier/refs/heads/main/openapi/mycarrier-orders-api-openapi.yml