Shipments

shipments

get Shipments

get

Service to get Inventory Count Import Item details.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

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

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

get

/shipments

HTTPcURLJavaScriptPython

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

basicAuthapi_key

AuthorizationstringRequired

Body

application/jsonmultipart/form-data

_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

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

post

/shipments

HTTPcURLJavaScriptPython

POST /rest/s1/poorti/shipments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 11032

{
  "_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-12-16T11:40:57.900Z",
  "estimatedShipDate": "2025-12-16T11:40:57.900Z",
  "estimatedShipWorkEffId": "text",
  "estimatedArrivalDate": "2025-12-16T11:40:57.900Z",
  "estimatedArrivalWorkEffId": "text",
  "latestCancelDate": "2025-12-16T11:40:57.900Z",
  "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-12-16T11:40:57.900Z",
  "createdByUserLogin": "text",
  "lastModifiedDate": "2025-12-16T11:40:57.900Z",
  "lastModifiedByUserLogin": "text",
  "carrierPartyId": "text",
  "shipmentMethodTypeId": "text",
  "lastUpdatedStamp": "2025-12-16T11:40:57.900Z",
  "type": {
    "_entity": "org.apache.ofbiz.shipment.shipment.ShipmentType",
    "shipmentTypeId": "text",
    "parentTypeId": "text",
    "hasTable": "text",
    "description": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "statusItem": {
    "_entity": "statuses",
    "statusId": "text",
    "statusTypeId": "text",
    "statusCode": "text",
    "sequenceNum": 1,
    "description": "text",
    "statusAge": 1,
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "currencyUom": {
    "_entity": "uoms",
    "uomId": "text",
    "uomTypeEnumId": "UT_AREA_MEASURE",
    "abbreviation": "text",
    "description": "text",
    "fractionDigits": 1,
    "symbol": "text",
    "numericCode": 1,
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "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-12-16T11:40:57.900Z",
    "closedDate": "2025-12-16T11:40:57.900Z",
    "description": "text",
    "defaultDimensionUomId": "text",
    "defaultWeightUomId": "text",
    "geoPointId": "text",
    "externalId": "text",
    "openTime": "text",
    "closeTime": "text",
    "facilityTimeZone": "text",
    "maximumOrderLimit": 1,
    "postalCode": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "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-12-16T11:40:57.900Z",
    "closedDate": "2025-12-16T11:40:57.900Z",
    "description": "text",
    "defaultDimensionUomId": "text",
    "defaultWeightUomId": "text",
    "geoPointId": "text",
    "externalId": "text",
    "openTime": "text",
    "closeTime": "text",
    "facilityTimeZone": "text",
    "maximumOrderLimit": 1,
    "postalCode": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "originContactMech": {
    "_entity": "org.apache.ofbiz.party.contact.ContactMech",
    "contactMechId": "text",
    "externalId": "text",
    "contactMechTypeId": "text",
    "infoString": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "destinationContactMech": {
    "_entity": "org.apache.ofbiz.party.contact.ContactMech",
    "contactMechId": "text",
    "externalId": "text",
    "contactMechTypeId": "text",
    "infoString": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "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-12-16T11:40:57.900Z"
  },
  "originTelecomNumber": {
    "_entity": "org.apache.ofbiz.party.contact.TelecomNumber",
    "contactMechId": "text",
    "countryCode": "text",
    "areaCode": "text",
    "contactNumber": "text",
    "askForName": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "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-12-16T11:40:57.900Z"
  },
  "destinationTelecomNumber": {
    "_entity": "org.apache.ofbiz.party.contact.TelecomNumber",
    "contactMechId": "text",
    "countryCode": "text",
    "areaCode": "text",
    "contactNumber": "text",
    "askForName": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "order": {
    "_entity": "org.apache.ofbiz.order.order.OrderHeader",
    "orderId": "text",
    "orderTypeId": "text",
    "orderName": "text",
    "externalId": "text",
    "salesChannelEnumId": "text",
    "orderDate": "2025-12-16T11:40:57.900Z",
    "priority": "text",
    "entryDate": "2025-12-16T11:40:57.900Z",
    "pickSheetPrintedDate": "2025-12-16T11:40:57.900Z",
    "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-12-16T11:40:57.900Z",
    "localeString": "text",
    "customerClassificationId": "text",
    "presentmentCurrencyUom": "text",
    "autoApprove": "text",
    "statusFlowId": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "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-12-16T11:40:57.900Z",
    "originContactMechId": "text",
    "destinationFacilityId": "text",
    "needsInventoryReceive": "text",
    "currencyUomId": "text",
    "supplierRmaId": "text",
    "returnChannelEnumId": "text",
    "transactionId": "text",
    "returnDate": "2025-12-16T11:40:57.900Z",
    "employeeId": "text",
    "terminalId": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "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-12-16T11:40:57.900Z",
    "shipByDate": "2025-12-16T11:40:57.900Z",
    "estimatedShipDate": "2025-12-16T11:40:57.900Z",
    "estimatedDeliveryDate": "2025-12-16T11:40:57.900Z",
    "carrierAccountNumber": "text",
    "carrierService": "text",
    "orderFacilityId": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z",
    "items": [
      {
        "_entity": "org.apache.ofbiz.order.order.OrderItem",
        "orderId": "text",
        "orderItemSeqId": "text",
        "externalId": "text",
        "orderItemTypeId": "text",
        "orderItemGroupSeqId": "text",
        "isItemGroupPrimary": "text",
        "fromInventoryItemId": "text",
        "budgetId": "text",
        "budgetItemSeqId": "text",
        "productId": "text",
        "supplierProductId": "text",
        "productFeatureId": "text",
        "prodCatalogId": "text",
        "productCategoryId": "text",
        "isPromo": "text",
        "quoteId": "text",
        "quoteItemSeqId": "text",
        "shoppingListId": "text",
        "shoppingListItemSeqId": "text",
        "subscriptionId": "text",
        "deploymentId": "text",
        "quantity": 1,
        "cancelQuantity": 1,
        "selectedAmount": 1,
        "unitPrice": 1,
        "unitListPrice": 1,
        "unitAverageCost": 1,
        "unitRecurringPrice": 1,
        "isModifiedPrice": "text",
        "recurringFreqUomId": "text",
        "itemDescription": "text",
        "comments": "text",
        "correspondingPoId": "text",
        "statusId": "text",
        "syncStatusId": "text",
        "estimatedShipDate": "2025-12-16T11:40:57.900Z",
        "estimatedDeliveryDate": "2025-12-16T11:40:57.900Z",
        "autoCancelDate": "2025-12-16T11:40:57.900Z",
        "dontCancelSetDate": "2025-12-16T11:40:57.900Z",
        "dontCancelSetUserLogin": "text",
        "shipBeforeDate": "2025-12-16T11:40:57.900Z",
        "shipAfterDate": "2025-12-16T11:40:57.900Z",
        "cancelBackOrderDate": "2025-12-16T11:40:57.900Z",
        "overrideGlAccountId": "text",
        "salesOpportunityId": "text",
        "changeByUserLoginId": "text",
        "shipGroupSeqId": "text",
        "returnTillDate": "2025-12-16T11:40:57.900Z",
        "promisedDatetime": "2025-12-16T11:40:57.900Z",
        "shipmentId": "text",
        "isNewProduct": "text",
        "availableToPromise": 1,
        "requestedDeliveryDate": "2025-12-16",
        "requestedDeliveryTime": "text",
        "requestedShipMethTypeId": "text",
        "deliveryWindow": 1,
        "taxCode": "text",
        "lastUpdatedStamp": "2025-12-16T11:40:57.900Z",
        "adjustments": [
          {
            "_entity": "org.apache.ofbiz.order.order.OrderAdjustment",
            "orderAdjustmentId": "text",
            "orderAdjustmentTypeId": "text",
            "orderId": "text",
            "orderItemSeqId": "text",
            "shipGroupSeqId": "text",
            "comments": "text",
            "description": "text",
            "amount": 1,
            "recurringAmount": 1,
            "amountAlreadyIncluded": 1,
            "productPromoId": "text",
            "productPromoRuleId": "text",
            "productPromoActionSeqId": "text",
            "productFeatureId": "text",
            "correspondingProductId": "text",
            "taxAuthorityRateSeqId": "text",
            "sourceReferenceId": "text",
            "sourcePercentage": 1,
            "customerReferenceId": "text",
            "primaryGeoId": "text",
            "secondaryGeoId": "text",
            "exemptAmount": 1,
            "taxAuthGeoId": "text",
            "taxAuthPartyId": "text",
            "overrideGlAccountId": "text",
            "includeInTax": "text",
            "includeInShipping": "text",
            "isManual": "text",
            "createdDate": "2025-12-16T11:40:57.900Z",
            "createdByUserLogin": "text",
            "lastModifiedDate": "2025-12-16T11:40:57.900Z",
            "lastModifiedByUserLogin": "text",
            "originalAdjustmentId": "text",
            "oldAmountPerQuantity": 1,
            "oldPercentage": 1,
            "billingShipmentId": "text",
            "lastUpdatedStamp": "2025-12-16T11:40:57.900Z",
            "attributes": [
              {
                "_entity": "org.apache.ofbiz.order.order.OrderAdjustmentAttribute",
                "orderAdjustmentId": "text",
                "attrName": "text",
                "attrValue": "text",
                "attrDescription": "text",
                "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
              }
            ]
          }
        ],
        "attributes": [
          {
            "_entity": "org.apache.ofbiz.order.order.OrderItemAttribute",
            "orderId": "text",
            "orderItemSeqId": "text",
            "attrName": "text",
            "attrValue": "text",
            "attrDescription": "text",
            "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
          }
        ],
        "statuses": [
          {
            "_entity": "org.apache.ofbiz.order.order.OrderStatus",
            "orderStatusId": "text",
            "statusId": "text",
            "orderId": "text",
            "orderItemSeqId": "text",
            "orderPaymentPreferenceId": "text",
            "statusDatetime": "2025-12-16T11:40:57.900Z",
            "statusUserLogin": "text",
            "changeReason": "text",
            "changeReasonEnumId": "text",
            "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
          }
        ]
      }
    ]
  }
}

application/jsonmultipart/form-data

{
  "_entity": "org.apache.ofbiz.shipment.shipment.Shipment.PK",
  "shipmentId": "text"
}

update Shipment (master: default)

put

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

shipmentIdstringRequired

Body

application/jsonmultipart/form-data

_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

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

put

/shipments/{shipmentId}

HTTPcURLJavaScriptPython

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: 11032

{
  "_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-12-16T11:40:57.900Z",
  "estimatedShipDate": "2025-12-16T11:40:57.900Z",
  "estimatedShipWorkEffId": "text",
  "estimatedArrivalDate": "2025-12-16T11:40:57.900Z",
  "estimatedArrivalWorkEffId": "text",
  "latestCancelDate": "2025-12-16T11:40:57.900Z",
  "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-12-16T11:40:57.900Z",
  "createdByUserLogin": "text",
  "lastModifiedDate": "2025-12-16T11:40:57.900Z",
  "lastModifiedByUserLogin": "text",
  "carrierPartyId": "text",
  "shipmentMethodTypeId": "text",
  "lastUpdatedStamp": "2025-12-16T11:40:57.900Z",
  "type": {
    "_entity": "org.apache.ofbiz.shipment.shipment.ShipmentType",
    "shipmentTypeId": "text",
    "parentTypeId": "text",
    "hasTable": "text",
    "description": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "statusItem": {
    "_entity": "statuses",
    "statusId": "text",
    "statusTypeId": "text",
    "statusCode": "text",
    "sequenceNum": 1,
    "description": "text",
    "statusAge": 1,
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "currencyUom": {
    "_entity": "uoms",
    "uomId": "text",
    "uomTypeEnumId": "UT_AREA_MEASURE",
    "abbreviation": "text",
    "description": "text",
    "fractionDigits": 1,
    "symbol": "text",
    "numericCode": 1,
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "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-12-16T11:40:57.900Z",
    "closedDate": "2025-12-16T11:40:57.900Z",
    "description": "text",
    "defaultDimensionUomId": "text",
    "defaultWeightUomId": "text",
    "geoPointId": "text",
    "externalId": "text",
    "openTime": "text",
    "closeTime": "text",
    "facilityTimeZone": "text",
    "maximumOrderLimit": 1,
    "postalCode": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "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-12-16T11:40:57.900Z",
    "closedDate": "2025-12-16T11:40:57.900Z",
    "description": "text",
    "defaultDimensionUomId": "text",
    "defaultWeightUomId": "text",
    "geoPointId": "text",
    "externalId": "text",
    "openTime": "text",
    "closeTime": "text",
    "facilityTimeZone": "text",
    "maximumOrderLimit": 1,
    "postalCode": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "originContactMech": {
    "_entity": "org.apache.ofbiz.party.contact.ContactMech",
    "contactMechId": "text",
    "externalId": "text",
    "contactMechTypeId": "text",
    "infoString": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "destinationContactMech": {
    "_entity": "org.apache.ofbiz.party.contact.ContactMech",
    "contactMechId": "text",
    "externalId": "text",
    "contactMechTypeId": "text",
    "infoString": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "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-12-16T11:40:57.900Z"
  },
  "originTelecomNumber": {
    "_entity": "org.apache.ofbiz.party.contact.TelecomNumber",
    "contactMechId": "text",
    "countryCode": "text",
    "areaCode": "text",
    "contactNumber": "text",
    "askForName": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "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-12-16T11:40:57.900Z"
  },
  "destinationTelecomNumber": {
    "_entity": "org.apache.ofbiz.party.contact.TelecomNumber",
    "contactMechId": "text",
    "countryCode": "text",
    "areaCode": "text",
    "contactNumber": "text",
    "askForName": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "order": {
    "_entity": "org.apache.ofbiz.order.order.OrderHeader",
    "orderId": "text",
    "orderTypeId": "text",
    "orderName": "text",
    "externalId": "text",
    "salesChannelEnumId": "text",
    "orderDate": "2025-12-16T11:40:57.900Z",
    "priority": "text",
    "entryDate": "2025-12-16T11:40:57.900Z",
    "pickSheetPrintedDate": "2025-12-16T11:40:57.900Z",
    "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-12-16T11:40:57.900Z",
    "localeString": "text",
    "customerClassificationId": "text",
    "presentmentCurrencyUom": "text",
    "autoApprove": "text",
    "statusFlowId": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "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-12-16T11:40:57.900Z",
    "originContactMechId": "text",
    "destinationFacilityId": "text",
    "needsInventoryReceive": "text",
    "currencyUomId": "text",
    "supplierRmaId": "text",
    "returnChannelEnumId": "text",
    "transactionId": "text",
    "returnDate": "2025-12-16T11:40:57.900Z",
    "employeeId": "text",
    "terminalId": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
  },
  "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-12-16T11:40:57.900Z",
    "shipByDate": "2025-12-16T11:40:57.900Z",
    "estimatedShipDate": "2025-12-16T11:40:57.900Z",
    "estimatedDeliveryDate": "2025-12-16T11:40:57.900Z",
    "carrierAccountNumber": "text",
    "carrierService": "text",
    "orderFacilityId": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z",
    "items": [
      {
        "_entity": "org.apache.ofbiz.order.order.OrderItem",
        "orderId": "text",
        "orderItemSeqId": "text",
        "externalId": "text",
        "orderItemTypeId": "text",
        "orderItemGroupSeqId": "text",
        "isItemGroupPrimary": "text",
        "fromInventoryItemId": "text",
        "budgetId": "text",
        "budgetItemSeqId": "text",
        "productId": "text",
        "supplierProductId": "text",
        "productFeatureId": "text",
        "prodCatalogId": "text",
        "productCategoryId": "text",
        "isPromo": "text",
        "quoteId": "text",
        "quoteItemSeqId": "text",
        "shoppingListId": "text",
        "shoppingListItemSeqId": "text",
        "subscriptionId": "text",
        "deploymentId": "text",
        "quantity": 1,
        "cancelQuantity": 1,
        "selectedAmount": 1,
        "unitPrice": 1,
        "unitListPrice": 1,
        "unitAverageCost": 1,
        "unitRecurringPrice": 1,
        "isModifiedPrice": "text",
        "recurringFreqUomId": "text",
        "itemDescription": "text",
        "comments": "text",
        "correspondingPoId": "text",
        "statusId": "text",
        "syncStatusId": "text",
        "estimatedShipDate": "2025-12-16T11:40:57.900Z",
        "estimatedDeliveryDate": "2025-12-16T11:40:57.900Z",
        "autoCancelDate": "2025-12-16T11:40:57.900Z",
        "dontCancelSetDate": "2025-12-16T11:40:57.900Z",
        "dontCancelSetUserLogin": "text",
        "shipBeforeDate": "2025-12-16T11:40:57.900Z",
        "shipAfterDate": "2025-12-16T11:40:57.900Z",
        "cancelBackOrderDate": "2025-12-16T11:40:57.900Z",
        "overrideGlAccountId": "text",
        "salesOpportunityId": "text",
        "changeByUserLoginId": "text",
        "shipGroupSeqId": "text",
        "returnTillDate": "2025-12-16T11:40:57.900Z",
        "promisedDatetime": "2025-12-16T11:40:57.900Z",
        "shipmentId": "text",
        "isNewProduct": "text",
        "availableToPromise": 1,
        "requestedDeliveryDate": "2025-12-16",
        "requestedDeliveryTime": "text",
        "requestedShipMethTypeId": "text",
        "deliveryWindow": 1,
        "taxCode": "text",
        "lastUpdatedStamp": "2025-12-16T11:40:57.900Z",
        "adjustments": [
          {
            "_entity": "org.apache.ofbiz.order.order.OrderAdjustment",
            "orderAdjustmentId": "text",
            "orderAdjustmentTypeId": "text",
            "orderId": "text",
            "orderItemSeqId": "text",
            "shipGroupSeqId": "text",
            "comments": "text",
            "description": "text",
            "amount": 1,
            "recurringAmount": 1,
            "amountAlreadyIncluded": 1,
            "productPromoId": "text",
            "productPromoRuleId": "text",
            "productPromoActionSeqId": "text",
            "productFeatureId": "text",
            "correspondingProductId": "text",
            "taxAuthorityRateSeqId": "text",
            "sourceReferenceId": "text",
            "sourcePercentage": 1,
            "customerReferenceId": "text",
            "primaryGeoId": "text",
            "secondaryGeoId": "text",
            "exemptAmount": 1,
            "taxAuthGeoId": "text",
            "taxAuthPartyId": "text",
            "overrideGlAccountId": "text",
            "includeInTax": "text",
            "includeInShipping": "text",
            "isManual": "text",
            "createdDate": "2025-12-16T11:40:57.900Z",
            "createdByUserLogin": "text",
            "lastModifiedDate": "2025-12-16T11:40:57.900Z",
            "lastModifiedByUserLogin": "text",
            "originalAdjustmentId": "text",
            "oldAmountPerQuantity": 1,
            "oldPercentage": 1,
            "billingShipmentId": "text",
            "lastUpdatedStamp": "2025-12-16T11:40:57.900Z",
            "attributes": [
              {
                "_entity": "org.apache.ofbiz.order.order.OrderAdjustmentAttribute",
                "orderAdjustmentId": "text",
                "attrName": "text",
                "attrValue": "text",
                "attrDescription": "text",
                "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
              }
            ]
          }
        ],
        "attributes": [
          {
            "_entity": "org.apache.ofbiz.order.order.OrderItemAttribute",
            "orderId": "text",
            "orderItemSeqId": "text",
            "attrName": "text",
            "attrValue": "text",
            "attrDescription": "text",
            "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
          }
        ],
        "statuses": [
          {
            "_entity": "org.apache.ofbiz.order.order.OrderStatus",
            "orderStatusId": "text",
            "statusId": "text",
            "orderId": "text",
            "orderItemSeqId": "text",
            "orderPaymentPreferenceId": "text",
            "statusDatetime": "2025-12-16T11:40:57.900Z",
            "statusUserLogin": "text",
            "changeReason": "text",
            "changeReasonEnumId": "text",
            "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
          }
        ]
      }
    ]
  }
}

application/jsonmultipart/form-data

{
  "_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

basicAuthapi_key

AuthorizationstringRequired

Path parameters

shipmentIdstringRequired

Body

application/jsonmultipart/form-data

shipmentIdstringRequired

facilityIdstringRequired

orderIdstringRequired

shipmentPackageContentsarrayOptional

rejectedOrderItemsarrayOptional

trackingCodestringOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/shipments/{shipmentId}/pack

HTTPcURLJavaScriptPython

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"
}

application/jsonmultipart/form-data

{
  "packedShipmentId": "text"
}

unpack Shipment

post

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

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

shipmentIdstringRequired

Responses

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/shipments/{shipmentId}/unpack

HTTPcURLJavaScriptPython

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

basicAuthapi_key

AuthorizationstringRequired

Path parameters

shipmentIdstringRequired

Responses

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/shipments/{shipmentId}/ship

HTTPcURLJavaScriptPython

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

basicAuthapi_key

AuthorizationstringRequired

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

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/shipments/{shipmentId}/shipmentPackages

HTTPcURLJavaScriptPython

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-12-16T11:40:57.900Z",
    "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-12-16T11:40:57.900Z"
    },
    "weight": 1,
    "weightUomId": {
      "_entity": "uoms",
      "uomId": "text",
      "uomTypeEnumId": "UT_AREA_MEASURE",
      "abbreviation": "text",
      "description": "text",
      "fractionDigits": 1,
      "symbol": "text",
      "numericCode": 1,
      "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
    },
    "insuredValue": 1,
    "packageName": "text",
    "lastUpdatedStamp": "2025-12-16T11:40:57.900Z",
    "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-12-16T11:40:57.900Z",
      "estimatedShipDate": "2025-12-16T11:40:57.900Z",
      "estimatedShipWorkEffId": "text",
      "estimatedArrivalDate": "2025-12-16T11:40:57.900Z",
      "estimatedArrivalWorkEffId": "text",
      "latestCancelDate": "2025-12-16T11:40:57.900Z",
      "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-12-16T11:40:57.900Z",
      "createdByUserLogin": "text",
      "lastModifiedDate": "2025-12-16T11:40:57.900Z",
      "lastModifiedByUserLogin": "text",
      "carrierPartyId": "text",
      "shipmentMethodTypeId": "text",
      "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
    },
    "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-12-16T11:40:57.900Z"
    },
    "carrierBoxType": [
      {
        "_entity": "org.apache.ofbiz.shipment.shipment.CarrierShipmentBoxType",
        "shipmentBoxTypeId": "text",
        "partyId": "text",
        "packagingTypeCode": "text",
        "oversizeCode": "text",
        "pickupContainerCode": "text",
        "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
      }
    ]
  }
]

create ShipmentPackage

post

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

shipmentIdstringRequired

Body

application/jsonmultipart/form-data

shipmentIdstringOptional

shipmentPackageSeqIdstringOptional

shipmentBoxTypeIdstringOptional

boxLengthnumberOptional

boxHeightnumberOptional

boxWidthnumberOptional

dimensionUomIdstringOptional

weightnumberOptional

weightUomIdstringOptional

insuredValuenumberOptional

packageNamestringOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/shipments/{shipmentId}/shipmentPackages

HTTPcURLJavaScriptPython

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-12-16T11:40:57.900Z"
}

application/jsonmultipart/form-data

{
  "shipmentId": "text",
  "shipmentPackageSeqId": "text"
}

one ShipmentPackage

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

shipmentIdstringRequired

shipmentPackageSeqIdstringRequired

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

/shipments/{shipmentId}/shipmentPackages/{shipmentPackageSeqId}

HTTPcURLJavaScriptPython

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-12-16T11:40:57.900Z",
  "boxLength": 1,
  "boxHeight": 1,
  "boxWidth": 1,
  "dimensionUomId": "text",
  "weight": 1,
  "weightUomId": "text",
  "insuredValue": 1,
  "packageName": "text",
  "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
}

update ShipmentPackage

put

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

shipmentIdstringRequired

shipmentPackageSeqIdstringRequired

Body

application/jsonmultipart/form-data

_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

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

put

/shipments/{shipmentId}/shipmentPackages/{shipmentPackageSeqId}

HTTPcURLJavaScriptPython

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-12-16T11:40:57.900Z",
  "boxLength": 1,
  "boxHeight": 1,
  "boxWidth": 1,
  "dimensionUomId": "text",
  "weight": 1,
  "weightUomId": "text",
  "insuredValue": 1,
  "packageName": "text",
  "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
}

application/jsonmultipart/form-data

{
  "_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackage.PK",
  "shipmentId": "text",
  "shipmentPackageSeqId": "text"
}

get ShippingLabel

get

Get shipping label from Third Party Shipping Services

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

shipmentIdstringRequired

Query parameters

carrierPartyIdstringOptional

Responses

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

get

/shipments/{shipmentId}/shippingLabels

HTTPcURLJavaScriptPython

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

basicAuthapi_key

AuthorizationstringRequired

Path parameters

shipmentIdstringRequired

Responses

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/shipments/{shipmentId}/shippingLabels/void

HTTPcURLJavaScriptPython

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

basicAuthapi_key

AuthorizationstringRequired

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

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/shipments/{shipmentId}/shipmentPackageContents

HTTPcURLJavaScriptPython

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-12-16T11:40:57.900Z"
  }
]

