fabric Orders API is one of 61 APIs that fabric publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
14 operations
across 14 paths,
and defines 66 schemas.
It is described by OpenAPI 3.2.0, at version 3.0.0.
Requests are made against a single base URL, https://api.fabric.inc/v3.
The identity and technical contract details declared by the specification.
cancellationResource
object
Cancellation resource
12 properties
updateOrderFeesAndTaxesRequestUpdateItemFeesAndTaxesResource
object
7 properties
shippingDiscount
object
An object containing shipping discount details.
8 properties
updateCustomerRequest
object
Update customer info request
7 properties
orderContactPhone
object
Contact person's phone details.
2 properties
orderPaymentIdentifier
object
An object containing the details of payment modes and payment identifiers.
5 properties
returnFeeDetail
object
An object containing return fee details.
5 properties
createOrderRequest
object
The object containing details related to order creation.
34 properties
3 required
orderResponse
object
An object containing order details.
67 properties
6 required
valueSearchFilter
object
Criteria to find orders by a single value. Condition between field and value is anything except IN and NIN when valueSearchFilter is used.
2 required
amountInCurrencyResource
object
Amount in currency object details.
3 properties
2 required
valuesSearchFilter
object
Criteria to find orders using multiple values. Condition between field and values is either IN or NIN when valuesSearchFilter is used.
2 required
orderStatusUpdateRequest
object
Request to update order status using state machine
2 properties
1 required
orderNote
object
Note for attention
3 properties
auditLog
object
Audit log to capture change history
18 properties
shipmentInvoiceResource
object
Shipment Invoice resource
3 properties
1 required
updateShipToAddressRequest
object
Request to update ship-to address for a specific shipToId
15 properties
8 required
paymentResponse
object
Payment information
10 properties
orderDiscountRequest
object
Order discount
9 properties
paymentReference
object
Payment details for order
3 properties
orderRetail
object
Optionally used as reference, for orders created from Point-of-Sale systems
4 properties
orderAppeasementPaymentInfo
object
Order appeasement payment info
3 properties
updateOrderFeesAndTaxesRequestUpdateShipInfoFeesAndTaxesResource
object
4 properties
taxDetail
object
An object containing tax information.
8 properties
orderReturnsInfo
object
Order returns info
9 properties
searchResponse
object
Search response
2 properties
quantityInStatus
object
Item quantity for each status
7 properties
orderReturns
object
An object containing the order return details.
15 properties
orderContactName
object
Contact person's name
3 properties
orderPayment
object
An object containing an orders payment details.
21 properties
orderAuditLogUpdatedField
object
Audit log for change history
2 properties
paymentCounterRefundInfo
object
An object containing payment counter refund details.
3 properties
trackingDetailsResource
object
Tracking details
2 properties
errorResponse
object
Error response
3 properties
currencyGroup
object
CurrencyGroup object details.
4 properties
2 required
pagination
object
Pagination response
3 properties
updateOrderFeesAndTaxesRequest
object
7 properties
itemFeeDetails
object
Item fees object containing item fee details.
10 properties
orderDiscount
object
An object containing all the discount details for an order.
9 properties
orderFeeDetail
object
An object containing an orders fee details.
10 properties
paymentDetailsResponseBody
object
Payment info
6 properties
orderItemRequest
object
Order item model
38 properties
5 required
cancellationItemResource
object
A resource used to capture detailed cancellation information at the item level.
13 properties
itemFulfillmentResource
object
Item fulfillment model
6 properties
updatePaymentBillToAddressRequest
object
Request to update bill-to address for a specific payment in an order.
15 properties
8 required
refundDetailResource
object
Used for credit rules. This resource captures the split of fees and tax refunds at the item and order level.
4 properties
orderShipInfo
object
An object containing an orders shipment details.
22 properties
1 required
orderPaymentRequest
object
An object containing the payment details for an order.
15 properties
erroredField
object
An object containing information on error fields, error messages, and the amended status.
3 properties
3 required
adjustmentDetail
object
Price adjustment details object.
11 properties
orderPaymentToken
object
An object containing the order payment token details.
2 properties
currencies
object
currencies
2 properties
pickupRequest
object
An object containing pickup details.
4 properties
addPaymentLogRequest
object
Request to add a payment log entry for a specific payment in an order
8 properties
paymentDetails
object
An object containing payment details.
2 properties
orderAppeasementDetail
object
The order appeasement details object containing appeasement details.
11 properties
orderSearchFilter
object
Search filter
3 properties
2 required
requestReferenceContextResource
object
Request reference context information
5 properties
customerResponse
object
Response for customer update request
4 properties
amountInCurrency
object
Amount in currency object details.
3 properties
2 required
address
object
Address details
14 properties
8 required
orderSearchRequest
object
Filter conditions with sort option
2 properties
1 required
orderPickup
object
An object containing the order pickup details.
4 properties
orderAttributesUpdateRequest
object
An object containing order attributes update request details.
2 properties
1 required
invoiceCustomer
object
Invoice customer
7 properties
orderItem
object
An object containing an orders item details.
89 properties
5 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs fabric publishes across the network.
