Radial Integration | 2016

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

POST api/v4/PickTickets/Confirm

Confirm the current pick progress of a specific Pick Ticket and mark the picking complete.

Request Parameters

pickTicketConfirmRequest: object of type PickTicketConfirmRequest

Name Description
Usage
Type
Allowed values
Required?

pickTicketId

Pick batch identifier for Pick Tickets.

String

yes

pickTicketPickerName

Indicates the name of the user that pick confirmed this Pick Ticket

String

no

pickTicketGroupId

Unique identifier of the specific Pick Ticket Group

Integer

no

includes

Indicates what data elements should be returned in the response

Enum of type PickTicketConfirmRequestIncludes – bitwise field that supports integer or string:

[Default] = 0

PickTicketHeader = 1

PickTicketItems = 2

PickTicketGroups = 4

ItemDetails = 8

Attributes = 16

Orders = 32

PickTicketPrintableDocuments = 64

no

Response Parameters

pickTicketConfirmResponse: object of type PickTicketConfirmResponse

PickTicketConfirmResponse

Name Description
Usage
Type
Allowed values
Required?

pickTicketDetail

Information about the Pick Ticket

Object of type PickTicketDetail

no

pickTicketPrintableDocuments

Information about the types of documents currently available to print for a specific Pick Ticket

Array of PickTicketPrintableDocument

no

pickTicketConfirmHasError

Indicates if the confirmation request had an error

Boolean

yes

pickTicketConfirmErrorMessage

General top level message about the type of error encountered

String

no

pickTicketConfirmErrors

Collection of error messages related to specific lines on the Pick Ticket

Array of PickTicketConfirmError

no

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

PickTicketPrintableDocument

Name Description
Usage
Type
Allowed values
Required?

pickTicketDocumentType

Identifies the type of document available to print

Enum – supports either text or integer.

PickTicket = 1

HoldTicket = 2

PutAwayTicket = 3

PackSlip = 4

ShippingLabel = 5

yes

packageShipMethod

Identifier of the ship method, if applicable for the related document type

String

no

Example - Confirm a Pick Ticket

XML Request

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

<PickTicketConfirmRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
   <includes>Default</includes>
   <pickTicketGroupId>0</pickTicketGroupId>
   <pickTicketId>2016-05-23 13:56:46.000</pickTicketId>
   <pickTicketPickerName i:nil="true" />
</PickTicketConfirmRequest>      

XML Response

