HomeGlossary

Shipments

shipments

get Shipments

get

Service to get Inventory Count Import Item details.

Authorizations
Query parameters
productStoreIdstringOptional
keywordstringOptional
shipmentIdstringOptional
carrierPartyIdstringOptional
orderIdstringOptional
picklistIdstringOptional
orderStatusIdstringOptional
orderTypeIdstringOptional
shippedDateFromstring · date-timeOptional
originFacilityIdstringOptional
orderBystringOptional
pageIndexinteger · int32Optional

The current page index to get the shipments.

pageSizeinteger · int32Optional

The maximum number of shipments to display.

Responses
200
Success
application/json
get
GET /rest/s1/poorti/shipments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "shipments": [],
  "shipmentCount": "text"
}

create Shipment (master: default)

post
Authorizations
Body
_entitystringOptionalDefault: org.apache.ofbiz.shipment.shipment.Shipment
shipmentIdstringOptional
externalIdstringOptional
shipmentTypeIdstringOptional
statusIdstringOptional
primaryOrderIdstringOptional
primaryReturnIdstringOptional
primaryShipGroupSeqIdstringOptional
picklistBinIdstringOptional
estimatedReadyDatestring · date-timeOptional
estimatedShipDatestring · date-timeOptional
estimatedShipWorkEffIdstringOptional
estimatedArrivalDatestring · date-timeOptional
estimatedArrivalWorkEffIdstringOptional
latestCancelDatestring · date-timeOptional
estimatedShipCostnumberOptional
currencyUomIdstringOptional
handlingInstructionsstringOptional
originFacilityIdstringOptional
destinationFacilityIdstringOptional
originContactMechIdstringOptional
originTelecomNumberIdstringOptional
destinationContactMechIdstringOptional
destinationTelecomNumberIdstringOptional
partyIdTostringOptional
partyIdFromstringOptional
additionalShippingChargenumberOptional
addtlShippingChargeDescstringOptional
createdDatestring · date-timeOptional
createdByUserLoginstringOptional
lastModifiedDatestring · date-timeOptional
lastModifiedByUserLoginstringOptional
carrierPartyIdstringOptional
shipmentMethodTypeIdstringOptional
lastUpdatedStampstring · date-timeOptional
Responses
200
Success
application/json
post
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-07-12T00:04:16.300Z",
  "estimatedShipDate": "2025-07-12T00:04:16.300Z",
  "estimatedShipWorkEffId": "text",
  "estimatedArrivalDate": "2025-07-12T00:04:16.300Z",
  "estimatedArrivalWorkEffId": "text",
  "latestCancelDate": "2025-07-12T00:04:16.300Z",
  "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-07-12T00:04:16.300Z",
  "createdByUserLogin": "text",
  "lastModifiedDate": "2025-07-12T00:04:16.300Z",
  "lastModifiedByUserLogin": "text",
  "carrierPartyId": "text",
  "shipmentMethodTypeId": "text",
  "lastUpdatedStamp": "2025-07-12T00:04:16.300Z",
  "type": {
    "_entity": "org.apache.ofbiz.shipment.shipment.ShipmentType",
    "shipmentTypeId": "text",
    "parentTypeId": "text",
    "hasTable": "text",
    "description": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "statusItem": {
    "_entity": "statuses",
    "statusId": "text",
    "statusTypeId": "text",
    "statusCode": "text",
    "sequenceNum": 1,
    "description": "text",
    "statusAge": 1,
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "currencyUom": {
    "_entity": "uoms",
    "uomId": "text",
    "uomTypeEnumId": "UT_AREA_MEASURE",
    "abbreviation": "text",
    "description": "text",
    "fractionDigits": 1,
    "symbol": "text",
    "numericCode": 1,
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "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-07-12T00:04:16.300Z",
    "closedDate": "2025-07-12T00:04:16.300Z",
    "description": "text",
    "defaultDimensionUomId": "text",
    "defaultWeightUomId": "text",
    "geoPointId": "text",
    "externalId": "text",
    "openTime": "text",
    "closeTime": "text",
    "facilityTimeZone": "text",
    "maximumOrderLimit": 1,
    "postalCode": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "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-07-12T00:04:16.300Z",
    "closedDate": "2025-07-12T00:04:16.300Z",
    "description": "text",
    "defaultDimensionUomId": "text",
    "defaultWeightUomId": "text",
    "geoPointId": "text",
    "externalId": "text",
    "openTime": "text",
    "closeTime": "text",
    "facilityTimeZone": "text",
    "maximumOrderLimit": 1,
    "postalCode": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "originContactMech": {
    "_entity": "org.apache.ofbiz.party.contact.ContactMech",
    "contactMechId": "text",
    "externalId": "text",
    "contactMechTypeId": "text",
    "infoString": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "destinationContactMech": {
    "_entity": "org.apache.ofbiz.party.contact.ContactMech",
    "contactMechId": "text",
    "externalId": "text",
    "contactMechTypeId": "text",
    "infoString": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "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-07-12T00:04:16.300Z"
  },
  "originTelecomNumber": {
    "_entity": "org.apache.ofbiz.party.contact.TelecomNumber",
    "contactMechId": "text",
    "countryCode": "text",
    "areaCode": "text",
    "contactNumber": "text",
    "askForName": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "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-07-12T00:04:16.300Z"
  },
  "destinationTelecomNumber": {
    "_entity": "org.apache.ofbiz.party.contact.TelecomNumber",
    "contactMechId": "text",
    "countryCode": "text",
    "areaCode": "text",
    "contactNumber": "text",
    "askForName": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "order": {
    "_entity": "org.apache.ofbiz.order.order.OrderHeader",
    "orderId": "text",
    "orderTypeId": "text",
    "orderName": "text",
    "externalId": "text",
    "salesChannelEnumId": "text",
    "orderDate": "2025-07-12T00:04:16.300Z",
    "priority": "text",
    "entryDate": "2025-07-12T00:04:16.300Z",
    "pickSheetPrintedDate": "2025-07-12T00:04:16.300Z",
    "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-07-12T00:04:16.300Z",
    "localeString": "text",
    "customerClassificationId": "text",
    "presentmentCurrencyUom": "text",
    "autoApprove": "text",
    "statusFlowId": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "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-07-12T00:04:16.300Z",
    "originContactMechId": "text",
    "destinationFacilityId": "text",
    "needsInventoryReceive": "text",
    "currencyUomId": "text",
    "supplierRmaId": "text",
    "returnChannelEnumId": "text",
    "transactionId": "text",
    "returnDate": "2025-07-12T00:04:16.300Z",
    "employeeId": "text",
    "terminalId": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "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-07-12T00:04:16.300Z",
    "shipByDate": "2025-07-12T00:04:16.300Z",
    "estimatedShipDate": "2025-07-12T00:04:16.300Z",
    "estimatedDeliveryDate": "2025-07-12T00:04:16.300Z",
    "carrierAccountNumber": "text",
    "carrierService": "text",
    "orderFacilityId": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  }
}
{
  "_entity": "org.apache.ofbiz.shipment.shipment.Shipment.PK",
  "shipmentId": "text"
}

update Shipment (master: default)

put
Authorizations
Path parameters
shipmentIdstringRequired
Body
_entitystringOptionalDefault: org.apache.ofbiz.shipment.shipment.Shipment
shipmentIdstringOptional
externalIdstringOptional
shipmentTypeIdstringOptional
statusIdstringOptional
primaryOrderIdstringOptional
primaryReturnIdstringOptional
primaryShipGroupSeqIdstringOptional
picklistBinIdstringOptional
estimatedReadyDatestring · date-timeOptional
estimatedShipDatestring · date-timeOptional
estimatedShipWorkEffIdstringOptional
estimatedArrivalDatestring · date-timeOptional
estimatedArrivalWorkEffIdstringOptional
latestCancelDatestring · date-timeOptional
estimatedShipCostnumberOptional
currencyUomIdstringOptional
handlingInstructionsstringOptional
originFacilityIdstringOptional
destinationFacilityIdstringOptional
originContactMechIdstringOptional
originTelecomNumberIdstringOptional
destinationContactMechIdstringOptional
destinationTelecomNumberIdstringOptional
partyIdTostringOptional
partyIdFromstringOptional
additionalShippingChargenumberOptional
addtlShippingChargeDescstringOptional
createdDatestring · date-timeOptional
createdByUserLoginstringOptional
lastModifiedDatestring · date-timeOptional
lastModifiedByUserLoginstringOptional
carrierPartyIdstringOptional
shipmentMethodTypeIdstringOptional
lastUpdatedStampstring · date-timeOptional
Responses
200
Success
application/json
put
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-07-12T00:04:16.300Z",
  "estimatedShipDate": "2025-07-12T00:04:16.300Z",
  "estimatedShipWorkEffId": "text",
  "estimatedArrivalDate": "2025-07-12T00:04:16.300Z",
  "estimatedArrivalWorkEffId": "text",
  "latestCancelDate": "2025-07-12T00:04:16.300Z",
  "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-07-12T00:04:16.300Z",
  "createdByUserLogin": "text",
  "lastModifiedDate": "2025-07-12T00:04:16.300Z",
  "lastModifiedByUserLogin": "text",
  "carrierPartyId": "text",
  "shipmentMethodTypeId": "text",
  "lastUpdatedStamp": "2025-07-12T00:04:16.300Z",
  "type": {
    "_entity": "org.apache.ofbiz.shipment.shipment.ShipmentType",
    "shipmentTypeId": "text",
    "parentTypeId": "text",
    "hasTable": "text",
    "description": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "statusItem": {
    "_entity": "statuses",
    "statusId": "text",
    "statusTypeId": "text",
    "statusCode": "text",
    "sequenceNum": 1,
    "description": "text",
    "statusAge": 1,
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "currencyUom": {
    "_entity": "uoms",
    "uomId": "text",
    "uomTypeEnumId": "UT_AREA_MEASURE",
    "abbreviation": "text",
    "description": "text",
    "fractionDigits": 1,
    "symbol": "text",
    "numericCode": 1,
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "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-07-12T00:04:16.300Z",
    "closedDate": "2025-07-12T00:04:16.300Z",
    "description": "text",
    "defaultDimensionUomId": "text",
    "defaultWeightUomId": "text",
    "geoPointId": "text",
    "externalId": "text",
    "openTime": "text",
    "closeTime": "text",
    "facilityTimeZone": "text",
    "maximumOrderLimit": 1,
    "postalCode": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "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-07-12T00:04:16.300Z",
    "closedDate": "2025-07-12T00:04:16.300Z",
    "description": "text",
    "defaultDimensionUomId": "text",
    "defaultWeightUomId": "text",
    "geoPointId": "text",
    "externalId": "text",
    "openTime": "text",
    "closeTime": "text",
    "facilityTimeZone": "text",
    "maximumOrderLimit": 1,
    "postalCode": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "originContactMech": {
    "_entity": "org.apache.ofbiz.party.contact.ContactMech",
    "contactMechId": "text",
    "externalId": "text",
    "contactMechTypeId": "text",
    "infoString": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "destinationContactMech": {
    "_entity": "org.apache.ofbiz.party.contact.ContactMech",
    "contactMechId": "text",
    "externalId": "text",
    "contactMechTypeId": "text",
    "infoString": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "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-07-12T00:04:16.300Z"
  },
  "originTelecomNumber": {
    "_entity": "org.apache.ofbiz.party.contact.TelecomNumber",
    "contactMechId": "text",
    "countryCode": "text",
    "areaCode": "text",
    "contactNumber": "text",
    "askForName": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "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-07-12T00:04:16.300Z"
  },
  "destinationTelecomNumber": {
    "_entity": "org.apache.ofbiz.party.contact.TelecomNumber",
    "contactMechId": "text",
    "countryCode": "text",
    "areaCode": "text",
    "contactNumber": "text",
    "askForName": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "order": {
    "_entity": "org.apache.ofbiz.order.order.OrderHeader",
    "orderId": "text",
    "orderTypeId": "text",
    "orderName": "text",
    "externalId": "text",
    "salesChannelEnumId": "text",
    "orderDate": "2025-07-12T00:04:16.300Z",
    "priority": "text",
    "entryDate": "2025-07-12T00:04:16.300Z",
    "pickSheetPrintedDate": "2025-07-12T00:04:16.300Z",
    "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-07-12T00:04:16.300Z",
    "localeString": "text",
    "customerClassificationId": "text",
    "presentmentCurrencyUom": "text",
    "autoApprove": "text",
    "statusFlowId": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "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-07-12T00:04:16.300Z",
    "originContactMechId": "text",
    "destinationFacilityId": "text",
    "needsInventoryReceive": "text",
    "currencyUomId": "text",
    "supplierRmaId": "text",
    "returnChannelEnumId": "text",
    "transactionId": "text",
    "returnDate": "2025-07-12T00:04:16.300Z",
    "employeeId": "text",
    "terminalId": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  },
  "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-07-12T00:04:16.300Z",
    "shipByDate": "2025-07-12T00:04:16.300Z",
    "estimatedShipDate": "2025-07-12T00:04:16.300Z",
    "estimatedDeliveryDate": "2025-07-12T00:04:16.300Z",
    "carrierAccountNumber": "text",
    "carrierService": "text",
    "orderFacilityId": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
  }
}
{
  "_entity": "org.apache.ofbiz.shipment.shipment.Shipment.PK",
  "shipmentId": "text"
}

pack Shipment

post

Packs a shipment, updates its status, and marks related picklist items as picked.

Authorizations
Path parameters
shipmentIdstringRequired
Body
shipmentIdstringRequired
facilityIdstringRequired
orderIdstringRequired
shipmentPackageContentsarrayOptional
rejectedOrderItemsarrayOptional
trackingCodestringOptional
Responses
200
Success
application/json
post
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 Shipment

post

Unpack a shipment, updates its status to approved and change fulfillment status to InProgress on SOLR .

Authorizations
Path parameters
shipmentIdstringRequired
Responses
401
Authentication required
post
POST /rest/s1/poorti/shipments/{shipmentId}/unpack HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

No content

ship Shipment

post
Authorizations
Path parameters
shipmentIdstringRequired
Responses
401
Authentication required
post
POST /rest/s1/poorti/shipments/{shipmentId}/ship HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

No content

list ShipmentPackage (master: default)

get
Authorizations
Path parameters
shipmentIdstringRequired
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

shipmentPackageSeqIdstringOptional
shipmentBoxTypeIdstringOptional
dateCreatedstring · date-timeOptional
boxLengthnumberOptional

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

boxHeightnumberOptional

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

boxWidthnumberOptional

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

dimensionUomIdstringOptional

This field store the unit of measurement of dimension (length, width and height)

weightnumberOptional
weightUomIdstringOptional
insuredValuenumberOptional
packageNamestringOptional
lastUpdatedStampstring · date-timeOptional
Responses
200
Success
application/json
get
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-07-12T00:04:16.300Z",
    "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-07-12T00:04:16.300Z"
    },
    "weight": 1,
    "weightUomId": {
      "_entity": "uoms",
      "uomId": "text",
      "uomTypeEnumId": "UT_AREA_MEASURE",
      "abbreviation": "text",
      "description": "text",
      "fractionDigits": 1,
      "symbol": "text",
      "numericCode": 1,
      "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
    },
    "insuredValue": 1,
    "packageName": "text",
    "lastUpdatedStamp": "2025-07-12T00:04:16.300Z",
    "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-07-12T00:04:16.300Z",
      "estimatedShipDate": "2025-07-12T00:04:16.300Z",
      "estimatedShipWorkEffId": "text",
      "estimatedArrivalDate": "2025-07-12T00:04:16.300Z",
      "estimatedArrivalWorkEffId": "text",
      "latestCancelDate": "2025-07-12T00:04:16.300Z",
      "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-07-12T00:04:16.300Z",
      "createdByUserLogin": "text",
      "lastModifiedDate": "2025-07-12T00:04:16.300Z",
      "lastModifiedByUserLogin": "text",
      "carrierPartyId": "text",
      "shipmentMethodTypeId": "text",
      "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
    },
    "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-07-12T00:04:16.300Z"
    },
    "carrierBoxType": [
      {
        "_entity": "org.apache.ofbiz.shipment.shipment.CarrierShipmentBoxType",
        "shipmentBoxTypeId": "text",
        "partyId": "text",
        "packagingTypeCode": "text",
        "oversizeCode": "text",
        "pickupContainerCode": "text",
        "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
      }
    ]
  }
]

create ShipmentPackage

post
Authorizations
Path parameters
shipmentIdstringRequired
Body
shipmentIdstringOptional
shipmentPackageSeqIdstringOptional
shipmentBoxTypeIdstringOptional
boxLengthnumberOptional
boxHeightnumberOptional
boxWidthnumberOptional
dimensionUomIdstringOptional
weightnumberOptional
weightUomIdstringOptional
insuredValuenumberOptional
packageNamestringOptional
lastUpdatedStampstring · date-timeOptional
Responses
200
Success
application/json
post
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-07-12T00:04:16.300Z"
}
{
  "shipmentId": "text",
  "shipmentPackageSeqId": "text"
}

one ShipmentPackage

get
Authorizations
Path parameters
shipmentIdstringRequired
shipmentPackageSeqIdstringRequired
Responses
200
Success
application/json
get
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-07-12T00:04:16.300Z",
  "boxLength": 1,
  "boxHeight": 1,
  "boxWidth": 1,
  "dimensionUomId": "text",
  "weight": 1,
  "weightUomId": "text",
  "insuredValue": 1,
  "packageName": "text",
  "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
}

