Radial Integration | 2016

Store Fulfillment > Store Fulfillment API > POST api/v4/PickTickets/Search

POST api/v4/PickTickets/Search

This method can be used to access the Pick Tickets currently available within Store Fulfillment for the requesting user.

Request Parameters

pickTicketSearchRequest: object of type PickTicketSearchRequest

Name Description
Usage		 Type
Allowed values		 Required?

pickTicketType

Indicates the type of Orders contained within the Pick Ticket

Enum – supports either text or integer.

DropShip = 1

StockPO = 2

ShipFromStore = 4

InStorePickUp = 8

no

pickTicketStatus

Indicates the current status of the Pick Ticket within Store Fulfillment

Enum – supports either text or integer.

notSet = 0

[Default] = 1

[New] = 2

Locked = 4

Confirmed = 8

Printed = 16

Saved = 32

no

pickTicketId

Pick batch identifier for previously printed Pick Tickets

String

no

pickTicketAllotmentType

Numeric identifier of the Pick Allotment

Integer

no

pickTicketShowAlternatives

This option creates a special type of ticket. Generally, an order can be on one pick ticket. However, an order can be in multiple "alternative" pick tickets. If an order has multiple sections, the order can possibly get listed on multiple pick tickets. But the order can only be on one physical pick ticket, so when the pick ticket is printed, the other pick ticket with that order becomes invalid and needs to be refreshed. Show alternatives can be used to find pick tickets that match the Section you are in. Products without sections do not get listed.

Boolean

no

pickTicketRollupEnabled

Applies to new Pick Tickets only. Indicates if all new Pick Tickets should be displayed individually or, if rollup is Enabled, display as a single record based on Pick Allotment grouping

Boolean

no

pickTicketSearchRequestIncludes

Indicates what data elements should be returned in the response

Enum – bitwise operator that supports either text or integer.

[Default] = 0

PickTicketHeader = 1

PickTicketGroups = 2

Attributes = 4

no

maxRecordCount

Maximum number of records to be returned in the response. If not specified, this value defaults to 2500. Values specified in excess of 2500 will be defaulted to 2500 and should utilize the pagination feature to access additional records.

integer

no

pageNumber

Optional pagination parameter

Integer

no

Response Parameters

pickTicketSearchResponse: object of type PickTicketSearchResponse

PickTicketSearchResponse

Name Description
Usage		 Type
Allowed values		 Required?

pickTicketEssentials

Pick Tickets matching the requested search criteria. The number of Pick Tickets included in this collection will be determined by the maxRecordCount passed in the request.

Array of PickTicketEssentials

yes

totalPickTicketCount

Indicates the version of the underlying Store Fulfillment core application.

Integer

yes

sessionToken

Session token to be used for maintaining session state across batch operations.

String

yes

baseSystemVersion

Indicates the version of the underlying Store Fulfillment core application.

String

yes

PickTicketEssentials

Name Description
Usage		 Type
Allowed values		 Required?

pickTicketId

Pick batch identifier for previously printed Pick Tickets. This value will be temporarily auto-generated for New Pick Tickets and can change once the Pick Ticket has been printed.

String

yes

pickTicketNumber

Optional numeric identifier of the Pick Ticket

String

no

pickTicketType

Indicates the type of Orders contained within the Pick Ticket

Enum – supports either text or integer.

DropShip = 1

StockPO = 2

ShipFromStore = 4

InStorePickUp = 8

yes

pickTicketItemCount

Indicates the total number of skus contained in the Pick Ticket

Integer

yes

pickTicketQuantityCount

Indicates the total quantity of items contained in the Pick Ticket

Integer

yes

pickTicketStatus

Indicates the current status of the Pick Ticket within Store Fulfillment

Enum – supports either text or integer.

notSet = 0

[Default] = 1

[New] = 2

Locked = 4

Confirmed = 8

Printed = 16

Saved = 32

yes

pickTicketPickBy

For Pick Tickets that have already been printed, this indicates the user that pick confirmed this Pick Ticket (if supplied) or the user currently picking the ticket (for locked tickets) or the user that saved an in-progress ticket

String

no

pickTicketAllotmentGroupNumber

Numeric identifier of the pick allotment

String

no

pickTicketAllotmentGroupDescription