<PickTicketConfirmResponse 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>X3J0W30CQ718B5NI</sessionToken>
   <pickTicketConfirmErrorMessage i:nil="true" />
   <pickTicketConfirmErrors />
   <pickTicketConfirmHasError>false</pickTicketConfirmHasError>
   <pickTicketDetail>
      <orderEssentials />
      <pickTicketAllotmentGroupDescription>0</pickTicketAllotmentGroupDescription>
      <pickTicketAllotmentGroupNumber>0</pickTicketAllotmentGroupNumber>
      <pickTicketAssignByDate i:nil="true" />
      <pickTicketAttributes />
      <pickTicketConfirmByDate i:nil="true" />
      <pickTicketGroups />
      <pickTicketHoldURL>/printing/printpack.aspx?Pozlookup=P2XVYZD4TPCXECK2&amp;OrderType=4&amp;Batch=P
      </pickTicketHoldURL>
      <pickTicketId>2016-05-23 13:56:46.000</pickTicketId>
      <pickTicketItemCount>1</pickTicketItemCount>
      <pickTicketItems>
         <PickTicketItemDetail>
            <itemDetail>
               <itemAdditionalGTINs 
                  xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
               <itemAliases />
               <itemAttributes />
               <itemCategory i:nil="true" />
               <itemClasses xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
               <itemCompany i:nil="true" />
               <itemDepartment i:nil="true" />
               <itemDescription>NFLEETTMC</itemDescription>
               <itemDivision i:nil="true" />
               <itemExternalId>226514</itemExternalId>
               <itemGTIN/>
               <itemHostSku>QCTXQCHOGQYXUTBPSFNG</itemHostSku>
               <itemId>207</itemId>
               <itemImages />
               <itemInventory>
                  <itemQuantityAllocated>0</itemQuantityAllocated>
                  <itemQuantityMissing>0</itemQuantityMissing>
                  <itemQuantityOnHand>0</itemQuantityOnHand>
                  <itemQuantityOnHold>0</itemQuantityOnHold>
                  <itemStockLevels />
               </itemInventory>
               <itemLocations xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
               <itemSection/>
               <itemSharedProduct>false</itemSharedProduct>
               <itemSku>QCTXQCHOGQYXUTBPSFNG</itemSku>
               <itemStoreSellingPrice>0</itemStoreSellingPrice>
               <itemStyle i:nil="true" />
               <itemStyleDescription i:nil="true" />
               <itemStyleProperties />
               <itemTitle>NFLEETTMC</itemTitle>
               <itemWeight>0</itemWeight>
               <vendorNumber>jnyst3</vendorNumber>
            </itemDetail>
            <pickTicketGroup>
               <pickTicketGroupId>0</pickTicketGroupId>
               <pickTicketGroupName>SLOT 0</pickTicketGroupName>
               <pickTicketGroupStatus>Confirmed</pickTicketGroupStatus>
            </pickTicketGroup>
            <pickTicketItemAttributes>
               <Attribute>
                  <key>LineId</key>
                  <value>1</value>
               </Attribute>
            </pickTicketItemAttributes>
            <pickTicketItemQuantityCancelled>0</pickTicketItemQuantityCancelled>
            <pickTicketItemQuantityConfirmed>4</pickTicketItemQuantityConfirmed>
            <pickTicketItemQuantityOrdered>4</pickTicketItemQuantityOrdered>
            <pickTicketItemQuantityPicked>0</pickTicketItemQuantityPicked>
            <pickTicketItemReasonCode/>
            <pickTicketItemReasonDescription/>
         </PickTicketItemDetail>
      </pickTicketItems>
      <pickTicketNumber/>
      <pickTicketOrderCount>0</pickTicketOrderCount>
      <pickTicketPickBy i:nil="true" />
      <pickTicketPickMethod>PickBySku</pickTicketPickMethod>
      <pickTicketPickerName i:nil="true" />
      <pickTicketPrintURL>/printing/pickticket.aspx?Pozlookup=P2XVYZD4TPCXECK2&amp;OrderType=4&amp;Batch=P
      </pickTicketPrintURL>
      <pickTicketQuantityCount>0</pickTicketQuantityCount>
      <pickTicketStatus>Confirmed</pickTicketStatus>
      <pickTicketType>ShipFromStore</pickTicketType>
   </pickTicketDetail>
   <pickTicketPrintableDocuments />
</PickTicketConfirmResponse>

JSON Request

Authorization: Basic MTk4NTo6S1ZBRzgxRzBPSk5QNDNPVw==

{
   "pickTicketId": "2016-05-11 13:30:42.000",
   "pickTicketPickerName": "TestStoreUser",
   "pickTicketGroupId": 0,
}

JSON Response