update ShipmentPackage

put
Authorizations
Path parameters
shipmentIdstringRequired
shipmentPackageSeqIdstringRequired
Body
_entitystringOptionalDefault: org.apache.ofbiz.shipment.shipment.ShipmentPackage
shipmentIdstringOptional
shipmentPackageSeqIdstringOptional
shipmentBoxTypeIdstringOptional
dateCreatedstring · date-timeOptional
boxLengthnumberOptional
boxHeightnumberOptional
boxWidthnumberOptional
dimensionUomIdstringOptional
weightnumberOptional
weightUomIdstringOptional
insuredValuenumberOptional
packageNamestringOptional
lastUpdatedStampstring · date-timeOptional
Responses
200
Success
application/json
put
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-07-12T00:04:16.300Z",
  "boxLength": 1,
  "boxHeight": 1,
  "boxWidth": 1,
  "dimensionUomId": "text",
  "weight": 1,
  "weightUomId": "text",
  "insuredValue": 1,
  "packageName": "text",
  "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
}
{
  "_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackage.PK",
  "shipmentId": "text",
  "shipmentPackageSeqId": "text"
}

get ShippingLabel

get

Get shipping label from Third Party Shipping Services

Authorizations
Path parameters
shipmentIdstringRequired
Query parameters
carrierPartyIdstringOptional
Responses
401
Authentication required
get
GET /rest/s1/poorti/shipments/{shipmentId}/shippingLabels HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