Name identifier of the pick allotment

String

no

pickTicketOrderCount

Indicates the total quantity of Orders contained in the Pick Ticket

Integer

yes

pickTicketAssignByDate

Pick Ticket print (assign) action SLA

DateTime (2013-11-08T00:00:00)

no

pickTicketConfirmByDate

Pick Ticket confirm action SLA

DateTime (2013-11-08T00:00:00)

no

pickTicketPickerName

For Pick Tickets that have already been picked, this indicates the name of the user that pick confirmed this Pick Ticket (if supplied)

String

no

pickTicketGroups

Collection of items to be picked, the organization of which is determined by the configuration of the pick allotment type of this Pick Ticket

Array of type PickTicketGroup

no

pickTicketAttributes

Collection of additional Attributes about this Pick Ticket

Array of type Attribute

no

PickTicketGroup

Name Description
Usage		 Type
Allowed values		 Required?

pickTicketGroupId

A numeric value that represents the group to which this pick ticket is assigned; generally used as a bin or slot number that corresponds to the user’s physical pick environment, such as a specialized pick cart.

** In environments where one pick ticket is issued for one order, the pickTicketGroupId will default to zero if a pickTicketGroupId is not sent as part of the request.

** In environments where one pick ticket can contain multiple orders, the pickTicketGroupId must be sent as part of the request or VendorNet will return an error.

Integer

yes

pickTicketGroupName

Description of this group

String

no

pickTicketStatus

Indicates the current status of the Pick Ticket Group within Store Fulfillment

Enum – supports either text or integer.

notSet = 0

[Default] = 1

[New] = 2

Locked = 4

Confirmed = 8

Printed = 16

Saved = 32

yes

Example - Search for all ISPU Pick Tickets

XML Request

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

<PickTicketSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
   <maxRecordCount>0</maxRecordCount>
   <pageNumber i:nil="true" />
   <includes>Default</includes>
   <pickTicketAllotmentType i:nil="true" />
   <pickTicketId i:nil="true" />
   <pickTicketRollupEnabled>false</pickTicketRollupEnabled>
   <pickTicketShowAlternatives>false</pickTicketShowAlternatives>
   <pickTicketStatus>Default</pickTicketStatus>
   <pickTicketType>InStorePickUp</pickTicketType>
</PickTicketSearchRequest>

