GET api/Personal/CBIP/GetOrdersForShipping?orderID={orderID}&startDate={startDate}&endDate={endDate}&warehouseID={warehouseID}
This API method fetches order shipping information for CBIP. You may filter for a specific order, or all orders within the specified date range. Or, if NO filter criteria is specified it will return all the latest posted orders since the last time the data was fetched. Only orders whose shipping addresses match the territory of your access right will be returned
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
orderID |
Optional - specify the order # to restrict the results to that one order only |
integer |
None. |
startDate |
Optional - specify along with endDate if you wish to return a date range of posted orders |
date |
None. |
endDate |
Optional - specify along with startDate if you wish to return a date range of posted orders |
date |
None. |
warehouseID |
Optional - specify the warehouse id that relates to the orders you want to pull. User territory access must include the country of that warehouse |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of ICustomShippingOrderInformationModelName | Description | Type | Additional information |
---|---|---|---|
ID | integer |
None. |
|
StatusID | integer |
None. |
|
TotalPrice | decimal number |
None. |
|
DatePosted | date |
None. |
|
ShipName1 | string |
None. |
|
ShipName2 | string |
None. |
|
ShipStreet1 | string |
None. |
|
ShipStreet2 | string |
None. |
|
ShipCounty | string |
None. |
|
ShipCity | string |
None. |
|
ShipState | string |
None. |
|
ShipPostalCode | string |
None. |
|
ShipCountry | string |
None. |
|
ShipPhone | string |
None. |
|
ShipEmail | string |
None. |
|
CustomerFirstName | string |
None. |
|
CustomerLastName | string |
None. |
|
CustomerDID | string |
None. |
|
OrderDate | date |
None. |
|
OrderType | string |
None. |
|
Quantity | integer |
None. |
|
RepID | integer |
None. |
|
RepFirstName | string |
None. |
|
RepLastName | string |
None. |
|
RepDID | string |
None. |
|
SubjectID | integer |
None. |
|
SubjectTypeID | integer |
None. |
|
SecondarySubjectID | integer |
None. |
|
SecondarySubjectTypeID | integer |
None. |
|
Currency | string |
None. |
|
DiscountsTotal | decimal number |
None. |
|
TaxTotal | decimal number |
None. |
|
ShippingTotal | decimal number |
None. |
|
OrderDetails | Collection of ICustomShippingOrderDetailInformationModel |
None. |
Response Formats
application/xml, text/xml, application/json, text/json
Sample not available.