No content

void ShipmentLabel

post

Void shipping label from Third Party Shipping Services

Authorizations
Path parameters
shipmentIdstringRequired
Responses
401
Authentication required
post
POST /rest/s1/poorti/shipments/{shipmentId}/shippingLabels/void HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

No content

list ShipmentPackageContent

get
Authorizations
Path parameters
shipmentIdstringRequired
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

shipmentPackageSeqIdstringOptional
shipmentItemSeqIdstringOptional
quantitynumberOptional
subProductIdstringOptional
subProductQuantitynumberOptional
lastUpdatedStampstring · date-timeOptional
Responses
200
Success
application/json
get
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-07-12T00:04:16.300Z"
  }
]

create ShipmentPackageContent

post
Authorizations
Path parameters
shipmentIdstringRequired
Body
_entitystringOptionalDefault: org.apache.ofbiz.shipment.shipment.ShipmentPackageContent
shipmentIdstringOptional
shipmentPackageSeqIdstringOptional
shipmentItemSeqIdstringOptional
quantitynumberOptional
subProductIdstringOptional
subProductQuantitynumberOptional
lastUpdatedStampstring · date-timeOptional
Responses
200
Success
application/json
post
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-07-12T00:04:16.300Z"
}
{
  "_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackageContent.PK",
  "shipmentId": "text",
  "shipmentPackageSeqId": "text",
  "shipmentItemSeqId": "text"
}