{
    "pickTicketDetail": {
        "pickTicketId": "2016-05-11 13:30:42.000",
        "pickTicketNumber": "0107",
        "pickTicketType": "InStorePickUp",
        "pickTicketPickMethod": "PickBySku",
        "pickTicketAssignByDate": null,
        "pickTicketConfirmByDate": null,
        "pickTicketItemCount": 1,
        "pickTicketQuantityCount": 0,
        "pickTicketStatus": "Confirmed",
        "pickTicketPickBy": null,
        "pickTicketAllotmentGroupNumber": "0",
        "pickTicketAllotmentGroupDescription": "0",
        "pickTicketOrderCount": 0,
        "pickTicketPrintURL": "/printing/pickticket.aspx?Pozlookup=HXL13HY9W8MR3QYA&OrderType=4&Batch=P",
        "pickTicketHoldURL": "/printing/printpack.aspx?Pozlookup=HXL13HY9W8MR3QYA&OrderType=4&Batch=P",
        "pickTicketPickerName": null,
        "pickTicketGroups": [],
        "pickTicketItemDetails": [
            {
                "itemDetail": {
                    "itemId": 900,
                    "vendorNumber": "TEST",
                    "itemSku": "1332210",
                    "itemHostSku": "1332210",
                    "itemGTIN": "00886860199524",
                    "itemTitle": "Lilac Blossoms Trellis Ceramic 8-oz Yankee Candle®",
                    "itemDescription": "Lilac Blossoms Trellis Ceramic 8-oz Yankee Candle®",
                    "itemStyle": null,
                    "itemStyleDescription": null,
                    "itemStyleProperties": [],
                    "itemWeight": 0,
                    "itemStoreSellingPrice": 0,
                    "itemCategory": null,
                    "itemCompany": null,
                    "itemDivision": null,
                    "itemDepartment": null,
                    "itemSection": "",
                    "itemExternalId": null,
                    "itemSharedProduct": true,
                    "itemImages": [
                        {
                            "itemImageType": "Primary",
                            "itemImageUrl": "http://sampleitemimage.jpg"
                        }
                    ],
                    "itemLocations": [],
                    "itemAdditionalGTINs": [
                        "886860199524"
                    ],
                    "itemAliases": [
                        {
                            "itemSku": "Other Gifts-ED",
                            "itemAliasType": "CLS",
                            "vendorNumber": "",
                            "orderType": "All"
                        },
                    ],
                    "itemClasses": [
                        "13237",
                        "13200"
                    ],
                    "itemInventory": {
                        "itemQuantityOnHand": 0,
                        "itemQuantityOnHold": 0,
                        "itemQuantityAllocated": 0,
                        "itemQuantityMissing": 0,
                        "itemStockLevels": []
                    },
                    "itemAttributes": []
                },
                "pickTicketItemQuantityOrdered": 1,
                "pickTicketItemQuantityPicked": 0,
                "pickTicketItemQuantityConfirmed": 1,
                "pickTicketItemQuantityCancelled": 0,
                "pickTicketItemReasonCode": "",
                "pickTicketItemReasonDescription": "",
                "pickTicketGroup": {
                    "pickTicketGroupId": 0,
                    "pickTicketGroupName": "SLOT 0",
                    "pickTicketStatus": "Confirmed"
                },
                "pickTicketItemAttributes": [
                    {
                        "key": "LineId",
                        "value": "1"
                    }
                ]
            }
        ],
        "pickTicketAttributes": [],
        "orderEssentials": []
    },
    "pickTicketPrintableDocuments": [],
    "pickTicketConfirmHasError": false,
    "pickTicketConfirmErrorMessage": null,
    "pickTicketConfirmErrors": [],
    "sessionToken": "AUZHSGUZEJ81QCII",
    "baseSystemVersion": "45"
}

Example - Confirm a Pick Ticket and request any documents available to print be returned

XML Request

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

<PickTicketConfirmRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
    <includes>PickTicketPrintableDocuments</includes>
    <pickTicketGroupId>0</pickTicketGroupId>
    <pickTicketId>2016-05-25 16:25:38.000</pickTicketId>
    <pickTicketPickerName i:nil="true" />
</PickTicketConfirmRequest>

XML Response

