Radial Integration | 2016

Store Fulfillment > Store Fulfillment API > POST api/v4/Shipments/RecapPending

POST api/v4/Shipments/RecapPending

This method gives visibility to the Order Item(s) that have been packed but not yet confirmed.

Request Parameters

shipmentRecapPendingRequest: object of type ShipmentRecapPendingRequest

Name Description
Usage		 Type
Allowed values		 Required?

shipmentPendingRecordType

Indicates what type of pending records should be reported in the response

Enum supports integer or string:

Pack = 0

Ship = 1

yes

includes

Indicates what data elements should be returned in the response.

Default will return Summary + Orders

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

[Default] = 0

Summary = 1

Orders = 2

OrderItems = 4

OrderShipments = 8

OrderShipmentItems = 16

OrderShipmentCases = 32

OrderShipmentPackages = 64

no

Response Parameters

shipmentRecapPendingResponse: object of type ShipmentRecapPendingResponse

ShipmentRecapPendingResponse

Name Description
Usage		 Type
Allowed values		 Required?

shipmentPendingRecordType

Indicates what type of pending records should be reported in the response

Enum supports integer or string:

Pack = 0

Ship = 1

yes

shipmentRecap

Information about the records pending in the current batch.

Object of type ShipmentRecap

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

ShipmentRecap

Name Description
Usage		 Type
Allowed values		 Required?

ordersCount

 

Integer

yes

lineItemsCount

 

Integer

yes

totalItemCount

 

Integer

yes

totalFreight

 

Decimal

yes

errorOrdersCount

 

Integer

yes

errorLineItemsCount

 

Integer

yes

errorTotalItemCount

 

Integer

yes

errorTotalFreight

 

Decimal

yes

shipmentRecapOrders

 

Array of ShipmentRecapOrder

no

shipmentErrors

Collection of errors relating to this specific pending batch

Array of ShipmentError

no

ShipmentRecapOrder

Name Description
Usage		 Type
Allowed values		 Required?

orderNumber

Unique identifier of the Order

String

yes

shipmentNumber

Unique identifier of the package/shipment to which the item being packed was assigned.

String

yes

vendorNumber

Assigned Vendor Number

String

yes

shipmentRecapOrderEstimatedShipDate

Estimated ship date

String

no

shipmentRecapOrderErrors

Collection of errors relating to this specific pending batch

Array of ShipmentError

no

shipmentRecapOrderItems

Collection of information about this Order’s Order Items specific to this Shipment

Array of ShipmentRecapOrderItem

no

shipmentRecapOrderShipments

Collection of information about this Order Shipment

Array of ShipmentRecapOrderShipment

no

ShipmentRecapOrderItem

Name Description
Usage		 Type
Allowed values		 Required?

orderItemLineId

Unique order line item identifier within Store Fulfillment

Integer

yes

itemId

unique identifier of the item within the Store Fulfillment application

Integer

yes

shipmentRecapOrderItemSku

 

String

yes

shipmentRecapOrderItemHostSku

 

String

yes

shipmentRecapOrderItemDescription

 

String

no

shipmentRecapOrderItemHostDescription

 

String

no

shipmentRecapOrderItemEstimatedShipDate

Estimated ship date

String

no

shipmentRecapOrderItemShipMethod

Identifier of the ship method

String

yes

shipmentRecapOrderItemShipMethodDescription

description of the ship method

String

no

shipmentRecapOrderItemTrackingNumber

Tracking number for this item’s shipment, if available

String

no

shipmentRecapOrderItemQuantityOrdered

Total quantity of this order item that was ordered

Decimal

yes

shipmentRecapOrderItemQuantityShipping

Total quantity of this order item that is shipping on this shipment

Decimal

yes

shipmentRecapOrderItemErrors

Collection of errors relating to this specific pending batch

Array of ShipmentError

no

Example - View all pack checked items that are pending confirmation

XML Request

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

<ShipmentRecapPendingRequest 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>Orders OrderItems OrderShipments OrderShipmentItems OrderShipmentCases 
      OrderShipmentPackages</includes>
   <shipmentPendingRecordType>Pack</shipmentPendingRecordType>
</ShipmentRecapPendingRequest>

XML Response