create ShipmentPackageRouteSeg

post
Authorizations
Path parameters
shipmentIdstringRequired
Body
_entitystringOptionalDefault: org.apache.ofbiz.shipment.shipment.ShipmentPackageRouteSeg
shipmentIdstringOptional
shipmentPackageSeqIdstringOptional
shipmentRouteSegmentIdstringOptional
trackingCodestringOptional
boxNumberstringOptional
labelImagestringOptional
labelIntlSignImagestringOptional
labelHtmlstringOptional
labelPrintedstringOptional
internationalInvoicestringOptional
packageTransportCostnumberOptional
packageServiceCostnumberOptional
packageOtherCostnumberOptional
codAmountnumberOptional
insuredAmountnumberOptional
currencyUomIdstringOptional
labelImageUrlstringOptional
internationalInvoiceUrlstringOptional
packagePickupPrnstringOptional
packagePickupDatestring · date-timeOptional
gatewayMessagestringOptional
gatewayStatusstringOptional
lastUpdatedStampstring · date-timeOptional
Responses
200
Success
application/json
post
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-07-12T00:04:16.300Z",
  "gatewayMessage": "text",
  "gatewayStatus": "text",
  "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
}
{
  "_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackageRouteSeg.PK",
  "shipmentId": "text",
  "shipmentPackageSeqId": "text",
  "shipmentRouteSegmentId": "text"
}