XML Response

 <PickTicketSearchResponse 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>B0PP5FSHTL4A8ZA3</sessionToken>
    <pickTickets>
        <PickTicketEssentials>
            <pickTicketAllotmentGroupDescription>ISPU</pickTicketAllotmentGroupDescription>
            <pickTicketAllotmentGroupNumber>1</pickTicketAllotmentGroupNumber>
            <pickTicketAssignByDate>2014-05-05T09:37:00</pickTicketAssignByDate>
            <pickTicketAttributes />
            <pickTicketConfirmByDate i:nil="true" />
            <pickTicketGroups />
            <pickTicketId>2014-06-03 12:43:27.293</pickTicketId>
            <pickTicketItemCount>1</pickTicketItemCount>
            <pickTicketNumber></pickTicketNumber>
            <pickTicketOrderCount>1</pickTicketOrderCount>
            <pickTicketPickBy i:nil="true" />
            <pickTicketPickerName i:nil="true" />
            <pickTicketQuantityCount>4</pickTicketQuantityCount>
            <pickTicketStatus>New</pickTicketStatus>
            <pickTicketType>InStorePickUp</pickTicketType>
        </PickTicketEssentials>
        <PickTicketEssentials>
            <pickTicketAllotmentGroupDescription>ISPU</pickTicketAllotmentGroupDescription>
            <pickTicketAllotmentGroupNumber>0</pickTicketAllotmentGroupNumber>
            <pickTicketAssignByDate i:nil="true" />
            <pickTicketAttributes />
            <pickTicketConfirmByDate i:nil="true" />
            <pickTicketGroups />
            <pickTicketId>2014-05-02 14:45:49.000</pickTicketId>
            <pickTicketItemCount>1</pickTicketItemCount>
            <pickTicketNumber></pickTicketNumber>
            <pickTicketOrderCount>1</pickTicketOrderCount>
            <pickTicketPickBy i:nil="true" />
            <pickTicketPickerName i:nil="true" />
            <pickTicketQuantityCount>4</pickTicketQuantityCount>
            <pickTicketStatus>Confirmed</pickTicketStatus>
            <pickTicketType>InStorePickUp</pickTicketType>
        </PickTicketEssentials>
        <PickTicketEssentials>
            <pickTicketAllotmentGroupDescription>ISPU</pickTicketAllotmentGroupDescription>
            <pickTicketAllotmentGroupNumber>0</pickTicketAllotmentGroupNumber>
            <pickTicketAssignByDate i:nil="true" />
            <pickTicketAttributes />
            <pickTicketConfirmByDate>2014-05-02T14:33:00</pickTicketConfirmByDate>
            <pickTicketGroups />
            <pickTicketId>2014-05-02 15:33:01.690</pickTicketId>
            <pickTicketItemCount>1</pickTicketItemCount>
            <pickTicketNumber></pickTicketNumber>
            <pickTicketOrderCount>1</pickTicketOrderCount>
            <pickTicketPickBy i:nil="true" />
            <pickTicketPickerName i:nil="true" />
            <pickTicketQuantityCount>4</pickTicketQuantityCount>
            <pickTicketStatus>Printed</pickTicketStatus>
            <pickTicketType>InStorePickUp</pickTicketType>
        </PickTicketEssentials>
        <PickTicketEssentials>
            <pickTicketAllotmentGroupDescription>ISPU</pickTicketAllotmentGroupDescription>
            <pickTicketAllotmentGroupNumber>0</pickTicketAllotmentGroupNumber>
            <pickTicketAssignByDate i:nil="true" />
            <pickTicketAttributes />
            <pickTicketConfirmByDate>2014-05-02T14:33:00</pickTicketConfirmByDate>
            <pickTicketGroups />
            <pickTicketId>2014-05-05 10:05:39.000</pickTicketId>
            <pickTicketItemCount>1</pickTicketItemCount>
            <pickTicketNumber></pickTicketNumber>
            <pickTicketOrderCount>1</pickTicketOrderCount>
            <pickTicketPickBy>jnyst3</pickTicketPickBy>
            <pickTicketPickerName i:nil="true" />
            <pickTicketQuantityCount>4</pickTicketQuantityCount>
            <pickTicketStatus>Saved</pickTicketStatus>
            <pickTicketType>InStorePickUp</pickTicketType>
        </PickTicketEssentials>
    </pickTickets>
    <totalPickTicketCount>73</totalPickTicketCount>
</PickTicketSearchResponse>

JSON Request

Authorization: Basic U2VydmljZTpzZXJ2aWNlOg==

{
   "pickTicketType": " InStorePickUp ",
   "pickTicketStatus": “Default”,
   "pickTicketId": null,
   "pickTicketAllotmentType": null,
   "pickTicketShowAlternatives": false,
   "pickTicketRollupEnabled": false,
   "pickTicketSearchRequestIncludes": "Default",
   "maxRecordCount": null,
   "pageNumber": null
}

JSON Response