<PickTicketConfirmResponse 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>W1BUWOLHK2L96L78</sessionToken>
    <pickTicketConfirmErrorMessage i:nil="true" />
    <pickTicketConfirmErrors />
    <pickTicketConfirmHasError>false</pickTicketConfirmHasError>
    <pickTicketDetail>
        <orderEssentials />
        <pickTicketAllotmentGroupDescription>0</pickTicketAllotmentGroupDescription>
        <pickTicketAllotmentGroupNumber>0</pickTicketAllotmentGroupNumber>
        <pickTicketAssignByDate i:nil="true" />
        <pickTicketAttributes />
        <pickTicketConfirmByDate i:nil="true" />
        <pickTicketGroups />
        <pickTicketHoldURL>/printing/printpack.aspx?Pozlookup=6EGONOUZB008JSVH&amp;OrderType=4&amp;Batch=P
        </pickTicketHoldURL>
        <pickTicketId>2016-05-25 16:25:38.000</pickTicketId>
        <pickTicketItemCount>1</pickTicketItemCount>
        <pickTicketItems>
            <PickTicketItemDetail>
                <itemDetail>
                    <itemAdditionalGTINs 
                       xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
                    <itemAliases />
                    <itemAttributes />
                    <itemCategory i:nil="true" />
                    <itemClasses xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
                    <itemCompany i:nil="true" />
                    <itemDepartment i:nil="true" />
                    <itemDescription>GTVKRNGCOYPXOKCQCGRODFELRCIKYIYCFDSEGVUGCHXNUOVBLHBPEOMBPKRQG
                    </itemDescription>
                    <itemDivision i:nil="true" />
                    <itemExternalId>505002</itemExternalId>
                    <itemGTIN/>
                    <itemHostSku>UF</itemHostSku>
                    <itemId>206</itemId>
                    <itemImages />
                    <itemInventory>
                        <itemQuantityAllocated>0</itemQuantityAllocated>
                        <itemQuantityMissing>0</itemQuantityMissing>
                        <itemQuantityOnHand>0</itemQuantityOnHand>
                        <itemQuantityOnHold>0</itemQuantityOnHold>
                        <itemStockLevels />
                    </itemInventory>
                    <itemLocations 
                       xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
                    <itemSection/>
                    <itemSharedProduct>false</itemSharedProduct>
                    <itemSku>UF</itemSku>
                    <itemStoreSellingPrice>0</itemStoreSellingPrice>
                    <itemStyle i:nil="true" />
                    <itemStyleDescription i:nil="true" />
                    <itemStyleProperties />
                    <itemTitle>GTVKRNGCOYPXOKCQCGRODFELRCIKYIYCFDSEGVUGCHXNUOVBLHBPEOMBPKRQG</itemTitle>
                    <itemWeight>0</itemWeight>
                    <vendorNumber>jnyst3</vendorNumber>
                </itemDetail>
                <pickTicketGroup>
                    <pickTicketGroupId>0</pickTicketGroupId>
                    <pickTicketGroupName>SLOT 0</pickTicketGroupName>
                    <pickTicketGroupStatus>Confirmed</pickTicketGroupStatus>
                </pickTicketGroup>
                <pickTicketItemAttributes>
                    <Attribute>
                        <key>LineId</key>
                        <value>1</value>
                    </Attribute>
                </pickTicketItemAttributes>
                <pickTicketItemQuantityCancelled>0</pickTicketItemQuantityCancelled>
                <pickTicketItemQuantityConfirmed>4</pickTicketItemQuantityConfirmed>
                <pickTicketItemQuantityOrdered>4</pickTicketItemQuantityOrdered>
                <pickTicketItemQuantityPicked>0</pickTicketItemQuantityPicked>
                <pickTicketItemReasonCode/>
                <pickTicketItemReasonDescription/>
            </PickTicketItemDetail>
        </pickTicketItems>
        <pickTicketNumber/>
        <pickTicketOrderCount>0</pickTicketOrderCount>
        <pickTicketPickBy i:nil="true" />
        <pickTicketPickMethod>PickBySku</pickTicketPickMethod>
        <pickTicketPickerName i:nil="true" />
        <pickTicketPrintURL>
           /printing/pickticket.aspx?Pozlookup=6EGONOUZB008JSVH&amp;OrderType=4&amp;Batch=P
        </pickTicketPrintURL>
        <pickTicketQuantityCount>0</pickTicketQuantityCount>
        <pickTicketStatus>Confirmed</pickTicketStatus>
        <pickTicketType>ShipFromStore</pickTicketType>
    </pickTicketDetail>
    <pickTicketPrintableDocuments>
        <PickTicketPrintableDocument>
            <packageShipMethod>USPS</packageShipMethod>
            <pickTicketDocumentType>PackSlip</pickTicketDocumentType>
        </PickTicketPrintableDocument>
    </pickTicketPrintableDocuments>
</PickTicketConfirmResponse>

JSON Request

Authorization: Basic MTk4NTo6S1ZBRzgxRzBPSk5QNDNPVw==

