OrderShipmentAndRouteSegments

orderShipmentAndRouteSegments

list OrderShipmentAndRouteSegment

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Query parameters

pageIndexnumber · int32Optional

Page number to return, starting with zero

pageSizenumber · int32Optional

Number of records per page (default 100)

orderByFieldstringOptional

Field name to order by (or comma separated names)

pageNoLimitstringOptional

If true don't limit page size (no pagination)

dependentLevelsnumber · int32Optional

Levels of dependent child records to include

orderIdstringOptional

orderDatestring · date-timeOptional

orderTypeIdstringOptional

webSiteIdstringOptional

externalIdstringOptional

orderNamestringOptional

statusIdstringOptional

originFacilityIdstringOptional

currencyUomstringOptional

shipGroupSeqIdstringOptional

orderFacilityIdstringOptional

facilityIdstringOptional

carrierPartyIdstringOptional

shipmentMethodTypeIdstringOptional

shipmentIdstringOptional

shipmentTypeIdstringOptional

shipmentStatusIdstringOptional

shipmentCreatedDatestring · date-timeOptional

shipmentShippedDatestring · date-timeOptional

shippingEstimateAmountnumberOptional

trackingIdNumberstringOptional

shipmentRouteSegmentIdstringOptional

routeSegShipmentMethodDescriptionstringOptional

statusDatestring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/orderShipmentAndRouteSegments

HTTPcURLJavaScriptPython

GET /rest/s1/poorti/orderShipmentAndRouteSegments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

[
  {
    "_entity": "co.hotwax.customerservice.order.OrderShipmentAndRouteSegment",
    "orderId": "text",
    "orderDate": "2025-12-17T13:12:29.322Z",
    "orderTypeId": "text",
    "webSiteId": "text",
    "externalId": "text",
    "orderName": "text",
    "statusId": "text",
    "originFacilityId": "text",
    "currencyUom": "text",
    "shipGroupSeqId": "text",
    "orderFacilityId": "text",
    "facilityId": "text",
    "carrierPartyId": "text",
    "shipmentMethodTypeId": "text",
    "shipmentId": "text",
    "shipmentTypeId": "text",
    "shipmentStatusId": "text",
    "shipmentCreatedDate": "2025-12-17T13:12:29.322Z",
    "shipmentShippedDate": "2025-12-17T13:12:29.322Z",
    "shippingEstimateAmount": 1,
    "trackingIdNumber": "text",
    "shipmentRouteSegmentId": "text",
    "routeSegShipmentMethodDescription": "text",
    "statusDate": "2025-12-17T13:12:29.322Z"
  }
]