Paths
/orders
Get Order
Retrieves an order or list of orders based on the query parameters provided in the request.
Enter Client Secret
Enter Client ID
Enter AccessToken, it is mandatory in case of basic authentication.
Enter all the query parameters. Sample: createdTimestamp=gt|2016-09-21T14:30:59-05:00&responseFilter=All&pageLimit=5
200 OK
Create Order
Creates a new Order for fulfillment within the Fulfillment portal. Once the order is submitted, it will be processed and sent to one or more warehouses for fulfillment based on business rules and inventory availability
Enter Client Secret
Enter Client ID
Sample JSON Request. {"order": {"orderNumber": "091167792","orderDate": "2017-01-20T15:12:54-05:00","orderType": "B2C","shipMethod": "FSON","estimatedDeliveryDate": "2017-08-15","shipType": "PCL","salesChannel": "BigCommerce","holdUntilDate": "2017-02-15T00:00:00-05:00","facility": "HFY","freightCost": "23.50","insuranceCost": "10","dutiesAndTaxes": "11.67","alternatePackaging": true,"excludeCollateral": true,"accessorial": ["COA", "SAT"],"destinationAddress": {"name": "James Smith","addressLine1": "100 Papercraft Avenue","addressLine2": "Suite 300","city": "Pittsburgh","stateCode": "PA","zipCode": "15238","countryCode": "US","deliveryType": "R","phoneNumber": "888-787-8888","email": "abc@gmail.com"},"orderNote": [{"noteCode": "NOTES","noteText": "This is a test order"},{"noteCode": "GIFT_FROM","noteText": "Joseph"},{"noteCode": "GIFT_TO","noteText": "Johnson"}, {"noteCode": "GIFT_MSG","noteText": "Happy Birthday!!"}],"line": [{"sku": "003-003-0001111","skuDescripton": "Mens Oxford (Small/Blue/Slim)","orderedQty": "2","unitPrice": "2.56"},{"sku": "005-001-0001","skuDescription": "Fancy T-Shirt","orderedQty": "2","unitPrice": "2.56"}]}}
{
"schema": {
"type": "object"
}
}Enter AccessToken, it is mandatory in case of basic authentication.
200 OK
/orders/{fedexOrderId}
Update Order
Updates an existing Order within the Fulfillment portal. If an order cannot be updated, API call will return an error.
Enter Client Secret
Enter Client ID
Sample JSON Request. {"order": {"orderNumber": "091167792","orderDate": "2017-01-20T15:12:54-05:00","orderType": "B2C","shipMethod": "FSON","estimatedDeliveryDate": "2017-08-15","shipType": "PCL","salesChannel": "BigCommerce","holdUntilDate": "2017-02-15T00:00:00-05:00","facility": "HFY","freightCost": "23.50","insuranceCost": "10","dutiesAndTaxes": "11.67","alternatePackaging": true,"excludeCollateral": true,"accessorial": ["COA", "SAT"],"destinationAddress": {"name": "James Smith","addressLine1": "100 Papercraft Avenue","addressLine2": "Suite 300","city": "Pittsburgh","stateCode": "PA","zipCode": "15238","countryCode": "US","deliveryType": "R","phoneNumber": "888-787-8888","email": "abc@gmail.com"},"orderNote": [{"noteCode": "NOTES","noteText": "This is a test order"},{"noteCode": "GIFT_FROM","noteText": "Joseph"},{"noteCode": "GIFT_TO","noteText": "Johnson"}, {"noteCode": "GIFT_MSG","noteText": "Happy Birthday!!"}],"line": [{"sku": "003-003-0001111","skuDescripton": "Mens Oxford (Small/Blue/Slim)","orderedQty": "2","unitPrice": "2.56"},{"sku": "005-001-0001","skuDescription": "Fancy T-Shirt","orderedQty": "2","unitPrice": "2.56"}]}}
{
"schema": {
"type": "object"
}
}Enter FedEx Order Id
Enter AccessToken, it is mandatory in case of basic authentication.
200 OK
/orders/{fedexOrderId}/cancel
Cancel Order
Cancels an existing order by providing Order Id and the reason for cancelling the order. The order can be cancelled only when the orders is not processed by the fulfillment center.
Enter Client Secret
Enter Client ID
Sample JSON Request. { "order": { "cancelReasonCode": "CCBR" } }
{
"schema": {
"type": "object"
}
}Enter Fedex Order Id
Enter AccessToken, it is mandatory in case of basic authentication.
200 OK