{
   "pickTicketId": "2016-05-23 23:26:55.000",
   "pickTicketPickerName": "testuser",
   "pickTicketGroupId": 0,
   "includes": 64
}

JSON Response

{
    "pickTicketDetail": {
        "pickTicketId": "2016-05-23 23:26:55.000",
        "pickTicketNumber": "0126",
        "pickTicketType": "InStorePickUp",
        "pickTicketPickMethod": "PickBySku",
        "pickTicketAssignByDate": null,
        "pickTicketConfirmByDate": "2015-08-18T03:52:25",
        "pickTicketItemCount": 1,
        "pickTicketQuantityCount": 0,
        "pickTicketStatus": "Confirmed",
        "pickTicketPickBy": null,
        "pickTicketAllotmentGroupNumber": "0",
        "pickTicketAllotmentGroupDescription": "0",
        "pickTicketOrderCount": 0,
        "pickTicketPrintURL": "/printing/pickticket.aspx?Pozlookup=A4B0RWNC3AJQ1CW7&OrderType=4&Batch=P",
        "pickTicketHoldURL": "/printing/printpack.aspx?Pozlookup=A4B0RWNC3AJQ1CW7&OrderType=4&Batch=P",
        "pickTicketPickerName": null,
        "pickTicketGroups": [],
        "pickTicketItemDetails": [
            {
                "itemDetail": {
                    "itemId": 253,
                    "vendorNumber": "TEST",
                    "itemSku": "1PAJ3221",
                    "itemHostSku": "1PAJ3221",
                    "itemGTIN": "00795902135294",
                    "itemTitle": "Large Classic Snoopy",
                    "itemDescription": "Large Classic Snoopy",
                    "itemStyle": null,
                    "itemStyleDescription": null,
                    "itemStyleProperties": [],
                    "itemWeight": 0,
                    "itemStoreSellingPrice": 0,
                    "itemCategory": null,
                    "itemCompany": null,
                    "itemDivision": null,
                    "itemDepartment": null,
                    "itemSection": "",
                    "itemExternalId": null,
                    "itemSharedProduct": true,
                    "itemImages": [
                        {
                            "itemImageType": "Primary",
                            "itemImageUrl": "http://sampleitemimage.jpg"
                        }
                    ],
                    "itemLocations": [],
                    "itemAdditionalGTINs": [
                        "795902135294"
                    ],
                    "itemAliases": [
                        {
                            "itemSku": "Collections",
                            "itemAliasType": "CLS",
                            "vendorNumber": "",
                            "orderType": "All"
                        },
                    ],
                    "itemClasses": [
                        "13237",
                        "13202"
                    ],
                    "itemInventory": {
                        "itemQuantityOnHand": 0,
                        "itemQuantityOnHold": 0,
                        "itemQuantityAllocated": 0,
                        "itemQuantityMissing": 0,
                        "itemStockLevels": []
                    },
                    "itemAttributes": []
                },
                "pickTicketItemQuantityOrdered": 1,
                "pickTicketItemQuantityPicked": 0,
                "pickTicketItemQuantityConfirmed": 1,
                "pickTicketItemQuantityCancelled": 0,
                "pickTicketItemReasonCode": "",
                "pickTicketItemReasonDescription": "",
                "pickTicketGroup": {
                    "pickTicketGroupId": 0,
                    "pickTicketGroupName": "SLOT 0",
                    "pickTicketStatus": "Confirmed"
                },
                "pickTicketItemAttributes": [
                    {
                        "key": "LineId",
                        "value": "1"
                    }
                ]
            }
        ],
        "pickTicketAttributes": [],
        "orderEssentials": []
    },
    "pickTicketPrintableDocuments": [
        {
            "pickTicketDocumentType": 4,
            "packageShipMethod": "ISP"
        }
    ],
    "pickTicketConfirmHasError": false,
    "pickTicketConfirmErrorMessage": null,
    "pickTicketConfirmErrors": [],
    "sessionToken": "11UFGZROTR5UTL9T",
    "baseSystemVersion": "45"
}

 

 

Copyright © 2017 Radial. All rights reserved.