{
    "pickTicketEssentials": [
        {
            "pickTicketId": "2014-06-03 12:43:27.293",
            "pickTicketNumber": "",
            "pickTicketType": "InStorePickUp",
            "pickTicketItemCount": 1,
            "pickTicketQuantityCount": 4,
            "pickTicketStatus": "New",
            "pickTicketPickBy": null,
            "pickTicketAllotmentGroupNumber": "1",
            "pickTicketAllotmentGroupDescription": "ISPU",
            "pickTicketOrderCount": 1,
            "pickTicketAssignByDate": "2014-05-05T09:37:00",
            "pickTicketConfirmByDate": null,
            "pickTicketPickerName": null,
            "pickTicketGroups": [],
            "pickTicketAttributes": []
        },
        {
            "pickTicketId": "2014-05-02 14:45:49.000",
            "pickTicketNumber": "",
            "pickTicketType": "InStorePickUp",
            "pickTicketItemCount": 1,
            "pickTicketQuantityCount": 4,
            "pickTicketStatus": "Confirmed",
            "pickTicketPickBy": null,
            "pickTicketAllotmentGroupNumber": "0",
            "pickTicketAllotmentGroupDescription": "ISPU",
            "pickTicketOrderCount": 1,
            "pickTicketAssignByDate": null,
            "pickTicketConfirmByDate": null,
            "pickTicketPickerName": null,
            "pickTicketGroups": [],
            "pickTicketAttributes": []
        },
        {
            "pickTicketId": "2014-05-02 15:33:01.690",
            "pickTicketNumber": "",
            "pickTicketType": "InStorePickUp",
            "pickTicketItemCount": 1,
            "pickTicketQuantityCount": 4,
            "pickTicketStatus": "Printed",
            "pickTicketPickBy": null,
            "pickTicketAllotmentGroupNumber": "0",
            "pickTicketAllotmentGroupDescription": "ISPU",
            "pickTicketOrderCount": 1,
            "pickTicketAssignByDate": null,
            "pickTicketConfirmByDate": "2014-05-02T14:33:00",
            "pickTicketPickerName": null,
            "pickTicketGroups": [],
            "pickTicketAttributes": []
        },
        {
            "pickTicketId": "2014-05-05 10:05:39.000",
            "pickTicketNumber": "",
            "pickTicketType": "InStorePickUp",
            "pickTicketItemCount": 1,
            "pickTicketQuantityCount": 4,
            "pickTicketStatus": "Saved",
            "pickTicketPickBy": "jnyst3",
            "pickTicketAllotmentGroupNumber": "0",
            "pickTicketAllotmentGroupDescription": "ISPU",
            "pickTicketOrderCount": 1,
            "pickTicketAssignByDate": null,
            "pickTicketConfirmByDate": "2014-05-02T14:33:00",
            "pickTicketPickerName": null,
            "pickTicketGroups": [],
            "pickTicketAttributes": []
        }
    ],
    "totalPickTicketCount": 73,
    "sessionToken": "G72PTDBZ3EVLQBR6",
    "baseSystemVersion": "45"
}

Example - Search for SFS Pick Tickets by Pick Allotment

XML Request

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

<PickTicketSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
   <maxRecordCount>0</maxRecordCount>
   <pageNumber i:nil="true" />
   <includes>Default</includes>
   <pickTicketAllotmentType>3</pickTicketAllotmentType>
   <pickTicketId i:nil="true" />
   <pickTicketRollupEnabled>true</pickTicketRollupEnabled>
   <pickTicketShowAlternatives>false</pickTicketShowAlternatives>
<pickTicketStatus>Default</pickTicketStatus>
   <pickTicketType>ShipFromStore</pickTicketType>
</PickTicketSearchRequest>

XML Response

<PickTicketSearchResponse 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>40DP11BZ527MHJQF</sessionToken>
    <pickTickets>
        <PickTicketEssentials>
            <pickTicketAllotmentGroupDescription>multi</pickTicketAllotmentGroupDescription>
            <pickTicketAllotmentGroupNumber>3</pickTicketAllotmentGroupNumber>
            <pickTicketAssignByDate i:nil="true" />
            <pickTicketAttributes />
            <pickTicketConfirmByDate i:nil="true" />
            <pickTicketGroups />
            <pickTicketId></pickTicketId>
            <pickTicketItemCount>8</pickTicketItemCount>
            <pickTicketNumber></pickTicketNumber>
            <pickTicketOrderCount>20</pickTicketOrderCount>
            <pickTicketPickBy i:nil="true" />
            <pickTicketPickerName i:nil="true" />
            <pickTicketQuantityCount>290</pickTicketQuantityCount>
            <pickTicketStatus>New</pickTicketStatus>
            <pickTicketType>ShipFromStore</pickTicketType>
        </PickTicketEssentials>
        <PickTicketEssentials>
            <pickTicketAllotmentGroupDescription>multi</pickTicketAllotmentGroupDescription>
            <pickTicketAllotmentGroupNumber>3</pickTicketAllotmentGroupNumber>
            <pickTicketAssignByDate i:nil="true" />
            <pickTicketAttributes />
            <pickTicketConfirmByDate i:nil="true" />
            <pickTicketGroups />
            <pickTicketId>2014-11-05 15:59:51.000</pickTicketId>
            <pickTicketItemCount>1</pickTicketItemCount>
            <pickTicketNumber></pickTicketNumber>
            <pickTicketOrderCount>1</pickTicketOrderCount>
            <pickTicketPickBy i:nil="true" />
            <pickTicketPickerName i:nil="true" />
            <pickTicketQuantityCount>2</pickTicketQuantityCount>
            <pickTicketStatus>Printed</pickTicketStatus>
            <pickTicketType>ShipFromStore</pickTicketType>
        </PickTicketEssentials>
        <PickTicketEssentials>
            <pickTicketAllotmentGroupDescription>multi</pickTicketAllotmentGroupDescription>
            <pickTicketAllotmentGroupNumber>3</pickTicketAllotmentGroupNumber>
            <pickTicketAssignByDate i:nil="true" />
            <pickTicketAttributes />
            <pickTicketConfirmByDate i:nil="true" />
            <pickTicketGroups />
            <pickTicketId>2015-05-18 10:55:05.000</pickTicketId>
            <pickTicketItemCount>4</pickTicketItemCount>
            <pickTicketNumber></pickTicketNumber>
            <pickTicketOrderCount>3</pickTicketOrderCount>
            <pickTicketPickBy i:nil="true" />
            <pickTicketPickerName i:nil="true" />
            <pickTicketQuantityCount>48</pickTicketQuantityCount>
            <pickTicketStatus>Printed</pickTicketStatus>
            <pickTicketType>ShipFromStore</pickTicketType>
        </PickTicketEssentials>
    </pickTickets>
    <totalPickTicketCount>3</totalPickTicketCount>
