Radial Integration | 2016

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

POST api/v4/Orders/Search

Get a list of orders matching the provided search criteria

Request Parameters

orderSearchRequest: object of type OrderSearchRequest

OrderSearchRequest

Name Description
Usage		 Type
Allowed values		 Required?

orderNumber

Unique identifier of the order within the Store Fulfillment application

String

no

orderAlias

Alternate identifier optionally stored with the order

Object of Type OrderAlias

no

orderPrintBatch

Print batch identifier of the order

String

no

orderStatus

The current status of the order

Enum – supports either text or integer.

All = 0

WaitingToPick = 1

WaitingToShip = 2

Shipped = 3

PendingCancel = 4

Cancelled = 5

OnHold = 6

WaitingToPrint = 7

WaitingRelease = 8

Open = 9

no

vendorNumber

Assigned Vendor Number

String

no

orderType

The type of order

Enum – supports either text or integer.

DropShip = 0

StockPo = 1

ReportingOnlyDropShip = 2

ReportingOnlyStockPo = 3

CarrierIntegratedDropShip = 4

CarrierIntegratedStockPo = 5

InStorePickUp = 6

ShipFromStore = 7

ShipToStore = 8

no

orderImportedAfterDate

Parameter searching on order import date

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

no

orderImportedBeforeDate

Parameter searching on order import date

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

no

orderCustomerLocator

Identification of the customer information on the order

Object of type OrderCustomerLocator

no

orderItemLocator

Identification of the item information on the order

Object of type OrderItemLocator

no

includeAreaVendors

Can be used only if roaming users are enabled, which gives visibility to orders at vendors outside the user’s primary vendor assignment

Boolean

no

includes

OrderSearchRequestIncludes

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

[Default] = 0

OrderHeader = 1

OrderCustomerInfo = 2

OrderItems = 4

OrderPayments = 8

Attributes = 16

OrderShipments = 32

OrderStagingLocations = 64

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

OrderAlias

Name Description
Usage		 Type
Allowed values		 Required?

orderAliasType

Identifier to indicate the type of data stored in the order alias

Enum – supports either text or integer.

WebOrderNumber

OrderReference

OrderSplitAliasOriginal

OrderSplitAliasNew

TrackingNumber

ProvisionalTrackingNumber

HostOrderNumber

PackageReference

ShipmentNumber

yes

orderAliasValue

String value of the order alias for the specified type

String

yes

OrderCustomerLocator

Name Description
Usage		 Type
Allowed values		 Required?

customerId

Unique numeric identifier of the customer within the Store Fulfillment application

Nullable integer

no

customerNumber

String identifier of the customer, typically from the host system

String

no

customerName

Customer full name

String

no

customerFirstName

String value of the customer first name

String

no

customerLastName

String value of the customer last name

String

no

customerCompanyName

String value of the customer company name

String

no

customerCity

String value of the customer city

String

no

customerPostalCode

String value of the customer postal code

String

no

customerEmail

String value of the customer email address

 

no

customerPhone

String value of the customer phone

String

no

orderCustomerType

Identifier to indicate the type of customer to be searched

Enum – supports either text or integer.

notSet = 0

BillTo = 1

ShipTo = 2

OrderTo = 3

Buyer = 4

 

yes

OrderItemLocator

Name Description
Usage		 Type
Allowed values		 Required?

itemId

Unique identifier of the item within the Store fulfillment application

Nullable Integer

no

sku

SKU of the item

String

no

gtin

Global Trade Item Number

string

no

Response Parameters

orderSearchResponse: object of type OrderSearchResponse

OrderSearchResponse

Name Description
Usage		 Type
Allowed values		 Required?

orders

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

Array of type OrderEssentials

no

totalOrderCount

Total number of orders returned in the search

String

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

OrderEssentials

Name Description
Usage		 Type
Allowed values		 Required?

orderNumber

Unique identifier of the order within the Store Fulfillment application

String

yes

orderDate

order creation date

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

yes

vendorNumber

Assigned Store Number

String

yes

vendorName

Assigned Store Name

String

yes

orderType

The type of order

Enum – supports either text or integer.

DropShip = 0

StockPo = 1

ReportingOnlyDropShip = 2

ReportingOnlyStockPo = 3

CarrierIntegratedDropShip = 4

CarrierIntegratedStockPo = 5

InStorePickUp = 6

ShipFromStore = 7

ShipToStore = 8

yes

orderCustomers

Information about the customer records associated to the order

