Picklists

picklists

list Picklist (master: picker)

get

Authorizations

basicAuthapi_key

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

picklistIdstringOptional

externalIdstringOptional

This field stores picklist ID of the external system

descriptionstringOptional

facilityIdstringOptional

shipmentMethodTypeIdstringOptional

statusIdstringOptional

picklistDatestring · date-timeOptional

createdByUserLoginstringOptional

lastModifiedByUserLoginstringOptional

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

HTTPcURLJavaScriptPython

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

[
  {
    "_entity": "org.apache.ofbiz.shipment.picklist.Picklist",
    "picklistId": "text",
    "externalId": "text",
    "description": "text",
    "facilityId": "text",
    "shipmentMethodTypeId": "text",
    "statusId": "text",
    "picklistDate": "2025-07-11T21:03:51.726Z",
    "createdByUserLogin": "text",
    "lastModifiedByUserLogin": "text",
    "lastUpdatedStamp": "2025-07-11T21:03:51.726Z",
    "roles": [
      {
        "_entity": "org.apache.ofbiz.shipment.picklist.PicklistRole",
        "picklistId": "text",
        "partyId": "text",
        "roleTypeId": "text",
        "fromDate": "2025-07-11T21:03:51.726Z",
        "thruDate": "2025-07-11T21:03:51.726Z",
        "createdByUserLogin": "text",
        "lastModifiedByUserLogin": "text",
        "lastUpdatedStamp": "2025-07-11T21:03:51.726Z",
        "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": "2025-07-11",
          "deceasedDate": "2025-07-11",
          "height": 1,
          "weight": 1,
          "mothersMaidenName": "text",
          "maritalStatus": "text",
          "socialSecurityNumber": "text",
          "passportNumber": "text",
          "passportExpireDate": "2025-07-11",
          "totalYearsWorkExperience": 1,
          "comments": "text",
          "employmentStatusEnumId": "text",
          "residenceStatusEnumId": "text",
          "occupation": "text",
          "yearsWithEmployer": 1,
          "monthsWithEmployer": 1,
          "existingCustomer": "text",
          "cardId": "text",
          "anniversaryDate": "2025-07-11",
          "lastUpdatedStamp": "2025-07-11T21:03:51.726Z"
        },
        "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": "2025-07-11T21:03:51.726Z"
        }
      }
    ]
  }
]

create Picklist (master: default)

post

Authorizations

basicAuthapi_key

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: org.apache.ofbiz.shipment.picklist.Picklist

picklistIdstringOptional

externalIdstringOptional

descriptionstringOptional

facilityIdstringOptional

shipmentMethodTypeIdstringOptional

statusIdstringOptional

picklistDatestring · date-timeOptional

createdByUserLoginstringOptional

lastModifiedByUserLoginstringOptional

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

HTTPcURLJavaScriptPython

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

{
  "_entity": "org.apache.ofbiz.shipment.picklist.Picklist",
  "picklistId": "text",
  "externalId": "text",
  "description": "text",
  "facilityId": "text",
  "shipmentMethodTypeId": "text",
  "statusId": "text",
  "picklistDate": "2025-07-11T21:03:51.726Z",
  "createdByUserLogin": "text",
  "lastModifiedByUserLogin": "text",
  "lastUpdatedStamp": "2025-07-11T21:03:51.726Z",
  "roles": [
    {
      "_entity": "org.apache.ofbiz.shipment.picklist.PicklistRole",
      "picklistId": "text",
      "partyId": "text",
      "roleTypeId": "text",
      "fromDate": "2025-07-11T21:03:51.726Z",
      "thruDate": "2025-07-11T21:03:51.726Z",
      "createdByUserLogin": "text",
      "lastModifiedByUserLogin": "text",
      "lastUpdatedStamp": "2025-07-11T21:03:51.726Z",
      "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": "2025-07-11",
        "deceasedDate": "2025-07-11",
        "height": 1,
        "weight": 1,
        "mothersMaidenName": "text",
        "maritalStatus": "text",
        "socialSecurityNumber": "text",
        "passportNumber": "text",
        "passportExpireDate": "2025-07-11",
        "totalYearsWorkExperience": 1,
        "comments": "text",
        "employmentStatusEnumId": "text",
        "residenceStatusEnumId": "text",
        "occupation": "text",
        "yearsWithEmployer": 1,
        "monthsWithEmployer": 1,
        "existingCustomer": "text",
        "cardId": "text",
        "anniversaryDate": "2025-07-11",
        "lastUpdatedStamp": "2025-07-11T21:03:51.726Z"
      },
      "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": "2025-07-11T21:03:51.726Z"
      }
    }
  ]
}

application/jsonmultipart/form-data