</PickTicketSearchResponse>

JSON Request

Authorization: Basic U2VydmljZTpzZXJ2aWNlOg==

{
   "pickTicketType": "ShipFromStore",
   "pickTicketStatus": null,
   "pickTicketId": null,
   "pickTicketAllotmentType": 3,
   "pickTicketShowAlternatives": false,
   "pickTicketRollupEnabled": true,
   "pickTicketSearchRequestIncludes": "Default",
   "maxRecordCount": null,
   "pageNumber": null
}

JSON Response

{
   "pickTicketEssentials": [{
      "pickTicketId": "",
      "pickTicketNumber": "",
      "pickTicketType": "ShipFromStore",
      "pickTicketItemCount": 8,
      "pickTicketQuantityCount": 290,
      "pickTicketStatus": "New",
      "pickTicketPickBy": null,
      "pickTicketAllotmentGroupNumber": "3",
      "pickTicketAllotmentGroupDescription": "multi",
      "pickTicketOrderCount": 20,
      "pickTicketAssignByDate": null,
      "pickTicketConfirmByDate": null,
      "pickTicketPickerName": null,
      "pickTicketGroups": [],
      "pickTicketAttributes": []
   },
   {
      "pickTicketId": "2014-11-05 15:59:51.000",
      "pickTicketNumber": "",
      "pickTicketType": "ShipFromStore",
      "pickTicketItemCount": 1,
      "pickTicketQuantityCount": 2,
      "pickTicketStatus": "Printed",
      "pickTicketPickBy": null,
      "pickTicketAllotmentGroupNumber": "3",
      "pickTicketAllotmentGroupDescription": "multi",
      "pickTicketOrderCount": 1,
      "pickTicketAssignByDate": null,
      "pickTicketConfirmByDate": null,
      "pickTicketPickerName": null,
      "pickTicketGroups": [],
      "pickTicketAttributes": []
   },
   {
      "pickTicketId": "2015-05-18 10:55:05.000",
      "pickTicketNumber": "",
      "pickTicketType": "ShipFromStore",
      "pickTicketItemCount": 4,
      "pickTicketQuantityCount": 48,
      "pickTicketStatus": "Printed",
      "pickTicketPickBy": null,
      "pickTicketAllotmentGroupNumber": "3",
      "pickTicketAllotmentGroupDescription": "multi",
      "pickTicketOrderCount": 3,
      "pickTicketAssignByDate": null,
      "pickTicketConfirmByDate": null,
      "pickTicketPickerName": null,
      "pickTicketGroups": [],
      "pickTicketAttributes": []
   }],
   "totalPickTicketCount": 3,
   "sessionToken": "VR5AKL0S38YQ3UDU",
   "baseSystemVersion": "45"
}

 

Copyright © 2017 Radial. All rights reserved.