Jump to Content

Recipes API Reference GraphQL

API Reference

Recipes API Reference GraphQL

Kibo COmmerce

Getting Started With Your API
GraphQL
SDKs and Tool Kits

Catalog Storefront

Catalog Storefront Overview
Campaigns
- Get Search Campaignsget
- Get Search Campaignget
Currencies
- Get Exchange Ratesget
PriceLists
Categories
ProductRule
- Preview Product Rulepost
Products
ProductSearch
SearchPreview
- Site Search Previewpost
- Search Previewpost
Rules
SearchMerchandizingRules
- Preview Search Merchandizing Rulepost
SearchRedirect
- Get Search Redirectsget
- Get Search Redirectget

Catalog Admin

Cart/Checkout/Quote

Commerce Overview
Cart
Channel
ChannelGroup
Checkout
Job
- B2B Order Releasepost
Order
OrderAttributeDefinitions
Quote
Return
Wishlist

Pricing Storefront

Pricing Storefront Overview
Discounts
Products
Taxes
- Estimate Order Taxpost

Customer

Customer Overview
CustomerAccountAttributeDefinitions
AccountRankingRule
AddressValidation
- Validate Addresspost
StorefrontAuthTicket
B2BAccount
B2BContact
- Get B2B Contactsget
Credit
CustomerAccount
CustomerAttributeDefinition
CustomerSegment
CustomerSet
- Get Customer Setsget
- Get Customer Setget
CustomerVisit
InStockNotificationSubscription

Fulfillment - Production Profile

Fulfillment Overview
CustomerSurvey
Fulfillment
FutureShipment
GiftReceipt
- Update Gift Receiptput
- Item Gift Receipt Updateput
Manifest
PickWave
Rendition
- Render Order Summaryget
- Render Return Receiptget
ShipmentAttributes
ShipmentContact
Shipment
ShipmentData
ShipmentNotes
ShipmentPackages
ShipmentResendEmail
- Resend Shipment Cancel Emailput
- Resend Shipment Fulfilled Emailput
ShippingNotification
- Handle Carrier Notificationspost
Storefront
- Get Storefront Shipmentsget
- Get Storefront Shipmentget
Substitutions
WorkflowProcess

Entities

Entities Overview
Entities
EntityContainers
EntityLists
ListViews

Inventory

Inventory Overview
InventoryBin
ExportInventory
InventoryFetchFileConfig
InventoryJob
InventoryLocation
ModifyInventory
ShipmentInventoryAllocation
- Get Shipment Inventory Allocationspost
InventorySilo
- Update Tenant Silo Configpost
InventoryTag
InventoryTagCategory
- Get Tag Category Allget
- Get Tag Categoryget
InventoryTagcategory
- Update Tag Categoryput
- Delete Tag Categorydelete
InventoryFutureDate
- Adjust Future Dateput
InventoryAllocation
InventoryBlockAssignment
- Block Assignmentpost
Inventory
- Get Inventorypost
- Aggregatepost
InventoryLocationGroup
- Get Location Groupsget
InventoryOrderItem
- Get Order Item Informationpost

Location Admin

Location Admin Overview
CutoffTimeOverride
LocationAdmin
LocationAttributeDefinitions
LocationGroup
LocationGroupConfiguration
LocationSettings
LocationType
TransferTimes

Location Storefront

Location Storefront Overview
Location

Order Routing

Order Routing Overview
OrderRoutingSettings
OrderRoutingDataList
Routing
OrderRoutingEstimatedDeliveryDate
- Suggest Routing With EDDpost
OrderRoutingGroup
OrderRoutingFilter
OrderRoutingLocation
- Get Locationsget
- Get Location by Location Codeget

Reservation Web

Reservations Overview
Reservation

Site Settings

Site Settings Overview
CartSettings
CheckoutSettings
FulfillmentSettings
GeneralSettings
InventorySettings
ReturnSettings
ShippingSettings
SubscriptionSettings

Subscriptions

Subscriptions Overview
Subscription

Content

Content Overview
Documents
DocumentList
Views
- Get View Documentsget
DocumentListType
DocumentPublishing
DocumentPublishSet
DocumentType
DocumentPropertyType

Tenant

Tenant Overview
Tenants
- Get Tenant by IDget

App Development

App Development Overview
AppAuthTickets
AppEvent
AppInstall
FilebasedPackage
- Get Fileget
HeadlessApp
Package
PublicApplication

Shipping Admin

Shipping Admin Overview
CarrierConfiguration
CarrierConfigurationGlobal
CarrierCredential
CarrierCredentialSet
CarrierDefinition
- Get Carrier Definitionget
- Get Carrier Definitionsget
ShippingProfile
TargetRules

Shipping Storefront

Shipping Storefront Overview
Shipping

Import Export

Import-Export Overview
BatchJob
Export
Files
Import

Admin User

Admin User Overview
AdminGroup
AdminAuthTicket
AdminUser
DeveloperAdminAuthTicket
Role
- Get Rolesget

Audit Logs Web

Audit Log Overview
History

WebHooks

Webhooks Overview
ApplicationEvents
B2bAccountEvents
- B2 B Account Status Changedpost
CartEvents
CreditEvents
CustomerEvents
EventsEvents
FulfillmentEvents
LocationEvents
NotificationEvents
- Email Requestedpost
OrderEvents
ProductEvents
ReservationEvents
- Reservation Deallocatedpost
- Reservation Expiredpost
SearchEvents
- Search Settings Updatedpost
SiteEvents
SubscriptionEvents
TenantEvents
WishlistEvents

Customer Segment Created

post https://example.com/CustomerEvents/CustomerSegmentCreated

Customer Segment Created

Language