{
  "_entity": "org.apache.ofbiz.shipment.picklist.Picklist.PK",
  "picklistId": "text"
}

one Picklist (master: picker)

get

Authorizations

basicAuthapi_key

Path parameters

picklistIdstringRequired

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

HTTPcURLJavaScriptPython

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

{
  "_entity": "org.apache.ofbiz.shipment.picklist.Picklist",
  "picklistId": "text",
  "externalId": "text",
  "description": "text",
  "facilityId": "text",
  "shipmentMethodTypeId": "text",
  "statusId": "text",
  "picklistDate": "2025-07-11T21:03:51.726Z",
  "createdByUserLogin": "text",
  "lastModifiedByUserLogin": "text",
  "lastUpdatedStamp": "2025-07-11T21:03:51.726Z",
  "roles": [
    {
      "_entity": "org.apache.ofbiz.shipment.picklist.PicklistRole",
      "picklistId": "text",
      "partyId": "text",
      "roleTypeId": "text",
      "fromDate": "2025-07-11T21:03:51.726Z",
      "thruDate": "2025-07-11T21:03:51.726Z",
      "createdByUserLogin": "text",
      "lastModifiedByUserLogin": "text",
      "lastUpdatedStamp": "2025-07-11T21:03:51.726Z",
      "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": "2025-07-11",
        "deceasedDate": "2025-07-11",
        "height": 1,
        "weight": 1,
        "mothersMaidenName": "text",
        "maritalStatus": "text",
        "socialSecurityNumber": "text",
        "passportNumber": "text",
        "passportExpireDate": "2025-07-11",
        "totalYearsWorkExperience": 1,
        "comments": "text",
        "employmentStatusEnumId": "text",
        "residenceStatusEnumId": "text",
        "occupation": "text",
        "yearsWithEmployer": 1,
        "monthsWithEmployer": 1,
        "existingCustomer": "text",
        "cardId": "text",
        "anniversaryDate": "2025-07-11",
        "lastUpdatedStamp": "2025-07-11T21:03:51.726Z"
      },
      "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": "2025-07-11T21:03:51.726Z"
      }
    }
  ]
}

update Picklist (master: default)

put

Authorizations

basicAuthapi_key

Path parameters

picklistIdstringRequired

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: org.apache.ofbiz.shipment.picklist.Picklist

picklistIdstringOptional

externalIdstringOptional

descriptionstringOptional

facilityIdstringOptional

shipmentMethodTypeIdstringOptional

statusIdstringOptional

picklistDatestring · date-timeOptional

createdByUserLoginstringOptional

lastModifiedByUserLoginstringOptional

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

HTTPcURLJavaScriptPython

PUT /rest/s1/poorti/picklists/{picklistId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 1809

{
  "_entity": "org.apache.ofbiz.shipment.picklist.Picklist",
  "picklistId": "text",
  "externalId": "text",
  "description": "text",
  "facilityId": "text",
  "shipmentMethodTypeId": "text",
  "statusId": "text",
  "picklistDate": "2025-07-11T21:03:51.726Z",
  "createdByUserLogin": "text",
  "lastModifiedByUserLogin": "text",
  "lastUpdatedStamp": "2025-07-11T21:03:51.726Z",
  "roles": [
    {
      "_entity": "org.apache.ofbiz.shipment.picklist.PicklistRole",
      "picklistId": "text",
      "partyId": "text",
      "roleTypeId": "text",
      "fromDate": "2025-07-11T21:03:51.726Z",
      "thruDate": "2025-07-11T21:03:51.726Z",
      "createdByUserLogin": "text",
      "lastModifiedByUserLogin": "text",
      "lastUpdatedStamp": "2025-07-11T21:03:51.726Z",
      "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": "2025-07-11",
        "deceasedDate": "2025-07-11",
        "height": 1,
        "weight": 1,
        "mothersMaidenName": "text",
        "maritalStatus": "text",
        "socialSecurityNumber": "text",
        "passportNumber": "text",
        "passportExpireDate": "2025-07-11",
        "totalYearsWorkExperience": 1,
        "comments": "text",
        "employmentStatusEnumId": "text",
        "residenceStatusEnumId": "text",
        "occupation": "text",
        "yearsWithEmployer": 1,
        "monthsWithEmployer": 1,
        "existingCustomer": "text",
        "cardId": "text",
        "anniversaryDate": "2025-07-11",
        "lastUpdatedStamp": "2025-07-11T21:03:51.726Z"
      },
      "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": "2025-07-11T21:03:51.726Z"
      }
    }
  ]
}

application/jsonmultipart/form-data

{
  "_entity": "org.apache.ofbiz.shipment.picklist.Picklist.PK",
  "picklistId": "text"
}