update ShipmentRouteSegment

put
Authorizations
Path parameters
shipmentIdstringRequired
Body
_entitystringOptionalDefault: org.apache.ofbiz.shipment.shipment.ShipmentRouteSegment
shipmentIdstringOptional
shipmentRouteSegmentIdstringOptional
deliveryIdstringOptional
originFacilityIdstringOptional
destFacilityIdstringOptional
originContactMechIdstringOptional
originTelecomNumberIdstringOptional
destContactMechIdstringOptional
destTelecomNumberIdstringOptional
carrierPartyIdstringOptional
shipmentMethodTypeIdstringOptional
carrierServiceStatusIdstringOptional
carrierDeliveryZonestringOptional
carrierRestrictionCodesstringOptional
carrierRestrictionDescstringOptional
billingWeightnumberOptional
billingWeightUomIdstringOptional
actualTransportCostnumberOptional
actualServiceCostnumberOptional
actualOtherCostnumberOptional
actualCostnumberOptional
currencyUomIdstringOptional
actualStartDatestring · date-timeOptional
actualArrivalDatestring · date-timeOptional
estimatedStartDatestring · date-timeOptional
estimatedArrivalDatestring · date-timeOptional
trackingIdNumberstringOptional
trackingDigeststringOptional
updatedByUserLoginIdstringOptional
lastUpdatedDatestring · date-timeOptional
homeDeliveryTypestringOptional
homeDeliveryDatestring · date-timeOptional
thirdPartyAccountNumberstringOptional
thirdPartyPostalCodestringOptional
thirdPartyCountryGeoCodestringOptional
upsHighValueReportstringOptional
trackingUrlstringOptional
codReturnLabelImagestringOptional
codReturnLabelHtmlstringOptional
codCollectionAmountnumberOptional
carrierAccountNumberstringOptional
carrierServicestringOptional
isGenerateThirdPartyLabelstringOptional
isTrackingRequiredstringOptional
referenceNumberstringOptional
actualCarrierCodestringOptional
labelImagestringOptional
labelImageUrlstringOptional
labelHtmlstringOptional
requestedDeliveryDatestring · dateOptional
requestedDeliveryTimestringOptional
requestedShipMethTypeIdstringOptional
deliveryWindownumber · doubleOptional
lastUpdatedStampstring · date-timeOptional
Responses
200
Success
application/json
put
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-07-12T00:04:16.300Z",
  "actualArrivalDate": "2025-07-12T00:04:16.300Z",
  "estimatedStartDate": "2025-07-12T00:04:16.300Z",
  "estimatedArrivalDate": "2025-07-12T00:04:16.300Z",
  "trackingIdNumber": "text",
  "trackingDigest": "text",
  "updatedByUserLoginId": "text",
  "lastUpdatedDate": "2025-07-12T00:04:16.300Z",
  "homeDeliveryType": "text",
  "homeDeliveryDate": "2025-07-12T00:04:16.300Z",
  "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-07-12",
  "requestedDeliveryTime": "text",
  "requestedShipMethTypeId": "text",
  "deliveryWindow": 1,
  "lastUpdatedStamp": "2025-07-12T00:04:16.300Z"
}
{
  "_entity": "org.apache.ofbiz.shipment.shipment.ShipmentRouteSegment.PK",
  "shipmentId": "text",
  "shipmentRouteSegmentId": "text"
}

pack Shipments

post

Pack shipments

Authorizations
Body
shipmentsarrayRequired
Responses
200
Success
application/json
post
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": []
}

ship Shipments

post

Pack shipments

Authorizations
Body
shipmentIdsarrayRequired
Responses
401
Authentication required
post
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 ShippingLabel

post

Retry Shipping Label, this would handle do rate shopping and accept shipment accordingly

Authorizations
Body
forceRateShopstringOptionalDefault: N
generateLabelstringOptionalDefault: N
shipmentIdsarrayOptional
Responses
401
Authentication required
post
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
PreviousPicklistsNextShipmentPicklists

Was this helpful?