Skip to content
/
Get Shipping Order By Id

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

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

Get Shipping Order By Id

Request

Get Shipping Order By Id

Security
Authorization
Path
orderIdstring(uuid)required
curl -i -X GET \
  'https://apidocs.fulfillmentwms.com/_mock/openapi/v1/api/pub/order/orders/{orderId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Ok

Bodyapplication/json
idstring(uuid)
orderhdr_idstring(uuid)
order_numberstring
po_numberstring
so_numberstring
swcstring
startdtstring(date-time)
canceldtstring(date-time)
planneddtstring(date-time)
supplier_idstring(uuid)
carrier_idstring(uuid)
shipto_idstring(uuid)
markfor_idstring(uuid)
orderedby_idstring(uuid)
billfreightto_idstring(uuid)
billfreighttermsstring
Enum"SENDER""RECIPIENT""THIRD_PARTY""THIRD_PARTY_CONSIGNEE""COLLECT"
trailer_idstring(uuid)
chassis_idstring(uuid)
truck_idstring(uuid)
order_parcel_idstring(uuid)
appt_idstring(uuid)
hdrobject(OrderHdrSecureType)
shiptoobject(AccountSecureType)
markforobject(AccountSecureType)
orderedbyobject(AccountSecureType)
billfreighttoobject(AccountSecureType)
palletsArray of objects(OrderShipHdrPalletsViewSecureType)unique
ctnsArray of objects(OrderShipHdrCtnsViewSecureType)unique
returnsArray of objects(OrderLineReturnSecureType)
trailerobject(OrderHdrEquipSecureType)
chassisobject(OrderHdrEquipSecureType)
truckobject(OrderHdrEquipSecureType)
carrierobject(AccountCarrierSecureType)
order_parcelobject(OrderParcelSecureType)
apptobject(DockAppointmentsSecureType)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "orderhdr_id": "fcbe07ea-8d6c-49af-8aae-61a11b0dc975",
  "order_number": "string",
  "po_number": "string",
  "so_number": "string",
  "swc": "string",
  "startdt": "2019-08-24T14:15:22Z",
  "canceldt": "2019-08-24T14:15:22Z",
  "planneddt": "2019-08-24T14:15:22Z",
  "supplier_id": "3cb1e20c-c6c9-4e71-ba66-399c468f697c",
  "carrier_id": "48e94619-563d-402c-b442-97b2c8fb116b",
  "shipto_id": "6aeb979e-223b-4e3a-875b-e72ab6f16edd",
  "markfor_id": "98f5fb5c-34ba-4fb0-8971-c7f5d5fbe89c",
  "orderedby_id": "b84f43c5-cf04-4f30-bda2-66e41b997b94",
  "billfreightto_id": "fc26f79c-64cf-4028-b044-68d9c779ac73",
  "billfreightterms": "SENDER",
  "trailer_id": "97e29c62-c50b-4b0c-96e3-bd5143739e18",
  "chassis_id": "d2407ce7-9a09-4c19-a766-239486331a8d",
  "truck_id": "323c15aa-b996-4e49-8db5-4aff1b8dd3ec",
  "order_parcel_id": "df596f9a-f648-43a0-9b8a-17d843daf5b6",
  "appt_id": "174bf154-0543-4ed1-8217-69feeed19483",
  "hdr": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "createdby": "string",
    "createdon": "2019-08-24T14:15:22Z",
    "modifiedon": "2019-08-24T14:15:22Z",
    "trans_number": "string",
    "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
    "internalstatus": "PENDING",
    "internaltype": "PO",
    "priority": "LOW",
    "Facility Requested": "2c279f6b-03b3-42cf-9c01-61c040aa1285",
    "requestedcompdt": "2019-08-24T14:15:22Z",
    "actualcompdt": "2019-08-24T14:15:22Z",
    "sourcetxt": "string",
    "Channel": "18744e1a-a956-41a8-9581-0fe67b83fb14",
    "country_flag": "string",
    "account": { … },
    "facility_requested": { … },
    "channel": { … }
  },
  "shipto": {
    "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"
  },
  "markfor": {
    "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"
  },
  "orderedby": {
    "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"
  },
  "billfreightto": {
    "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"
  },
  "pallets": [
    { … }
  ],
  "ctns": [
    { … }
  ],
  "returns": [
    { … }
  ],
  "trailer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "equip_type": "CONTAINER_20",
    "equip_number": "string"
  },
  "chassis": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "equip_type": "CONTAINER_20",
    "equip_number": "string"
  },
  "truck": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "equip_type": "CONTAINER_20",
    "equip_number": "string"
  },
  "carrier": {
    "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"
  },
  "order_parcel": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "createdby": "string",
    "createdon": "2019-08-24T14:15:22Z",
    "modifiedon": "2019-08-24T14:15:22Z",
    "mode": "string",
    "service": "string",
    "carrier_account": "string",
    "rate": 0,
    "rate_denom_id": "e1ffa20a-913c-4a15-9438-9ee9722d1a60",
    "retail_rate": 0,
    "retail_rate_denom_id": "96325d62-4ed3-4af6-929e-4ccb80064af7",
    "list_rate": 0,
    "list_rate_denom_id": "f29d474f-a61f-4d33-ab99-97218f8865ad",
    "insurance_rate": 0,
    "insurance_rate_denom_id": "b875ce78-922f-4325-8b85-cc81b32bcc0f",
    "status": "string",
    "has_return_label": true,
    "return_label_id": "3172f41b-51dc-48cb-be53-8fec44e33324",
    "err_msg": "string",
    "rate_denom": { … },
    "retail_rate_denom": { … },
    "list_rate_rate_denom": { … },
    "insurance_rate_rate_denom": { … },
    "return_label": { … },
    "options": [ … ]
  },
  "appt": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "createdby": "string",
    "createdon": "2019-08-24T14:15:22Z",
    "modifiedon": "2019-08-24T14:15:22Z",
    "status": "PENDING",
    "facility_id": "82d24387-b696-4928-8926-f6f7f16d3353",
    "dock_door_id": "107cedae-aba2-40b2-be17-6d2613906e8c",
    "appt_duration": 0,
    "apptstart_rangedt": "2019-08-24T14:15:22Z",
    "apptend_rangedt": "2019-08-24T14:15:22Z",
    "apptstartdt": "2019-08-24T14:15:22Z",
    "apptenddt": "2019-08-24T14:15:22Z",
    "actualstartdt": "2019-08-24T14:15:22Z",
    "actualenddt": "2019-08-24T14:15:22Z",
    "driver_checkindt": "2019-08-24T14:15:22Z",
    "driver_name": "string",
    "driver_licensenum": "string",
    "driver_licensest": "string",
    "driver_licenseexp": "2019-08-24T14:15:22Z",
    "driver_licenseclass": "string",
    "driver_addr1": "string",
    "driver_addr2": "string",
    "driver_addr3": "string",
    "driver_city": "string",
    "driver_stateprovince": "string",
    "driver_postalcode": "string",
    "driver_country": "string",
    "driver_license_image_url": "string",
    "appt_schedule_select_url": "string",
    "appt_schedule_selectdt": "2019-08-24T14:15:22Z",
    "dock_door": { … },
    "facility": { … }
  }
}

