public class JetAPIOrder extends JetAPI implements IJetOrder, IJetAPIOrder
API.REQUEST_TYPE
AUTH_TEST_RESPONSE, config
client, context, lockHost, maxDownloadSize
Constructor and Description |
---|
JetAPIOrder(IAPIHttpClient client,
JetConfig conf)
Create a new API instance
|
JetAPIOrder(IAPIHttpClient client,
JetConfig conf,
boolean lockHost)
Create a new API instance
|
JetAPIOrder(IAPIHttpClient client,
JetConfig conf,
boolean lockHost,
long maxDownloadSize)
Create a new API instance
|
Modifier and Type | Method and Description |
---|---|
List<String> |
getDirectCancelTokens(boolean includePath)
Poll jet for direct cancel uri's and return the list of tokens
|
OrderRec |
getOrderDetail(String jetOrderId)
Retrieve details about an order
|
List<String> |
getOrderStatusTokens(OrderStatus status)
Poll Jet and retrieve a list of order status tokens for doing stuff
with orders.
|
List<String> |
getOrderStatusTokens(OrderStatus status,
boolean includePath)
Poll Jet and retrieve a list of order status tokens for doing stuff
with orders.
|
IJetAPIResponse |
sendGetOrderDetail(String jetOrderId)
Retrieve details about an order
|
IJetAPIResponse |
sendPollDirectedCancel()
Poll jet for directed cancel uri's
|
IJetAPIResponse |
sendPollOrders(OrderStatus status)
Poll Jet for some orders by status.
|
IJetAPIResponse |
sendPutAckOrder(String jetOrderId,
AckRequestRec req)
The order acknowledge call is utilized to allow a retailer to accept or
reject an order.
|
IJetAPIResponse |
sendPutShipOrder(String jetOrderId,
ShipRequestRec req)
The order shipped call is utilized to provide Jet with the SKUs that
have been shipped or cancelled in an order, the tracking information,
carrier information and any additional returns information for the order.
|
executeRequest, get, getHeaderBuilder, getJSONHeaderBuilder, getPlainHeaderBuilder, jsonArrayToTokenList, login, post, post, post, put, put, put, setErrorHandler
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
get, getHeaderBuilder, getJSONHeaderBuilder, getPlainHeaderBuilder, post, post, post, put, put, put, setErrorHandler
public JetAPIOrder(IAPIHttpClient client, JetConfig conf)
client
- The built APIHttpClient instanceconf
- The Jet Configuration objectpublic JetAPIOrder(IAPIHttpClient client, JetConfig conf, boolean lockHost)
client
- The built APIHttpClient instanceconf
- The Jet Configuration objectlockHost
- Toggle locking the host to a domain if http is not present
in the url string.public JetAPIOrder(IAPIHttpClient client, JetConfig conf, boolean lockHost, long maxDownloadSize)
client
- The built APIHttpClient instanceconf
- The Jet Configuration objectlockHost
- Toggle locking the host to a domain if http is not present
in the url string.maxDownloadSize
- Set a maximum download site for the local client.
This is a fixed limit.public IJetAPIResponse sendPollOrders(OrderStatus status) throws APIException, JetException
sendPollOrders
in interface IJetAPIOrder
status
- The jet status to pollAPIException
JetException
public List<String> getOrderStatusTokens(OrderStatus status) throws APIException, JetException
getOrderStatusTokens
in interface IJetAPIOrder
getOrderStatusTokens
in interface IJetOrder
status
- status to pollAPIException
JetException
public List<String> getOrderStatusTokens(OrderStatus status, boolean includePath) throws APIException, JetException
getOrderStatusTokens
in interface IJetAPIOrder
getOrderStatusTokens
in interface IJetOrder
status
- status to pollincludePath
- If this is false, only the rightmost path part
is returned from the uri.APIException
JetException
public IJetAPIResponse sendPollDirectedCancel() throws APIException, JetException
sendPollDirectedCancel
in interface IJetAPIOrder
APIException
JetException
public List<String> getDirectCancelTokens(boolean includePath) throws APIException, JetException
getDirectCancelTokens
in interface IJetAPIOrder
getDirectCancelTokens
in interface IJetOrder
includePath
- Toggle including full uriAPIException
JetException
public IJetAPIResponse sendGetOrderDetail(String jetOrderId) throws APIException, JetException
sendGetOrderDetail
in interface IJetAPIOrder
jetOrderId
- Jet order id (need to poll for these first)APIException
JetException
public OrderRec getOrderDetail(String jetOrderId) throws APIException, JetException
getOrderDetail
in interface IJetAPIOrder
getOrderDetail
in interface IJetOrder
jetOrderId
- Jet order id (need to poll for these first)APIException
JetException
public IJetAPIResponse sendPutAckOrder(String jetOrderId, AckRequestRec req) throws APIException, JetException
sendPutAckOrder
in interface IJetAPIOrder
jetOrderId
- Jet-defined order idreq
- The acknowledgement request to reply to jet withAPIException
JetException
public IJetAPIResponse sendPutShipOrder(String jetOrderId, ShipRequestRec req) throws APIException, JetException
sendPutShipOrder
in interface IJetAPIOrder
jetOrderId
- Jet-defined order idreq
- shipment requestAPIException
JetException
Copyright © 2017. All rights reserved.