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
ConfigurationOption
All
Pages
Start typing to searchā¦
JUMP TO
Liftoff OData API v1
About the Liftoff OData API
Authentication
Authorization
Making Liftoff OData API requests
Pagination
Rate limits
Response codes
Interactive documentation
Batch requests
Batch API requests
Budget resources
Budget
Get budget
get
Get budgets
get
Add budget
post
Update budget
patch
BudgetTransaction
Get budget transactions
get
Get budget transaction
get
Add budget transaction
post
Category resources
Category
Get categories
get
Get category
get
Add category
post
Update category
patch
CategoryProduct
Get category products
get
Get category product
get
Add category product
post
Update category product
patch
Delete category product
del
Customer resources
Customer
Get customers
get
Get customer
get
Add customer
post
Update customer
patch
CustomerBillingAddress
Get customer billing addresses
get
Get customer billing address
get
CustomerShippingAddress
Get customer shipping addresses
get
Get customer shipping address
get
AccountCustomerField
Get account customer fields
get
Get account customer field
get
CustomerField
Get customer fields
get
Get customer field
get
Update customer field
patch
Customer role resources
CustomerRole
Get customer roles
get
Get customer role
get
Add customer role
post
Update customer role
patch
CustomerRoleMember
Get customer role members
get
Get customer role member
get
Add customer role member
post
Delete customer role member
del
CustomerRoleProduct
Get customer role products
get
Get customer role product
get
Add customer role product
post
Delete customer role product
del
CustomerRoleCategory
Get customer role categories
get
Get customer role category
get
Add customer role category
post
Delete customer role category
del
Discount resources
Discount
Get discounts
get
Get discount
get
Fulfillment workflow resources
FulfillmentWorkflow
Get fulfillment workflows
get
Get fulfillment workflow
get
FulfillmentWorkflowAccount
Get fulfillment workflow accounts
get
Get fulfillment workflow account
get
FulfillmentWorkflowVendor
Get fulfillment workflow vendors
get
Get fulfillment workflow vendor
get
FulfillmentWorkflowVendorLocation
Get fulfillment workflow vendor locations
get
Get fulfillment workflow vendor location
get
Fulfillment PO resources
FulfillmentPO
Get fulfillment POs
get
Get fulfillment PO
get
FulfillmentPOItem
Get fulfillment PO items
get
Get fulfillment PO item
get
Get fulfillment PO item by item/location/shipping group
get
FulfillmentPOItemPricing
FulfillmentPOItemUpcharge
Get fulfillment PO item upcharges
get
Get fulfillment PO item upcharge
get
Inventory resources
Inventory
Get inventories
get
Get inventory
get
Update inventory
patch
InventoryPO
Get inventory POs
get
Get inventory PO
get
Add inventory PO
post
Update inventory PO
patch
InventoryPOItem
Get inventory PO items
get
Get inventory PO item
get
Add inventory PO item
post
Delete inventory PO item
del
InventoryPOItemFulfillment
Get inventory PO item fulfillments
get
Get inventory PO item fulfillment
get
Add inventory PO item fulfillment
post
Update inventory PO item fulfillment
patch
InventoryTransaction
Get inventory transactions
get
Get inventory transaction
get
Add inventory transaction
post
Order resources
Order
Get orders
get
Get order
get
OrderApproval
Get order approvals
get
Get order approval
get
AccountOrderField
Get account order fields
get
Get account order field
get
OrderField
Get order fields
get
Get order field
get
Update order field
patch
Item
Get items
get
Get item
get
ItemField
Get item fields
get
Get item field
get
ItemFile
Get item files
get
Get item file
get
ItemUpcharge
Get item upcharges
get
Get item upcharge
get
PaymentTransaction
Get payment transactions
get
Get payment transaction
get
Product resources
Product
Get products
get
Get product
get
Add product
post
Update product
patch
Delete product
del
ProductVariant
Get product variants
get
Get product variant
get
Add product variant
post
Update product variant
patch
Delete product variant
del
ProductPrice
Get product prices
get
Get product price
get
Add product price
post
Update product price
patch
Delete product price
del
ProductFulfillmentWorkflow
Get product fulfillment workflows
get
Get product fulfillment workflow
get
AccountProductVariantField
Get account product variant fields
get
Get account product variant field
get
ProductVariantField
Get product variant fields
get
Get product variant field
get
Add product variant field
post
Update product variant field
patch
ProductVariantFile
Get product variant files
get
Get product variant file
get
ProductVariantImage
Get product variant images
get
Get product variant image
get
Add product variant image
post
Update product variant image
patch
Delete product variant image
del
ProductVariantSKUOptionValue
Get product variant SKU option values
get
Get product variant SKU option value
get
Update product variant SKU option value
patch
SKUOption
Get SKU options
get
Get SKU option
get
Add SKU option
post
Update SKU option
patch
SKUOptionValue
Get SKU option values
get
Get SKU option value
get
Add SKU option value
post
Update SKU option value
patch
ConfigurationOption
Get configuration options
get
Get configuration option
get
Add configuration option
post
Update configuration option
patch
ConfigurationOptionValue
Get configuration option values
get
Get configuration option value
get
Add configuration option value
post
Update configuration option value
patch
Profile resources
Profile
Get profile
get
Rule Resources
Rule
Get rules
get
Get rule
get
Shipment resources
Shipment
Get shipments
get
Get shipment
get
Update shipment
patch
Split shipment
post
ShipmentItem
Get shipment items
get
Get shipment item
get
Template resources
Template
Get templates
get
Get template
get
Vendor resources
Vendor
Get vendors
get
Get vendor
get
Location
Get vendor locations
get
Get vendor location
get
Shared resources
Account
AccountRole
Address
AddressShip
Admin
ShippingOption
Powered byĀ
ConfigurationOption
Ask AI