ShipmentPicklists

shipmentPicklists

list Shipment (master: picklistShipment)

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Query parameters

pageIndexnumber · int32Optional

Page number to return, starting with zero

pageSizenumber · int32Optional

Number of records per page (default 100)

orderByFieldstringOptional

Field name to order by (or comma separated names)

pageNoLimitstringOptional

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

dependentLevelsnumber · int32Optional

Levels of dependent child records to include

shipmentIdstringOptional

externalIdstringOptional

This field stores product category ID of the external system

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

_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

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/shipmentPicklists

HTTPcURLJavaScriptPython

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

[
  {
    "_entity": "org.apache.ofbiz.shipment.shipment.Shipment",
    "shipmentId": "text",
    "externalId": "text",
    "shipmentTypeId": "text",
    "statusId": "text",
    "primaryOrderId": "text",
    "primaryReturnId": "text",
    "primaryShipGroupSeqId": "text",
    "picklistBinId": "text",
    "estimatedReadyDate": "2026-02-20T00:37:31.825Z",
    "estimatedShipDate": "2026-02-20T00:37:31.825Z",
    "estimatedShipWorkEffId": "text",
    "estimatedArrivalDate": "2026-02-20T00:37:31.825Z",
    "estimatedArrivalWorkEffId": "text",
    "latestCancelDate": "2026-02-20T00:37:31.825Z",
    "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": "2026-02-20T00:37:31.825Z",
    "createdByUserLogin": "text",
    "lastModifiedDate": "2026-02-20T00:37:31.825Z",
    "lastModifiedByUserLogin": "text",
    "carrierPartyId": "text",
    "shipmentMethodTypeId": "text",
    "lastUpdatedStamp": "2026-02-20T00:37:31.825Z",
    "picklistShipment": [
      {
        "_entity": "org.apache.ofbiz.shipment.picklist.PicklistShipment",
        "picklistId": "text",
        "shipmentId": "text",
        "lastUpdatedStamp": "2026-02-20T00:37:31.825Z",
        "picklist": {
          "_entity": "org.apache.ofbiz.shipment.picklist.Picklist",
          "picklistId": "text",
          "externalId": "text",
          "description": "text",
          "facilityId": "text",
          "shipmentMethodTypeId": "text",
          "statusId": "text",
          "picklistDate": "2026-02-20T00:37:31.825Z",
          "createdByUserLogin": "text",
          "lastModifiedByUserLogin": "text",
          "lastUpdatedStamp": "2026-02-20T00:37:31.825Z",
          "roles": [
            {
              "_entity": "org.apache.ofbiz.shipment.picklist.PicklistRole",
              "picklistId": "text",
              "partyId": "text",
              "roleTypeId": "text",
              "fromDate": "2026-02-20T00:37:31.825Z",
              "thruDate": "2026-02-20T00:37:31.825Z",
              "createdByUserLogin": "text",
              "lastModifiedByUserLogin": "text",
              "lastUpdatedStamp": "2026-02-20T00:37:31.825Z",
              "person": {
                "_entity": "org.apache.ofbiz.party.party.Person",
                "partyId": "text",
                "salutation": "text",
                "firstName": "text",
                "middleName": "text",
                "lastName": "text",
                "personalTitle": "text",
                "suffix": "text",
                "nickname": "text",
                "firstNameLocal": "text",
                "middleNameLocal": "text",
                "lastNameLocal": "text",
                "otherLocal": "text",
                "memberId": "text",
                "gender": "text",
                "birthDate": "2026-02-20",
                "deceasedDate": "2026-02-20",
                "height": 1,
                "weight": 1,
                "mothersMaidenName": "text",
                "maritalStatus": "text",
                "socialSecurityNumber": "text",
                "passportNumber": "text",
                "passportExpireDate": "2026-02-20",
                "totalYearsWorkExperience": 1,
                "comments": "text",
                "employmentStatusEnumId": "text",
                "residenceStatusEnumId": "text",
                "occupation": "text",
                "yearsWithEmployer": 1,
                "monthsWithEmployer": 1,
                "existingCustomer": "text",
                "cardId": "text",
                "anniversaryDate": "2026-02-20",
                "lastUpdatedStamp": "2026-02-20T00:37:31.825Z"
              },
              "partyGroup": {
                "_entity": "org.apache.ofbiz.party.party.PartyGroup",
                "partyId": "text",
                "groupName": "text",
                "groupNameLocal": "text",
                "officeSiteName": "text",
                "annualRevenue": 1,
                "numEmployees": 1,
                "tickerSymbol": "text",
                "comments": "text",
                "logoImageUrl": "text",
                "pdfLogoImageUrl": "text",
                "lastUpdatedStamp": "2026-02-20T00:37:31.825Z"
              }
            }
          ]
        }
      }
    ],
    "order": {
      "_entity": "org.apache.ofbiz.order.order.OrderHeader",
      "orderId": "text",
      "orderTypeId": "text",
      "orderName": "text",
      "externalId": "text",
      "salesChannelEnumId": "text",
      "orderDate": "2026-02-20T00:37:31.825Z",
      "priority": "text",
      "entryDate": "2026-02-20T00:37:31.825Z",
      "pickSheetPrintedDate": "2026-02-20T00:37:31.825Z",
      "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": "2026-02-20T00:37:31.825Z",
      "localeString": "text",
      "customerClassificationId": "text",
      "presentmentCurrencyUom": "text",
      "autoApprove": "text",
      "statusFlowId": "text",
      "lastUpdatedStamp": "2026-02-20T00:37:31.825Z"
    }
  }
]