# ShipmentPicklists

shipmentPicklists

## GET /shipmentPicklists

> list Shipment (master: picklistShipment)

```json
{"openapi":"3.1.1","info":{"title":"Poorti API","version":"1.0.0"},"tags":[{"name":"shipmentPicklists","description":"shipmentPicklists"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/poorti"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"org.apache.ofbiz.shipment.shipment.Shipment.picklistShipment":{"title":"Shipment (Master: picklistShipment)","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.shipment.shipment.Shipment"},"shipmentId":{"type":"string"},"externalId":{"type":"string"},"shipmentTypeId":{"type":"string"},"statusId":{"type":"string"},"primaryOrderId":{"type":"string"},"primaryReturnId":{"type":"string"},"primaryShipGroupSeqId":{"type":"string"},"picklistBinId":{"type":"string"},"estimatedReadyDate":{"type":"string","format":"date-time"},"estimatedShipDate":{"type":"string","format":"date-time"},"estimatedShipWorkEffId":{"type":"string"},"estimatedArrivalDate":{"type":"string","format":"date-time"},"estimatedArrivalWorkEffId":{"type":"string"},"latestCancelDate":{"type":"string","format":"date-time"},"estimatedShipCost":{"type":"number"},"currencyUomId":{"type":"string"},"handlingInstructions":{"type":"string"},"originFacilityId":{"type":"string"},"destinationFacilityId":{"type":"string"},"originContactMechId":{"type":"string"},"originTelecomNumberId":{"type":"string"},"destinationContactMechId":{"type":"string"},"destinationTelecomNumberId":{"type":"string"},"partyIdTo":{"type":"string"},"partyIdFrom":{"type":"string"},"additionalShippingCharge":{"type":"number"},"addtlShippingChargeDesc":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"createdByUserLogin":{"type":"string"},"lastModifiedDate":{"type":"string","format":"date-time"},"lastModifiedByUserLogin":{"type":"string"},"carrierPartyId":{"type":"string"},"shipmentMethodTypeId":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"picklistShipment":{"type":"array","items":{"$ref":"#/components/schemas/org.apache.ofbiz.shipment.picklist.PicklistShipment"}},"order":{"$ref":"#/components/schemas/org.apache.ofbiz.order.order.OrderHeader"}}},"org.apache.ofbiz.shipment.picklist.PicklistShipment":{"title":"Picklist Shipment","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.shipment.picklist.PicklistShipment"},"picklistId":{"type":"string"},"shipmentId":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"picklist":{"$ref":"#/components/schemas/org.apache.ofbiz.shipment.picklist.Picklist"}}},"org.apache.ofbiz.shipment.picklist.Picklist":{"title":"Picklist","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.shipment.picklist.Picklist"},"picklistId":{"type":"string"},"externalId":{"type":"string"},"description":{"type":"string"},"facilityId":{"type":"string"},"shipmentMethodTypeId":{"type":"string"},"statusId":{"type":"string"},"picklistDate":{"type":"string","format":"date-time"},"createdByUserLogin":{"type":"string"},"lastModifiedByUserLogin":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/org.apache.ofbiz.shipment.picklist.PicklistRole"}}}},"org.apache.ofbiz.shipment.picklist.PicklistRole":{"title":"Picklist Role","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.shipment.picklist.PicklistRole"},"picklistId":{"type":"string"},"partyId":{"type":"string"},"roleTypeId":{"type":"string"},"fromDate":{"type":"string","format":"date-time"},"thruDate":{"type":"string","format":"date-time"},"createdByUserLogin":{"type":"string"},"lastModifiedByUserLogin":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"person":{"$ref":"#/components/schemas/org.apache.ofbiz.party.party.Person"},"partyGroup":{"$ref":"#/components/schemas/org.apache.ofbiz.party.party.PartyGroup"}}},"org.apache.ofbiz.party.party.Person":{"title":"Person","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.party.party.Person"},"partyId":{"type":"string"},"salutation":{"type":"string"},"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"},"personalTitle":{"type":"string"},"suffix":{"type":"string"},"nickname":{"type":"string"},"firstNameLocal":{"type":"string"},"middleNameLocal":{"type":"string"},"lastNameLocal":{"type":"string"},"otherLocal":{"type":"string"},"memberId":{"type":"string"},"gender":{"type":"string"},"birthDate":{"type":"string","format":"date"},"deceasedDate":{"type":"string","format":"date"},"height":{"type":"number","format":"double"},"weight":{"type":"number","format":"double"},"mothersMaidenName":{"type":"string"},"maritalStatus":{"type":"string"},"socialSecurityNumber":{"type":"string"},"passportNumber":{"type":"string"},"passportExpireDate":{"type":"string","format":"date"},"totalYearsWorkExperience":{"type":"number","format":"double"},"comments":{"type":"string"},"employmentStatusEnumId":{"type":"string"},"residenceStatusEnumId":{"type":"string"},"occupation":{"type":"string"},"yearsWithEmployer":{"type":"number","format":"int64"},"monthsWithEmployer":{"type":"number","format":"int64"},"existingCustomer":{"type":"string"},"cardId":{"type":"string"},"anniversaryDate":{"type":"string","format":"date"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}},"org.apache.ofbiz.party.party.PartyGroup":{"title":"Party Group","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.party.party.PartyGroup"},"partyId":{"type":"string"},"groupName":{"type":"string"},"groupNameLocal":{"type":"string"},"officeSiteName":{"type":"string"},"annualRevenue":{"type":"number"},"numEmployees":{"type":"number","format":"int64"},"tickerSymbol":{"type":"string"},"comments":{"type":"string"},"logoImageUrl":{"type":"string"},"pdfLogoImageUrl":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}},"org.apache.ofbiz.order.order.OrderHeader":{"title":"Order Header","type":"object","properties":{"_entity":{"type":"string","default":"org.apache.ofbiz.order.order.OrderHeader"},"orderId":{"type":"string"},"orderTypeId":{"type":"string"},"orderName":{"type":"string"},"externalId":{"type":"string"},"salesChannelEnumId":{"type":"string"},"orderDate":{"type":"string","format":"date-time"},"priority":{"type":"string"},"entryDate":{"type":"string","format":"date-time"},"pickSheetPrintedDate":{"type":"string","format":"date-time"},"visitId":{"type":"string"},"statusId":{"type":"string"},"createdBy":{"type":"string"},"firstAttemptOrderId":{"type":"string"},"currencyUom":{"type":"string"},"syncStatusId":{"type":"string"},"billingAccountId":{"type":"string"},"originFacilityId":{"type":"string"},"webSiteId":{"type":"string"},"productStoreId":{"type":"string"},"terminalId":{"type":"string"},"transactionId":{"type":"string"},"autoOrderShoppingListId":{"type":"string"},"needsInventoryIssuance":{"type":"string"},"isRushOrder":{"type":"string"},"internalCode":{"type":"string"},"remainingSubTotal":{"type":"number"},"grandTotal":{"type":"number"},"isViewed":{"type":"string"},"invoicePerShipment":{"type":"string"},"expireDate":{"type":"string","format":"date-time"},"localeString":{"type":"string"},"customerClassificationId":{"type":"string"},"presentmentCurrencyUom":{"type":"string"},"autoApprove":{"type":"string"},"statusFlowId":{"type":"string"},"lastUpdatedStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/shipmentPicklists":{"get":{"tags":["shipmentPicklists"],"summary":"list Shipment (master: picklistShipment)","description":null,"parameters":[{"schema":{"type":"number","format":"int32"},"name":"pageIndex","in":"query","required":false,"description":"Page number to return, starting with zero"},{"schema":{"type":"number","format":"int32"},"name":"pageSize","in":"query","required":false,"description":"Number of records per page (default 100)"},{"schema":{"type":"string"},"name":"orderByField","in":"query","required":false,"description":"Field name to order by (or comma separated names)"},{"schema":{"type":"string"},"name":"pageNoLimit","in":"query","required":false,"description":"If true don't limit page size (no pagination)"},{"schema":{"type":"number","format":"int32"},"name":"dependentLevels","in":"query","required":false,"description":"Levels of dependent child records to include"},{"schema":{"type":"string","format":""},"name":"shipmentId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"externalId","in":"query","required":false,"description":"This field stores product category ID of the external system"},{"schema":{"type":"string","format":""},"name":"shipmentTypeId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"statusId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"primaryOrderId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"primaryReturnId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"primaryShipGroupSeqId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"picklistBinId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"estimatedReadyDate","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"estimatedShipDate","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"estimatedShipWorkEffId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"estimatedArrivalDate","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"estimatedArrivalWorkEffId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"latestCancelDate","in":"query","required":false,"description":null},{"schema":{"type":"number","format":""},"name":"estimatedShipCost","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"currencyUomId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"handlingInstructions","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"originFacilityId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"destinationFacilityId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"originContactMechId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"originTelecomNumberId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"destinationContactMechId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"destinationTelecomNumberId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"partyIdTo","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"partyIdFrom","in":"query","required":false,"description":null},{"schema":{"type":"number","format":""},"name":"additionalShippingCharge","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"addtlShippingChargeDesc","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"createdDate","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"createdByUserLogin","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"lastModifiedDate","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"lastModifiedByUserLogin","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"carrierPartyId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"shipmentMethodTypeId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"lastUpdatedStamp","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/org.apache.ofbiz.shipment.shipment.Shipment.picklistShipment"}}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```