Array of OrderCustomerEssentials

no

orderTotal

Total value of the order

Decimal

yes

orderStatus

Current status of the order within Store Fulfillment

Enum – supports either text or integer.

All = 0

WaitingToPick = 1

WaitingToShip = 2

Shipped = 3

PendingCancel = 4

Cancelled = 5

OnHold = 6

WaitingToPrint = 7

WaitingRelease = 8

yes

orderPrintByDate

The date by which the order must be printed to meet SLA requirements in environments where the PrintBy SLA event is used.

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

no

orderPickConfirmByDate

The date by which the order must be confirmed to meet SLA requirements where the ConfirmBy SLA event is used.

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

no

orderShipByDate

The date by which the order must be shipped to meet SLA requirements where the ShipBy SLA event is used.

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

no

orderPickStatus

Current Pick status of the Order

Enum – supports either text or integer.

WaitingToPick = 0

PickInProcess = 1

PickPaused = 2

PickComplete = 3

yes

orderPickByUser

User that picked the order (if specified)

String

no

orderHoldTicketURL

 

String

no

orderItemCount

Number of line items on the Order

Integer

yes

orderItems

Collection of order item information

Array of OrderItemEssentials

no

orderItemStagingLocations

Collection of order item staging information

Array of OrderItemStagingLocation

no

orderShipments

Collection of order shipment information

Array of ShipmentEssentials

no

orderPayments

Collection of order payment information

Array of OrderPaymentEssentials

no

orderAliases

Collection of alternate order identifiers supplied

Array of OrderAlias

no

itemDetails

Collection of product details related to the items on the order

Array of ItemDetail

no

orderAttributes

Collection of additional attributes available about the order

Array of Attribute

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

OrderItemEssentials

Name Description
Usage		 Type
Allowed values		 Required?

orderItemLineId

Unique order line item identifier within Store Fulfillment

Integer

yes

itemId

Unique item identifier within Store Fulfillment

Integer

yes

orderItemSku

 

String

yes

orderItemDescription

 

String

no

orderItemQuantityOrdered

 

Decimal

yes

orderItemQuantityPicked

 

Decimal

yes

orderItemQuantityShipped

 

Decimal

yes

orderItemQuantityCancelled

 

Decimal

yes

orderItemUnitPrice

 

Nullable Decimal

no

orderItemUnitCost

 

Nullable Decimal

no

orderItemExtendedPrice

 

Nullable Decimal

no

orderItemExtendedCost

 

Nullable Decimal

no

orderItemSection

 

String

no

orderItemAttributes

Collection of additional attributes available about the order item

Array of Attribute

no

OrderItemStagingLocation

Name Description
Usage		 Type
Allowed values		 Required?

itemId

Unique item identifier within Store Fulfillment

Integer

yes

orderItemSku

Sku of the order item

String

yes

orderItemQuantity

Quantity of the specified order item that is at the specified staging location

Decimal

yes

orderItemStagingLocation

Location where this order item quantity has been staged

String

yes

orderItemStagedBy

User that staged the order item (if specified)

String

no

ShipmentEssentials

Name Description
Usage		 Type
Allowed values		 Required?

orderNumber

 

String

yes

shipmentNumber

Unique identifier of the shipment relative to the Order

Integer

yes

shipmentDate

 

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

yes

shipmentStatus

Current status of the shipment within Store Fulfillment

Enum – supports either text or integer.

WaitingToShip = 1

Shipped = 2

yes

shipmentPackChecked

Indicates if the shipment has been marked as Pack Checked

Boolean

yes

shipmentItems

Collection of order item quantities on this Shipment

Array of ShipmentItemEssentials

yes

shipmentPackages

Collection of Packages on this Shipment

Array of ShipmentPackageEssentials

no

shipmentAttributes

Collection of additional Attributes about this Shipment

Array of Attribute

no

OrderPaymentEssentials

Name Description
Usage		 Type
Allowed values		 Required?

paymentMethod

Payment method type identifier (Visa, MC, etc)

String

yes

paymentNumber

Short identifier of the payment method (typically last 4 of card number)

String

yes

paymentExpiration

Expiration of the payment method

String

yes

paymentDescription

Description of the payment method

String

yes

paymentAttributes

Collection of additional Attributes about this payment

String

no

Example- Search for ISPU Orders waiting pickup

XML Request

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

<OrderSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
   <maxRecordCount>1</maxRecordCount>
   <pageNumber i:nil="true" />
   <includeAreaVendors>false</includeAreaVendors>
   <includes>OrderHeader</includes>
   <orderAlias i:nil="true" />
   <orderCustomerLocator>
      <customerCity i:nil="true" />
      <customerCompanyName i:nil="true" />
      <customerEmail>test@radial.com</customerEmail>
      <customerFirstName i:nil="true" />
      <customerId i:nil="true" />
      <customerLastName i:nil="true" />
      <customerName i:nil="true" />
      <customerNumber i:nil="true" />
      <customerPhone i:nil="true" />
      <customerPostalCode i:nil="true" />
      <orderCustomerType>ShipTo</orderCustomerType>
   </orderCustomerLocator>
   <orderImportedAfterDate i:nil="true" />
   <orderImportedBeforeDate i:nil="true" />
   <orderItemLocator i:nil="true" />
   <orderNumber i:nil="true" />
   <orderPrintBatch i:nil="true" />
   <orderStatus>WaitingToShip</orderStatus>
   <orderType>InStorePickUp</orderType>
   <vendorNumber i:nil="true" />
</OrderSearchRequest>

XML Response

<OrderSearchResponse 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>G78LTAQ68XI4VUDU</sessionToken>
    <orders>
        <OrderEssentials>
            <orderAliases>
                <OrderAlias>
                    <orderAliasType>OrderReference</orderAliasType>
                    <orderAliasValue>3312000010210202</orderAliasValue>
                </OrderAlias>
            </orderAliases>
            <orderAttributes />
            <orderCustomers>
                <OrderCustomerEssentials>
                    <customerAddress>
                        <city i:nil="true" />
                        <country>
                            <countryISOCode i:nil="true" />
                            <countryId i:nil="true" />
                            <countryName i:nil="true" />
                            <countryThreeLetterISOCode i:nil="true" />
                            <countryTwoLetterISOCode i:nil="true" />
                        </country>
                        <countryRegion i:nil="true" />
                        <district i:nil="true" />
                        <email>test@radial.com</email>
                        <phones xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" 
                           i:nil="true" />
                        <postalCode i:nil="true" />
                        <street i:nil="true" />
                        <street2 i:nil="true" />
                        <street3 i:nil="true" />
                        <street4 i:nil="true" />
                        <territory i:nil="true" />
                    </customerAddress>
                    <customerAttributes />
                    <customerCompanyName i:nil="true" />
                    <customerDisplayName i:nil="true" />
                    <customerFirstName i:nil="true" />
                    <customerId>1</customerId>
                    <customerLastName i:nil="true" />
                    <customerMiddleName i:nil="true" />
                    <customerNumber i:nil="true" />
                    <customerSuffix i:nil="true" />
                    <customerTitle i:nil="true" />
                    <orderCustomerType>BillTo</orderCustomerType>
                </OrderCustomerEssentials>
                <OrderCustomerEssentials>
                    <customerAddress>
                        <city i:nil="true" />
                        <country>
                            <countryISOCode i:nil="true" />
                            <countryId i:nil="true" />
                            <countryName i:nil="true" />
                            <countryThreeLetterISOCode i:nil="true" />
                            <countryTwoLetterISOCode i:nil="true" />
                        </country>
                        <countryRegion i:nil="true" />
                        <district i:nil="true" />
                        <email>test@radial.com</email>
                        <phones xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" 
                           i:nil="true" />
                        <postalCode i:nil="true" />
                        <street i:nil="true" />
                        <street2 i:nil="true" />
                        <street3 i:nil="true" />
                        <street4 i:nil="true" />
                        <territory i:nil="true" />
                    </customerAddress>
                    <customerAttributes />
                    <customerCompanyName i:nil="true" />
                    <customerDisplayName i:nil="true" />
                    <customerFirstName i:nil="true" />
                    <customerId>1</customerId>
                    <customerLastName i:nil="true" />
                    <customerMiddleName i:nil="true" />
                    <customerNumber i:nil="true" />
                    <customerSuffix i:nil="true" />
                    <customerTitle i:nil="true" />
                    <orderCustomerType>ShipTo</orderCustomerType>
                </OrderCustomerEssentials>
            </orderCustomers>
            <orderDate>2013-04-10T00:00:00</orderDate>
            <orderItemCount>1</orderItemCount>
            <orderItemStagingLocations />
            <orderItems />
            <orderNumber>MCI111000166</orderNumber>
            <orderPayments />
            <orderPickByUser i:nil="true" />
            <orderPickConfirmByDate>2013-04-10T19:25:00</orderPickConfirmByDate>
            <orderPickStatus>PickComplete</orderPickStatus>
            <orderPrintByDate>2013-04-10T19:20:00</orderPrintByDate>
            <orderShipByDate>2013-04-10T19:30:00</orderShipByDate>
            <orderShipments />
            <orderStatus>WaitingToShip</orderStatus>
            <orderTotal>54.000000</orderTotal>
            <orderType>InStorePickUp</orderType>
            <vendorName>Test StoreNet Vendor</vendorName>
            <vendorNumber>TESTSN</vendorNumber>
        </OrderEssentials>
    </orders>
    <totalOrderCount>1</totalOrderCount>
