Omnichannel API | RAML Definition

This API provides a design best practice to work with customers, channels, categories, stores, partners, orders, products, and shopping cart data from systems using a set of RESTful services in RAML, making it easily consumable by any developer within the enterprise.

This RAML API specification is part of the Accelerator for Salesforce B2C Commerce Cloud and the Accelerator for Retail.

This API depends on these RAML fragments:

• Retail Common
• Retail Contact
• Retail Customer Types
• Retail Fulfillment
• Retail GeoSearch
• Retail Inventory
• Retail Order Types
• Retail Partner
• Retail Payment
• Retail Product
• Retail Shopping Cart Types
• Retail Store
• Retail Taxonomy

Defined types:

• CategoryCollectionResponse - Defines category collection response.
• CategoryResponse - Defines category response.
• ChannelCollectionResponse - Defines channel collection response.
• ChannelResponse - Defines channel response.
• ContactMethodCollectionResponse - Defines contact method collection response.
• ContactMethodResponse - Defines contact method response.
• FeatureCollectionResponse - Defines feature collection response.
• FeatureResponse - Defines feature response.
• FulfillmentMethodCollectionResponse - Defines fulfillment method collection response.
• OrderCollectionResponse - Defines order collection response.
• PartnerCollectionResponse - Defines partner collection response.
• PartnerResponse - Defines partner response.
• PaymentResponse - Defines payment response.
• ProductCollectionResponse - Defines product collection response.
• ProductResponse - Defines product response.
• ProductVariantAvailabilityResponse - Defines product variant availability collection response.
• ProductVariantCollectionResponse - Defines product variant collection response.
• ProductVariantResponse - Defines product variant response.
• SalesOrderCollectionResponse - Defines sales order collection response.
• SalesOrderFulfillmentResponse - Defines sales order fulfillment response.
• SalesOrderItemCollectionResponse - Defines sales order item collection response.
• SalesOrderPaymentMethodResponse - Defines sales order payment method response.
• SalesOrderResponse - Defines sales order response.
• ShoppingCartCollectionResponse - Defines shopping cart collection response.
• ShoppingCartResponse - Defines shopping cart response.
• StoreCollectionResponse - Defines store collection response.
• StoreResponse - Defines store response.