Shipments
shipments
Service to get Inventory Count Import Item details.
The current page index to get the shipments.
The maximum number of shipments to display.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
GET /rest/s1/poorti/shipments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"shipments": [],
"shipmentCount": "text"
}
org.apache.ofbiz.shipment.shipment.Shipment
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
POST /rest/s1/poorti/shipments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 7542
{
"_entity": "org.apache.ofbiz.shipment.shipment.Shipment",
"shipmentId": "text",
"externalId": "text",
"shipmentTypeId": "text",
"statusId": "text",
"primaryOrderId": "text",
"primaryReturnId": "text",
"primaryShipGroupSeqId": "text",
"picklistBinId": "text",
"estimatedReadyDate": "2025-08-08T09:12:26.691Z",
"estimatedShipDate": "2025-08-08T09:12:26.691Z",
"estimatedShipWorkEffId": "text",
"estimatedArrivalDate": "2025-08-08T09:12:26.691Z",
"estimatedArrivalWorkEffId": "text",
"latestCancelDate": "2025-08-08T09:12:26.691Z",
"estimatedShipCost": 1,
"currencyUomId": "text",
"handlingInstructions": "text",
"originFacilityId": "text",
"destinationFacilityId": "text",
"originContactMechId": "text",
"originTelecomNumberId": "text",
"destinationContactMechId": "text",
"destinationTelecomNumberId": "text",
"partyIdTo": "text",
"partyIdFrom": "text",
"additionalShippingCharge": 1,
"addtlShippingChargeDesc": "text",
"createdDate": "2025-08-08T09:12:26.691Z",
"createdByUserLogin": "text",
"lastModifiedDate": "2025-08-08T09:12:26.691Z",
"lastModifiedByUserLogin": "text",
"carrierPartyId": "text",
"shipmentMethodTypeId": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z",
"type": {
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentType",
"shipmentTypeId": "text",
"parentTypeId": "text",
"hasTable": "text",
"description": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"statusItem": {
"_entity": "statuses",
"statusId": "text",
"statusTypeId": "text",
"statusCode": "text",
"sequenceNum": 1,
"description": "text",
"statusAge": 1,
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"currencyUom": {
"_entity": "uoms",
"uomId": "text",
"uomTypeEnumId": "UT_AREA_MEASURE",
"abbreviation": "text",
"description": "text",
"fractionDigits": 1,
"symbol": "text",
"numericCode": 1,
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"originFacility": {
"_entity": "org.apache.ofbiz.product.facility.Facility",
"facilityId": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"productStoreId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-08-08T09:12:26.691Z",
"closedDate": "2025-08-08T09:12:26.691Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"destinationFacility": {
"_entity": "org.apache.ofbiz.product.facility.Facility",
"facilityId": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"productStoreId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-08-08T09:12:26.691Z",
"closedDate": "2025-08-08T09:12:26.691Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"originContactMech": {
"_entity": "org.apache.ofbiz.party.contact.ContactMech",
"contactMechId": "text",
"externalId": "text",
"contactMechTypeId": "text",
"infoString": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"destinationContactMech": {
"_entity": "org.apache.ofbiz.party.contact.ContactMech",
"contactMechId": "text",
"externalId": "text",
"contactMechTypeId": "text",
"infoString": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"originPostalAddress": {
"_entity": "org.apache.ofbiz.party.contact.PostalAddress",
"contactMechId": "text",
"toName": "text",
"attnName": "text",
"address1": "text",
"address2": "text",
"houseNumber": 1,
"houseNumberExt": "text",
"directions": "text",
"city": "text",
"cityGeoId": "text",
"postalCode": "text",
"postalCodeExt": "text",
"countryGeoId": "text",
"stateProvinceGeoId": "text",
"countyGeoId": "text",
"municipalityGeoId": "text",
"postalCodeGeoId": "text",
"geoPointId": "text",
"encodedAddressKey": "text",
"latitude": 1,
"longitude": 1,
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"originTelecomNumber": {
"_entity": "org.apache.ofbiz.party.contact.TelecomNumber",
"contactMechId": "text",
"countryCode": "text",
"areaCode": "text",
"contactNumber": "text",
"askForName": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"destinationPostalAddress": {
"_entity": "org.apache.ofbiz.party.contact.PostalAddress",
"contactMechId": "text",
"toName": "text",
"attnName": "text",
"address1": "text",
"address2": "text",
"houseNumber": 1,
"houseNumberExt": "text",
"directions": "text",
"city": "text",
"cityGeoId": "text",
"postalCode": "text",
"postalCodeExt": "text",
"countryGeoId": "text",
"stateProvinceGeoId": "text",
"countyGeoId": "text",
"municipalityGeoId": "text",
"postalCodeGeoId": "text",
"geoPointId": "text",
"encodedAddressKey": "text",
"latitude": 1,
"longitude": 1,
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"destinationTelecomNumber": {
"_entity": "org.apache.ofbiz.party.contact.TelecomNumber",
"contactMechId": "text",
"countryCode": "text",
"areaCode": "text",
"contactNumber": "text",
"askForName": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"order": {
"_entity": "org.apache.ofbiz.order.order.OrderHeader",
"orderId": "text",
"orderTypeId": "text",
"orderName": "text",
"externalId": "text",
"salesChannelEnumId": "text",
"orderDate": "2025-08-08T09:12:26.691Z",
"priority": "text",
"entryDate": "2025-08-08T09:12:26.691Z",
"pickSheetPrintedDate": "2025-08-08T09:12:26.691Z",
"visitId": "text",
"statusId": "text",
"createdBy": "text",
"firstAttemptOrderId": "text",
"currencyUom": "text",
"syncStatusId": "text",
"billingAccountId": "text",
"originFacilityId": "text",
"webSiteId": "text",
"productStoreId": "text",
"terminalId": "text",
"transactionId": "text",
"autoOrderShoppingListId": "text",
"needsInventoryIssuance": "text",
"isRushOrder": "text",
"internalCode": "text",
"remainingSubTotal": 1,
"grandTotal": 1,
"isViewed": "text",
"invoicePerShipment": "text",
"expireDate": "2025-08-08T09:12:26.691Z",
"localeString": "text",
"customerClassificationId": "text",
"presentmentCurrencyUom": "text",
"autoApprove": "text",
"statusFlowId": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"return": {
"_entity": "org.apache.ofbiz.order.return.ReturnHeader",
"returnId": "text",
"externalId": "text",
"returnHeaderTypeId": "text",
"statusId": "text",
"createdBy": "text",
"fromPartyId": "text",
"toPartyId": "text",
"paymentMethodId": "text",
"finAccountId": "text",
"billingAccountId": "text",
"entryDate": "2025-08-08T09:12:26.691Z",
"originContactMechId": "text",
"destinationFacilityId": "text",
"needsInventoryReceive": "text",
"currencyUomId": "text",
"supplierRmaId": "text",
"returnChannelEnumId": "text",
"transactionId": "text",
"returnDate": "2025-08-08T09:12:26.691Z",
"employeeId": "text",
"terminalId": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"orderItemShipGroup": {
"_entity": "org.apache.ofbiz.order.order.OrderItemShipGroup",
"orderId": "text",
"shipGroupSeqId": "text",
"shipmentMethodTypeId": "text",
"supplierPartyId": "text",
"vendorPartyId": "text",
"carrierPartyId": "text",
"carrierRoleTypeId": "text",
"facilityId": "text",
"contactMechId": "text",
"telecomContactMechId": "text",
"trackingNumber": "text",
"shippingInstructions": "text",
"maySplit": "text",
"giftMessage": "text",
"isGift": "text",
"shipAfterDate": "2025-08-08T09:12:26.691Z",
"shipByDate": "2025-08-08T09:12:26.691Z",
"estimatedShipDate": "2025-08-08T09:12:26.691Z",
"estimatedDeliveryDate": "2025-08-08T09:12:26.691Z",
"carrierAccountNumber": "text",
"carrierService": "text",
"orderFacilityId": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
}
}
{
"_entity": "org.apache.ofbiz.shipment.shipment.Shipment.PK",
"shipmentId": "text"
}
org.apache.ofbiz.shipment.shipment.Shipment
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
PUT /rest/s1/poorti/shipments/{shipmentId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 7542
{
"_entity": "org.apache.ofbiz.shipment.shipment.Shipment",
"shipmentId": "text",
"externalId": "text",
"shipmentTypeId": "text",
"statusId": "text",
"primaryOrderId": "text",
"primaryReturnId": "text",
"primaryShipGroupSeqId": "text",
"picklistBinId": "text",
"estimatedReadyDate": "2025-08-08T09:12:26.691Z",
"estimatedShipDate": "2025-08-08T09:12:26.691Z",
"estimatedShipWorkEffId": "text",
"estimatedArrivalDate": "2025-08-08T09:12:26.691Z",
"estimatedArrivalWorkEffId": "text",
"latestCancelDate": "2025-08-08T09:12:26.691Z",
"estimatedShipCost": 1,
"currencyUomId": "text",
"handlingInstructions": "text",
"originFacilityId": "text",
"destinationFacilityId": "text",
"originContactMechId": "text",
"originTelecomNumberId": "text",
"destinationContactMechId": "text",
"destinationTelecomNumberId": "text",
"partyIdTo": "text",
"partyIdFrom": "text",
"additionalShippingCharge": 1,
"addtlShippingChargeDesc": "text",
"createdDate": "2025-08-08T09:12:26.691Z",
"createdByUserLogin": "text",
"lastModifiedDate": "2025-08-08T09:12:26.691Z",
"lastModifiedByUserLogin": "text",
"carrierPartyId": "text",
"shipmentMethodTypeId": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z",
"type": {
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentType",
"shipmentTypeId": "text",
"parentTypeId": "text",
"hasTable": "text",
"description": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"statusItem": {
"_entity": "statuses",
"statusId": "text",
"statusTypeId": "text",
"statusCode": "text",
"sequenceNum": 1,
"description": "text",
"statusAge": 1,
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"currencyUom": {
"_entity": "uoms",
"uomId": "text",
"uomTypeEnumId": "UT_AREA_MEASURE",
"abbreviation": "text",
"description": "text",
"fractionDigits": 1,
"symbol": "text",
"numericCode": 1,
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"originFacility": {
"_entity": "org.apache.ofbiz.product.facility.Facility",
"facilityId": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"productStoreId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-08-08T09:12:26.691Z",
"closedDate": "2025-08-08T09:12:26.691Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"destinationFacility": {
"_entity": "org.apache.ofbiz.product.facility.Facility",
"facilityId": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"productStoreId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-08-08T09:12:26.691Z",
"closedDate": "2025-08-08T09:12:26.691Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"originContactMech": {
"_entity": "org.apache.ofbiz.party.contact.ContactMech",
"contactMechId": "text",
"externalId": "text",
"contactMechTypeId": "text",
"infoString": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"destinationContactMech": {
"_entity": "org.apache.ofbiz.party.contact.ContactMech",
"contactMechId": "text",
"externalId": "text",
"contactMechTypeId": "text",
"infoString": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"originPostalAddress": {
"_entity": "org.apache.ofbiz.party.contact.PostalAddress",
"contactMechId": "text",
"toName": "text",
"attnName": "text",
"address1": "text",
"address2": "text",
"houseNumber": 1,
"houseNumberExt": "text",
"directions": "text",
"city": "text",
"cityGeoId": "text",
"postalCode": "text",
"postalCodeExt": "text",
"countryGeoId": "text",
"stateProvinceGeoId": "text",
"countyGeoId": "text",
"municipalityGeoId": "text",
"postalCodeGeoId": "text",
"geoPointId": "text",
"encodedAddressKey": "text",
"latitude": 1,
"longitude": 1,
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"originTelecomNumber": {
"_entity": "org.apache.ofbiz.party.contact.TelecomNumber",
"contactMechId": "text",
"countryCode": "text",
"areaCode": "text",
"contactNumber": "text",
"askForName": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"destinationPostalAddress": {
"_entity": "org.apache.ofbiz.party.contact.PostalAddress",
"contactMechId": "text",
"toName": "text",
"attnName": "text",
"address1": "text",
"address2": "text",
"houseNumber": 1,
"houseNumberExt": "text",
"directions": "text",
"city": "text",
"cityGeoId": "text",
"postalCode": "text",
"postalCodeExt": "text",
"countryGeoId": "text",
"stateProvinceGeoId": "text",
"countyGeoId": "text",
"municipalityGeoId": "text",
"postalCodeGeoId": "text",
"geoPointId": "text",
"encodedAddressKey": "text",
"latitude": 1,
"longitude": 1,
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"destinationTelecomNumber": {
"_entity": "org.apache.ofbiz.party.contact.TelecomNumber",
"contactMechId": "text",
"countryCode": "text",
"areaCode": "text",
"contactNumber": "text",
"askForName": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"order": {
"_entity": "org.apache.ofbiz.order.order.OrderHeader",
"orderId": "text",
"orderTypeId": "text",
"orderName": "text",
"externalId": "text",
"salesChannelEnumId": "text",
"orderDate": "2025-08-08T09:12:26.691Z",
"priority": "text",
"entryDate": "2025-08-08T09:12:26.691Z",
"pickSheetPrintedDate": "2025-08-08T09:12:26.691Z",
"visitId": "text",
"statusId": "text",
"createdBy": "text",
"firstAttemptOrderId": "text",
"currencyUom": "text",
"syncStatusId": "text",
"billingAccountId": "text",
"originFacilityId": "text",
"webSiteId": "text",
"productStoreId": "text",
"terminalId": "text",
"transactionId": "text",
"autoOrderShoppingListId": "text",
"needsInventoryIssuance": "text",
"isRushOrder": "text",
"internalCode": "text",
"remainingSubTotal": 1,
"grandTotal": 1,
"isViewed": "text",
"invoicePerShipment": "text",
"expireDate": "2025-08-08T09:12:26.691Z",
"localeString": "text",
"customerClassificationId": "text",
"presentmentCurrencyUom": "text",
"autoApprove": "text",
"statusFlowId": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"return": {
"_entity": "org.apache.ofbiz.order.return.ReturnHeader",
"returnId": "text",
"externalId": "text",
"returnHeaderTypeId": "text",
"statusId": "text",
"createdBy": "text",
"fromPartyId": "text",
"toPartyId": "text",
"paymentMethodId": "text",
"finAccountId": "text",
"billingAccountId": "text",
"entryDate": "2025-08-08T09:12:26.691Z",
"originContactMechId": "text",
"destinationFacilityId": "text",
"needsInventoryReceive": "text",
"currencyUomId": "text",
"supplierRmaId": "text",
"returnChannelEnumId": "text",
"transactionId": "text",
"returnDate": "2025-08-08T09:12:26.691Z",
"employeeId": "text",
"terminalId": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"orderItemShipGroup": {
"_entity": "org.apache.ofbiz.order.order.OrderItemShipGroup",
"orderId": "text",
"shipGroupSeqId": "text",
"shipmentMethodTypeId": "text",
"supplierPartyId": "text",
"vendorPartyId": "text",
"carrierPartyId": "text",
"carrierRoleTypeId": "text",
"facilityId": "text",
"contactMechId": "text",
"telecomContactMechId": "text",
"trackingNumber": "text",
"shippingInstructions": "text",
"maySplit": "text",
"giftMessage": "text",
"isGift": "text",
"shipAfterDate": "2025-08-08T09:12:26.691Z",
"shipByDate": "2025-08-08T09:12:26.691Z",
"estimatedShipDate": "2025-08-08T09:12:26.691Z",
"estimatedDeliveryDate": "2025-08-08T09:12:26.691Z",
"carrierAccountNumber": "text",
"carrierService": "text",
"orderFacilityId": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
}
}
{
"_entity": "org.apache.ofbiz.shipment.shipment.Shipment.PK",
"shipmentId": "text"
}
Packs a shipment, updates its status, and marks related picklist items as picked.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
POST /rest/s1/poorti/shipments/{shipmentId}/pack HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 133
{
"shipmentId": "text",
"facilityId": "text",
"orderId": "text",
"shipmentPackageContents": [],
"rejectedOrderItems": [],
"trackingCode": "text"
}
{
"packedShipmentId": "text"
}
Unpack a shipment, updates its status to approved and change fulfillment status to InProgress on SOLR .
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
POST /rest/s1/poorti/shipments/{shipmentId}/unpack HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
No content
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
POST /rest/s1/poorti/shipments/{shipmentId}/ship HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
No content
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
This field store the length of package; if a shipmentBoxTypeId is specified then this overrides the dimension specified there; this field is meant to be used when there is no applicable ShipmentBoxType
This field store the height of package; if a shipmentBoxTypeId is specified then this overrides the dimension specified there; this field is meant to be used when there is no applicable ShipmentBoxType
This field store the width of package; if a shipmentBoxTypeId is specified then this overrides the dimension specified there; this field is meant to be used when there is no applicable ShipmentBoxType
This field store the unit of measurement of dimension (length, width and height)
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
GET /rest/s1/poorti/shipments/{shipmentId}/shipmentPackages HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackage",
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentBoxTypeId": "text",
"dateCreated": "2025-08-08T09:12:26.691Z",
"boxLength": 1,
"boxHeight": 1,
"boxWidth": 1,
"dimensionUomId": {
"_entity": "uoms",
"uomId": "text",
"uomTypeEnumId": "UT_AREA_MEASURE",
"abbreviation": "text",
"description": "text",
"fractionDigits": 1,
"symbol": "text",
"numericCode": 1,
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"weight": 1,
"weightUomId": {
"_entity": "uoms",
"uomId": "text",
"uomTypeEnumId": "UT_AREA_MEASURE",
"abbreviation": "text",
"description": "text",
"fractionDigits": 1,
"symbol": "text",
"numericCode": 1,
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"insuredValue": 1,
"packageName": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z",
"shipment": {
"_entity": "org.apache.ofbiz.shipment.shipment.Shipment",
"shipmentId": "text",
"externalId": "text",
"shipmentTypeId": "text",
"statusId": "text",
"primaryOrderId": "text",
"primaryReturnId": "text",
"primaryShipGroupSeqId": "text",
"picklistBinId": "text",
"estimatedReadyDate": "2025-08-08T09:12:26.691Z",
"estimatedShipDate": "2025-08-08T09:12:26.691Z",
"estimatedShipWorkEffId": "text",
"estimatedArrivalDate": "2025-08-08T09:12:26.691Z",
"estimatedArrivalWorkEffId": "text",
"latestCancelDate": "2025-08-08T09:12:26.691Z",
"estimatedShipCost": 1,
"currencyUomId": "text",
"handlingInstructions": "text",
"originFacilityId": "text",
"destinationFacilityId": "text",
"originContactMechId": "text",
"originTelecomNumberId": "text",
"destinationContactMechId": "text",
"destinationTelecomNumberId": "text",
"partyIdTo": "text",
"partyIdFrom": "text",
"additionalShippingCharge": 1,
"addtlShippingChargeDesc": "text",
"createdDate": "2025-08-08T09:12:26.691Z",
"createdByUserLogin": "text",
"lastModifiedDate": "2025-08-08T09:12:26.691Z",
"lastModifiedByUserLogin": "text",
"carrierPartyId": "text",
"shipmentMethodTypeId": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"boxType": {
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentBoxType",
"shipmentBoxTypeId": "text",
"description": "text",
"dimensionUomId": "text",
"boxLength": 1,
"boxWidth": 1,
"boxHeight": 1,
"weightUomId": "text",
"boxWeight": 1,
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
},
"carrierBoxType": [
{
"_entity": "org.apache.ofbiz.shipment.shipment.CarrierShipmentBoxType",
"shipmentBoxTypeId": "text",
"partyId": "text",
"packagingTypeCode": "text",
"oversizeCode": "text",
"pickupContainerCode": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
}
]
}
]
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
POST /rest/s1/poorti/shipments/{shipmentId}/shipmentPackages HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 259
{
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentBoxTypeId": "text",
"boxLength": 1,
"boxHeight": 1,
"boxWidth": 1,
"dimensionUomId": "text",
"weight": 1,
"weightUomId": "text",
"insuredValue": 1,
"packageName": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
}
{
"shipmentId": "text",
"shipmentPackageSeqId": "text"
}
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
GET /rest/s1/poorti/shipments/{shipmentId}/shipmentPackages/{shipmentPackageSeqId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackage",
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentBoxTypeId": "text",
"dateCreated": "2025-08-08T09:12:26.691Z",
"boxLength": 1,
"boxHeight": 1,
"boxWidth": 1,
"dimensionUomId": "text",
"weight": 1,
"weightUomId": "text",
"insuredValue": 1,
"packageName": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
}
org.apache.ofbiz.shipment.shipment.ShipmentPackage
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
PUT /rest/s1/poorti/shipments/{shipmentId}/shipmentPackages/{shipmentPackageSeqId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 363
{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackage",
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentBoxTypeId": "text",
"dateCreated": "2025-08-08T09:12:26.691Z",
"boxLength": 1,
"boxHeight": 1,
"boxWidth": 1,
"dimensionUomId": "text",
"weight": 1,
"weightUomId": "text",
"insuredValue": 1,
"packageName": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
}
{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackage.PK",
"shipmentId": "text",
"shipmentPackageSeqId": "text"
}
Get shipping label from Third Party Shipping Services
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
GET /rest/s1/poorti/shipments/{shipmentId}/shippingLabels HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
No content
Void shipping label from Third Party Shipping Services
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
POST /rest/s1/poorti/shipments/{shipmentId}/shippingLabels/void HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
No content
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
GET /rest/s1/poorti/shipments/{shipmentId}/shipmentPackageContents HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackageContent",
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentItemSeqId": "text",
"quantity": 1,
"subProductId": "text",
"subProductQuantity": 1,
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
}
]
org.apache.ofbiz.shipment.shipment.ShipmentPackageContent
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
POST /rest/s1/poorti/shipments/{shipmentId}/shipmentPackageContents HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 252
{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackageContent",
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentItemSeqId": "text",
"quantity": 1,
"subProductId": "text",
"subProductQuantity": 1,
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
}
{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackageContent.PK",
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentItemSeqId": "text"
}
org.apache.ofbiz.shipment.shipment.ShipmentPackageRouteSeg
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
POST /rest/s1/poorti/shipments/{shipmentId}/shipmentPackageRouteSegments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 660
{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackageRouteSeg",
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentRouteSegmentId": "text",
"trackingCode": "text",
"boxNumber": "text",
"labelImage": "text",
"labelIntlSignImage": "text",
"labelHtml": "text",
"labelPrinted": "text",
"internationalInvoice": "text",
"packageTransportCost": 1,
"packageServiceCost": 1,
"packageOtherCost": 1,
"codAmount": 1,
"insuredAmount": 1,
"currencyUomId": "text",
"labelImageUrl": "text",
"internationalInvoiceUrl": "text",
"packagePickupPrn": "text",
"packagePickupDate": "2025-08-08T09:12:26.691Z",
"gatewayMessage": "text",
"gatewayStatus": "text",
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
}
{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackageRouteSeg.PK",
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentRouteSegmentId": "text"
}
org.apache.ofbiz.shipment.shipment.ShipmentRouteSegment
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
PUT /rest/s1/poorti/shipments/{shipmentId}/shipmentRouteSegment HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 1648
{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentRouteSegment",
"shipmentId": "text",
"shipmentRouteSegmentId": "text",
"deliveryId": "text",
"originFacilityId": "text",
"destFacilityId": "text",
"originContactMechId": "text",
"originTelecomNumberId": "text",
"destContactMechId": "text",
"destTelecomNumberId": "text",
"carrierPartyId": "text",
"shipmentMethodTypeId": "text",
"carrierServiceStatusId": "text",
"carrierDeliveryZone": "text",
"carrierRestrictionCodes": "text",
"carrierRestrictionDesc": "text",
"billingWeight": 1,
"billingWeightUomId": "text",
"actualTransportCost": 1,
"actualServiceCost": 1,
"actualOtherCost": 1,
"actualCost": 1,
"currencyUomId": "text",
"actualStartDate": "2025-08-08T09:12:26.691Z",
"actualArrivalDate": "2025-08-08T09:12:26.691Z",
"estimatedStartDate": "2025-08-08T09:12:26.691Z",
"estimatedArrivalDate": "2025-08-08T09:12:26.691Z",
"trackingIdNumber": "text",
"trackingDigest": "text",
"updatedByUserLoginId": "text",
"lastUpdatedDate": "2025-08-08T09:12:26.691Z",
"homeDeliveryType": "text",
"homeDeliveryDate": "2025-08-08T09:12:26.691Z",
"thirdPartyAccountNumber": "text",
"thirdPartyPostalCode": "text",
"thirdPartyCountryGeoCode": "text",
"upsHighValueReport": "text",
"trackingUrl": "text",
"codReturnLabelImage": "text",
"codReturnLabelHtml": "text",
"codCollectionAmount": 1,
"carrierAccountNumber": "text",
"carrierService": "text",
"isGenerateThirdPartyLabel": "text",
"isTrackingRequired": "text",
"referenceNumber": "text",
"actualCarrierCode": "text",
"labelImage": "text",
"labelImageUrl": "text",
"labelHtml": "text",
"requestedDeliveryDate": "2025-08-08",
"requestedDeliveryTime": "text",
"requestedShipMethTypeId": "text",
"deliveryWindow": 1,
"lastUpdatedStamp": "2025-08-08T09:12:26.691Z"
}
{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentRouteSegment.PK",
"shipmentId": "text",
"shipmentRouteSegmentId": "text"
}
Pack shipments
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
POST /rest/s1/poorti/shipments/bulkPack HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"shipments": []
}
{
"packedShipmentIds": []
}
Pack shipments
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
POST /rest/s1/poorti/shipments/bulkShip HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"shipmentIds": []
}
No content
Retry Shipping Label, this would handle do rate shopping and accept shipment accordingly
N
N
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
POST /rest/s1/poorti/shipments/retryShippingLabel HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 58
{
"forceRateShop": "N",
"generateLabel": "N",
"shipmentIds": []
}
No content
Was this helpful?