</OrderSearchResponse>

JSON Request

{
   "orderNumber": null,
   "orderAlias": null,
   "orderPrintBatch": null,
   "orderStatus": "WaitingToShip",
   "orderType": "InStorePickUp",
   "orderImportedAfterDate": null,
   "orderImportedBeforeDate": null,
   "orderCustomerLocator": {
      "customerId": null,
      "customerNumber": null,
      "customerName": null,
      "customerFirstName": null,
      "customerLastName": null,
      "customerCompanyName": null,
      "customerCity": null,
      "customerPostalCode": null,
      "customerEmail": "test@radial.com",
      "customerPhone": null,
      "orderCustomerType": "ShipTo"
   },
   "orderItemLocator": null,
   "vendorNumber": null,
   "includeAreaVendors": false,
   "orderSearchRequestIncludes": "OrderHeader",
   "maxRecordCount": 1,
   "pageNumber": null
}

JSON Response

{
   "orderEssentials": [{
      "orderNumber": "MCI111000166",
      "orderDate": "2013-04-10T00:00:00",
      "vendorNumber": "TESTSN",
      "vendorName": "Test StoreNet Vendor",
      "orderType": "InStorePickUp",
      "orderCustomerEssentials": [{
         "orderCustomerType": "BillTo",
         "customerId": 1,
         "customerNumber": null,
         "customerTitle": null,
         "customerFirstName": null,
         "customerMiddleName": null,
         "customerLastName": null,
         "customerSuffix": null,
         "customerCompanyName": null,
         "customerDisplayName": null,
         "address": {
            "street": null,
            "street2": null,
            "street3": null,
            "street4": null,
            "city": null,
            "countryRegion": null,
            "postalCode": null,
            "country": {
               "countryId": null,
               "countryName": null,
               "countryISOCode": null,
               "countryTwoLetterISOCode": null,
               "countryThreeLetterISOCode": null
            },
            "district": null,
            "territory": null,
            "phones": null,
            "email": "test@radial.com"
         },
         "customerAttributes": []
      },
      {
         "orderCustomerType": "ShipTo",
         "customerId": 1,
         "customerNumber": null,
         "customerTitle": null,
         "customerFirstName": null,
         "customerMiddleName": null,
         "customerLastName": null,
         "customerSuffix": null,
         "customerCompanyName": null,
         "customerDisplayName": null,
         "address": {
            "street": null,
            "street2": null,
            "street3": null,
            "street4": null,
            "city": null,
            "countryRegion": null,
            "postalCode": null,
            "country": {
               "countryId": null,
               "countryName": null,
               "countryISOCode": null,
               "countryTwoLetterISOCode": null,
               "countryThreeLetterISOCode": null
            },
            "district": null,
            "territory": null,
            "phones": null,
            "email": "test@radial.com"
         },
         "customerAttributes": []
      }],
      "orderTotal": 54,
      "orderStatus": "WaitingToShip",
      "orderPrintByDate": "2013-04-10T19:20:00",
      "orderPickConfirmByDate": "2013-04-10T19:25:00",
      "orderShipByDate": "2013-04-10T19:30:00",
      "orderPickStatus": "PickComplete",
      "orderPickByUser": null,
      "orderItemCount": 1,
      "orderItemEssentials": [],
      "orderItemStagingLocations": [],
      "orderPaymentEssentials": [],
      "orderShipmentEssentials": [],
      "orderAliases": [{
         "orderAliasType": "OrderReference",
         "orderAliasValue": "3312000010210202"
      }],
      "orderAttributes": []
   }],
   "totalOrderCount": 41,
   "sessionToken": "TO6QOZTMU4SOWJVH",
   "baseSystemVersion": "45"
}

 

 

Copyright © 2017 Radial. All rights reserved.