Get All Shipping Orders

Request

Get All Shipping Orders

Security
Authorization
Body*/*
facilitiesArray of strings(uuid)
accountsArray of strings(uuid)
itemsArray of strings(uuid)
lotsArray of strings
sublotsArray of strings
lpnsArray of strings
channelsArray of strings(uuid)
orderNumberstring
poNumberstring
soNumberstring
swcstring
shipToContainsstring
markForContainsstring
transNumberstring
carriersArray of strings(uuid)
createdOnFromstring(date-time)
createdOnTostring(date-time)
shippedOnFromstring(date-time)
shippedOnTostring(date-time)
statusesArray of strings
Items Enum"PENDING""INTRANSIT""OPEN""HOLD""WAITING_PUTAWAY""PUTTINGAWAY""PUTAWAY""WAITING_RESERVE""RESERVED""WAITING_PICK"
startdtFromstring(date-time)
startdtTostring(date-time)
canceldtFromstring(date-time)
canceldtTostring(date-time)
planneddtFromstring(date-time)
planneddtTostring(date-time)
curl -i -X POST \
  https://apidocs.fulfillmentwms.com/_mock/openapi/v1/api/pub/order/orders/query \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: */*' \
  -d '[object Object]'

Responses

Ok

Bodyapplication/jsonArray [
idstring(uuid)
orderhdr_idstring(uuid)
order_numberstring
po_numberstring
so_numberstring
swcstring
startdtstring(date-time)
canceldtstring(date-time)
planneddtstring(date-time)
supplier_idstring(uuid)
carrier_idstring(uuid)
shipto_idstring(uuid)
markfor_idstring(uuid)
orderedby_idstring(uuid)
billfreightto_idstring(uuid)
billfreighttermsstring
Enum"SENDER""RECIPIENT""THIRD_PARTY""THIRD_PARTY_CONSIGNEE""COLLECT"
trailer_idstring(uuid)
chassis_idstring(uuid)
truck_idstring(uuid)
order_parcel_idstring(uuid)
appt_idstring(uuid)
hdrobject(OrderHdrSecureType)
shiptoobject(AccountSecureType)
markforobject(AccountSecureType)
orderedbyobject(AccountSecureType)
billfreighttoobject(AccountSecureType)
palletsArray of objects(OrderShipHdrPalletsViewSecureType)unique
ctnsArray of objects(OrderShipHdrCtnsViewSecureType)unique
returnsArray of objects(OrderLineReturnSecureType)
trailerobject(OrderHdrEquipSecureType)
chassisobject(OrderHdrEquipSecureType)
truckobject(OrderHdrEquipSecureType)
carrierobject(AccountCarrierSecureType)
order_parcelobject(OrderParcelSecureType)
apptobject(DockAppointmentsSecureType)
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "orderhdr_id": "fcbe07ea-8d6c-49af-8aae-61a11b0dc975",
    "order_number": "string",
    "po_number": "string",
    "so_number": "string",
    "swc": "string",
    "startdt": "2019-08-24T14:15:22Z",
    "canceldt": "2019-08-24T14:15:22Z",
    "planneddt": "2019-08-24T14:15:22Z",
    "supplier_id": "3cb1e20c-c6c9-4e71-ba66-399c468f697c",
    "carrier_id": "48e94619-563d-402c-b442-97b2c8fb116b",
    "shipto_id": "6aeb979e-223b-4e3a-875b-e72ab6f16edd",
    "markfor_id": "98f5fb5c-34ba-4fb0-8971-c7f5d5fbe89c",
    "orderedby_id": "b84f43c5-cf04-4f30-bda2-66e41b997b94",
    "billfreightto_id": "fc26f79c-64cf-4028-b044-68d9c779ac73",
    "billfreightterms": "SENDER",
    "trailer_id": "97e29c62-c50b-4b0c-96e3-bd5143739e18",
    "chassis_id": "d2407ce7-9a09-4c19-a766-239486331a8d",
    "truck_id": "323c15aa-b996-4e49-8db5-4aff1b8dd3ec",
    "order_parcel_id": "df596f9a-f648-43a0-9b8a-17d843daf5b6",
    "appt_id": "174bf154-0543-4ed1-8217-69feeed19483",
    "hdr": { … },
    "shipto": { … },
    "markfor": { … },
    "orderedby": { … },
    "billfreightto": { … },
    "pallets": [ … ],
    "ctns": [ … ],
    "returns": [ … ],
    "trailer": { … },
    "chassis": { … },
    "truck": { … },
    "carrier": { … },
    "order_parcel": { … },
    "appt": { … }
  }
]

Work/Project Order Service

Services related to Work/Project Orders

Operations

Authentication Service

Services related to authentication

Operations