create ShipmentPackageContent

post

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

shipmentIdstringRequired

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: org.apache.ofbiz.shipment.shipment.ShipmentPackageContent

shipmentIdstringOptional

shipmentPackageSeqIdstringOptional

shipmentItemSeqIdstringOptional

quantitynumberOptional

subProductIdstringOptional

subProductQuantitynumberOptional

lastUpdatedStampstring · 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

post

/shipments/{shipmentId}/shipmentPackageContents

HTTPcURLJavaScriptPython

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-12-16T11:40:57.900Z"
}

application/jsonmultipart/form-data

{
  "_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackageContent.PK",
  "shipmentId": "text",
  "shipmentPackageSeqId": "text",
  "shipmentItemSeqId": "text"
}

create ShipmentPackageRouteSeg

post

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

shipmentIdstringRequired

Body

application/jsonmultipart/form-data

_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

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

post

/shipments/{shipmentId}/shipmentPackageRouteSegments

HTTPcURLJavaScriptPython

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-12-16T11:40:57.900Z",
  "gatewayMessage": "text",
  "gatewayStatus": "text",
  "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
}

application/jsonmultipart/form-data

{
  "_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackageRouteSeg.PK",
  "shipmentId": "text",
  "shipmentPackageSeqId": "text",
  "shipmentRouteSegmentId": "text"
}