<ShipmentRecapPendingResponse 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>AY105MUP87Q90QSD</sessionToken>
   <shipmentPendingRecordType>Pack</shipmentPendingRecordType>
   <shipmentRecap>
      <errorLineItemsCount>0</errorLineItemsCount>
      <errorOrdersCount>0</errorOrdersCount>
      <errorTotalFreight>0</errorTotalFreight>
      <errorTotalItemCount>0</errorTotalItemCount>
      <lineItemsCount>0</lineItemsCount>
      <ordersCount>0</ordersCount>
      <shipmentErrors i:nil="true" />
      <shipmentRecapOrders>
         <ShipmentRecapOrder>
            <orderNumber>abb75866ea09449a8d66</orderNumber>
            <shipmentNumber>-1</shipmentNumber>
            <shipmentRecapOrderErrors />
            <shipmentRecapOrderEstimatedShipDate/>
            <shipmentRecapOrderItems>
               <ShipmentRecapOrderItem>
                  <itemId>177</itemId>
                  <orderItemLineId>1</orderItemLineId>
                  <shipmentRecapOrderItemDescription>GSLFSHBSDILHECDLOTBUQDUBKTSXOXTLUXICCLPULD
                     </shipmentRecapOrderItemDescription>
                  <shipmentRecapOrderItemErrors />
                  <shipmentRecapOrderItemEstimatedShipDate/>
                  <shipmentRecapOrderItemHostDescription>GSLFSHBSDILHECDLOTBUQDUBKTSXOXTLUXICCLPULD
                     </shipmentRecapOrderItemHostDescription>
                  <shipmentRecapOrderItemHostSku>GNUNQGDLV</shipmentRecapOrderItemHostSku>
                  <shipmentRecapOrderItemQuantityOrdered>4.000000</shipmentRecapOrderItemQuantityOrdered>
                  <shipmentRecapOrderItemQuantityShipping>0</shipmentRecapOrderItemQuantityShipping>
                  <shipmentRecapOrderItemShipMethod/>
                  <shipmentRecapOrderItemShipMethodDescription/>
                  <shipmentRecapOrderItemSku>GNUNQGDLV</shipmentRecapOrderItemSku>
                  <shipmentRecapOrderItemTrackingNumber i:nil="true" />
               </ShipmentRecapOrderItem>
            </shipmentRecapOrderItems>
            <shipmentRecapOrderShipments>
               <ShipmentRecapOrderShipment>
                  <shipmentNumber>1</shipmentNumber>
                  <shipmentRecapOrderShipmentCases />
                  <shipmentRecapOrderShipmentErrors />
                  <shipmentRecapOrderShipmentItems>
                     <ShipmentRecapOrderShipmentItem>
                        <itemId>177</itemId>
                        <orderItemLineId>1</orderItemLineId>
                        <shipmentRecapOrderShipmentItemDescription>
                           GSLFSHBSDILHECDLOTBUQDUBKTSXOXTLUXICCLPULD
                        </shipmentRecapOrderShipmentItemDescription>
                        <shipmentRecapOrderShipmentItemErrors />
                        <shipmentRecapOrderShipmentItemHostDescription>
                           GSLFSHBSDILHECDLOTBUQDUBKTSXOXTLUXICCLPULD
                        </shipmentRecapOrderShipmentItemHostDescription>
                        <shipmentRecapOrderShipmentItemHostSku>GNUNQGDLV
                        </shipmentRecapOrderShipmentItemHostSku>
                        <shipmentRecapOrderShipmentItemQuantityPending>1.000000
                        </shipmentRecapOrderShipmentItemQuantityPending>
                        <shipmentRecapOrderShipmentItemSku>GNUNQGDLV</shipmentRecapOrderShipmentItemSku>
                     </ShipmentRecapOrderShipmentItem>
                  </shipmentRecapOrderShipmentItems>
                  <shipmentRecapOrderShipmentLocation/>
                  <shipmentRecapOrderShipmentPackages>
                     <ShipmentRecapOrderShipmentPackage>
                        <shipmentPackageDryIce>0</shipmentPackageDryIce>
                        <shipmentPackageFreight>0</shipmentPackageFreight>
                        <shipmentPackageShipMethod>UPS2</shipmentPackageShipMethod>
                        <shipmentPackageShipMethodDescription>UPS 2nd Day Air
                        </shipmentPackageShipMethodDescription>
                        <shipmentPackageTrackingNumber/>
                        <shipmentPackageWeight>0</shipmentPackageWeight>
                     </ShipmentRecapOrderShipmentPackage>
                  </shipmentRecapOrderShipmentPackages>
                  <shipmentRecapOrderShipmentPacked>false</shipmentRecapOrderShipmentPacked>
                  <shipmentRecapOrderShipmentShipDate/>
                  <shipmentRecapOrderShipmentTotalFreight>0</shipmentRecapOrderShipmentTotalFreight>
               </ShipmentRecapOrderShipment>
            </shipmentRecapOrderShipments>
            <vendorNumber>TESTSN</vendorNumber>
         </ShipmentRecapOrder>
      </shipmentRecapOrders>
      <totalFreight>0</totalFreight>
      <totalItemCount>0</totalItemCount>
   </shipmentRecap>
