> For the complete documentation index, see [llms.txt](https://docs.hotwax.co/documents/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hotwax.co/documents/integrate-with-hotwax/components/fulfillment/pick-profile.md).

# Pick Profile

pickProfile

## list PickProfile

> Represents configurations for pick orders, including search pref for pick profile.

```json
{"openapi":"3.1.1","info":{"title":"Poorti API","version":"1.0.0"},"tags":[{"name":"pickProfile","description":"pickProfile"}],"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":{"pickProfile":{"title":"Pick Profile","type":"object","properties":{"_entity":{"type":"string","default":"pickProfile"},"profileId":{"type":"string"},"profileGroupId":{"type":"string"},"statusId":{"type":"string"},"profileName":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"description":{"type":"string"},"createdByUserId":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/pickProfile":{"get":{"tags":["pickProfile"],"summary":"list PickProfile","description":"Represents configurations for pick orders, including search pref for pick profile.","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":"profileId","in":"query","required":false,"description":"Unique identifier for the pick profile."},{"schema":{"type":"string","format":""},"name":"profileGroupId","in":"query","required":false,"description":"Unique identifier for the pick profile group"},{"schema":{"type":"string","format":""},"name":"statusId","in":"query","required":false,"description":"Status identifier for the pick profile."},{"schema":{"type":"string","format":""},"name":"profileName","in":"query","required":false,"description":"Name or identifier for the pick profile."},{"schema":{"type":"number","format":"int64"},"name":"sequenceNum","in":"query","required":false,"description":"Sequence number for ordering."},{"schema":{"type":"string","format":""},"name":"description","in":"query","required":false,"description":"Description or additional information about the pick profile."},{"schema":{"type":"string","format":""},"name":"createdByUserId","in":"query","required":false,"description":"User login ID of the creator."},{"schema":{"type":"string","format":"date-time"},"name":"createdDate","in":"query","required":false,"description":"Date and time when the order pick profile was created."},{"schema":{"type":"string","format":"date-time"},"name":"lastUpdatedStamp","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"createdStamp","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pickProfile"}}}}},"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"}}}}}}
```

## one PickProfile (master: default)

> Represents configurations for pick orders, including search pref for pick profile.

```json
{"openapi":"3.1.1","info":{"title":"Poorti API","version":"1.0.0"},"tags":[{"name":"pickProfile","description":"pickProfile"}],"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":{"pickProfile.default":{"title":"Pick Profile (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"pickProfile"},"profileId":{"type":"string"},"profileGroupId":{"type":"string"},"statusId":{"type":"string"},"profileName":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"description":{"type":"string"},"createdByUserId":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"},"pickProfileFilters":{"type":"array","items":{"$ref":"#/components/schemas/pickProfileFilter"}}}},"pickProfileFilter":{"title":"Pick Profile Condition","type":"object","properties":{"_entity":{"type":"string","default":"pickProfileFilter"},"profileId":{"type":"string"},"conditionSeqId":{"type":"string"},"conditionTypeEnumId":{"type":"string"},"fieldName":{"type":"string"},"conditionOperator":{"type":"string"},"fieldValue":{"type":"string"},"fieldType":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/pickProfile/{profileId}":{"get":{"tags":["pickProfile"],"summary":"one PickProfile (master: default)","description":"Represents configurations for pick orders, including search pref for pick profile.","parameters":[{"schema":{"type":"string"},"name":"profileId","in":"path","required":true,"description":"Unique identifier for the pick profile."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pickProfile.default"}}}},"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"}}}}}}
```

## update PickProfile (master: default)

> Represents configurations for pick orders, including search pref for pick profile.

```json
{"openapi":"3.1.1","info":{"title":"Poorti API","version":"1.0.0"},"tags":[{"name":"pickProfile","description":"pickProfile"}],"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":{"pickProfile.default.PK":{"title":"Pick Profile (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"pickProfile.PK"},"profileId":{"type":"string"}}},"pickProfile.default":{"title":"Pick Profile (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"pickProfile"},"profileId":{"type":"string"},"profileGroupId":{"type":"string"},"statusId":{"type":"string"},"profileName":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"description":{"type":"string"},"createdByUserId":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"},"pickProfileFilters":{"type":"array","items":{"$ref":"#/components/schemas/pickProfileFilter"}}}},"pickProfileFilter":{"title":"Pick Profile Condition","type":"object","properties":{"_entity":{"type":"string","default":"pickProfileFilter"},"profileId":{"type":"string"},"conditionSeqId":{"type":"string"},"conditionTypeEnumId":{"type":"string"},"fieldName":{"type":"string"},"conditionOperator":{"type":"string"},"fieldValue":{"type":"string"},"fieldType":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/pickProfile/{profileId}":{"put":{"tags":["pickProfile"],"summary":"update PickProfile (master: default)","description":"Represents configurations for pick orders, including search pref for pick profile.","parameters":[{"schema":{"type":"string"},"name":"profileId","in":"path","required":true,"description":"Unique identifier for the pick profile."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pickProfile.default.PK"}}}},"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"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pickProfile.default"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/pickProfile.default"}}},"required":false}}}}}
```

## POST /pickProfile/{profileId}/orderCount

> get PickProfileOrderCount

```json
{"openapi":"3.1.1","info":{"title":"Poorti API","version":"1.0.0"},"tags":[{"name":"pickProfile","description":"pickProfile"}],"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":{"co.hotwax.poorti.picking.PickProfileServices.getPickProfileOrderCount.Out":{"type":"object","properties":{"records":{"type":"array"}}},"co.hotwax.poorti.picking.PickProfileServices.getPickProfileOrderCount.In":{"type":"object","properties":{"profileId":{"type":"string"},"groupByFields":{"type":"array"}},"required":["profileId"]}}},"paths":{"/pickProfile/{profileId}/orderCount":{"post":{"tags":["pickProfile"],"summary":"get PickProfileOrderCount","description":null,"parameters":[{"schema":{"type":"string"},"name":"profileId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.poorti.picking.PickProfileServices.getPickProfileOrderCount.Out"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/co.hotwax.poorti.picking.PickProfileServices.getPickProfileOrderCount.In"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/co.hotwax.poorti.picking.PickProfileServices.getPickProfileOrderCount.In"}}},"required":true}}}}}
```

## delete PickProfileCondition

> Defines conditions used in pick profile to filter orders based on specified criteria.

```json
{"openapi":"3.1.1","info":{"title":"Poorti API","version":"1.0.0"},"tags":[{"name":"pickProfile","description":"pickProfile"}],"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"}}},"paths":{"/pickProfile/{profileId}/conditions/{conditionSeqId}":{"delete":{"tags":["pickProfile"],"summary":"delete PickProfileCondition","description":"Defines conditions used in pick profile to filter orders based on specified criteria.","parameters":[{"schema":{"type":"string"},"name":"profileId","in":"path","required":true,"description":"Unique identifier for the pick profile."},{"schema":{"type":"string"},"name":"conditionSeqId","in":"path","required":true,"description":"Unique identifier for the condition."}],"responses":{"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"}}}}}}
```

## list PickProfileGroup (master: default)

> Represents a group or category used for organizing and managing pick profile configurations.

```json
{"openapi":"3.1.1","info":{"title":"Poorti API","version":"1.0.0"},"tags":[{"name":"pickProfile","description":"pickProfile"}],"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":{"pickProfileGroup.default":{"title":"Pick Profile Group (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"pickProfileGroup"},"profileGroupId":{"type":"string"},"groupTypeEnumId":{"type":"string"},"groupName":{"type":"string"},"facilityId":{"type":"string"},"jobName":{"type":"string"},"description":{"type":"string"},"createdByUserId":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"},"profiles":{"type":"array","items":{"$ref":"#/components/schemas/pickProfile"}}}},"pickProfile":{"title":"Pick Profile","type":"object","properties":{"_entity":{"type":"string","default":"pickProfile"},"profileId":{"type":"string"},"profileGroupId":{"type":"string"},"statusId":{"type":"string"},"profileName":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"description":{"type":"string"},"createdByUserId":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/pickProfile/groups":{"get":{"tags":["pickProfile"],"summary":"list PickProfileGroup (master: default)","description":"Represents a group or category used for organizing and managing pick profile configurations.","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":"profileGroupId","in":"query","required":false,"description":"Unique identifier for the pick profile group"},{"schema":{"type":"string","format":""},"name":"groupTypeEnumId","in":"query","required":false,"description":"Type of a profile group"},{"schema":{"type":"string","format":""},"name":"groupName","in":"query","required":false,"description":"Name of the pick profile group."},{"schema":{"type":"string","format":""},"name":"facilityId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"jobName","in":"query","required":false,"description":"moqui.service.job.Service reference"},{"schema":{"type":"string","format":""},"name":"description","in":"query","required":false,"description":"Description or additional information about the pick profile group."},{"schema":{"type":"string","format":""},"name":"createdByUserId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"createdDate","in":"query","required":false,"description":"Date and time when the pick profile group was created"},{"schema":{"type":"string","format":"date-time"},"name":"lastUpdatedStamp","in":"query","required":false,"description":null},{"schema":{"type":"string","format":"date-time"},"name":"createdStamp","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pickProfileGroup.default"}}}}},"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"}}}}}}
```

## one PickProfileGroup (master: default)

> Represents a group or category used for organizing and managing pick profile configurations.

```json
{"openapi":"3.1.1","info":{"title":"Poorti API","version":"1.0.0"},"tags":[{"name":"pickProfile","description":"pickProfile"}],"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":{"pickProfileGroup.default":{"title":"Pick Profile Group (Master: default)","type":"object","properties":{"_entity":{"type":"string","default":"pickProfileGroup"},"profileGroupId":{"type":"string"},"groupTypeEnumId":{"type":"string"},"groupName":{"type":"string"},"facilityId":{"type":"string"},"jobName":{"type":"string"},"description":{"type":"string"},"createdByUserId":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"},"profiles":{"type":"array","items":{"$ref":"#/components/schemas/pickProfile"}}}},"pickProfile":{"title":"Pick Profile","type":"object","properties":{"_entity":{"type":"string","default":"pickProfile"},"profileId":{"type":"string"},"profileGroupId":{"type":"string"},"statusId":{"type":"string"},"profileName":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"description":{"type":"string"},"createdByUserId":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastUpdatedStamp":{"type":"string","format":"date-time"},"createdStamp":{"type":"string","format":"date-time"}}}}},"paths":{"/pickProfile/groups/{profileGroupId}":{"get":{"tags":["pickProfile"],"summary":"one PickProfileGroup (master: default)","description":"Represents a group or category used for organizing and managing pick profile configurations.","parameters":[{"schema":{"type":"string"},"name":"profileGroupId","in":"path","required":true,"description":"Unique identifier for the pick profile group"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pickProfileGroup.default"}}}},"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"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.hotwax.co/documents/integrate-with-hotwax/components/fulfillment/pick-profile.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
