Analytics: Port Intelligence1

Appointments5

Asset Tracking2

Capacity1

Capacity Provider Account Group Management3

Capacity Provider Account Management5

Capacity Provider Contact Management4

Capacity Provider Metadata2

Filter Suggestions1

Inventory Order and Load Webhook Data2

Invitations2

LTL: Address Book4

LTL: Dispatch6

LTL: Electronic BOL3

LTL: Image Retrieval1

LTL: Push Imaging1

LTL: Push Tracking2

LTL: Quotes2

LTL: Tracking5

Milestones1

Multi-Modal: Booking12

Multi-Modal: Document6

Multi-Modal: Image Retrieval1

Multi-Modal: Packaging5

Multi-Modal: Rating3

OAuth 2.0: Client Applications6

OAuth 2.0: Token Generation1

Ocean: Point-to-Point Schedules2

Ocean: Tracking3

Order Visibility12

Parcel: Push Tracking1

Parcel: Tracking3

Parcel: Webhook3

Postal Address Validation1

Push Updates1

Rail: Tracking4

Reason Codes1

Shipment Attributes2

Shipment Search2

Shipment Webhook Data2

Shipment: Loads5

Shipment: Tracking12

Site Codes1

Slots1

Stop Location Management6

TL: Available Vehicles1

TL: Capacity Provider Push9

TL: Connected Capacity2

TL: Tracking13

TL: Webhook3

Universal Push: Truckload1

VLTL: Dispatch1

VLTL: Quotes1

Webhook5

post/webhook-schema-

Order Visibility

Search for orders.

Use the BasicInventoryOrderSearchCriteria, page number, page size and sort field to perform Inventory Order search.

post/api/v4/inventory/orders/search

Request

Base URL
https://na12.api.project44.com
Auth
OAuth 2
Client credentials
Token URL/api/v4/oauth2/token
TypeScript
https://skmtc.dev/project44/apis/project44-rest-api/docs/api/v4/inventory/orders/search/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

pageinteger

Page number valid range: [1, 50]

sizeinteger

Page size valid range: [1, 1000]

sortstring

Order Sortable Fields: [orderType, orderIdentifier, statusCode, orderSubmissionDateTime, supplierReadyDateTimeWindow.startDateTime, supplierReadyDateTimeWindow.endDateTime, originalDeliveryDateTimeWindow.startDateTime,originalDeliveryDateTimeWindow.endDateTime, derivedOrderHealth.estimatedTimeOfArrival]

Request body

billToLocationAddressTextstring

Search for orders whose bill-to location match the given address fields (i.e. postalCode, addressLines, city, state, country).

destinationLocationAddressTextstring

Search for orders whose destination location match the given address fields. (i.e. postalCode, addressLines, city, state, country).

hasShipmentIdsboolean

Search for the existence of shipmentIds on an order. If value is 'true', it searches for orders that contain shipments. If the value is 'false', it searches for orders that contain no shipments. If the value is null, this criterion is excluded. If this is used in combination with 'shipmentIds' search criteria, it might cause unexpected results.

idsstring[]

Search for orders with ids that match the provided ids.

orderIdentifiersstring[]

Search for orders with identifiers that match the provided order identifiers.

orderTypesstring[]

Search for orders with types that match the provided types.

originLocationAddressTextstring

Search for orders whose origin location match the given address fields. (i.e. postalCode, addressLines, city, state, country).

relatedOrderIdsstring[]

Search for orders that contain related orders matching the provided ids.

searchTextstring

Provide a multi field text search across the full inventory order object.

shipmentIdsstring[]

Search for orders with shipment ids that match the provided shipment ids. These must be project44-generated masterShipmentIds.

statusCodesstring[]

Search for orders containing any of the provided status codes.

vendorLocationAddressTextstring

Search for orders whose vendor location match the given address fields (i.e. postalCode, addressLines, city, state, country).

Response

Changes

No recorded changes to this operation across all 1 revision of this API.