update ShipmentRouteSegment

put

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

shipmentIdstringRequired

Body

application/jsonmultipart/form-data

_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

gatewayRateIdstringOptional

lastUpdatedStampstring · 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

put

/shipments/{shipmentId}/shipmentRouteSegment

HTTPcURLJavaScriptPython

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: 1671

{
  "_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-12-16T11:40:57.900Z",
  "actualArrivalDate": "2025-12-16T11:40:57.900Z",
  "estimatedStartDate": "2025-12-16T11:40:57.900Z",
  "estimatedArrivalDate": "2025-12-16T11:40:57.900Z",
  "trackingIdNumber": "text",
  "trackingDigest": "text",
  "updatedByUserLoginId": "text",
  "lastUpdatedDate": "2025-12-16T11:40:57.900Z",
  "homeDeliveryType": "text",
  "homeDeliveryDate": "2025-12-16T11:40:57.900Z",
  "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-12-16",
  "requestedDeliveryTime": "text",
  "requestedShipMethTypeId": "text",
  "deliveryWindow": 1,
  "gatewayRateId": "text",
  "lastUpdatedStamp": "2025-12-16T11:40:57.900Z"
}

application/jsonmultipart/form-data

{
  "_entity": "org.apache.ofbiz.shipment.shipment.ShipmentRouteSegment.PK",
  "shipmentId": "text",
  "shipmentRouteSegmentId": "text"
}

pack Shipments

post

Pack shipments

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Body

application/jsonmultipart/form-data

shipmentsarrayRequired

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/shipments/bulkPack

HTTPcURLJavaScriptPython

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": []
}

application/jsonmultipart/form-data

{
  "packedShipmentIds": []
}

ship Shipments

post

Pack shipments

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Body

application/jsonmultipart/form-data

shipmentIdsarrayRequired

Responses

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/shipments/bulkShip

HTTPcURLJavaScriptPython

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": []
}

application/jsonmultipart/form-data

No content

retry ShippingLabel

post

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

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Body

application/jsonmultipart/form-data

forceRateShopstringOptionalDefault: N

generateLabelstringOptionalDefault: N

shipmentIdsarrayOptional

Responses

401

Authentication required

403

Access Forbidden (no authz)

429

Too Many Requests (tarpit)

500

General Error

post

/shipments/retryShippingLabel

HTTPcURLJavaScriptPython

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": []
}

application/jsonmultipart/form-data

No content