Jump to Content

Recipes API Reference

Liftoff Knowledge Base Liftoff Developer Reference Liftoff Support

API Reference

Liftoff Knowledge Base Liftoff Developer Reference Liftoff Support

Recipes API Reference

Liftoff OData API v1

About the Liftoff OData API
Authentication
Authorization
Making Liftoff OData API requests
Rate limits
Response codes
Interactive documentation

Batch requests

Batch API requests

Budget resources

Budget
BudgetTransaction

Category resources

Category
CategoryProduct

Customer resources

Customer
CustomerBillingAddress
- Get customer billing addressesget
- Get customer billing addressget
CustomerShippingAddress
- Get customer shipping addressesget
- Get customer shipping addressget
AccountCustomerField
- Get account customer fieldsget
- Get account customer fieldget
CustomerField

Customer role resources

CustomerRole
CustomerRoleMember
CustomerRoleProduct
CustomerRoleCategory

Discount resources

Discount
- Get discountsget
- Get discountget

Fulfillment workflow resources

FulfillmentWorkflow
- Get fulfillment workflowsget
- Get fulfillment workflowget
FulfillmentWorkflowAccount
- Get fulfillment workflow accountsget
- Get fulfillment workflow accountget
FulfillmentWorkflowVendor
- Get fulfillment workflow vendorsget
- Get fulfillment workflow vendorget
FulfillmentWorkflowVendorLocation
- Get fulfillment workflow vendor locationsget
- Get fulfillment workflow vendor locationget

Fulfillment PO resources

FulfillmentPO
- Get fulfillment POsget
- Get fulfillment POget
FulfillmentPOItem
- Get fulfillment PO itemsget
- Get fulfillment PO itemget

Inventory resources

Inventory
InventoryPO
InventoryPOItem
InventoryPOItemFulfillment
InventoryTransaction

Order resources

Order
- Get ordersget
- Get orderget
OrderApproval
- Get order approvalsget
- Get order approvalget
AccountOrderField
- Get account order fieldsget
- Get account order fieldget
OrderField
Item
- Get itemsget
- Get itemget
ItemField
- Get item fieldsget
- Get item fieldget
ItemFile
- Get item filesget
- Get item fileget
PaymentTransaction
- Get payment transactionsget
- Get payment transactionget

Product resources

Product
ProductVariant
ProductPrice
ProductFulfillmentWorkflow
- Get product fulfillment workflowsget
- Get product fulfillment workflowget
AccountProductVariantField
- Get account product variant fieldsget
- Get account product variant fieldget
ProductVariantField
ProductVariantFile
- Get product variant filesget
- Get product variant fileget
ProductVariantImage
ProductVariantSKUOptionValue
SKUOption
SKUOptionValue
ConfigurationOption
ConfigurationOptionValue

Profile resources

Profile
- Get profileget

Rule Resources

Rule
- Get rulesget
- Get ruleget

Shipment resources

Shipment
ShipmentItem
- Get shipment itemsget
- Get shipment itemget

Template resources

Template
- Get templatesget
- Get templateget

Vendor resources

Vendor
- Get vendorsget
- Get vendorget
Location
- Get vendor locationsget
- Get vendor locationget

Shared resources

Account
AccountRole
Address
AddressShip
Admin
ShippingOption

Powered by

Liftoff OData API v1

About the Liftoff OData API
Authentication
Authorization
Making Liftoff OData API requests
Rate limits
Response codes
Interactive documentation

Batch requests

Batch API requests

Budget resources

Budget
BudgetTransaction

Category resources

Category
CategoryProduct

Customer resources

Customer
CustomerBillingAddress
- Get customer billing addressesget
- Get customer billing addressget
CustomerShippingAddress
- Get customer shipping addressesget
- Get customer shipping addressget
AccountCustomerField
- Get account customer fieldsget
- Get account customer fieldget
CustomerField

Customer role resources

CustomerRole
CustomerRoleMember
CustomerRoleProduct
CustomerRoleCategory

Discount resources

Discount
- Get discountsget
- Get discountget

Fulfillment workflow resources

FulfillmentWorkflow
- Get fulfillment workflowsget
- Get fulfillment workflowget
FulfillmentWorkflowAccount
- Get fulfillment workflow accountsget
- Get fulfillment workflow accountget
FulfillmentWorkflowVendor
- Get fulfillment workflow vendorsget
- Get fulfillment workflow vendorget
FulfillmentWorkflowVendorLocation
- Get fulfillment workflow vendor locationsget
- Get fulfillment workflow vendor locationget

Fulfillment PO resources

FulfillmentPO
- Get fulfillment POsget
- Get fulfillment POget
FulfillmentPOItem
- Get fulfillment PO itemsget
- Get fulfillment PO itemget

Inventory resources

Inventory
InventoryPO
InventoryPOItem
InventoryPOItemFulfillment
InventoryTransaction

Order resources

Order
- Get ordersget
- Get orderget
OrderApproval
- Get order approvalsget
- Get order approvalget
AccountOrderField
- Get account order fieldsget
- Get account order fieldget
OrderField
Item
- Get itemsget
- Get itemget
ItemField
- Get item fieldsget
- Get item fieldget
ItemFile
- Get item filesget
- Get item fileget
PaymentTransaction
- Get payment transactionsget
- Get payment transactionget

Product resources

Product
ProductVariant
ProductPrice
ProductFulfillmentWorkflow
- Get product fulfillment workflowsget
- Get product fulfillment workflowget
AccountProductVariantField
- Get account product variant fieldsget
- Get account product variant fieldget
ProductVariantField
ProductVariantFile
- Get product variant filesget
- Get product variant fileget
ProductVariantImage
ProductVariantSKUOptionValue
SKUOption
SKUOptionValue
ConfigurationOption
ConfigurationOptionValue

Profile resources

Profile
- Get profileget

Rule Resources

Rule
- Get rulesget
- Get ruleget

Shipment resources

Shipment
ShipmentItem
- Get shipment itemsget
- Get shipment itemget

Template resources

Template
- Get templatesget
- Get templateget

Vendor resources

Vendor
- Get vendorsget
- Get vendorget
Location
- Get vendor locationsget
- Get vendor locationget

Shared resources

Account
AccountRole
Address
AddressShip
Admin
ShippingOption

Powered by

Rate limits

Liftoff OData API requests are limited to 100 requests per 30 seconds per originating IP address. If you exceed this threshold, you will receive a 429 response code.