</ShipmentRecapPendingResponse>

JSON Request

Authorization: Basic dGVzdHNuMTp0ZXN0c24xOkdXNDdHMUZBQkM3OFlBWjc=
{
   "shipmentPendingRecordType": "Pack",
   "includes": "Orders, OrderItems, OrderShipments, OrderShipmentItems, OrderShipmentCases, 
OrderShipmentPackages",
   "maxRecordCount": 0,
   "pageNumber": null
}

JSON Response

{
   "shipmentPendingRecordType": "Pack",
   "shipmentRecap": {
      "ordersCount": 0,
      "lineItemsCount": 0,
      "totalItemCount": 0,
      "totalFreight": 0.0,
      "errorOrdersCount": 0,
      "errorLineItemsCount": 0,
      "errorTotalItemCount": 0,
      "errorTotalFreight": 0.0,
      "shipmentRecapOrders": [{
         "orderNumber": "031de848760d4be18b86",
         "shipmentNumber": "-1",
         "vendorNumber": "TESTSN",
         "shipmentRecapOrderEstimatedShipDate": "",
         "shipmentRecapOrderErrors": [],
         "shipmentRecapOrderItems": [{
            "orderItemLineId": 1,
            "itemId": 180,
            "shipmentRecapOrderItemSku": "SYHXERUXGHNCOGNLX",
            "shipmentRecapOrderItemHostSku": "SYHXERUXGHNCOGNLX",
            "shipmentRecapOrderItemDescription": "MOUIMCYUSKFIIRLDCE",
            "shipmentRecapOrderItemHostDescription": "MOUIMCYUSKFIIRLDCE",
            "shipmentRecapOrderItemEstimatedShipDate": "",
            "shipmentRecapOrderItemShipMethod": "",
            "shipmentRecapOrderItemShipMethodDescription": "",
            "shipmentRecapOrderItemTrackingNumber": null,
            "shipmentRecapOrderItemQuantityOrdered": 4.000000,
            "shipmentRecapOrderItemQuantityShipping": 0.0,
            "shipmentRecapOrderItemErrors": []
         }],
         "shipmentRecapOrderShipments": [{
            "shipmentNumber": 1,
            "shipmentRecapOrderShipmentPacked": false,
            "shipmentRecapOrderShipmentTotalFreight": 0.0,
            "shipmentRecapOrderShipmentLocation": "",
            "shipmentRecapOrderShipmentShipDate": "",
            "shipmentRecapOrderShipmentItems": [{
               "orderItemLineId": 1,
               "itemId": 180,
               "shipmentRecapOrderShipmentItemSku": "SYHXERUXGHNCOGNLX",
               "shipmentRecapOrderShipmentItemHostSku": "SYHXERUXGHNCOGNLX",
               "shipmentRecapOrderShipmentItemDescription": "MOUIMCYUSKFIIRLDCE",
               "shipmentRecapOrderShipmentItemHostDescription": "MOUIMCYUSKFIIRLDCE",
               "shipmentRecapOrderShipmentItemQuantityPending": 1.000000,
               "shipmentRecapOrderShipmentItemErrors": []
            }],
            "shipmentRecapOrderShipmentPackages": [{
               "shipmentPackageShipMethod": "UPS2",
               "shipmentPackageShipMethodDescription": "UPS 2nd Day Air",
               "shipmentPackageTrackingNumber": "",
               "shipmentPackageFreight": 0.0,
               "shipmentPackageWeight": 0.0,
               "shipmentPackageDryIce": 0.0
            }],
            "shipmentRecapOrderShipmentCases": [],
            "shipmentRecapOrderShipmentErrors": []
         }]
      }],
      "shipmentErrors": null
   },
   "sessionToken": "GW47G1FABC78YAZ7",
   "baseSystemVersion": "45"
}

 

 

Copyright © 2017 Radial. All rights reserved.