POST api/v4/PickTickets/Pick

This method enables setting the pick information for one or more items on a Pick Ticket.

Request Parameters

pickTicketPickRequest: object of type PickTicketPickRequest

PickTicketPickRequest

Name	Description Usage	Type Allowed values	Required?
pickTicketEdits	Collection of information regarding the Pick Ticket(s) to be picked	Array of PickTicketEdit	yes

PickTicketEdit

Name	Description Usage	Type Allowed values	Required?
pickTicketId	Pick batch identifier for Pick Tickets.	String	yes
pickTicketItemEdits	Collection of information regarding the Pick Ticket Item(s) to be picked	Array of PickTicketItemEdit	yes

PickTicketItemEdit

Name	Description Usage	Type Allowed values	Required?
pickTicketItemOrderNumber	not implemented – future use.	String	no
itemId	unique identifier of the item within the Store Fulfillment application	String	yes
pickTicketGroupId	Unique identifier of the specific Pick Ticket Group. If not supplied, this will default to zer0. Required if the Pick Ticket being picked has multiple groups.	Integer	no
pickTicketItemSKU	not implemented – future use.	String	no
pickTicketItemQuantityPicked	Quantity that has been picked	Integer	yes
pickTicketItemQuantityCancelled	not implemented – future use.	Integer	yes
pickTicketItemReasonCode	Reason code justifying any quantity that was pick declined	String	no
pickTicketItemReasonCodeDescription	Description of the reason why any quantity was pick declined	String	no
pickTicketItemSerialNumbers	For serialized items, the list of serial numbers corresponding to the quantity that was picked	Array of string	no

Response Parameters

pickTicketPickResponse: object of type PickTicketPickResponse

PickTicketPickResponse

Name	Description Usage	Type Allowed values	Required?
pickTicketEditResults	Collection detailing the result of the requested Pick action	Array of PickTicketEditResult	yes

PickTicketEditResult

Name	Description Usage	Type Allowed values	Required?
pickTicketId	Pick batch identifier for Pick Tickets.	String	yes
pickTicketErrorMessage	If an error occurred in the request processing, that will be detailed here.	String	no
pickTicketItemEditResults	Collection of information about the result of the requested Pick action	Array of PickTicketItemEditResult	yes
pickTicketHasErrors	Indicates if an error occurred processing the request	Boolean	yes
pickTicketAttributes	not implemented – future use.	Array of Attribute	no

PickTicketItemEditResult

Name	Description Usage	Type Allowed values	Required?
pickTicketGroup	Information about the group of items to be picked to which this specific item belongs, the organization of which is determined by the configuration of the pick allotment type of this Pick Ticket	Object of type PickTicketGroup	yes
pickTicketItemId	unique identifier of the item within the Store Fulfillment application	String	yes
pickTicketItemSku	SKU of the item	String	yes
pickTicketItemErrors	Collection of errors relating to this specific Pick Ticket Item	Array of PickTicketItemError	no
pickTicketItemAttributes	not implemented – future use.	Array of Attribute	no

Example - Pick an item on a Pick Ticket

XML Request

Authorization: Basic MTk4NTo6S1ZBRzgxRzBPSk5QNDNPVw==
Content-Type: application/xml; charset=utf-8
Accept: application/xml

<PickTicketPickRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
   <pickTickets>
      <PickTicketEdit>
         <pickTicketId>2016-05-06 16:15:46.000</pickTicketId>
         <pickTicketItems>
            <PickTicketItemEdit>
               <itemId>53</itemId>
               <pickTicketGroupId>0</pickTicketGroupId>
               <pickTicketItemQuantityPicked>15</pickTicketItemQuantityPicked>
            </PickTicketItemEdit>
         </pickTicketItems>
      </PickTicketEdit>
   </pickTickets>
</PickTicketPickRequest>

XML Response

<PickTicketPickResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
    <baseSystemVersion>45</baseSystemVersion>
    <sessionToken>QM798TT0NXM9TT4M</sessionToken>
    <pickTickets>
        <PickTicketEditResult>
            <pickTicketAttributes />
            <pickTicketErrorMessage i:nil="true" />
            <pickTicketHasErrors>false</pickTicketHasErrors>
            <pickTicketId>2016-05-06 16:15:46.000</pickTicketId>
            <pickTicketItems />
        </PickTicketEditResult>
    </pickTickets>
</PickTicketPickResponse>

JSON Request

Authorization: Basic MTk4NTo6S1ZBRzgxRzBPSk5QNDNPVw==

{
   "pickTicketEdits": [{
      "pickTicketId": "2016-05-06 16:15:46.000",
      "pickTicketItemEdits": [{
         "itemId": "53",
         "pickTicketGroupId": 0,
         "pickTicketItemQuantityPicked": 15
      }]
   }]
}

JSON Response

{
    "pickTicketEditResults": [
        {
            "pickTicketId": "2016-05-06 16:15:46.000",
            "pickTicketErrorMessage": null,
            "pickTicketItemEditResults": [],
            "pickTicketHasErrors": false,
            "pickTicketAttributes": []
        }
    ],
    "sessionToken": "8J1U9BHMZGEUBHIF",
    "baseSystemVersion": "45"
}

Example - Pick decline an item on a Pick Ticket

XML Request

Authorization: Basic MTk4NTo6S1ZBRzgxRzBPSk5QNDNPVw==
Content-Type: application/xml; charset=utf-8
Accept: application/xml


<PickTicketPickRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
   <pickTickets>
      <PickTicketEdit>
         <pickTicketId>2016-05-06 16:15:46.000</pickTicketId>
         <pickTicketItems>
            <PickTicketItemEdit>
               <itemId>24</itemId>
               <pickTicketGroupId>0</pickTicketGroupId>
               <pickTicketItemQuantityPicked>0</pickTicketItemQuantityPicked>
               <pickTicketItemReasonCode>OS</pickTicketItemReasonCode>
            </PickTicketItemEdit>
         </pickTicketItems>
      </PickTicketEdit>
   </pickTickets>
</PickTicketPickRequest>

XML Response

<PickTicketPickResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
    <baseSystemVersion>45</baseSystemVersion>
    <sessionToken>8J1U9BHMZGEUBHIF</sessionToken>
    <pickTickets>
        <PickTicketEditResult>
            <pickTicketAttributes />
            <pickTicketErrorMessage i:nil="true" />
            <pickTicketHasErrors>false</pickTicketHasErrors>
            <pickTicketId>2016-05-06 16:15:46.000</pickTicketId>
            <pickTicketItems />
        </PickTicketEditResult>
    </pickTickets>
</PickTicketPickResponse>

JSON Request

Authorization: Basic MTk4NTo6S1ZBRzgxRzBPSk5QNDNPVw==

{
   "pickTicketEdits": [{
      "pickTicketId": "2016-05-06 16:15:46.000",
      "pickTicketItemEdits": [{
         "itemId": "24",
         "pickTicketGroupId": 0,
         "pickTicketItemQuantityPicked": 0,
         "pickTicketItemReasonCode": "OS"
      }]
   }]
}

JSON Response

{
    "pickTicketEditResults": [
        {
            "pickTicketId": "2016-05-06 16:15:46.000",
            "pickTicketErrorMessage": null,
            "pickTicketItemEditResults": [],
            "pickTicketHasErrors": false,
            "pickTicketAttributes": []
        }
    ],
    "sessionToken": "8J1U9BHMZGEUBHIF",
    "baseSystemVersion": "45"
}