{"openapi":"3.0.0","info":{"title":"OrderCloud","description":"Sitecore OrderCloud provides a powerful, flexible, and extensible platform for managing \n    e-commerce operations. Built with a headless, API-first design, OrderCloud supports any B2C, B2B, B2B2C \n    business models, allowing businesses to create, manage, and scale e-commerce experiences with full \n    control over their product catalogs, pricing, orders, and customer management.\n\n    Key Features:\n    - **Product Management**: Create, manage, and organize products, variants, categories, and pricing. \n      Manage inventories and set custom attributes.\n    - **Order Management**: Create and track orders, manage status updates, process payments, and handle \n      shipping and fulfillment. OrderCloud supports customizable workflows for order processing.\n    - **Customer & User Management**: Manage customer profiles, roles, permissions, and user-specific pricing.\n    - **Multi-Channel Commerce**: Seamlessly manage commerce experiences across B2B, B2C, and marketplace \n      environments, offering a unified system to power all customer touch points.\n    - **Integrations**: OrderCloud integrates with third-party systems like payment gateways, shipping \n      providers, and ERP systems. Custom integrations can also be built via extensible webhooks and API connectors.\n    - **Security**: Built with security in mind, OrderCloud supports role-based access control (RBAC) and OAuth \n      2.0 authentication to ensure secure and compliant access to your resources.\n\n    OrderCloud is highly customizable and extensible, providing the flexibility to adapt the platform to \n    your unique business needs and workflows. It’s designed to integrate smoothly into any existing \n    ecosystem and scale as your business grows.\n\n    For detailed API documentation, integration guides, and tutorials, visit our [documentation site](https://ordercloud.io)","version":"1.0.447.36344","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"contact":{"name":"OrderCloud","url":"http://ordercloud.io"}},"servers":[{"url":"https://api.ordercloud.io/v1","description":"Production sever for Ordercloud"}],"tags":[{"name":"Authentication and authorization","description":"OrderCloud implements OAuth2 combined with our own notion of roles to control user authentication and authorization at fine-grain level. If you over-privilege your users and attempt to control what they can do via front-end code, you run the risk of technically savvy users circumventing this by making direct API calls.","x-id":"AuthenticationAndAuthorization"},{"name":"API clients","description":"API clients represent applications or tools that need to interact with OrderCloud to send requests and receive data.","x-section-id":"AuthenticationAndAuthorization"},{"name":"Security profiles","description":"Security profiles define the access levels and permissions granted to users and roles within the platform, ensuring that only authorized individuals can perform specific actions. These profiles are customizable, allowing organizations to tailor security settings based on the unique needs of their operations and workflows.","x-section-id":"AuthenticationAndAuthorization"},{"name":"Forgotten credentials","description":"These endpoints allow you to reset a user's password or retrieve a forgotten username.","x-section-id":"AuthenticationAndAuthorization"},{"name":"Impersonation configs","description":"ImpersonationConfigs allow users to make API calls on behalf of a buyer user, which we refer to as impersonation.\nIf you're a marketplace owner user with the BuyerImpersonation role you can impersonate any buyer user under your organization as long as an applicable Impersonation Config has been created.\nIf you're a buyer user with the BuyerImpersonation role you can impersonate any other buyer user within the same buyer company as long as an applicable Impersonation Config has been created.","x-section-id":"AuthenticationAndAuthorization"},{"name":"Open ID connects","description":"OpenID Connect (OIDC) is an authentication protocol built on top of the OAuth 2.0 framework, allowing applications to verify the identity of users and obtain basic profile information securely. It enables Single Sign-On by allowing users to authenticate with an identity provider (such as Google, Microsoft, or a custom provider) rather than directly within OrderCloud.","x-section-id":"AuthenticationAndAuthorization"},{"name":"Marketplace owner","description":"A single seller organization is at the center of any OrderCloud solution, this seller is referred to as the marketplace owner. It is the only organization that can administer other organizations and their resources. It consists of users, user groups, and addresses. You should establish these components before setting up catalogs, products, buyers, and suppliers.","x-id":"MarketplaceOwner"},{"name":"Admin users","description":"Admin users are people with access to the marketplace. A user's organization and roles define who they are and what they can do when they log in. Admin users may have broader access than other user types, as they can access information about other organizations with the proper roles.","x-section-id":"MarketplaceOwner"},{"name":"Admin user groups","description":"User groups streamline user management in your marketplace. By placing similar users in groups, you can filter content, define order management rules, and manage changes more easily than accounting for individual users.","x-section-id":"MarketplaceOwner"},{"name":"Admin addresses","description":"Admin addresses define a ShipFromAddress on a product or line item, or represent physical locations for product specific inventory.","x-section-id":"MarketplaceOwner"},{"name":"Incrementors","description":"Incrementors add an atomically incremented number to your object IDs. For example, using \"aprefix-{myIncrementorID}\" results in an order ID of \"aprefix-10010\".","x-section-id":"MarketplaceOwner"},{"name":"Locales","description":"Locales facilitate multi-currency product pricing and ordering in a marketplace. You can assign locales to Buyers or Buyer UserGroups. Duplicate Currency/Language combinations are not permitted.","x-section-id":"MarketplaceOwner"},{"name":"Webhooks","description":"Webhooks are HTTP callbacks that allow OrderCloud to send real-time data or notifications to a specified target when an event occurs.","x-section-id":"MarketplaceOwner"},{"name":"XP indices","description":"XP indices are created for a given XP property on a resource to optimize that data for indexing. This allows filtering on that property.","x-section-id":"MarketplaceOwner"},{"name":"Buyer","description":"Buyers represent real-world entities to which the seller offers product catalogs and from which the seller receives orders. Buyers have many of the same resources as sellers (users, user groups, addresses) and much more, including cost centers, spending accounts, and approval rules. Assignments are a prevalent concept. Most resources can be assigned to a group, or entire buyer organization.","x-id":"Buyer"},{"name":"Buyers","description":"Buyers are the organizations that view the categories and products and place orders.","x-section-id":"Buyer"},{"name":"Users","description":"Users are people with access to the marketplace. A user's roles define who they are and what they can do when they log in to the application.","x-section-id":"Buyer"},{"name":"Buyer groups","description":"Buyer groups streamline buyer management in your marketplace. By assigning similar buyers to groups, you can define shared pricing and catalog access and manage changes more easily than accounting for individual buyers.","x-section-id":"Buyer"},{"name":"User groups","description":"User groups streamline user management in your marketplace. By assigning similar users to groups, you can filter content, define order management rules, and manage changes more easily than accounting for individual users.","x-section-id":"Buyer"},{"name":"Addresses","description":"Addresses are used for billing and shipping an order. You can create multiple addresses and assign them to user groups, or create private addresses through the Me resource.","x-section-id":"Buyer"},{"name":"Cost centers","description":"Cost centers are used to allocate organizational expenditures. Customers may have different names for this, such as \"allocation codes\" or \"charge back codes\", but the purpose is to allocate an expense to a person or department in an organization. Cost centers can referenced on line items, but they do not influence any behavior in OrderCloud.","x-section-id":"Buyer"},{"name":"Credit cards","description":"Credit cards are used as a payment method for an order.  A user may have access to one or many credit cards for personal spend or group spending.\nCredit Cards may be saved and assigned to members of an organization for use during purchase.","x-section-id":"Buyer"},{"name":"Spending accounts","description":"Spending accounts are funds assigned to users that can be used as a payment method on an order. These funds are generally used as corporate budget accounts or rewards dollars. They include parameters that control expiration, balance available, balance renewal, user access and overdraft.","x-section-id":"Buyer"},{"name":"Approval rules","description":"Approval rules are used to verify the integrity of an order. Common examples include orders requiring managerial approval, approval for orders that contain a specific product category, approval for quantity thresholds, or approval for orders that exceed a specific price. Properties are also available to control the triggers and timing for processing approvals whether parallel to another rule, or in succession of a previous rule.","x-section-id":"Buyer"},{"name":"Product collections","description":"Product collections are used to group products into lists to support things like wishlists, or \"saved for later\" features for individual buyer users.","x-section-id":"Buyer"},{"name":"Supplier","description":"Suppliers represent real-world entities, and are an optional type of organization. Like the marketplace owner, they contain users, user groups and addresses. Once established, products can be configured to auto-forward when ordered, or ordered directly from suppliers.","x-id":"Supplier"},{"name":"Suppliers","description":"Suppliers can own, supply, and/or distribute products within the marketplace.","x-section-id":"Supplier"},{"name":"Supplier users","description":"Supplier users are people with access to the marketplace. A user's organization and roles define who they are and what they can do when they log in to the application.","x-section-id":"Supplier"},{"name":"Supplier user groups","description":"User groups streamline user management in your marketplace. By placing similar users in groups, you can filter content, define order management rules, and manage changes more easily than accounting for individual users.","x-section-id":"Supplier"},{"name":"Supplier addresses","description":"Supplier addresses define a ShipFromAddress on a product or line item, or represent physical locations for product specific inventory.","x-section-id":"Supplier"},{"name":"Product catalogs","description":"Products are priced (or unpriced) goods that can be offered to buyers for placement on orders. A product can belong to any number of catalogs, and a catalog can be organized into hierarchical categories to any arbitrary depth. Catalogs are assigned to buyers, though visibility and pricing may vary by buyer, user group, category, or individual product. Pricing may include quantity breaks (collectively called a price schedule), and price schedules may be shared with multiple products. User selected specs, which may include price markups, can be assigned to products, enabling buyer configurability at the time of ordering.","x-id":"ProductCatalogs"},{"name":"Catalogs","description":"Catalogs represent containers for multiple categories used to group products for a specific audience. When a buyer is created, they are issued and assigned a default catalog unless an existing catalog ID is provided. Catalogs can be shared between buyers using assignments., and should be when appropriate.","x-section-id":"ProductCatalogs"},{"name":"Categories","description":"Categories are used within a catalog to group products or other categories.","x-section-id":"ProductCatalogs"},{"name":"Products","description":"Products represent a physical, digital, or abstract good that is offered for sale by a seller or supplier and is purchasable by a buyer user via an order. Products can be a static SKU or a version of a a static SKU, known as a variant. For example, a variant is often a size or color choice that drives a different product SKU. Products may also have inventory associated with them and various inventory attributes like quantity available and configurable stock level notifications.","x-section-id":"ProductCatalogs"},{"name":"Price schedules","description":"Price schedules let you sell the same product with different prices or rules within the same marketplace. A price schedule can include quantity price breaks, min and max quantity per order, or whether to apply tax or shipping calculations.","x-section-id":"ProductCatalogs"},{"name":"Specs","description":"Specs are name-value pairs, typically captured during user input when adding a product to an order. A spec value may have a price markup or markdown associated with it. In more advanced scenarios, specs can define a specific product variant. For example, a product may be available in 3 colors and 3 sizes and therefore have a total of 9 variants. OrderCloud will choose the correct variant to add based on the user-selected values, in this example color and size.","x-section-id":"ProductCatalogs"},{"name":"Product facets","description":"Product facets are extended properties (values on product XP) designated to drive data to support faceted navigation. Buyer list endpoints for products will populate and return facets in the meta object, a collection of facet names, values, and counts. Counts represent the total results that would be returned if the current set were filtered on that facet value.","x-section-id":"ProductCatalogs"},{"name":"Inventory records","description":"Inventory records represent physical locations where inventory for a given product exists. Use of inventory records will prevent writing to Product.Inventory.QuantityAvailable, which will instead be a sum of inventories across all locations associated to the product.","x-section-id":"ProductCatalogs"},{"name":"Bundles","description":"Bundles represent a collection of physical, digital, or abstract goods that are offered for sale, sometimes at a specially defined price, by a seller or supplier and are purchasable by buyer users via an order.","x-section-id":"ProductCatalogs"},{"name":"Discounts","description":"Discounts provide configurable pricing adjustments at various levels (catalog, category, product). Support percentage, flat per quantity, and flat amount discount types with party-based assignments.","x-section-id":"ProductCatalogs","x-lifecycle":"Beta"},{"name":"Orders and fulfillment","description":"Orders are the central concept within OrderCloud. They are where buyers, sellers, products, addresses, and just about everything else come together to form business transactions. A feature that is somewhat unique to this area of the API is that you'll use the same set of endpoints regardless of whether you're a buyer, seller, or supplier. Buyers add line items to orders by specifying a product, quantity, and (optionally) spec values. Shipping is applied at either the order level or line item level. Shipments are independent of orders; you can ship a partial order, or aggregate items from multiple orders onto a single shipment.","x-id":"OrdersAndFulfillment"},{"name":"Orders","description":"Orders represent a business transaction between two parties. They typically consist of a collection of line items, a payment method, tax and shipping information, etc. The platform defines various \"actions\" that can be performed against orders, such as Submit, Approve, Ship, etc. These actions transform the state of the order and often trigger external events such as financial transactions.","x-section-id":"OrdersAndFulfillment"},{"name":"Cart","description":"Carts are a straightforward way for a buyer user to interact with an order before submitting it. Unlike order endpoints, an order ID is not needed to interact with the cart. This simplifies workflows and eliminates the need to keep track of the order ID on the front end. Please note cart should be used as a distinct alternative to order endpoints for a buyer user during the shopping experience; combining the use of cart endpoints with order endpoints is not supported and may have unexpected results. Only available to buyer users.","x-section-id":"OrdersAndFulfillment"},{"name":"Line items","description":"Line items represent a single line on an order. At a minimum, they contain a single product ID and a quantity. A line item may also include spec values, a cost center, shipping details, date needed, and other custom information.","x-section-id":"OrdersAndFulfillment"},{"name":"Promotions","description":"Promotions reduce the cost of a line item or an order. Promotions can have redemption rules that can be applied for available dates, occurrences, eligible products and categories and value. Promotions can can be assigned to buyers or  user groups for redemption.","x-section-id":"OrdersAndFulfillment"},{"name":"Payments","description":"Payments store information about payments and transactions related to a spending account, or those that occur in a 3rd party payment provider.","x-section-id":"OrdersAndFulfillment"},{"name":"Shipments","description":"Shipments are a grouping of one or more line items from one or more orders that are physically packaged and delivered to the Buyer as a single unit. They are typically created by the marketplace owner or supplier after the order is submitted as part of the fulfillment process.","x-section-id":"OrdersAndFulfillment"},{"name":"Order returns","description":"Order returns represent a transaction between two parties. They can be a record of physical items being returned, or a credit being issued not tied to the return of an item, for example, a delayed shipping credit.","x-section-id":"OrdersAndFulfillment"},{"name":"Seller approval rules","description":"Order return approval rules verify the integrity of an order return. Common examples include order returns exceeding a specified refund amount or order returns that contain no physical items to return. Properties are also available to control the triggers and timing for processing approvals whether parallel to another rule, or in succession of a previous rule.","x-section-id":"OrdersAndFulfillment"},{"name":"Bundle line items","description":"Bundles represent a group of lines on an order. At a minimum, each line contains a single product ID and a quantity. A line item may also include spec values, a cost center, shipping details, date needed, and other custom information.","x-section-id":"OrdersAndFulfillment"},{"name":"Bundle subscription items","description":"Subscription orders allow users to set up recurring orders for bundled products or services that are needed on a regular basis.","x-section-id":"OrdersAndFulfillment"},{"name":"Group orders","description":"Group orders endpoint returns a token which can be used to interact with the order associated with the invitation.","x-section-id":"OrdersAndFulfillment","x-lifecycle":"Beta"},{"name":"Subscription items","description":"Subscription items are used in conjunction with Subscriptions to order products on a recurring basis.","x-section-id":"OrdersAndFulfillment"},{"name":"Subscriptions","description":"Subscription orders allow users to set up recurring orders for products or services that are needed on a regular basis.","x-section-id":"OrdersAndFulfillment"},{"name":"Me and my stuff","description":"OrderCloud offers robust pricing and visibility options involving roles, group-level assignments, buyer-specific pricing, and more. Resources that begin with \"me\" enforce all of those configurations into a set of endpoints that are generally all available with only the singular Shopper role. Whether authenticated as yourself or impersonating as someone else, you see only what that user is allowed to see. Other than authentication, you should be able to build an entire buyer experience using only endpoints that start with \"orders\" or \"me\".","x-id":"MeAndMyStuff"},{"name":"Me","description":"\"Me\" is a container for endpoints that return a filtered view of things that the current user is allowed to see. It also provides ways for a user to update or change their own information.","x-section-id":"MeAndMyStuff"},{"name":"Integrations","description":"Integrations support interactions between OrderCloud and customer middleware or other external systems.","x-id":"Integrations"},{"name":"Tracking events","description":"Tracking events can be configured for cart, order, and user events that occur in the context of a specific API Client. When these events are triggered by user actions, like adding a line item to a cart, OrderCloud will record specifics about the event and publish a message encapsulating that information so that external systems can be synchronized accordingly. OrderCloud will only publish messages for events that have been configured for the API client in whose context they occur.","x-section-id":"Integrations"},{"name":"Delivery configurations","description":"Delivery configurations let a marketplace owner to specify one or more external systems and their related configuration details. OrderCloud uses this configuration when delivering information about certain events that occur in OrderCloud, such as Tracking Events.","x-section-id":"Integrations"},{"name":"Entity synchronization","description":"Entity synchronization lets marketplace owners to configure synchronization for different types of base entities changes with external systems.","x-section-id":"Integrations"},{"name":"Error configs","description":"Error configurations let a marketplace owner to get notifications when errors occur during processing events, such as product synchronization or post-webhook delivery.","x-section-id":"Integrations"},{"name":"Integration events","description":"Integration events let you configure connections to your middleware to process custom logic related to your solution. The available types are OrderCheckout, OpenIDConnect, OrderReturn, and AddToCart.","x-section-id":"Integrations"},{"name":"Inventory","description":"Required for inventory notifications. The inventory update will be sent to the URL specified in this resource.","x-section-id":"Integrations"},{"name":"Message senders","description":"Message senders enable the delivery of event-driven notifications to users. Each message sender handles a group of predefined MessageTypes, which you can assign to the parties that should receive those emails.","x-section-id":"Integrations"},{"name":"Order synchronization","description":"Order synchronization lets a marketplace owner configure synchronization of orders to external systems.","x-section-id":"Integrations"},{"name":"Product synchronization","description":"Product synchronization lets a marketplace owner configure synchronization of products to external systems.","x-section-id":"Integrations"},{"name":"Promotion","description":"Required for evaluation of promotions where UseIntegration is true. The promotion with order or line item data will be sent to the URL specified in this resource.","x-section-id":"Integrations"},{"name":"Subscription","description":"Required for processing subscription orders. When a subscription is due to be processed, an order, line items, and payment will be created. The order and subscription will be sent to the URL specified in this resource.","x-section-id":"Integrations"}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"password":{"tokenUrl":"https://auth.ordercloud.io/oauth/token","scopes":{"AddressAdmin":"","AddressReader":"","AdminAddressAdmin":"","AdminAddressReader":"","AdminUserAdmin":"","AdminUserGroupAdmin":"","AdminUserGroupReader":"","AdminUserReader":"","ApiClientAdmin":"","ApiClientReader":"","ApprovalRuleAdmin":"","ApprovalRuleReader":"","BundleAdmin":"","BundleAssignmentAdmin":"","BundleReader":"","BuyerAdmin":"","BuyerImpersonation":"","BuyerReader":"","BuyerUserAdmin":"","BuyerUserReader":"","CatalogAdmin":"","CatalogReader":"","CategoryAdmin":"","CategoryReader":"","CostCenterAdmin":"","CostCenterReader":"","CreditCardAdmin":"","CreditCardReader":"","DeliveryConfigAdmin":"","EntitySyncConfigAdmin":"","ErrorConfigAdmin":"","FullAccess":"","IncrementorAdmin":"","IncrementorReader":"","IntegrationEventAdmin":"","IntegrationEventReader":"","LocaleAdmin":"","LocaleReader":"","MeAddressAdmin":"","MeAdmin":"","MeCreditCardAdmin":"","MessageConfigAssignmentAdmin":"","MessageSenderAdmin":"","MessageSenderReader":"","MeSubscriptionAdmin":"","MeXpAdmin":"","OrderAdmin":"","OrderReader":"","OrderSyncConfigAdmin":"","OverrideShipping":"","OverrideTax":"","OverrideUnitPrice":"","PasswordReset":"","PriceScheduleAdmin":"","PriceScheduleReader":"","ProductAdmin":"","ProductAssignmentAdmin":"","ProductCollectionReader":"","ProductFacetAdmin":"","ProductFacetReader":"","ProductReader":"","ProductSyncConfigAdmin":"","PromotionAdmin":"","PromotionReader":"","SecurityProfileAdmin":"","SecurityProfileReader":"","SetSecurityProfile":"","ShipmentAdmin":"","ShipmentReader":"","Shopper":"","SpendingAccountAdmin":"","SpendingAccountReader":"","SubscriptionAdmin":"","SubscriptionReader":"","SupplierAddressAdmin":"","SupplierAddressReader":"","SupplierAdmin":"","SupplierReader":"","SupplierUserAdmin":"","SupplierUserGroupAdmin":"","SupplierUserGroupReader":"","SupplierUserReader":"","TrackingEventAdmin":"","TrackingEventReader":"","UnsubmittedOrderReader":"","UserGroupAdmin":"","UserGroupReader":"","WebhookAdmin":"","WebhookReader":"","XpIndexAdmin":""}},"clientCredentials":{"tokenUrl":"https://auth.ordercloud.io/oauth/token","scopes":{"AddressAdmin":"","AddressReader":"","AdminAddressAdmin":"","AdminAddressReader":"","AdminUserAdmin":"","AdminUserGroupAdmin":"","AdminUserGroupReader":"","AdminUserReader":"","ApiClientAdmin":"","ApiClientReader":"","ApprovalRuleAdmin":"","ApprovalRuleReader":"","BundleAdmin":"","BundleAssignmentAdmin":"","BundleReader":"","BuyerAdmin":"","BuyerImpersonation":"","BuyerReader":"","BuyerUserAdmin":"","BuyerUserReader":"","CatalogAdmin":"","CatalogReader":"","CategoryAdmin":"","CategoryReader":"","CostCenterAdmin":"","CostCenterReader":"","CreditCardAdmin":"","CreditCardReader":"","DeliveryConfigAdmin":"","EntitySyncConfigAdmin":"","ErrorConfigAdmin":"","FullAccess":"","IncrementorAdmin":"","IncrementorReader":"","IntegrationEventAdmin":"","IntegrationEventReader":"","LocaleAdmin":"","LocaleReader":"","MeAddressAdmin":"","MeAdmin":"","MeCreditCardAdmin":"","MessageConfigAssignmentAdmin":"","MessageSenderAdmin":"","MessageSenderReader":"","MeSubscriptionAdmin":"","MeXpAdmin":"","OrderAdmin":"","OrderReader":"","OrderSyncConfigAdmin":"","OverrideShipping":"","OverrideTax":"","OverrideUnitPrice":"","PasswordReset":"","PriceScheduleAdmin":"","PriceScheduleReader":"","ProductAdmin":"","ProductAssignmentAdmin":"","ProductCollectionReader":"","ProductFacetAdmin":"","ProductFacetReader":"","ProductReader":"","ProductSyncConfigAdmin":"","PromotionAdmin":"","PromotionReader":"","SecurityProfileAdmin":"","SecurityProfileReader":"","SetSecurityProfile":"","ShipmentAdmin":"","ShipmentReader":"","Shopper":"","SpendingAccountAdmin":"","SpendingAccountReader":"","SubscriptionAdmin":"","SubscriptionReader":"","SupplierAddressAdmin":"","SupplierAddressReader":"","SupplierAdmin":"","SupplierReader":"","SupplierUserAdmin":"","SupplierUserGroupAdmin":"","SupplierUserGroupReader":"","SupplierUserReader":"","TrackingEventAdmin":"","TrackingEventReader":"","UnsubmittedOrderReader":"","UserGroupAdmin":"","UserGroupReader":"","WebhookAdmin":"","WebhookReader":"","XpIndexAdmin":""}}}}},"schemas":{"AccessLevel":{"type":"string","enum":["Private","Public","Shareable"],"description":""},"AccessToken":{"type":"object","example":{"access_token":"","expires_in":0,"token_type":"","refresh_token":""},"properties":{"access_token":{"type":"string"},"expires_in":{"type":"integer","format":"int32"},"token_type":{"type":"string"},"refresh_token":{"type":"string"}}},"AccessTokenBasic":{"type":"object","example":{"access_token":""},"properties":{"access_token":{"type":"string"}}},"AddedPromo":{"type":"object","example":{"LineItemID":"","Amount":0,"ID":"","LineItemLevel":false,"Code":"","Name":"","RedemptionLimit":0,"RedemptionLimitPerUser":0,"RedemptionCount":0,"QuantityLimitPerOrder":0,"ItemLimitPerOrder":0,"ItemSortBy":"","Description":"","FinePrint":"","StartDate":"2018-01-01T00:00:00-06:00","ExpirationDate":"2018-01-01T00:00:00-06:00","EligibleExpression":"","ValueExpression":"","CanCombine":false,"AllowAllBuyers":false,"OwnerID":"","AutoApply":false,"Active":false,"UseIntegration":false,"Priority":0,"xp":{}},"properties":{"LineItemID":{"type":"string","maxLength":100},"Amount":{"type":"number","format":"float"},"ID":{"type":"string","maxLength":100},"LineItemLevel":{"type":"boolean","description":"If true, certain eligible expression requirements must be met, and the PromotionDiscount will be applied at the line item level."},"Code":{"type":"string","description":"Must be unique. Entered by buyer when adding promo to order.","maxLength":100},"Name":{"type":"string","maxLength":100},"RedemptionLimit":{"type":"integer","format":"int32","description":"Limit the total number of orders this promotion can be applied to across all users."},"RedemptionLimitPerUser":{"type":"integer","format":"int32","description":"Limit the total number of orders this promotion can be applied to per user."},"RedemptionCount":{"type":"integer","format":"int32","readOnly":true,"description":"The number of times this promotion has been applied to an order."},"QuantityLimitPerOrder":{"type":"integer","format":"int32","description":"Can only be used when LineItemLevel is true and ItemLimitPerOrder does not have a value. When defined the ValueExpression will be the discount applied to each qualifying quantity of eligible items. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.","minimum":1},"ItemLimitPerOrder":{"type":"integer","format":"int32","description":"Can only be used when LineItemLevel is true and QuantityLimitPerOrder does not have a value. Limits the number of items the promotion will apply to when eligible. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.","minimum":1},"ItemSortBy":{"type":"string","description":"Comma delimited list of properties to sort by. Can only be used when ItemLimitPerOrder is true. Used to determine the order in which the promotion is applied to the specified limit of items. Use ! to reverse sort order on a property.","maxLength":200},"Description":{"type":"string","maxLength":2000},"FinePrint":{"type":"string","description":"For reference only. Terms, conditions, and other legal jargon.","maxLength":2000},"StartDate":{"type":"string","format":"date-time"},"ExpirationDate":{"type":"string","format":"date-time"},"EligibleExpression":{"type":"string","description":"The expression evaluated to determine if an item or order is eligible for a promotion. See rules engine documentation for formatting details.","maxLength":400},"ValueExpression":{"type":"string","description":"The expression evaluated to determine the discount amount of an eligible promotion. See rules engine documentation for formatting details.","maxLength":1000},"CanCombine":{"type":"boolean","description":"If true, the promotion can be applied to an order that already other promotions applied, as long as they can also be combined."},"AllowAllBuyers":{"type":"boolean","description":"Allow promo to be used by all buyers without creating explicit assignments."},"OwnerID":{"type":"string","description":"ID of the organization that owns the promotion. Only the marketplace owner can override the OwnerID on create."},"AutoApply":{"type":"boolean","default":false},"Active":{"type":"boolean","default":true},"UseIntegration":{"type":"boolean"},"Priority":{"type":"integer","format":"int32","description":"Used to control the order in which promotions are applied when calling the auto apply or refresh endpoint."},"xp":{"type":"object"}}},"Address":{"type":"object","example":{"ID":"","DateCreated":"2018-01-01T00:00:00-06:00","CompanyName":"","FirstName":"","LastName":"","Street1":"","Street2":"","City":"","State":"","Zip":"","Country":"","Phone":"","AddressName":"","xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"CompanyName":{"type":"string","maxLength":100},"FirstName":{"type":"string","maxLength":100},"LastName":{"type":"string","maxLength":100},"Street1":{"type":"string","maxLength":100},"Street2":{"type":"string","maxLength":100},"City":{"type":"string","maxLength":100},"State":{"type":"string","maxLength":100},"Zip":{"type":"string","maxLength":100},"Country":{"type":"string","maxLength":2},"Phone":{"type":"string","maxLength":100},"AddressName":{"type":"string","maxLength":100},"xp":{"type":"object"}}},"AddressAssignment":{"type":"object","example":{"AddressID":"","UserID":"","UserGroupID":"","IsShipping":false,"IsBilling":false},"properties":{"AddressID":{"type":"string"},"UserID":{"type":"string"},"UserGroupID":{"type":"string"},"IsShipping":{"type":"boolean"},"IsBilling":{"type":"boolean"}}},"AdHocProduct":{"type":"object","example":{"ID":"","Name":"","Description":"","QuantityMultiplier":0,"ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"DefaultSupplierID":"","Returnable":false,"xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100},"Description":{"type":"string","maxLength":2000},"QuantityMultiplier":{"type":"integer","format":"int32","default":1,"description":"Informational only, does not influence any OrderCloud behavior. Used to indicate an amount per Quantity.","minimum":1},"ShipWeight":{"type":"number","format":"float"},"ShipHeight":{"type":"number","format":"float"},"ShipWidth":{"type":"number","format":"float"},"ShipLength":{"type":"number","format":"float"},"DefaultSupplierID":{"type":"string","description":"Used for forwarding orders to suppliers."},"Returnable":{"type":"boolean"},"xp":{"type":"object"}}},"ApiClient":{"type":"object","example":{"ID":"","ClientSecret":"","AccessTokenDuration":0,"Active":false,"AppName":"","RefreshTokenDuration":0,"AnonymousTokenDuration":0,"DefaultContextUserName":"","xp":{},"AllowAnyBuyer":false,"AllowAnySupplier":false,"AllowSeller":false,"IsAnonBuyer":false,"AssignedBuyerCount":0,"AssignedSupplierCount":0,"OrderCheckoutIntegrationEventID":"","OrderCheckoutIntegrationEventName":"","OrderReturnIntegrationEventID":"","OrderReturnIntegrationEventName":"","AddToCartIntegrationEventID":"","AddToCartIntegrationEventName":"","MinimumRequiredRoles":["ApiClientAdmin"],"MinimumRequiredCustomRoles":[""],"MaximumGrantedRoles":["ApiClientAdmin"],"MaximumGrantedCustomRoles":[""]},"properties":{"ID":{"type":"string","readOnly":true,"description":"Used for OAuth 2.0 workflows and impersonation."},"ClientSecret":{"type":"string","description":"Enables the OAuth 2.0 client credentials grant type. Required on all OAuth workflows when present."},"AccessTokenDuration":{"type":"integer","format":"int32"},"Active":{"type":"boolean","description":"All user authentication is prohibited if false."},"AppName":{"type":"string"},"RefreshTokenDuration":{"type":"integer","format":"int32"},"AnonymousTokenDuration":{"type":"integer","format":"int32","default":10080,"description":"Specifies the duration of anonymous tokens, expressed in minutes. This value is only used if the API Client is configured for anonymous shopping."},"DefaultContextUserName":{"type":"string","description":"Optionally define a user that will be used when authenticating with a client credentials grant type flow. This grant type is often used for anonymous browsing on buyer applications and authentication on server integration layers."},"xp":{"type":"object"},"AllowAnyBuyer":{"type":"boolean","description":"Allow all buyer users in your organization access to authenticate using this API Client."},"AllowAnySupplier":{"type":"boolean","description":"Allow all supplier users in your organization access to authenticate using this API Client."},"AllowSeller":{"type":"boolean","description":"Allow all marketplace owner users in your organization access to authenticate using this API Client."},"IsAnonBuyer":{"type":"boolean","description":"Enables anonymous shopping when a buyer user is the DefaultContextUser."},"AssignedBuyerCount":{"type":"integer","format":"int32","readOnly":true},"AssignedSupplierCount":{"type":"integer","format":"int32","readOnly":true},"OrderCheckoutIntegrationEventID":{"type":"string","description":"If populated, an error will be thrown when attempting to submit an order that has not been processed through the OrderCheckout integration."},"OrderCheckoutIntegrationEventName":{"type":"string","readOnly":true},"OrderReturnIntegrationEventID":{"type":"string","description":"If populated, and not overriden by an OrderAdmin, the integration event will be used to calculate ReturnAmount on the order return or each individual return item."},"OrderReturnIntegrationEventName":{"type":"string","readOnly":true},"AddToCartIntegrationEventID":{"type":"string","description":"If populated, the integration event will be used to fetch product information from an external system when a line item is added to an unsubmitted order and the product does not exist in OrderCloud."},"AddToCartIntegrationEventName":{"type":"string","readOnly":true},"MinimumRequiredRoles":{"type":"array","items":{"$ref":"#/components/schemas/ApiRole"}},"MinimumRequiredCustomRoles":{"type":"array","items":{"type":"string"}},"MaximumGrantedRoles":{"type":"array","items":{"$ref":"#/components/schemas/ApiRole"}},"MaximumGrantedCustomRoles":{"type":"array","items":{"type":"string"}}}},"ApiClientAssignment":{"type":"object","example":{"ApiClientID":"","BuyerID":"","SupplierID":""},"properties":{"ApiClientID":{"type":"string"},"BuyerID":{"type":"string"},"SupplierID":{"type":"string"}}},"ApiClientSecret":{"type":"object","example":{"ID":"","Name":"","Expiration":"2018-01-01T00:00:00-06:00"},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string"},"Expiration":{"type":"string","format":"date-time"}}},"ApiClientSecretCreateResponse":{"type":"object","example":{"ClientSecret":"","ID":"","Name":"","Expiration":"2018-01-01T00:00:00-06:00"},"properties":{"ClientSecret":{"type":"string","readOnly":true},"ID":{"type":"string","maxLength":100},"Name":{"type":"string"},"Expiration":{"type":"string","format":"date-time"}}},"ApiError":{"type":"object","example":{"ErrorCode":"","Message":"","Data":{}},"properties":{"ErrorCode":{"type":"string"},"Message":{"type":"string"},"Data":{"type":"object"}}},"ApiRole":{"type":"string","enum":["ApiClientAdmin","ApiClientReader","AddressAdmin","AddressReader","AdminAddressAdmin","AdminAddressReader","AdminUserAdmin","AdminUserGroupAdmin","AdminUserGroupReader","AdminUserReader","ApprovalRuleAdmin","ApprovalRuleReader","BundleAdmin","BundleAssignmentAdmin","BundleReader","BuyerAdmin","BuyerImpersonation","BuyerReader","BuyerUserAdmin","BuyerUserReader","CatalogAdmin","CatalogReader","CategoryAdmin","CategoryReader","CostCenterAdmin","CostCenterReader","CreditCardAdmin","CreditCardReader","EntitySyncConfigAdmin","FullAccess","IncrementorAdmin","IncrementorReader","LocaleReader","LocaleAdmin","MeAddressAdmin","MeAdmin","MeCreditCardAdmin","MessageConfigAssignmentAdmin","MeSubscriptionAdmin","MeXpAdmin","OrderAdmin","OrderReader","OverrideShipping","OverrideTax","OverrideUnitPrice","PasswordReset","PriceScheduleAdmin","PriceScheduleReader","ProductAdmin","ProductAssignmentAdmin","ProductCollectionReader","ProductFacetAdmin","ProductFacetReader","ProductReader","ProductSyncConfigAdmin","PromotionAdmin","PromotionReader","SecurityProfileAdmin","SecurityProfileReader","SetSecurityProfile","ShipmentAdmin","ShipmentReader","Shopper","SpendingAccountAdmin","SpendingAccountReader","SubscriptionAdmin","SubscriptionReader","SupplierAddressAdmin","SupplierAddressReader","SupplierAdmin","SupplierReader","SupplierUserAdmin","SupplierUserGroupAdmin","SupplierUserGroupReader","SupplierUserReader","UnsubmittedOrderReader","UserGroupAdmin","UserGroupReader","OpenIDConnectReader","OpenIDConnectAdmin","MessageSenderReader","MessageSenderAdmin","XpIndexAdmin","WebhookReader","WebhookAdmin","IntegrationEventReader","IntegrationEventAdmin","TrackingEventReader","TrackingEventAdmin","DeliveryConfigAdmin","OrderSyncConfigAdmin","ErrorConfigAdmin"],"description":""},"ApprovalInfo":{"type":"object","example":{"Comments":""},"properties":{"Comments":{"type":"string","description":"Comments to be saved with the order approval or denial.","maxLength":2000}}},"ApprovalRule":{"type":"object","example":{"ID":"","Name":"","Description":"","ApprovingGroupID":"","RuleExpression":"","xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100},"Description":{"type":"string","maxLength":2000},"ApprovingGroupID":{"type":"string"},"RuleExpression":{"type":"string","description":"The expression evaluated to determine an order requires approval. See rules engine documentation for formatting details.","maxLength":400},"xp":{"type":"object"}}},"ApprovalStatus":{"type":"string","enum":["Pending","Approved","Declined"],"description":""},"ApprovalType":{"type":"string","enum":["Order","OrderReturn"],"description":""},"AzureBlobConfig":{"type":"object","example":{"ConnectionString":"","OverrideContainerName":""},"properties":{"ConnectionString":{"type":"string","description":"Storage account connection string."},"OverrideContainerName":{"type":"string"}}},"AzureTableConfig":{"type":"object","example":{"ConnectionString":"","OverrideTableName":""},"properties":{"ConnectionString":{"type":"string","description":"Storage account connection string."},"OverrideTableName":{"type":"string"}}},"Bundle":{"type":"object","example":{"ID":"","OwnerID":"","Name":"","Description":"","Active":false,"xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"OwnerID":{"type":"string","description":"ID of the organization that owns the bundle. Only the ma marketplace owner can override the OwnerID on create."},"Name":{"type":"string","maxLength":100},"Description":{"type":"string","maxLength":2000},"Active":{"type":"boolean","description":"If false, bundle is not visible or purchasable from a buyer's perspective."},"xp":{"type":"object","description":"Consider keeping bundle and product xp schemas consistent. Defining conflicting xp types will result in indexing problems."}}},"BundleAssignment":{"type":"object","example":{"SellerID":"","BundleID":"","BuyerID":"","UserGroupID":""},"properties":{"SellerID":{"type":"string","description":"Marketplace owner can write to this property when creating bundle assignments for other sellers."},"BundleID":{"type":"string"},"BuyerID":{"type":"string"},"UserGroupID":{"type":"string"}}},"BundleCatalogAssignment":{"type":"object","example":{"CatalogID":"","BundleID":""},"properties":{"CatalogID":{"type":"string"},"BundleID":{"type":"string"}}},"BundleItems":{"type":"object","example":{"LineItems":[{"ID":"","ProductID":"","Quantity":0,"BundleItemID":"","IsBundle":false,"DateAdded":"2018-01-01T00:00:00-06:00","QuantityShipped":0,"UnitPrice":0,"PromotionDiscount":0,"BaseDiscount":0,"DiscountID":"","LineTotal":0,"LineSubtotal":0,"CostCenter":"","DateNeeded":"2018-01-01T00:00:00-06:00","ShippingAccount":"","ShippingAddressID":"","ShipFromAddressID":"","Product":{"ID":"","Name":"","Description":"","Returnable":false,"QuantityMultiplier":0,"ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"DefaultSupplierID":"","ParentID":"","xp":{}},"Variant":{"ID":"","Name":"","Description":"","ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"xp":{}},"ShippingAddress":{"ID":"","DateCreated":"2018-01-01T00:00:00-06:00","CompanyName":"","FirstName":"","LastName":"","Street1":"","Street2":"","City":"","State":"","Zip":"","Country":"","Phone":"","AddressName":"","xp":{}},"ShipFromAddress":{"ID":"","DateCreated":"2018-01-01T00:00:00-06:00","CompanyName":"","FirstName":"","LastName":"","Street1":"","Street2":"","City":"","State":"","Zip":"","Country":"","Phone":"","AddressName":"","xp":{}},"SupplierID":"","InventoryRecordID":"","PriceScheduleID":"","IsOnSale":false,"PriceOverridden":false,"Specs":[{"SpecID":"","Name":"","OptionID":"","Value":"","PriceMarkupType":"NoMarkup","PriceMarkup":0}],"IncomingOrderID":"","OutgoingOrderID":"","xp":{}}]},"properties":{"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}}}},"BundleProductAssignment":{"type":"object","example":{"ProductID":"","BundleID":"","Required":false,"DefaultQuantity":0},"properties":{"ProductID":{"type":"string"},"BundleID":{"type":"string"},"Required":{"type":"boolean"},"DefaultQuantity":{"type":"integer","format":"int32"}}},"Buyer":{"type":"object","example":{"ID":"","Name":"","GroupID":"","DefaultCatalogID":"","Active":false,"DateCreated":"2018-01-01T00:00:00-06:00","xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100},"GroupID":{"type":"string"},"DefaultCatalogID":{"type":"string","description":"Allows filtering products by category without explicitly providing a CatalogID. Inherits from buyer group if not specified. If neither is specified when buyer is created, a new catalog is automatically created."},"Active":{"type":"boolean","description":"If false, all user authentication is blocked."},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"xp":{"type":"object"}}},"BuyerAddress":{"type":"object","example":{"ID":"","Shipping":false,"Billing":false,"Editable":false,"DateCreated":"2018-01-01T00:00:00-06:00","CompanyName":"","FirstName":"","LastName":"","Street1":"","Street2":"","City":"","State":"","Zip":"","Country":"","Phone":"","AddressName":"","xp":{}},"properties":{"ID":{"type":"string","readOnly":true,"maxLength":100},"Shipping":{"type":"boolean","description":"Indicates whether this address can be used as a ShippingAddress on an order or line item."},"Billing":{"type":"boolean","description":"Indicates whether this address can be used as a BillingAddress on an order."},"Editable":{"type":"boolean","readOnly":true,"description":"Indicates whether this address can be edited by the current user."},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"CompanyName":{"type":"string","maxLength":100},"FirstName":{"type":"string","maxLength":100},"LastName":{"type":"string","maxLength":100},"Street1":{"type":"string","maxLength":100},"Street2":{"type":"string","maxLength":100},"City":{"type":"string","maxLength":100},"State":{"type":"string","maxLength":100},"Zip":{"type":"string","maxLength":100},"Country":{"type":"string","maxLength":2},"Phone":{"type":"string","maxLength":100},"AddressName":{"type":"string","maxLength":100},"xp":{"type":"object"}}},"BuyerCreditCard":{"type":"object","example":{"ID":"","Editable":false,"Token":"","DateCreated":"2018-01-01T00:00:00-06:00","CardType":"","PartialAccountNumber":"","CardholderName":"","ExpirationDate":"2018-01-01T00:00:00-06:00","xp":{}},"properties":{"ID":{"type":"string","readOnly":true,"maxLength":100},"Editable":{"type":"boolean","readOnly":true},"Token":{"type":"string","description":"Token provided by the credit card processor used to reference the card with that processor.","maxLength":100},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"CardType":{"type":"string"},"PartialAccountNumber":{"type":"string","maxLength":5},"CardholderName":{"type":"string"},"ExpirationDate":{"type":"string","format":"date-time"},"xp":{"type":"object"}}},"BuyerGroup":{"type":"object","example":{"ID":"","Name":"","Description":"","DefaultCatalogID":"","xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100},"Description":{"type":"string","maxLength":2000},"DefaultCatalogID":{"type":"string","description":"If null at the individual buyer level, and buyer is a member of this group, buyer inherits this default catalog."},"xp":{"type":"object"}}},"BuyerPriceBreak":{"type":"object","example":{"Discounted":{"Price":0,"SalePrice":0,"SubscriptionPrice":0,"BundlePrice":0},"Quantity":0,"Price":0,"SalePrice":0,"SubscriptionPrice":0,"BundlePrice":0},"properties":{"Discounted":{"allOf":[{"$ref":"#/components/schemas/DiscountedPrices"}],"description":"Calculated discounted prices. Only populated when a discount applies to this price break."},"Quantity":{"type":"integer","format":"int32","description":"Most commonly 1, except when offering tiered/bulk pricing.","minimum":0},"Price":{"type":"number","format":"float","description":"Price per unit."},"SalePrice":{"type":"number","format":"float","description":"Sale Price per unit. If the current date/time is within the PriceSchedule SaleStart and SaleEnd, this SalePrice will be used."},"SubscriptionPrice":{"type":"number","format":"float","description":"Subscription Price per unit. If set, this price is used when a subscription order is created."},"BundlePrice":{"type":"number","format":"float","description":"Bundle Price per unit. If set, this price is used when an item being added to an order is part of a bundle."}}},"BuyerPriceSchedule":{"type":"object","example":{"PriceBreaks":[{"Discounted":{"Price":0,"SalePrice":0,"SubscriptionPrice":0,"BundlePrice":0},"Quantity":0,"Price":0,"SalePrice":0,"SubscriptionPrice":0,"BundlePrice":0}],"Discount":{"ID":"","Description":"","DiscountBreaks":[{"Quantity":0,"Amount":0}],"ProductFilter":"","CatalogID":"","CategoryID":"","ProductID":"","xp":{}},"OwnerID":"","ID":"","Name":"","ApplyTax":false,"ApplyShipping":false,"MinQuantity":0,"MaxQuantity":0,"UseCumulativeQuantity":false,"RestrictedQuantity":false,"Currency":"","SaleStart":"2018-01-01T00:00:00-06:00","SaleEnd":"2018-01-01T00:00:00-06:00","IsOnSale":false,"xp":{}},"properties":{"PriceBreaks":{"type":"array","items":{"$ref":"#/components/schemas/BuyerPriceBreak"}},"Discount":{"allOf":[{"$ref":"#/components/schemas/Discount"}],"description":"The best applicable discount for this buyer. Only populated when a discount applies."},"OwnerID":{"type":"string","description":"ID of the organization that owns the PriceSchedule. Only the marketplace owner can override the OwnerID on create."},"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100},"ApplyTax":{"type":"boolean","description":"For reference only for calculating tax, does not influence any OrderCloud behavior."},"ApplyShipping":{"type":"boolean","description":"For reference only for calculating shipping cost, does not influence any OrderCloud behavior."},"MinQuantity":{"type":"integer","format":"int32","default":1,"description":"The minimum line item Quantity when UseCumulativeQuantity is false.","minimum":1},"MaxQuantity":{"type":"integer","format":"int32","description":"The maximum line item Quantity when UseCumulativeQuantity is false."},"UseCumulativeQuantity":{"type":"boolean","description":"If true, line item quantities will be aggregated by productID when determining which price break applies, and when Min/Max quantities are met. Else, each line item is treated separately."},"RestrictedQuantity":{"type":"boolean","description":"If true, this product can only be ordered in quantities that exactly match one of the price breaks on this schedule."},"Currency":{"type":"string","description":"We recommend using ISO-4217 currency codes for compatibility with tax and payment processors.","maxLength":100},"SaleStart":{"type":"string","format":"date-time","default":null,"description":"Starting date/time for PriceBreak.SalePrice to be used as the price for the LineItem. Requires that the PriceBreak.SalePrice value is set."},"SaleEnd":{"type":"string","format":"date-time","default":null,"description":"Ending date/time for PriceBreak.SalePrice to be used as the price for the LineItem. Requires that the PriceBreak.SalePrice value is set."},"IsOnSale":{"type":"boolean","readOnly":true,"description":"True when at least one PriceBreak has a SalePrice defined, and the current time is between the SaleStart and SaleEnd date."},"xp":{"type":"object"}}},"BuyerProduct":{"type":"object","example":{"PriceSchedule":{"PriceBreaks":[{"Discounted":{"Price":0,"SalePrice":0,"SubscriptionPrice":0,"BundlePrice":0},"Quantity":0,"Price":0,"SalePrice":0,"SubscriptionPrice":0,"BundlePrice":0}],"Discount":{"ID":"","Description":"","DiscountBreaks":[{"Quantity":0,"Amount":0}],"ProductFilter":"","CatalogID":"","CategoryID":"","ProductID":"","xp":{}},"OwnerID":"","ID":"","Name":"","ApplyTax":false,"ApplyShipping":false,"MinQuantity":0,"MaxQuantity":0,"UseCumulativeQuantity":false,"RestrictedQuantity":false,"Currency":"","SaleStart":"2018-01-01T00:00:00-06:00","SaleEnd":"2018-01-01T00:00:00-06:00","IsOnSale":false,"xp":{}},"ID":"","ParentID":"","IsParent":false,"IsBundle":false,"Name":"","Description":"","QuantityMultiplier":0,"ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"Active":false,"SpecCount":0,"VariantCount":0,"ShipFromAddressID":"","Inventory":{"Enabled":false,"NotificationPoint":0,"VariantLevelTracking":false,"OrderCanExceed":false,"QuantityAvailable":0,"LastUpdated":"2018-01-01T00:00:00-06:00"},"DefaultSupplierID":"","AllSuppliersCanSell":false,"Returnable":false,"DateCreated":"2018-01-01T00:00:00-06:00","xp":{}},"properties":{"PriceSchedule":{"allOf":[{"$ref":"#/components/schemas/BuyerPriceSchedule"}],"readOnly":true},"ID":{"type":"string","maxLength":100},"ParentID":{"type":"string","description":"ID of the parent product. If not null, IsParent should be false"},"IsParent":{"type":"boolean","description":"If true, ParentID must be null, as a parent product cannot have a parent itself."},"IsBundle":{"type":"boolean","readOnly":true,"description":"If true, IsParent must be false, as a parent product cannot be a bundle."},"Name":{"type":"string","maxLength":100},"Description":{"type":"string","maxLength":2000},"QuantityMultiplier":{"type":"integer","format":"int32","default":1,"description":"For reference only, does not influence any OrderCloud behavior. Used to indicate an amount per Quantity.","minimum":1},"ShipWeight":{"type":"number","format":"float"},"ShipHeight":{"type":"number","format":"float"},"ShipWidth":{"type":"number","format":"float"},"ShipLength":{"type":"number","format":"float"},"Active":{"type":"boolean","description":"If false, product is not visible or purchasable from a buyer's perspective."},"SpecCount":{"type":"integer","format":"int32","readOnly":true,"description":"Count of specs assigned to the product."},"VariantCount":{"type":"integer","format":"int32","readOnly":true,"description":"Count of variants generated from the product/spec combinations."},"ShipFromAddressID":{"type":"string","description":"Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs."},"Inventory":{"allOf":[{"$ref":"#/components/schemas/Inventory"}]},"DefaultSupplierID":{"type":"string","description":"Used for forwarding orders to suppliers."},"AllSuppliersCanSell":{"type":"boolean","description":"If true, all suppliers are eligible to opt into selling this product."},"Returnable":{"type":"boolean"},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"xp":{"type":"object"}}},"BuyerSupplier":{"type":"object","example":{"ID":"","Name":""},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100}}},"Catalog":{"type":"object","example":{"ID":"","OwnerID":"","Name":"","Description":"","Active":false,"CategoryCount":0,"xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"OwnerID":{"type":"string","description":"ID of the organization that owns the catalog. Only the marketplace owner can override the OwnerID on create."},"Name":{"type":"string","maxLength":100},"Description":{"type":"string","maxLength":2000},"Active":{"type":"boolean","description":"Categories and products within to this catalog will not be visible to buyer users if false."},"CategoryCount":{"type":"integer","format":"int32","readOnly":true},"xp":{"type":"object"}}},"CatalogAssignment":{"type":"object","example":{"CatalogID":"","BuyerID":"","BuyerGroupID":"","ViewAllCategories":false,"ViewAllProducts":false},"properties":{"CatalogID":{"type":"string"},"BuyerID":{"type":"string"},"BuyerGroupID":{"type":"string"},"ViewAllCategories":{"type":"boolean"},"ViewAllProducts":{"type":"boolean"}}},"Category":{"type":"object","example":{"ID":"","Name":"","Description":"","ListOrder":1,"Active":false,"ParentID":"","ChildCount":0,"xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100},"Description":{"type":"string","maxLength":2000},"ListOrder":{"type":"integer","format":"int32","description":"Order that the category appears within its parent or catalog (if root level).","minimum":0},"Active":{"type":"boolean","description":"If false, buyers cannot see this category or any categories or products under it."},"ParentID":{"type":"string","description":"ID of the parent category."},"ChildCount":{"type":"integer","format":"int32","readOnly":true,"description":"Number of categories that are *immediate* children of this category."},"xp":{"type":"object"}}},"CategoryAssignment":{"type":"object","example":{"CategoryID":"","BuyerID":"","UserGroupID":"","Visible":false,"ViewAllProducts":false},"properties":{"CategoryID":{"type":"string"},"BuyerID":{"type":"string"},"UserGroupID":{"type":"string"},"Visible":{"type":"boolean","description":"Set to null to inherit from parent category or catalog level."},"ViewAllProducts":{"type":"boolean","description":"Set to null to inherit from parent category or catalog level."}}},"CategoryBundleAssignment":{"type":"object","example":{"CategoryID":"","BundleID":"","ListOrder":1},"properties":{"CategoryID":{"type":"string"},"BundleID":{"type":"string"},"ListOrder":{"type":"integer","format":"int32"}}},"CategoryProductAssignment":{"type":"object","example":{"CategoryID":"","ProductID":"","ListOrder":1},"properties":{"CategoryID":{"type":"string"},"ProductID":{"type":"string"},"ListOrder":{"type":"integer","format":"int32"}}},"CommerceRole":{"type":"string","enum":["Buyer","Seller","Supplier"],"description":""},"ContentHubConfig":{"type":"object","example":{"ApiKey":"","Endpoint":"","TargetSchemaName":"","ConfigData":{}},"properties":{"ApiKey":{"type":"string","maxLength":50},"Endpoint":{"type":"string"},"TargetSchemaName":{"type":"string"},"ConfigData":{"type":"object","description":"Any custom property mapping should be included here."}}},"CosmosDbConfig":{"type":"object","example":{"ConnectionString":"","OverrideDatabaseName":""},"properties":{"ConnectionString":{"type":"string","description":"Storage account connection string."},"OverrideDatabaseName":{"type":"string"}}},"CostCenter":{"type":"object","example":{"ID":"","Name":"","Description":"","xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100},"Description":{"type":"string","maxLength":2000},"xp":{"type":"object"}}},"CostCenterAssignment":{"type":"object","example":{"CostCenterID":"","UserGroupID":""},"properties":{"CostCenterID":{"type":"string"},"UserGroupID":{"type":"string"}}},"CreditCard":{"type":"object","example":{"ID":"","Token":"","DateCreated":"2018-01-01T00:00:00-06:00","CardType":"","PartialAccountNumber":"","CardholderName":"","ExpirationDate":"2018-01-01T00:00:00-06:00","xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"Token":{"type":"string","description":"Token provided by the credit card processor used to reference the card with that processor.","maxLength":100},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"CardType":{"type":"string"},"PartialAccountNumber":{"type":"string","maxLength":5},"CardholderName":{"type":"string"},"ExpirationDate":{"type":"string","format":"date-time"},"xp":{"type":"object"}}},"CreditCardAssignment":{"type":"object","example":{"CreditCardID":"","UserID":"","UserGroupID":""},"properties":{"CreditCardID":{"type":"string"},"UserID":{"type":"string"},"UserGroupID":{"type":"string"}}},"DeliveryConfig":{"type":"object","example":{"ID":"","Name":"","Enabled":false,"DeliveryTargets":{"Kafka":{"BootstrapServers":"","SaslUsername":"","SaslPassword":"","Topic":""},"Http":{"Endpoint":"","Secret":"","CustomAuthHeaderName":"","CustomAuthHeaderValue":""},"SearchIngestion":{"Domain":"","Source":"","Endpoint":"","Entity":"","ApiKey":"","Content":{"Locales":[""],"Http":{"Endpoint":"","CustomAuthHeaderName":"","CustomAuthHeaderValue":""}}},"SendEvent":{"SiteID":"","ServiceEndpoint":""},"DiscoverEvent":{"ClientID":"","ApiKey":"","ServiceEndpoint":""},"EventHub":{"EventHubName":"","ConnectionString":""},"AzureBlob":{"ConnectionString":"","OverrideContainerName":""},"AzureTable":{"ConnectionString":"","OverrideTableName":""},"CosmosDb":{"ConnectionString":"","OverrideDatabaseName":""},"Mailchimp":{"ApiKey":""},"MessageSender":{"Secret":"","Endpoint":""},"ContentHub":{"ApiKey":"","Endpoint":"","TargetSchemaName":"","ConfigData":{}}}},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":128},"Enabled":{"type":"boolean"},"DeliveryTargets":{"allOf":[{"$ref":"#/components/schemas/DeliveryTargets"}]}}},"DeliveryTargets":{"type":"object","example":{"Kafka":{"BootstrapServers":"","SaslUsername":"","SaslPassword":"","Topic":""},"Http":{"Endpoint":"","Secret":"","CustomAuthHeaderName":"","CustomAuthHeaderValue":""},"SearchIngestion":{"Domain":"","Source":"","Endpoint":"","Entity":"","ApiKey":"","Content":{"Locales":[""],"Http":{"Endpoint":"","CustomAuthHeaderName":"","CustomAuthHeaderValue":""}}},"SendEvent":{"SiteID":"","ServiceEndpoint":""},"DiscoverEvent":{"ClientID":"","ApiKey":"","ServiceEndpoint":""},"EventHub":{"EventHubName":"","ConnectionString":""},"AzureBlob":{"ConnectionString":"","OverrideContainerName":""},"AzureTable":{"ConnectionString":"","OverrideTableName":""},"CosmosDb":{"ConnectionString":"","OverrideDatabaseName":""},"Mailchimp":{"ApiKey":""},"MessageSender":{"Secret":"","Endpoint":""},"ContentHub":{"ApiKey":"","Endpoint":"","TargetSchemaName":"","ConfigData":{}}},"properties":{"Kafka":{"allOf":[{"$ref":"#/components/schemas/KafkaConfig"}]},"Http":{"allOf":[{"$ref":"#/components/schemas/HttpConfig"}]},"SearchIngestion":{"allOf":[{"$ref":"#/components/schemas/SearchIngestion"}]},"SendEvent":{"allOf":[{"$ref":"#/components/schemas/SendEvent"}]},"DiscoverEvent":{"allOf":[{"$ref":"#/components/schemas/DiscoverEvent"}]},"EventHub":{"allOf":[{"$ref":"#/components/schemas/EventHubConfig"}]},"AzureBlob":{"allOf":[{"$ref":"#/components/schemas/AzureBlobConfig"}]},"AzureTable":{"allOf":[{"$ref":"#/components/schemas/AzureTableConfig"}]},"CosmosDb":{"allOf":[{"$ref":"#/components/schemas/CosmosDbConfig"}]},"Mailchimp":{"allOf":[{"$ref":"#/components/schemas/MailchimpConfig"}]},"MessageSender":{"allOf":[{"$ref":"#/components/schemas/MessageSenderConfig"}]},"ContentHub":{"allOf":[{"$ref":"#/components/schemas/ContentHubConfig"}]}}},"Discount":{"type":"object","example":{"ID":"","Description":"","DiscountBreaks":[{"Quantity":0,"Amount":0}],"ProductFilter":"","CatalogID":"","CategoryID":"","ProductID":"","xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"Description":{"type":"string","maxLength":2000},"DiscountBreaks":{"type":"array","items":{"$ref":"#/components/schemas/DiscountBreak"},"description":"Quantity-based percentage discount tiers. Each tier specifies a minimum quantity and percentage discount amount.","minLength":1},"ProductFilter":{"type":"string","maxLength":1000},"CatalogID":{"type":"string"},"CategoryID":{"type":"string"},"ProductID":{"type":"string"},"xp":{"type":"object"}}},"DiscountAssignment":{"type":"object","example":{"DiscountID":"","BuyerGroupID":"","BuyerID":"","UserGroupID":""},"properties":{"DiscountID":{"type":"string"},"BuyerGroupID":{"type":"string","description":"When specified, BuyerID and UserGroupID must be null."},"BuyerID":{"type":"string","description":"Required when BuyerGroupID is null."},"UserGroupID":{"type":"string","description":"Optional. Only valid when BuyerID is specified."}}},"DiscountBreak":{"type":"object","example":{"Quantity":0,"Amount":0},"properties":{"Quantity":{"type":"integer","format":"int32","description":"Minimum quantity required for this discount tier.","minimum":0},"Amount":{"type":"number","format":"float","description":"Percentage discount (e.g., 10.5 for 10.5% off). Must be between 0 and 100."}}},"DiscountedPrices":{"type":"object","example":{"Price":0,"SalePrice":0,"SubscriptionPrice":0,"BundlePrice":0},"properties":{"Price":{"type":"number","format":"float","description":"Discounted price per unit."},"SalePrice":{"type":"number","format":"float","description":"Discounted sale price per unit."},"SubscriptionPrice":{"type":"number","format":"float","description":"Discounted subscription price per unit."},"BundlePrice":{"type":"number","format":"float","description":"Discounted bundle price per unit."}}},"DiscoverEvent":{"type":"object","example":{"ClientID":"","ApiKey":"","ServiceEndpoint":""},"properties":{"ClientID":{"type":"string"},"ApiKey":{"type":"string"},"ServiceEndpoint":{"type":"string"}}},"EligiblePromotion":{"type":"object","example":{"Amount":0,"ID":"","LineItemLevel":false,"Code":"","Name":"","RedemptionLimit":0,"RedemptionLimitPerUser":0,"RedemptionCount":0,"QuantityLimitPerOrder":0,"ItemLimitPerOrder":0,"ItemSortBy":"","Description":"","FinePrint":"","StartDate":"2018-01-01T00:00:00-06:00","ExpirationDate":"2018-01-01T00:00:00-06:00","EligibleExpression":"","ValueExpression":"","CanCombine":false,"AllowAllBuyers":false,"OwnerID":"","AutoApply":false,"Active":false,"UseIntegration":false,"Priority":0,"xp":{}},"properties":{"Amount":{"type":"number","format":"float","readOnly":true},"ID":{"type":"string","maxLength":100},"LineItemLevel":{"type":"boolean","description":"If true, certain eligible expression requirements must be met, and the PromotionDiscount will be applied at the line item level."},"Code":{"type":"string","description":"Must be unique. Entered by buyer when adding promo to order.","maxLength":100},"Name":{"type":"string","maxLength":100},"RedemptionLimit":{"type":"integer","format":"int32","description":"Limit the total number of orders this promotion can be applied to across all users."},"RedemptionLimitPerUser":{"type":"integer","format":"int32","description":"Limit the total number of orders this promotion can be applied to per user."},"RedemptionCount":{"type":"integer","format":"int32","readOnly":true,"description":"The number of times this promotion has been applied to an order."},"QuantityLimitPerOrder":{"type":"integer","format":"int32","description":"Can only be used when LineItemLevel is true and ItemLimitPerOrder does not have a value. When defined the ValueExpression will be the discount applied to each qualifying quantity of eligible items. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.","minimum":1},"ItemLimitPerOrder":{"type":"integer","format":"int32","description":"Can only be used when LineItemLevel is true and QuantityLimitPerOrder does not have a value. Limits the number of items the promotion will apply to when eligible. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.","minimum":1},"ItemSortBy":{"type":"string","description":"Comma delimited list of properties to sort by. Can only be used when ItemLimitPerOrder is true. Used to determine the order in which the promotion is applied to the specified limit of items. Use ! to reverse sort order on a property.","maxLength":200},"Description":{"type":"string","maxLength":2000},"FinePrint":{"type":"string","description":"For reference only. Terms, conditions, and other legal jargon.","maxLength":2000},"StartDate":{"type":"string","format":"date-time"},"ExpirationDate":{"type":"string","format":"date-time"},"EligibleExpression":{"type":"string","description":"The expression evaluated to determine if an item or order is eligible for a promotion. See rules engine documentation for formatting details.","maxLength":400},"ValueExpression":{"type":"string","description":"The expression evaluated to determine the discount amount of an eligible promotion. See rules engine documentation for formatting details.","maxLength":1000},"CanCombine":{"type":"boolean","description":"If true, the promotion can be applied to an order that already other promotions applied, as long as they can also be combined."},"AllowAllBuyers":{"type":"boolean","description":"Allow promo to be used by all buyers without creating explicit assignments."},"OwnerID":{"type":"string","description":"ID of the organization that owns the promotion. Only the marketplace owner can override the OwnerID on create."},"AutoApply":{"type":"boolean","default":false},"Active":{"type":"boolean","default":true},"UseIntegration":{"type":"boolean"},"Priority":{"type":"integer","format":"int32","description":"Used to control the order in which promotions are applied when calling the auto apply or refresh endpoint."},"xp":{"type":"object"}}},"EntitySyncConfig":{"type":"object","example":{"DeliveryConfigID":"","SyncEntityChanged":false,"SyncEntityDeleted":false,"Paused":false},"properties":{"DeliveryConfigID":{"type":"string"},"SyncEntityChanged":{"type":"boolean"},"SyncEntityDeleted":{"type":"boolean"},"Paused":{"type":"boolean"}}},"Error":{"type":"object","properties":{"StatusCode":{"type":"integer","example":"404"},"ErrorCode":{"type":"string","example":"NotFoundError"},"Message":{"type":"string","example":"Object not found"},"Data":{"type":"object","example":{"ObjectType":"","ObjectID":""}}}},"ErrorConfig":{"type":"object","example":{"DeliveryConfigID":""},"properties":{"DeliveryConfigID":{"type":"string"}}},"EventHubConfig":{"type":"object","example":{"EventHubName":"","ConnectionString":""},"properties":{"EventHubName":{"type":"string"},"ConnectionString":{"type":"string"}}},"ExtendedLineItem":{"type":"object","example":{"OrderID":"","Order":{"ID":"","FromUser":{"ID":"","CompanyID":"","Username":"","Password":"","FirstName":"","LastName":"","Email":"","Phone":"","TermsAccepted":"2018-01-01T00:00:00-06:00","Active":false,"xp":{},"AvailableRoles":[""],"Locale":{"ID":"","OwnerID":"","Currency":"","Language":""},"DateCreated":"2018-01-01T00:00:00-06:00","LastActive":"2018-01-01T00:00:00-06:00","PasswordLastSetDate":"2018-01-01T00:00:00-06:00"},"FromCompanyID":"","ToCompanyID":"","FromUserID":"","BillingAddressID":"","BillingAddress":{"ID":"","DateCreated":"2018-01-01T00:00:00-06:00","CompanyName":"","FirstName":"","LastName":"","Street1":"","Street2":"","City":"","State":"","Zip":"","Country":"","Phone":"","AddressName":"","xp":{}},"ShippingAddressID":"","Comments":"","LineItemCount":0,"Status":"Unsubmitted","DateCreated":"2018-01-01T00:00:00-06:00","DateSubmitted":"2018-01-01T00:00:00-06:00","DateApproved":"2018-01-01T00:00:00-06:00","DateDeclined":"2018-01-01T00:00:00-06:00","DateCanceled":"2018-01-01T00:00:00-06:00","DateCompleted":"2018-01-01T00:00:00-06:00","LastUpdated":"2018-01-01T00:00:00-06:00","Subtotal":0,"ShippingCost":0,"TaxCost":0,"Gratuity":0,"Fees":0,"BaseDiscount":0,"PromotionDiscount":0,"Currency":"","Total":0,"IsSubmitted":false,"SubscriptionID":"","xp":{}},"ID":"","ProductID":"","Quantity":0,"BundleItemID":"","IsBundle":false,"DateAdded":"2018-01-01T00:00:00-06:00","QuantityShipped":0,"UnitPrice":0,"PromotionDiscount":0,"BaseDiscount":0,"DiscountID":"","LineTotal":0,"LineSubtotal":0,"CostCenter":"","DateNeeded":"2018-01-01T00:00:00-06:00","ShippingAccount":"","ShippingAddressID":"","ShipFromAddressID":"","Product":{"ID":"","Name":"","Description":"","Returnable":false,"QuantityMultiplier":0,"ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"DefaultSupplierID":"","ParentID":"","xp":{}},"Variant":{"ID":"","Name":"","Description":"","ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"xp":{}},"ShippingAddress":{"ID":"","DateCreated":"2018-01-01T00:00:00-06:00","CompanyName":"","FirstName":"","LastName":"","Street1":"","Street2":"","City":"","State":"","Zip":"","Country":"","Phone":"","AddressName":"","xp":{}},"ShipFromAddress":{"ID":"","DateCreated":"2018-01-01T00:00:00-06:00","CompanyName":"","FirstName":"","LastName":"","Street1":"","Street2":"","City":"","State":"","Zip":"","Country":"","Phone":"","AddressName":"","xp":{}},"SupplierID":"","InventoryRecordID":"","PriceScheduleID":"","IsOnSale":false,"PriceOverridden":false,"Specs":[{"SpecID":"","Name":"","OptionID":"","Value":"","PriceMarkupType":"NoMarkup","PriceMarkup":0}],"IncomingOrderID":"","OutgoingOrderID":"","xp":{}},"properties":{"OrderID":{"type":"string"},"Order":{"allOf":[{"$ref":"#/components/schemas/Order"}],"description":"Currently unused."},"ID":{"type":"string","maxLength":100},"ProductID":{"type":"string"},"Quantity":{"type":"integer","format":"int32","default":1,"minimum":1},"BundleItemID":{"type":"string","readOnly":true,"description":"The ID of the line item that represents the bundle. Signifies that the product is being purchased as part of a bundle."},"IsBundle":{"type":"boolean","readOnly":true,"description":"When true, this item represents a bundle being purchased."},"DateAdded":{"type":"string","format":"date-time","readOnly":true},"QuantityShipped":{"type":"integer","format":"int32","readOnly":true,"description":"Sum of QuantityShipped from all shipment items."},"UnitPrice":{"type":"number","format":"float","description":"Auto calculated price per quantity. Modification requires OverrideUnitPrice role."},"PromotionDiscount":{"type":"number","format":"float","readOnly":true,"description":"Sum of all line item level promotion discount amounts applied."},"BaseDiscount":{"type":"number","format":"float","readOnly":true,"description":"Discount amount from discount assignments applied to this line item."},"DiscountID":{"type":"string","readOnly":true,"description":"ID of the discount applied to this line item."},"LineTotal":{"type":"number","format":"float","readOnly":true,"description":"LineSubtotal - BaseDiscount - PromotionDiscount"},"LineSubtotal":{"type":"number","format":"float","readOnly":true,"description":"UnitPrice x Quantity"},"CostCenter":{"type":"string","description":"For reference only, does not influence any OrderCloud behavior."},"DateNeeded":{"type":"string","format":"date-time"},"ShippingAccount":{"type":"string","description":"For reference only, does not influence any OrderCloud behavior."},"ShippingAddressID":{"type":"string"},"ShipFromAddressID":{"type":"string","description":"Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs."},"Product":{"allOf":[{"$ref":"#/components/schemas/LineItemProduct"}],"readOnly":true},"Variant":{"allOf":[{"$ref":"#/components/schemas/LineItemVariant"}],"readOnly":true},"ShippingAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"readOnly":true},"ShipFromAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"readOnly":true},"SupplierID":{"type":"string","readOnly":true},"InventoryRecordID":{"type":"string","description":"InventoryRecordID of which product inventory location to use. Cannot be modified once an order is submitted."},"PriceScheduleID":{"type":"string","readOnly":true,"description":"PriceScheduleID used to determine unit price."},"IsOnSale":{"type":"boolean","readOnly":true,"description":"True when the price schedule and price break has an active SalePrice."},"PriceOverridden":{"type":"boolean","readOnly":true,"description":"If true, UnitPrice was overridden."},"Specs":{"type":"array","items":{"$ref":"#/components/schemas/LineItemSpec"}},"IncomingOrderID":{"type":"string","readOnly":true,"description":"ID of the original order. Only returns a value for the marketplace owner."},"OutgoingOrderID":{"type":"string","readOnly":true,"description":"ID of the split or forwarded order. Only returns a value for the marketplace owner."},"InvitationID":{"type":"string","readOnly":true,"x-lifecycle":"Beta"},"xp":{"type":"object"}}},"GroupOrderInvitation":{"type":"object","x-lifecycle":"Beta","example":{"ID":"","ExpirationDate":"2018-01-01T00:00:00-06:00","Name":"","OrderID":"","OrderStatus":"Unsubmitted","xp":{}},"properties":{"ID":{"type":"string","readOnly":true,"maxLength":100},"ExpirationDate":{"type":"string","format":"date-time","description":"Maximum 1 year."},"Name":{"type":"string","maxLength":100},"OrderID":{"type":"string"},"OrderStatus":{"$ref":"#/components/schemas/OrderStatus","readOnly":true},"xp":{"type":"object"}}},"HttpConfig":{"type":"object","example":{"Endpoint":"","Secret":"","CustomAuthHeaderName":"","CustomAuthHeaderValue":""},"properties":{"Endpoint":{"type":"string"},"Secret":{"type":"string","maxLength":50},"CustomAuthHeaderName":{"type":"string"},"CustomAuthHeaderValue":{"type":"string","maxLength":50}}},"ImpersonateTokenRequest":{"type":"object","example":{"ClientID":"","Roles":["ApiClientAdmin"],"CustomRoles":[""]},"properties":{"ClientID":{"type":"string"},"Roles":{"type":"array","items":{"$ref":"#/components/schemas/ApiRole"}},"CustomRoles":{"type":"array","items":{"type":"string"}}}},"ImpersonationConfig":{"type":"object","example":{"ID":"","ImpersonationBuyerID":"","ImpersonationGroupID":"","ImpersonationUserID":"","BuyerID":"","GroupID":"","UserID":"","SecurityProfileID":"","ClientID":""},"properties":{"ID":{"type":"string","maxLength":100},"ImpersonationBuyerID":{"type":"string","description":"The BuyerID of the impersonator group or user (party doing the impersonating)"},"ImpersonationGroupID":{"type":"string","description":"The UserGroupID of the impersonator (party doing the impersonating)"},"ImpersonationUserID":{"type":"string","description":"The UserID of the impersonator (party doing the impersonating)"},"BuyerID":{"type":"string","description":"The BuyerID of the impersonatee (party being impersonated). If null, the config can be used to impersonate users in any buyer in the marketplace that is able to access the specified API Client."},"GroupID":{"type":"string","description":"The UserGroupID of the impersonatee (party being impersonated)"},"UserID":{"type":"string","description":"The UserID of the impersonatee (party being impersonated)"},"SecurityProfileID":{"type":"string"},"ClientID":{"type":"string"}}},"Incrementor":{"type":"object","example":{"ID":"","Name":"","LastNumber":0,"LeftPaddingCount":0},"properties":{"ID":{"type":"string","description":"The string \"{replace-with-incrementor-ID}\" can be passed into any ID field to populate the next ID in the sequence. It can also be prefixed with other ID safe characters.","maxLength":100},"Name":{"type":"string","maxLength":100},"LastNumber":{"type":"integer","format":"int32","description":"Increments as IDs are generated."},"LeftPaddingCount":{"type":"integer","format":"int32","description":"Use to enforce a minimum incrementor ID length. For example if your LastNumber is 0 and LeftPaddingCount is 4, your first generated ID will be 0001."}}},"IntegrationEvent":{"type":"object","example":{"ElevatedRoles":["ApiClientAdmin"],"ID":"","ConfigData":{},"EventType":"OrderCheckout","CustomImplementationUrl":"","CustomAuthHeaderName":"","CustomAuthHeaderValue":"","Name":"","HashKey":""},"properties":{"ElevatedRoles":{"type":"array","items":{"$ref":"#/components/schemas/ApiRole"}},"ID":{"type":"string","maxLength":100},"ConfigData":{"type":"object","description":"Any additional data needed for your integration event should be included here."},"EventType":{"$ref":"#/components/schemas/IntegrationEventType"},"CustomImplementationUrl":{"type":"string","description":"URL the integration event will POST data to, likely a route within your middleware."},"CustomAuthHeaderName":{"type":"string","description":"The header name that can be passed to your middleware."},"CustomAuthHeaderValue":{"type":"string","description":"The header value that can be passed to your middleware."},"Name":{"type":"string"},"HashKey":{"type":"string","description":"Security feature that allows your middleware to verify the digital signature in the request header to ensure you only accept trusted data.","maxLength":50}}},"IntegrationEventType":{"type":"string","enum":["OrderCheckout","OpenIDConnect","OrderReturn","AddToCart"],"description":""},"Inventory":{"type":"object","example":{"Enabled":false,"NotificationPoint":0,"VariantLevelTracking":false,"OrderCanExceed":false,"QuantityAvailable":0,"LastUpdated":"2018-01-01T00:00:00-06:00"},"properties":{"Enabled":{"type":"boolean","description":"If true, inventory will be tracked and enforced."},"NotificationPoint":{"type":"integer","format":"int32"},"VariantLevelTracking":{"type":"boolean","description":"If true, QuantityAvailable will be determined at the variant level."},"OrderCanExceed":{"type":"boolean","description":"If true, a user can create line items and place orders for the product even if there is insufficient QuantityAvailable."},"QuantityAvailable":{"type":"integer","format":"int32","description":"Automatically decrements on order submit. If you utilize inventory records either at the product or variant level, this property becomes readonly, and is derived from the sum of all QuantityAvailable of each InventoryRecord. If VariantLevelTracking is enabled, this is the sum of all variant quantities."},"LastUpdated":{"type":"string","format":"date-time","readOnly":true}}},"InventoryIntegration":{"type":"object","example":{"DeliveryConfigID":"","LimitNotifications":false},"properties":{"DeliveryConfigID":{"type":"string"},"LimitNotifications":{"type":"boolean","description":"When true, events will only fire when QuantityAvailable changes in the following ways: is equal to or less than 0, increases from 0 or less than 0 to a positive number, is equal to or less than NotificationPoint, increases from a number equal to or less than the NotificationPoint to a number greater than the NotificationPoint."}}},"InventoryRecord":{"type":"object","example":{"ID":"","OwnerID":"","AllowAllBuyers":false,"Address":{"ID":"","DateCreated":"2018-01-01T00:00:00-06:00","CompanyName":"","FirstName":"","LastName":"","Street1":"","Street2":"","City":"","State":"","Zip":"","Country":"","Phone":"","AddressName":"","xp":{}},"AddressID":"","OrderCanExceed":false,"QuantityAvailable":0,"NotificationPoint":0,"LastUpdated":"2018-01-01T00:00:00-06:00","xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"OwnerID":{"type":"string"},"AllowAllBuyers":{"type":"boolean","default":true,"description":"Allow inventory record to be used by all buyers without creating explicit assignments."},"Address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"readOnly":true},"AddressID":{"type":"string","description":"AddressID is required because an inventory record represents a location where physical inventory for a given product exists."},"OrderCanExceed":{"type":"boolean"},"QuantityAvailable":{"type":"integer","format":"int32"},"NotificationPoint":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time","readOnly":true},"xp":{"type":"object"}}},"InventoryRecordAssignment":{"type":"object","example":{"InventoryRecordID":"","BuyerID":"","UserGroupID":""},"properties":{"InventoryRecordID":{"type":"string"},"BuyerID":{"type":"string"},"UserGroupID":{"type":"string"}}},"KafkaConfig":{"type":"object","example":{"BootstrapServers":"","SaslUsername":"","SaslPassword":"","Topic":""},"properties":{"BootstrapServers":{"type":"string"},"SaslUsername":{"type":"string"},"SaslPassword":{"type":"string"},"Topic":{"type":"string"}}},"LineItem":{"type":"object","example":{"ID":"","ProductID":"","Quantity":0,"BundleItemID":"","IsBundle":false,"DateAdded":"2018-01-01T00:00:00-06:00","QuantityShipped":0,"UnitPrice":0,"PromotionDiscount":0,"BaseDiscount":0,"DiscountID":"","LineTotal":0,"LineSubtotal":0,"CostCenter":"","DateNeeded":"2018-01-01T00:00:00-06:00","ShippingAccount":"","ShippingAddressID":"","ShipFromAddressID":"","Product":{"ID":"","Name":"","Description":"","Returnable":false,"QuantityMultiplier":0,"ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"DefaultSupplierID":"","ParentID":"","xp":{}},"Variant":{"ID":"","Name":"","Description":"","ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"xp":{}},"ShippingAddress":{"ID":"","DateCreated":"2018-01-01T00:00:00-06:00","CompanyName":"","FirstName":"","LastName":"","Street1":"","Street2":"","City":"","State":"","Zip":"","Country":"","Phone":"","AddressName":"","xp":{}},"ShipFromAddress":{"ID":"","DateCreated":"2018-01-01T00:00:00-06:00","CompanyName":"","FirstName":"","LastName":"","Street1":"","Street2":"","City":"","State":"","Zip":"","Country":"","Phone":"","AddressName":"","xp":{}},"SupplierID":"","InventoryRecordID":"","PriceScheduleID":"","IsOnSale":false,"PriceOverridden":false,"Specs":[{"SpecID":"","Name":"","OptionID":"","Value":"","PriceMarkupType":"NoMarkup","PriceMarkup":0}],"IncomingOrderID":"","OutgoingOrderID":"","xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"ProductID":{"type":"string"},"Quantity":{"type":"integer","format":"int32","default":1,"minimum":1},"BundleItemID":{"type":"string","readOnly":true,"description":"The ID of the line item that represents the bundle. Signifies that the product is being purchased as part of a bundle."},"IsBundle":{"type":"boolean","readOnly":true,"description":"When true, this item represents a bundle being purchased."},"DateAdded":{"type":"string","format":"date-time","readOnly":true},"QuantityShipped":{"type":"integer","format":"int32","readOnly":true,"description":"Sum of QuantityShipped from all shipment items."},"UnitPrice":{"type":"number","format":"float","description":"Auto calculated price per quantity. Modification requires OverrideUnitPrice role."},"PromotionDiscount":{"type":"number","format":"float","readOnly":true,"description":"Sum of all line item level promotion discount amounts applied."},"BaseDiscount":{"type":"number","format":"float","readOnly":true,"description":"Discount amount from discount assignments applied to this line item."},"DiscountID":{"type":"string","readOnly":true,"description":"ID of the discount applied to this line item."},"LineTotal":{"type":"number","format":"float","readOnly":true,"description":"LineSubtotal - BaseDiscount - PromotionDiscount"},"LineSubtotal":{"type":"number","format":"float","readOnly":true,"description":"UnitPrice x Quantity"},"CostCenter":{"type":"string","description":"For reference only, does not influence any OrderCloud behavior."},"DateNeeded":{"type":"string","format":"date-time"},"ShippingAccount":{"type":"string","description":"For reference only, does not influence any OrderCloud behavior."},"ShippingAddressID":{"type":"string"},"ShipFromAddressID":{"type":"string","description":"Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs."},"Product":{"allOf":[{"$ref":"#/components/schemas/LineItemProduct"}],"readOnly":true},"Variant":{"allOf":[{"$ref":"#/components/schemas/LineItemVariant"}],"readOnly":true},"ShippingAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"readOnly":true},"ShipFromAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"readOnly":true},"SupplierID":{"type":"string","readOnly":true},"InventoryRecordID":{"type":"string","description":"InventoryRecordID of which product inventory location to use. Cannot be modified once an order is submitted."},"PriceScheduleID":{"type":"string","readOnly":true,"description":"PriceScheduleID used to determine unit price."},"IsOnSale":{"type":"boolean","readOnly":true,"description":"True when the price schedule and price break has an active SalePrice."},"PriceOverridden":{"type":"boolean","readOnly":true,"description":"If true, UnitPrice was overridden."},"Specs":{"type":"array","items":{"$ref":"#/components/schemas/LineItemSpec"}},"IncomingOrderID":{"type":"string","readOnly":true,"description":"ID of the original order. Only returns a value for the marketplace owner."},"OutgoingOrderID":{"type":"string","readOnly":true,"description":"ID of the split or forwarded order. Only returns a value for the marketplace owner."},"InvitationID":{"type":"string","readOnly":true,"x-lifecycle":"Beta"},"xp":{"type":"object"}}},"LineItemOverride":{"type":"object","example":{"LineItemID":"","UnitPrice":0,"Product":{"ID":"","Name":"","Description":"","QuantityMultiplier":0,"ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"DefaultSupplierID":"","Returnable":false,"xp":{}},"PromotionOverrides":[{"PromotionID":"","Amount":0}],"InventoryRecordID":"","Remove":false},"properties":{"LineItemID":{"type":"string"},"UnitPrice":{"type":"number","format":"float"},"Product":{"allOf":[{"$ref":"#/components/schemas/AdHocProduct"}]},"PromotionOverrides":{"type":"array","items":{"$ref":"#/components/schemas/PromotionOverride"}},"InventoryRecordID":{"type":"string"},"Remove":{"type":"boolean"}}},"LineItemProduct":{"type":"object","example":{"ID":"","Name":"","Description":"","Returnable":false,"QuantityMultiplier":0,"ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"DefaultSupplierID":"","ParentID":"","xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string"},"Description":{"type":"string"},"Returnable":{"type":"boolean"},"QuantityMultiplier":{"type":"integer","format":"int32"},"ShipWeight":{"type":"number","format":"float"},"ShipHeight":{"type":"number","format":"float"},"ShipWidth":{"type":"number","format":"float"},"ShipLength":{"type":"number","format":"float"},"DefaultSupplierID":{"type":"string"},"ParentID":{"type":"string"},"xp":{"type":"object"}}},"LineItemSpec":{"type":"object","example":{"SpecID":"","Name":"","OptionID":"","Value":"","PriceMarkupType":"NoMarkup","PriceMarkup":0},"properties":{"SpecID":{"type":"string"},"Name":{"type":"string","readOnly":true},"OptionID":{"type":"string"},"Value":{"type":"string","maxLength":2000},"PriceMarkupType":{"$ref":"#/components/schemas/PriceMarkupType"},"PriceMarkup":{"type":"number","format":"float"}}},"LineItemVariant":{"type":"object","example":{"ID":"","Name":"","Description":"","ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string"},"Description":{"type":"string"},"ShipWeight":{"type":"number","format":"float"},"ShipHeight":{"type":"number","format":"float"},"ShipWidth":{"type":"number","format":"float"},"ShipLength":{"type":"number","format":"float"},"xp":{"type":"object"}}},"ListFacet":{"type":"object","properties":{"Name":{"type":"string"},"XpPath":{"type":"string"},"Values":{"type":"array","items":{"$ref":"#/components/schemas/ListFacetValue"}},"xp":{"type":"object"}}},"ListFacetValue":{"type":"object","properties":{"Value":{"type":"string"},"Count":{"type":"integer","format":"int32"}}},"Locale":{"type":"object","example":{"ID":"","OwnerID":"","Currency":"","Language":""},"properties":{"ID":{"type":"string","maxLength":100},"OwnerID":{"type":"string","description":"ID of the organization that owns the Locale. Only the marketplace owner can override the OwnerID on create."},"Currency":{"type":"string","description":"We recommend using ISO-4217 currency codes for compatibility with tax and payment processors.","maxLength":100},"Language":{"type":"string","description":"We recommend using ISO-639 language code - ISO-3166 Country code (e.g. en-US).","maxLength":100}}},"LocaleAssignment":{"type":"object","example":{"LocaleID":"","BuyerID":"","UserGroupID":""},"properties":{"LocaleID":{"type":"string"},"BuyerID":{"type":"string"},"UserGroupID":{"type":"string"}}},"MailchimpConfig":{"type":"object","example":{"ApiKey":""},"properties":{"ApiKey":{"type":"string","description":"The Mailchimp API key. If this property is not set, the default OrderCloud Mailchimp instance is used. The default instance is intended for test purposes only.","maxLength":50}}},"MeBuyer":{"type":"object","example":{"ID":"","DefaultCatalogID":""},"properties":{"ID":{"type":"string","readOnly":true,"maxLength":100},"DefaultCatalogID":{"type":"string","readOnly":true}}},"MeSeller":{"type":"object","example":{"ID":""},"properties":{"ID":{"type":"string","readOnly":true,"maxLength":100}}},"MessageCCListenerAssignment":{"type":"object","example":{"MessageSenderAssignment":{"MessageSenderID":"","BuyerID":"","SupplierID":"","UserGroupID":"","MessageConfigName":"","MessageConfigDescription":""},"MessageConfigName":"","MessageConfigDescription":"","MessageType":"OrderDeclined","BuyerID":"","SupplierID":"","UserGroupID":"","UserID":""},"properties":{"MessageSenderAssignment":{"allOf":[{"$ref":"#/components/schemas/MessageSenderAssignment"}]},"MessageConfigName":{"type":"string","readOnly":true},"MessageConfigDescription":{"type":"string","readOnly":true},"MessageType":{"$ref":"#/components/schemas/MessageType"},"BuyerID":{"type":"string"},"SupplierID":{"type":"string"},"UserGroupID":{"type":"string"},"UserID":{"type":"string"}}},"MessageSender":{"type":"object","example":{"ID":"","Name":"","MessageTypes":["OrderDeclined"],"Description":"","ElevatedRoles":["ApiClientAdmin"],"xp":{},"DeliveryConfigID":"","AllowAllBuyers":false},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string"},"MessageTypes":{"type":"array","items":{"$ref":"#/components/schemas/MessageType"}},"Description":{"type":"string"},"ElevatedRoles":{"type":"array","items":{"$ref":"#/components/schemas/ApiRole"},"description":"If additional data not provided by the message sender is needed, provide any elevated roles needed to make additional calls."},"xp":{"type":"object"},"DeliveryConfigID":{"type":"string"},"AllowAllBuyers":{"type":"boolean","default":false,"description":"Allow message sender to trigger for all buyers without creating explicit assignments."}}},"MessageSenderAssignment":{"type":"object","example":{"MessageSenderID":"","BuyerID":"","SupplierID":"","UserGroupID":"","MessageConfigName":"","MessageConfigDescription":""},"properties":{"MessageSenderID":{"type":"string"},"BuyerID":{"type":"string"},"SupplierID":{"type":"string"},"UserGroupID":{"type":"string"},"MessageConfigName":{"type":"string","readOnly":true},"MessageConfigDescription":{"type":"string","readOnly":true}}},"MessageSenderConfig":{"type":"object","example":{"Secret":"","Endpoint":""},"properties":{"Secret":{"type":"string","maxLength":50},"Endpoint":{"type":"string"}}},"MessageType":{"type":"string","enum":["OrderDeclined","OrderSubmitted","ShipmentCreated","ForgottenPassword","ForgottenUsername","OrderSubmittedForYourApproval","OrderSubmittedForApproval","OrderApproved","OrderSubmittedForYourApprovalHasBeenApproved","OrderSubmittedForYourApprovalHasBeenDeclined","NewUserInvitation","OrderReturnDeclined","OrderReturnSubmitted","OrderReturnSubmittedForYourApproval","OrderReturnSubmittedForApproval","OrderReturnApproved","OrderReturnSubmittedForYourApprovalHasBeenApproved","OrderReturnSubmittedForYourApprovalHasBeenDeclined","OrderReturnCompleted","SubscriptionReminder","ProductCollectionInvitationAccepted","ProductCollectionInvitationDeclined","OneTimePassword"],"description":""},"MeSupplier":{"type":"object","example":{"ID":""},"properties":{"ID":{"type":"string","readOnly":true,"maxLength":100}}},"Meta":{"type":"object","properties":{"Page":{"type":"integer","format":"int32"},"PageSize":{"type":"integer","format":"int32"},"TotalCount":{"type":"integer","format":"int32"},"TotalPages":{"type":"integer","format":"int32"},"ItemRange":{"type":"array","items":{"type":"integer","format":"int32"}},"NextPageKey":{"type":"string"}}},"MetaWithFacets":{"type":"object","properties":{"Facets":{"type":"array","items":{"$ref":"#/components/schemas/ListFacet"}},"Page":{"type":"integer","format":"int32"},"PageSize":{"type":"integer","format":"int32"},"TotalCount":{"type":"integer","format":"int32"},"TotalPages":{"type":"integer","format":"int32"},"ItemRange":{"type":"array","items":{"type":"integer","format":"int32"}},"NextPageKey":{"type":"string"}}},"MeUser":{"type":"object","example":{"Buyer":{"ID":"","DefaultCatalogID":""},"Supplier":{"ID":""},"Seller":{"ID":""},"ID":"","CompanyID":"","Username":"","Password":"","FirstName":"","LastName":"","Email":"","Phone":"","TermsAccepted":"2018-01-01T00:00:00-06:00","Active":false,"xp":{},"AvailableRoles":[""],"Locale":{"ID":"","OwnerID":"","Currency":"","Language":""},"DateCreated":"2018-01-01T00:00:00-06:00","LastActive":"2018-01-01T00:00:00-06:00","PasswordLastSetDate":"2018-01-01T00:00:00-06:00"},"properties":{"Buyer":{"allOf":[{"$ref":"#/components/schemas/MeBuyer"}],"readOnly":true},"Supplier":{"allOf":[{"$ref":"#/components/schemas/MeSupplier"}],"readOnly":true},"Seller":{"allOf":[{"$ref":"#/components/schemas/MeSeller"}],"readOnly":true},"ID":{"type":"string","maxLength":100},"CompanyID":{"type":"string","readOnly":true},"Username":{"type":"string","description":"Must be unique across all organizations.","maxLength":100},"Password":{"type":"string","format":"password"},"FirstName":{"type":"string","maxLength":100},"LastName":{"type":"string","maxLength":100},"Email":{"type":"string","maxLength":200},"Phone":{"type":"string","maxLength":100},"TermsAccepted":{"type":"string","format":"date-time"},"Active":{"type":"boolean","description":"If false, authentication is prohibited."},"xp":{"type":"object"},"AvailableRoles":{"type":"array","items":{"type":"string"},"readOnly":true,"description":"List of roles currently available to the user via all security profile assignments."},"Locale":{"allOf":[{"$ref":"#/components/schemas/Locale"}],"readOnly":true,"description":"Most specific locale assigned to the user, if any."},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"LastActive":{"type":"string","format":"date-time","readOnly":true,"description":"Accurate within a few minutes. Includes impersonation activity."},"PasswordLastSetDate":{"type":"string","format":"date-time","readOnly":true,"description":"Can be used in conjunction with SecurityProfile.PasswordConfig to enforce password reset schedules."}}},"OneTimePasswordRequest":{"type":"object","example":{"ClientID":"","Username":"","Email":""},"properties":{"ClientID":{"type":"string"},"Username":{"type":"string"},"Email":{"type":"string"}}},"OpenIdConnect":{"type":"object","example":{"ID":"","OrderCloudApiClientID":"","ConnectClientID":"","ConnectClientSecret":"","AppStartUrl":"","AuthorizationEndpoint":"","TokenEndpoint":"","UrlEncoded":false,"IntegrationEventID":"","CallSyncUserIntegrationEvent":false,"IntegrationEventName":"","AdditionalIdpScopes":[""],"CustomErrorUrl":""},"properties":{"ID":{"type":"string","description":"ID of this OpenID Connect configuration object. Each object allows authentication to one OrderCloud API Client through one Identity Providing Party.","maxLength":100},"OrderCloudApiClientID":{"type":"string","description":"An ID that references an OrderCloud API Client."},"ConnectClientID":{"type":"string","description":"An app ID from the Identity Provider that is required to get JWT tokens."},"ConnectClientSecret":{"type":"string","description":"A secret string from the Identity Provider that grants access to get JWT tokens."},"AppStartUrl":{"type":"string","description":"A URL on your front-end ordering site where users will be redirected after they authenticate through the Identity Provider. Supports placeholders: {0} = OrderCloud access token, {1} = IdP access token, {2} = appStartPath, {3} = OrderCloud refresh token, {4} = IdP refresh token (if available)."},"AuthorizationEndpoint":{"type":"string","description":"A publicly known URL from the Identity Provider that redirects to a resource where users enter personal credentials."},"TokenEndpoint":{"type":"string","description":"A publicly known URL from the Identity Provider where agents can get JWT tokens."},"UrlEncoded":{"type":"boolean","description":"If true, uses a url encoded form post with all auth values. Otherwise, an Authorization header with basic auth is passed with a JSON object in the body."},"IntegrationEventID":{"type":"string","description":"ID of the integration event to call upon authorization request. Used when you haven't pre-populated users into OrderCloud, or need to sync user data."},"CallSyncUserIntegrationEvent":{"type":"boolean","description":"If true, the integration event is always triggered regardless of if the user already exists in OrderCloud."},"IntegrationEventName":{"type":"string","readOnly":true},"AdditionalIdpScopes":{"type":"array","items":{"type":"string"},"description":"Any additional scopes needed by the IDP."},"CustomErrorUrl":{"type":"string","description":"A URL on your front-end ordering site where users will be redirected if an error occurs while trying to authenticate."}}},"Order":{"type":"object","example":{"ID":"","FromUser":{"ID":"","CompanyID":"","Username":"","Password":"","FirstName":"","LastName":"","Email":"","Phone":"","TermsAccepted":"2018-01-01T00:00:00-06:00","Active":false,"xp":{},"AvailableRoles":[""],"Locale":{"ID":"","OwnerID":"","Currency":"","Language":""},"DateCreated":"2018-01-01T00:00:00-06:00","LastActive":"2018-01-01T00:00:00-06:00","PasswordLastSetDate":"2018-01-01T00:00:00-06:00"},"FromCompanyID":"","ToCompanyID":"","FromUserID":"","BillingAddressID":"","BillingAddress":{"ID":"","DateCreated":"2018-01-01T00:00:00-06:00","CompanyName":"","FirstName":"","LastName":"","Street1":"","Street2":"","City":"","State":"","Zip":"","Country":"","Phone":"","AddressName":"","xp":{}},"ShippingAddressID":"","Comments":"","LineItemCount":0,"Status":"Unsubmitted","DateCreated":"2018-01-01T00:00:00-06:00","DateSubmitted":"2018-01-01T00:00:00-06:00","DateApproved":"2018-01-01T00:00:00-06:00","DateDeclined":"2018-01-01T00:00:00-06:00","DateCanceled":"2018-01-01T00:00:00-06:00","DateCompleted":"2018-01-01T00:00:00-06:00","LastUpdated":"2018-01-01T00:00:00-06:00","Subtotal":0,"ShippingCost":0,"TaxCost":0,"Gratuity":0,"Fees":0,"BaseDiscount":0,"PromotionDiscount":0,"Currency":"","Total":0,"IsSubmitted":false,"SubscriptionID":"","xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"FromUser":{"allOf":[{"$ref":"#/components/schemas/OrderUser"}],"readOnly":true,"description":"User placing the order."},"FromCompanyID":{"type":"string","description":"ID of the Buyer placing the order, or the marketplace owner when an order is being forwarded. Mainly useful to the marketplace owner or supplier receiving it."},"ToCompanyID":{"type":"string","description":"ID of the marketplace owner or supplier receiving the order, only writable on create. Mainly useful to the user placing it."},"FromUserID":{"type":"string","description":"This property is only writable when creating an order on behalf of a buyer user."},"BillingAddressID":{"type":"string"},"BillingAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"readOnly":true},"ShippingAddressID":{"type":"string","description":"ID of the ShippingAddress for all line items on the order. Null when there are multiple shipping addresses defined."},"Comments":{"type":"string","maxLength":2000},"LineItemCount":{"type":"integer","format":"int32","readOnly":true},"Status":{"$ref":"#/components/schemas/OrderStatus","readOnly":true},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"DateSubmitted":{"type":"string","format":"date-time","readOnly":true,"description":"Null until the order passes from the buyer to the marketplace owner, including when Status is PendingApproval."},"DateApproved":{"type":"string","format":"date-time","readOnly":true},"DateDeclined":{"type":"string","format":"date-time","readOnly":true},"DateCanceled":{"type":"string","format":"date-time","readOnly":true},"DateCompleted":{"type":"string","format":"date-time","readOnly":true,"description":"Populated when all items on an order have shipped, or the order is explicitly completed."},"LastUpdated":{"type":"string","format":"date-time","readOnly":true},"Subtotal":{"type":"number","format":"float","readOnly":true,"description":"Sum of all LineItem.LineSubtotals."},"ShippingCost":{"type":"number","format":"float","description":"Modifying requires OverrideShipping role."},"TaxCost":{"type":"number","format":"float","description":"Modifying requires TaxOverride role."},"Gratuity":{"type":"number","format":"float","default":0,"minimum":0},"Fees":{"type":"number","format":"float","default":0,"readOnly":true,"description":"Fees associated with order or line items","minimum":0},"BaseDiscount":{"type":"number","format":"float","readOnly":true,"description":"Sum of all discount amounts from discount assignments applied to line items on this order."},"PromotionDiscount":{"type":"number","format":"float","readOnly":true,"description":"Sum of all promotion amounts applied to the order."},"Currency":{"type":"string","readOnly":true,"description":"Inherited from the user placing the order."},"Total":{"type":"number","format":"float","readOnly":true,"description":"Subtotal - BaseDiscount - PromotionDiscount + TaxCost + ShippingCost + Gratuity + Fees"},"IsSubmitted":{"type":"boolean","readOnly":true,"description":"True if this order has been passed from the Buyer to the marketplace owner or supplier."},"SubscriptionID":{"type":"string","readOnly":true,"description":"ID of the subscription used to create an order in an automated process."},"xp":{"type":"object"}}},"OrderApproval":{"type":"object","example":{"AllowResubmit":false,"ApprovalRuleID":"","ApprovingGroupID":"","Status":"Pending","DateCreated":"2018-01-01T00:00:00-06:00","DateCompleted":"2018-01-01T00:00:00-06:00","Approver":{"FailedLoginAttempts":0,"ID":"","CompanyID":"","Username":"","Password":"","FirstName":"","LastName":"","Email":"","Phone":"","TermsAccepted":"2018-01-01T00:00:00-06:00","Active":false,"xp":{},"AvailableRoles":[""],"Locale":{"ID":"","OwnerID":"","Currency":"","Language":""},"DateCreated":"2018-01-01T00:00:00-06:00","LastActive":"2018-01-01T00:00:00-06:00","PasswordLastSetDate":"2018-01-01T00:00:00-06:00"},"Comments":""},"properties":{"AllowResubmit":{"type":"boolean","readOnly":true,"description":"If true, the submitting user will be able to modify the order and resubmit for approval."},"ApprovalRuleID":{"type":"string","readOnly":true},"ApprovingGroupID":{"type":"string","readOnly":true},"Status":{"$ref":"#/components/schemas/ApprovalStatus","readOnly":true},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"DateCompleted":{"type":"string","format":"date-time","readOnly":true},"Approver":{"allOf":[{"$ref":"#/components/schemas/User"}],"readOnly":true},"Comments":{"type":"string","readOnly":true}}},"OrderApprovalInfo":{"type":"object","example":{"AllowResubmit":false,"Comments":""},"properties":{"AllowResubmit":{"type":"boolean","description":"Only relevant when declining an order. Changes the order Status back to Unsubmitted and allows the user to make changes and resubmit."},"Comments":{"type":"string","description":"Comments to be saved with the order approval or denial.","maxLength":2000}}},"OrderApprovedResponse":{"type":"object","example":{"HttpStatusCode":0,"UnhandledErrorBody":"","xp":{},"Succeeded":false},"properties":{"HttpStatusCode":{"type":"integer","format":"int32"},"UnhandledErrorBody":{"type":"string"},"xp":{"type":"object"},"Succeeded":{"type":"boolean"}}},"OrderCalculateResponse":{"type":"object","example":{"LineItemOverrides":[{"LineItemID":"","UnitPrice":0,"Product":{"ID":"","Name":"","Description":"","QuantityMultiplier":0,"ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"DefaultSupplierID":"","Returnable":false,"xp":{}},"PromotionOverrides":[{"PromotionID":"","Amount":0}],"InventoryRecordID":"","Remove":false}],"ShippingTotal":0,"TaxTotal":0,"FeeTotal":0,"HttpStatusCode":0,"UnhandledErrorBody":"","xp":{},"Succeeded":false},"properties":{"LineItemOverrides":{"type":"array","items":{"$ref":"#/components/schemas/LineItemOverride"}},"ShippingTotal":{"type":"number","format":"float"},"TaxTotal":{"type":"number","format":"float"},"FeeTotal":{"type":"number","format":"float"},"HttpStatusCode":{"type":"integer","format":"int32"},"UnhandledErrorBody":{"type":"string"},"xp":{"type":"object"},"Succeeded":{"type":"boolean"}}},"OrderDirection":{"type":"string","enum":["Incoming","Outgoing","All"],"description":"Direction of the order, from the current user's perspective."},"OrderPromotion":{"type":"object","example":{"Amount":0,"LineItemID":"","AmountOverridden":false,"DateApplied":"2018-01-01T00:00:00-06:00","ID":"","LineItemLevel":false,"Code":"","Name":"","RedemptionLimit":0,"RedemptionLimitPerUser":0,"RedemptionCount":0,"QuantityLimitPerOrder":0,"ItemLimitPerOrder":0,"ItemSortBy":"","Description":"","FinePrint":"","StartDate":"2018-01-01T00:00:00-06:00","ExpirationDate":"2018-01-01T00:00:00-06:00","EligibleExpression":"","ValueExpression":"","CanCombine":false,"AllowAllBuyers":false,"OwnerID":"","AutoApply":false,"Active":false,"UseIntegration":false,"Priority":0,"xp":{}},"properties":{"Amount":{"type":"number","format":"float","readOnly":true},"LineItemID":{"type":"string","readOnly":true},"AmountOverridden":{"type":"boolean","readOnly":true,"description":"True when the Amount has been set via PromotionOverrides."},"DateApplied":{"type":"string","format":"date-time","readOnly":true},"ID":{"type":"string","maxLength":100},"LineItemLevel":{"type":"boolean","description":"If true, certain eligible expression requirements must be met, and the PromotionDiscount will be applied at the line item level."},"Code":{"type":"string","description":"Must be unique. Entered by buyer when adding promo to order.","maxLength":100},"Name":{"type":"string","maxLength":100},"RedemptionLimit":{"type":"integer","format":"int32","description":"Limit the total number of orders this promotion can be applied to across all users."},"RedemptionLimitPerUser":{"type":"integer","format":"int32","description":"Limit the total number of orders this promotion can be applied to per user."},"RedemptionCount":{"type":"integer","format":"int32","readOnly":true,"description":"The number of times this promotion has been applied to an order."},"QuantityLimitPerOrder":{"type":"integer","format":"int32","description":"Can only be used when LineItemLevel is true and ItemLimitPerOrder does not have a value. When defined the ValueExpression will be the discount applied to each qualifying quantity of eligible items. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.","minimum":1},"ItemLimitPerOrder":{"type":"integer","format":"int32","description":"Can only be used when LineItemLevel is true and QuantityLimitPerOrder does not have a value. Limits the number of items the promotion will apply to when eligible. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.","minimum":1},"ItemSortBy":{"type":"string","description":"Comma delimited list of properties to sort by. Can only be used when ItemLimitPerOrder is true. Used to determine the order in which the promotion is applied to the specified limit of items. Use ! to reverse sort order on a property.","maxLength":200},"Description":{"type":"string","maxLength":2000},"FinePrint":{"type":"string","description":"For reference only. Terms, conditions, and other legal jargon.","maxLength":2000},"StartDate":{"type":"string","format":"date-time"},"ExpirationDate":{"type":"string","format":"date-time"},"EligibleExpression":{"type":"string","description":"The expression evaluated to determine if an item or order is eligible for a promotion. See rules engine documentation for formatting details.","maxLength":400},"ValueExpression":{"type":"string","description":"The expression evaluated to determine the discount amount of an eligible promotion. See rules engine documentation for formatting details.","maxLength":1000},"CanCombine":{"type":"boolean","description":"If true, the promotion can be applied to an order that already other promotions applied, as long as they can also be combined."},"AllowAllBuyers":{"type":"boolean","description":"Allow promo to be used by all buyers without creating explicit assignments."},"OwnerID":{"type":"string","description":"ID of the organization that owns the promotion. Only the marketplace owner can override the OwnerID on create."},"AutoApply":{"type":"boolean","default":false},"Active":{"type":"boolean","default":true},"UseIntegration":{"type":"boolean"},"Priority":{"type":"integer","format":"int32","description":"Used to control the order in which promotions are applied when calling the auto apply or refresh endpoint."},"xp":{"type":"object"}}},"OrderRepeatResponse":{"type":"object","example":{"Order":{"ID":"","FromUser":{"ID":"","CompanyID":"","Username":"","Password":"","FirstName":"","LastName":"","Email":"","Phone":"","TermsAccepted":"2018-01-01T00:00:00-06:00","Active":false,"xp":{},"AvailableRoles":[""],"Locale":{"ID":"","OwnerID":"","Currency":"","Language":""},"DateCreated":"2018-01-01T00:00:00-06:00","LastActive":"2018-01-01T00:00:00-06:00","PasswordLastSetDate":"2018-01-01T00:00:00-06:00"},"FromCompanyID":"","ToCompanyID":"","FromUserID":"","BillingAddressID":"","BillingAddress":{"ID":"","DateCreated":"2018-01-01T00:00:00-06:00","CompanyName":"","FirstName":"","LastName":"","Street1":"","Street2":"","City":"","State":"","Zip":"","Country":"","Phone":"","AddressName":"","xp":{}},"ShippingAddressID":"","Comments":"","LineItemCount":0,"Status":"Unsubmitted","DateCreated":"2018-01-01T00:00:00-06:00","DateSubmitted":"2018-01-01T00:00:00-06:00","DateApproved":"2018-01-01T00:00:00-06:00","DateDeclined":"2018-01-01T00:00:00-06:00","DateCanceled":"2018-01-01T00:00:00-06:00","DateCompleted":"2018-01-01T00:00:00-06:00","LastUpdated":"2018-01-01T00:00:00-06:00","Subtotal":0,"ShippingCost":0,"TaxCost":0,"Gratuity":0,"Fees":0,"BaseDiscount":0,"PromotionDiscount":0,"Currency":"","Total":0,"IsSubmitted":false,"SubscriptionID":"","xp":{}},"UnavailableItems":[{"ProductID":"","Error":{"ErrorCode":"","Message":"","Data":{}}}]},"properties":{"Order":{"allOf":[{"$ref":"#/components/schemas/Order"}],"description":"The new unsubmitted order created from the original."},"UnavailableItems":{"type":"array","items":{"$ref":"#/components/schemas/UnavailableLineItem"},"description":"Products from the original order that could not be added to the new order."}}},"OrderReturn":{"type":"object","example":{"ID":"","OrderID":"","PaymentIDs":[""],"Status":"Unsubmitted","DateCreated":"2018-01-01T00:00:00-06:00","DateSubmitted":"2018-01-01T00:00:00-06:00","DateApproved":"2018-01-01T00:00:00-06:00","DateDeclined":"2018-01-01T00:00:00-06:00","DateCanceled":"2018-01-01T00:00:00-06:00","DateCompleted":"2018-01-01T00:00:00-06:00","LastUpdated":"2018-01-01T00:00:00-06:00","RefundAmount":0,"Comments":"","ItemsToReturn":[{"LineItemID":"","Quantity":0,"RefundAmount":0,"Comments":""}],"xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"OrderID":{"type":"string"},"PaymentIDs":{"type":"array","items":{"type":"string"},"readOnly":true,"description":"IDs of payments associated with this order return."},"Status":{"$ref":"#/components/schemas/OrderStatus","readOnly":true},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"DateSubmitted":{"type":"string","format":"date-time","readOnly":true,"description":"Will be null until the order return passes from the buyer to the seller, including when Status is PendingApproval."},"DateApproved":{"type":"string","format":"date-time","readOnly":true},"DateDeclined":{"type":"string","format":"date-time","readOnly":true},"DateCanceled":{"type":"string","format":"date-time","readOnly":true},"DateCompleted":{"type":"string","format":"date-time","readOnly":true,"description":"Populated when payment to customer has been completed."},"LastUpdated":{"type":"string","format":"date-time","readOnly":true},"RefundAmount":{"type":"number","format":"float","description":"Sum of all RefundAmounts for items. This value can be overridden by a user with the OrderAdmin role. To remove the override set the value to null."},"Comments":{"type":"string","maxLength":2000},"ItemsToReturn":{"type":"array","items":{"$ref":"#/components/schemas/OrderReturnItem"}},"xp":{"type":"object"}}},"OrderReturnApproval":{"type":"object","example":{"OrderReturnID":"","ApprovalRuleID":"","ApprovingGroupID":"","Status":"Pending","DateCreated":"2018-01-01T00:00:00-06:00","DateCompleted":"2018-01-01T00:00:00-06:00","Approver":{"FailedLoginAttempts":0,"ID":"","CompanyID":"","Username":"","Password":"","FirstName":"","LastName":"","Email":"","Phone":"","TermsAccepted":"2018-01-01T00:00:00-06:00","Active":false,"xp":{},"AvailableRoles":[""],"Locale":{"ID":"","OwnerID":"","Currency":"","Language":""},"DateCreated":"2018-01-01T00:00:00-06:00","LastActive":"2018-01-01T00:00:00-06:00","PasswordLastSetDate":"2018-01-01T00:00:00-06:00"},"Comments":""},"properties":{"OrderReturnID":{"type":"string"},"ApprovalRuleID":{"type":"string","readOnly":true},"ApprovingGroupID":{"type":"string","readOnly":true},"Status":{"$ref":"#/components/schemas/ApprovalStatus","readOnly":true},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"DateCompleted":{"type":"string","format":"date-time","readOnly":true},"Approver":{"allOf":[{"$ref":"#/components/schemas/User"}],"readOnly":true},"Comments":{"type":"string","readOnly":true}}},"OrderReturnItem":{"type":"object","example":{"LineItemID":"","Quantity":0,"RefundAmount":0,"Comments":""},"properties":{"LineItemID":{"type":"string"},"Quantity":{"type":"integer","format":"int32","default":0,"minimum":0},"RefundAmount":{"type":"number","format":"float"},"Comments":{"type":"string","maxLength":500}}},"OrderShipMethodSelection":{"type":"object","example":{"ShipMethodSelections":[{"ShipEstimateID":"","ShipMethodID":""}]},"properties":{"ShipMethodSelections":{"type":"array","items":{"$ref":"#/components/schemas/ShipMethodSelection"}}}},"OrderSplitResult":{"type":"object","example":{"OutgoingOrders":[{"ID":"","FromUser":{"ID":"","CompanyID":"","Username":"","Password":"","FirstName":"","LastName":"","Email":"","Phone":"","TermsAccepted":"2018-01-01T00:00:00-06:00","Active":false,"xp":{},"AvailableRoles":[""],"Locale":{"ID":"","OwnerID":"","Currency":"","Language":""},"DateCreated":"2018-01-01T00:00:00-06:00","LastActive":"2018-01-01T00:00:00-06:00","PasswordLastSetDate":"2018-01-01T00:00:00-06:00"},"FromCompanyID":"","ToCompanyID":"","FromUserID":"","BillingAddressID":"","BillingAddress":{"ID":"","DateCreated":"2018-01-01T00:00:00-06:00","CompanyName":"","FirstName":"","LastName":"","Street1":"","Street2":"","City":"","State":"","Zip":"","Country":"","Phone":"","AddressName":"","xp":{}},"ShippingAddressID":"","Comments":"","LineItemCount":0,"Status":"Unsubmitted","DateCreated":"2018-01-01T00:00:00-06:00","DateSubmitted":"2018-01-01T00:00:00-06:00","DateApproved":"2018-01-01T00:00:00-06:00","DateDeclined":"2018-01-01T00:00:00-06:00","DateCanceled":"2018-01-01T00:00:00-06:00","DateCompleted":"2018-01-01T00:00:00-06:00","LastUpdated":"2018-01-01T00:00:00-06:00","Subtotal":0,"ShippingCost":0,"TaxCost":0,"Gratuity":0,"Fees":0,"BaseDiscount":0,"PromotionDiscount":0,"Currency":"","Total":0,"IsSubmitted":false,"SubscriptionID":"","xp":{}}],"RemainingLineItemIDs":[""]},"properties":{"OutgoingOrders":{"type":"array","items":{"$ref":"#/components/schemas/Order"},"description":"The outgoing orders created, one for each unique Product.DefaultSupplierID on the original order."},"RemainingLineItemIDs":{"type":"array","items":{"type":"string"},"description":"IDs of line items not added to an outgoing order, most likely because Product.DefaultSupplierID is not set."}}},"OrderStatus":{"type":"string","enum":["Unsubmitted","AwaitingApproval","Declined","Open","Completed","Canceled"],"description":""},"OrderSubmitForApprovalResponse":{"type":"object","example":{"HttpStatusCode":0,"UnhandledErrorBody":"","xp":{},"Succeeded":false},"properties":{"HttpStatusCode":{"type":"integer","format":"int32"},"UnhandledErrorBody":{"type":"string"},"xp":{"type":"object"},"Succeeded":{"type":"boolean"}}},"OrderSubmitResponse":{"type":"object","example":{"HttpStatusCode":0,"UnhandledErrorBody":"","xp":{},"Succeeded":false},"properties":{"HttpStatusCode":{"type":"integer","format":"int32"},"UnhandledErrorBody":{"type":"string"},"xp":{"type":"object"},"Succeeded":{"type":"boolean"}}},"OrderSyncConfig":{"type":"object","example":{"DeliveryConfigID":"","ConfigData":{}},"properties":{"DeliveryConfigID":{"type":"string"},"ConfigData":{"type":"object"}}},"OrderUser":{"type":"object","example":{"ID":"","CompanyID":"","Username":"","Password":"","FirstName":"","LastName":"","Email":"","Phone":"","TermsAccepted":"2018-01-01T00:00:00-06:00","Active":false,"xp":{},"AvailableRoles":[""],"Locale":{"ID":"","OwnerID":"","Currency":"","Language":""},"DateCreated":"2018-01-01T00:00:00-06:00","LastActive":"2018-01-01T00:00:00-06:00","PasswordLastSetDate":"2018-01-01T00:00:00-06:00"},"properties":{"ID":{"type":"string","maxLength":100},"CompanyID":{"type":"string","readOnly":true},"Username":{"type":"string","description":"Must be unique across all organizations.","maxLength":100},"Password":{"type":"string","format":"password"},"FirstName":{"type":"string","maxLength":100},"LastName":{"type":"string","maxLength":100},"Email":{"type":"string","maxLength":200},"Phone":{"type":"string","maxLength":100},"TermsAccepted":{"type":"string","format":"date-time"},"Active":{"type":"boolean","description":"If false, authentication is prohibited."},"xp":{"type":"object"},"AvailableRoles":{"type":"array","items":{"type":"string"},"readOnly":true,"description":"List of roles currently available to the user via all security profile assignments."},"Locale":{"allOf":[{"$ref":"#/components/schemas/Locale"}],"readOnly":true,"description":"Most specific locale assigned to the user, if any."},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"LastActive":{"type":"string","format":"date-time","readOnly":true,"description":"Accurate within a few minutes. Includes impersonation activity."},"PasswordLastSetDate":{"type":"string","format":"date-time","readOnly":true,"description":"Can be used in conjunction with SecurityProfile.PasswordConfig to enforce password reset schedules."}}},"OrderWorksheet":{"type":"object","example":{"Order":{"ID":"","FromUser":{"ID":"","CompanyID":"","Username":"","Password":"","FirstName":"","LastName":"","Email":"","Phone":"","TermsAccepted":"2018-01-01T00:00:00-06:00","Active":false,"xp":{},"AvailableRoles":[""],"Locale":{"ID":"","OwnerID":"","Currency":"","Language":""},"DateCreated":"2018-01-01T00:00:00-06:00","LastActive":"2018-01-01T00:00:00-06:00","PasswordLastSetDate":"2018-01-01T00:00:00-06:00"},"FromCompanyID":"","ToCompanyID":"","FromUserID":"","BillingAddressID":"","BillingAddress":{"ID":"","DateCreated":"2018-01-01T00:00:00-06:00","CompanyName":"","FirstName":"","LastName":"","Street1":"","Street2":"","City":"","State":"","Zip":"","Country":"","Phone":"","AddressName":"","xp":{}},"ShippingAddressID":"","Comments":"","LineItemCount":0,"Status":"Unsubmitted","DateCreated":"2018-01-01T00:00:00-06:00","DateSubmitted":"2018-01-01T00:00:00-06:00","DateApproved":"2018-01-01T00:00:00-06:00","DateDeclined":"2018-01-01T00:00:00-06:00","DateCanceled":"2018-01-01T00:00:00-06:00","DateCompleted":"2018-01-01T00:00:00-06:00","LastUpdated":"2018-01-01T00:00:00-06:00","Subtotal":0,"ShippingCost":0,"TaxCost":0,"Gratuity":0,"Fees":0,"BaseDiscount":0,"PromotionDiscount":0,"Currency":"","Total":0,"IsSubmitted":false,"SubscriptionID":"","xp":{}},"LineItems":[{"ID":"","ProductID":"","Quantity":0,"BundleItemID":"","IsBundle":false,"DateAdded":"2018-01-01T00:00:00-06:00","QuantityShipped":0,"UnitPrice":0,"PromotionDiscount":0,"BaseDiscount":0,"DiscountID":"","LineTotal":0,"LineSubtotal":0,"CostCenter":"","DateNeeded":"2018-01-01T00:00:00-06:00","ShippingAccount":"","ShippingAddressID":"","ShipFromAddressID":"","Product":{"ID":"","Name":"","Description":"","Returnable":false,"QuantityMultiplier":0,"ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"DefaultSupplierID":"","ParentID":"","xp":{}},"Variant":{"ID":"","Name":"","Description":"","ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"xp":{}},"ShippingAddress":{"ID":"","DateCreated":"2018-01-01T00:00:00-06:00","CompanyName":"","FirstName":"","LastName":"","Street1":"","Street2":"","City":"","State":"","Zip":"","Country":"","Phone":"","AddressName":"","xp":{}},"ShipFromAddress":{"ID":"","DateCreated":"2018-01-01T00:00:00-06:00","CompanyName":"","FirstName":"","LastName":"","Street1":"","Street2":"","City":"","State":"","Zip":"","Country":"","Phone":"","AddressName":"","xp":{}},"SupplierID":"","InventoryRecordID":"","PriceScheduleID":"","IsOnSale":false,"PriceOverridden":false,"Specs":[{"SpecID":"","Name":"","OptionID":"","Value":"","PriceMarkupType":"NoMarkup","PriceMarkup":0}],"IncomingOrderID":"","OutgoingOrderID":"","xp":{}}],"OrderPromotions":[{"Amount":0,"LineItemID":"","AmountOverridden":false,"DateApplied":"2018-01-01T00:00:00-06:00","ID":"","LineItemLevel":false,"Code":"","Name":"","RedemptionLimit":0,"RedemptionLimitPerUser":0,"RedemptionCount":0,"QuantityLimitPerOrder":0,"ItemLimitPerOrder":0,"ItemSortBy":"","Description":"","FinePrint":"","StartDate":"2018-01-01T00:00:00-06:00","ExpirationDate":"2018-01-01T00:00:00-06:00","EligibleExpression":"","ValueExpression":"","CanCombine":false,"AllowAllBuyers":false,"OwnerID":"","AutoApply":false,"Active":false,"UseIntegration":false,"Priority":0,"xp":{}}],"Subscription":{"ID":"","Frequency":0,"Interval":"Days","NextOrderDate":"2018-01-01T00:00:00-06:00","LastOrderDate":"2018-01-01T00:00:00-06:00","NotificationDate":"2018-01-01T00:00:00-06:00","DateCreated":"2018-01-01T00:00:00-06:00","EndDate":"2018-01-01T00:00:00-06:00","Active":false,"FromCompanyID":"","FromUserID":"","ToCompanyID":"","Payment":{"Type":"PurchaseOrder","CreditCardID":"","SpendingAccountID":""},"BillingAddressID":"","ShippingAddressID":"","ProjectedSubtotal":0,"xp":{}},"ShipEstimateResponse":{"ShipEstimates":[{"ID":"","xp":{},"SelectedShipMethodID":"","ShipEstimateItems":[{"LineItemID":"","Quantity":0}],"ShipMethods":[{"ID":"","Name":"","Cost":0,"EstimatedTransitDays":0,"xp":{}}]}],"HttpStatusCode":0,"UnhandledErrorBody":"","xp":{},"Succeeded":false},"OrderCalculateResponse":{"LineItemOverrides":[{"LineItemID":"","UnitPrice":0,"Product":{"ID":"","Name":"","Description":"","QuantityMultiplier":0,"ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"DefaultSupplierID":"","Returnable":false,"xp":{}},"PromotionOverrides":[{"PromotionID":"","Amount":0}],"InventoryRecordID":"","Remove":false}],"ShippingTotal":0,"TaxTotal":0,"FeeTotal":0,"HttpStatusCode":0,"UnhandledErrorBody":"","xp":{},"Succeeded":false},"OrderSubmitResponse":{"HttpStatusCode":0,"UnhandledErrorBody":"","xp":{},"Succeeded":false},"OrderSubmitForApprovalResponse":{"HttpStatusCode":0,"UnhandledErrorBody":"","xp":{},"Succeeded":false},"OrderApprovedResponse":{"HttpStatusCode":0,"UnhandledErrorBody":"","xp":{},"Succeeded":false},"SubscriptionIntegrationResponse":{"HttpStatusCode":0,"UnhandledErrorBody":"","xp":{},"Succeeded":false}},"properties":{"Order":{"allOf":[{"$ref":"#/components/schemas/Order"}]},"LineItems":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"OrderPromotions":{"type":"array","items":{"$ref":"#/components/schemas/OrderPromotion"}},"Subscription":{"allOf":[{"$ref":"#/components/schemas/Subscription"}]},"ShipEstimateResponse":{"allOf":[{"$ref":"#/components/schemas/ShipEstimateResponse"}]},"OrderCalculateResponse":{"allOf":[{"$ref":"#/components/schemas/OrderCalculateResponse"}]},"OrderSubmitResponse":{"allOf":[{"$ref":"#/components/schemas/OrderSubmitResponse"}]},"OrderSubmitForApprovalResponse":{"allOf":[{"$ref":"#/components/schemas/OrderSubmitForApprovalResponse"}]},"OrderApprovedResponse":{"allOf":[{"$ref":"#/components/schemas/OrderApprovedResponse"}]},"SubscriptionIntegrationResponse":{"allOf":[{"$ref":"#/components/schemas/SubscriptionIntegrationResponse"}]}}},"PartyType":{"type":"string","enum":["User","Group","Company","BuyerGroup"],"description":""},"PasswordConfig":{"type":"object","example":{"LimitPasswordReuse":0,"MaxConsecutiveDupeChars":0,"MaximumPasswordAge":0,"MinimumPasswordAge":0,"AllowedFailedAttempts":0,"LockoutDuration":0,"UpperCaseRequired":false,"LowerCaseRequired":false,"SpecialCharacterRequired":false,"NumericRequired":false,"MinimumCharacterCount":0},"properties":{"LimitPasswordReuse":{"type":"integer","format":"int32","description":"The number of passwords, including the current password, that are blocked from reuse. For example, if set to 1, any password except the current one can be reused.","minimum":0,"maximum":24},"MaxConsecutiveDupeChars":{"type":"integer","format":"int32","description":"The maximum number of consecutive repeating characters in a password.","minimum":1,"maximum":24},"MaximumPasswordAge":{"type":"integer","format":"int32","description":"The password expires after MaximumPasswordAge in days.","minimum":1,"maximum":365},"MinimumPasswordAge":{"type":"integer","format":"int32","description":"The password may not be changed again until this number of minutes has passed.","minimum":1,"maximum":60},"AllowedFailedAttempts":{"type":"integer","format":"int32","description":"The number of failed attempts before the account is locked for the LockoutDuration.","minimum":1,"maximum":10},"LockoutDuration":{"type":"integer","format":"int32","description":"The number of minutes an account is locked when the AllowedFailedAttempts is reached. Use 0 to indicate that lockout should be indefinite, requiring the manual intervention by an admin user.","minimum":0,"maximum":1440},"UpperCaseRequired":{"type":"boolean","description":"At least one upper case character is required."},"LowerCaseRequired":{"type":"boolean","description":"At least one lower case character is required."},"SpecialCharacterRequired":{"type":"boolean","description":"At least one special character is required."},"NumericRequired":{"type":"boolean","description":"At least one number is required."},"MinimumCharacterCount":{"type":"integer","format":"int32","description":"The minimum length of a password.","minimum":8}}},"PasswordReset":{"type":"object","example":{"ClientID":"","Username":"","Password":""},"properties":{"ClientID":{"type":"string"},"Username":{"type":"string"},"Password":{"type":"string","format":"password"}}},"PasswordResetRequest":{"type":"object","example":{"ClientID":"","Email":"","Username":"","URL":""},"properties":{"ClientID":{"type":"string"},"Email":{"type":"string"},"Username":{"type":"string"},"URL":{"type":"string"}}},"Payment":{"type":"object","example":{"ID":"","Type":"PurchaseOrder","DateCreated":"2018-01-01T00:00:00-06:00","CreditCardID":"","SpendingAccountID":"","Description":"","Currency":"","Amount":0,"Accepted":false,"OrderReturnID":"","xp":{},"Transactions":[{"ID":"","Type":"","DateExecuted":"2018-01-01T00:00:00-06:00","Currency":"","Amount":0,"Succeeded":false,"ResultCode":"","ResultMessage":"","xp":{}}]},"properties":{"ID":{"type":"string","maxLength":100},"Type":{"$ref":"#/components/schemas/PaymentType"},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"CreditCardID":{"type":"string","description":"Only writeable on create."},"SpendingAccountID":{"type":"string","description":"Only writeable on create."},"Description":{"type":"string","maxLength":2000},"Currency":{"type":"string","readOnly":true,"description":"Inherited from order."},"Amount":{"type":"number","format":"float","description":"If null, payment applies to order total (or total of specific line items, if set), less any other payments where Amount is set. Value can only be negative if processing a payment for an order return."},"Accepted":{"type":"boolean","description":"All payments must be Accepted to submit an order. This property should be updated after authorizing or capturing the payment in your middleware by a user with the elevated OrderAdmin role."},"OrderReturnID":{"type":"string","description":"Used to indicate this payment is associated with an order return."},"xp":{"type":"object"},"Transactions":{"type":"array","items":{"$ref":"#/components/schemas/PaymentTransaction"},"readOnly":true}}},"PaymentTransaction":{"type":"object","example":{"ID":"","Type":"","DateExecuted":"2018-01-01T00:00:00-06:00","Currency":"","Amount":0,"Succeeded":false,"ResultCode":"","ResultMessage":"","xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"Type":{"type":"string"},"DateExecuted":{"type":"string","format":"date-time"},"Currency":{"type":"string","description":"Usually the same as Payment.Currency, but can be different. A marketplace owner may capture funds from the buyer user in one currency and process a payout to the seller in another.","maxLength":100},"Amount":{"type":"number","format":"float","description":"Usually the same as Payment.Amount, but can be different. A charge might have a subsequent partial credit, for example."},"Succeeded":{"type":"boolean"},"ResultCode":{"type":"string"},"ResultMessage":{"type":"string"},"xp":{"type":"object"}}},"PaymentType":{"type":"string","enum":["PurchaseOrder","CreditCard","SpendingAccount"],"description":""},"PriceBreak":{"type":"object","example":{"Quantity":0,"Price":0,"SalePrice":0,"SubscriptionPrice":0,"BundlePrice":0},"properties":{"Quantity":{"type":"integer","format":"int32","description":"Most commonly 1, except when offering tiered/bulk pricing.","minimum":0},"Price":{"type":"number","format":"float","description":"Price per unit."},"SalePrice":{"type":"number","format":"float","description":"Sale Price per unit. If the current date/time is within the PriceSchedule SaleStart and SaleEnd, this SalePrice will be used."},"SubscriptionPrice":{"type":"number","format":"float","description":"Subscription Price per unit. If set, this price is used when a subscription order is created."},"BundlePrice":{"type":"number","format":"float","description":"Bundle Price per unit. If set, this price is used when an item being added to an order is part of a bundle."}}},"PriceMarkupType":{"type":"string","enum":["NoMarkup","AmountPerQuantity","AmountTotal","Percentage"],"description":""},"PriceSchedule":{"type":"object","example":{"PriceBreaks":[{"Quantity":0,"Price":0,"SalePrice":0,"SubscriptionPrice":0,"BundlePrice":0}],"OwnerID":"","ID":"","Name":"","ApplyTax":false,"ApplyShipping":false,"MinQuantity":0,"MaxQuantity":0,"UseCumulativeQuantity":false,"RestrictedQuantity":false,"Currency":"","SaleStart":"2018-01-01T00:00:00-06:00","SaleEnd":"2018-01-01T00:00:00-06:00","IsOnSale":false,"xp":{}},"properties":{"PriceBreaks":{"type":"array","items":{"$ref":"#/components/schemas/PriceBreak"}},"OwnerID":{"type":"string","description":"ID of the organization that owns the PriceSchedule. Only the marketplace owner can override the OwnerID on create."},"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100},"ApplyTax":{"type":"boolean","description":"For reference only for calculating tax, does not influence any OrderCloud behavior."},"ApplyShipping":{"type":"boolean","description":"For reference only for calculating shipping cost, does not influence any OrderCloud behavior."},"MinQuantity":{"type":"integer","format":"int32","default":1,"description":"The minimum line item Quantity when UseCumulativeQuantity is false.","minimum":1},"MaxQuantity":{"type":"integer","format":"int32","description":"The maximum line item Quantity when UseCumulativeQuantity is false."},"UseCumulativeQuantity":{"type":"boolean","description":"If true, line item quantities will be aggregated by productID when determining which price break applies, and when Min/Max quantities are met. Else, each line item is treated separately."},"RestrictedQuantity":{"type":"boolean","description":"If true, this product can only be ordered in quantities that exactly match one of the price breaks on this schedule."},"Currency":{"type":"string","description":"We recommend using ISO-4217 currency codes for compatibility with tax and payment processors.","maxLength":100},"SaleStart":{"type":"string","format":"date-time","default":null,"description":"Starting date/time for PriceBreak.SalePrice to be used as the price for the LineItem. Requires that the PriceBreak.SalePrice value is set."},"SaleEnd":{"type":"string","format":"date-time","default":null,"description":"Ending date/time for PriceBreak.SalePrice to be used as the price for the LineItem. Requires that the PriceBreak.SalePrice value is set."},"IsOnSale":{"type":"boolean","readOnly":true,"description":"True when at least one PriceBreak has a SalePrice defined, and the current time is between the SaleStart and SaleEnd date."},"xp":{"type":"object"}}},"Product":{"type":"object","example":{"OwnerID":"","DefaultPriceScheduleID":"","AutoForward":false,"ID":"","ParentID":"","IsParent":false,"IsBundle":false,"Name":"","Description":"","QuantityMultiplier":0,"ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"Active":false,"SpecCount":0,"VariantCount":0,"ShipFromAddressID":"","Inventory":{"Enabled":false,"NotificationPoint":0,"VariantLevelTracking":false,"OrderCanExceed":false,"QuantityAvailable":0,"LastUpdated":"2018-01-01T00:00:00-06:00"},"DefaultSupplierID":"","AllSuppliersCanSell":false,"Returnable":false,"DateCreated":"2018-01-01T00:00:00-06:00","xp":{}},"properties":{"OwnerID":{"type":"string","description":"ID of the organization that owns the product. Only the marketplace owner can override the OwnerID on create."},"DefaultPriceScheduleID":{"type":"string","description":"When provided, no explicit price schedule assignment is required. When a price schedule assignment exists, it will override any default provided."},"AutoForward":{"type":"boolean","description":"If true, when this product is ordered by a buyer, it will automatically be added to a new order from the marketplace owner to the default supplier and submitted. Requires a valid DefaultSupplierID."},"ID":{"type":"string","maxLength":100},"ParentID":{"type":"string","description":"ID of the parent product. If not null, IsParent should be false"},"IsParent":{"type":"boolean","description":"If true, ParentID must be null, as a parent product cannot have a parent itself."},"IsBundle":{"type":"boolean","readOnly":true,"description":"If true, IsParent must be false, as a parent product cannot be a bundle."},"Name":{"type":"string","maxLength":100},"Description":{"type":"string","maxLength":2000},"QuantityMultiplier":{"type":"integer","format":"int32","default":1,"description":"For reference only, does not influence any OrderCloud behavior. Used to indicate an amount per Quantity.","minimum":1},"ShipWeight":{"type":"number","format":"float"},"ShipHeight":{"type":"number","format":"float"},"ShipWidth":{"type":"number","format":"float"},"ShipLength":{"type":"number","format":"float"},"Active":{"type":"boolean","description":"If false, product is not visible or purchasable from a buyer's perspective."},"SpecCount":{"type":"integer","format":"int32","readOnly":true,"description":"Count of specs assigned to the product."},"VariantCount":{"type":"integer","format":"int32","readOnly":true,"description":"Count of variants generated from the product/spec combinations."},"ShipFromAddressID":{"type":"string","description":"Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs."},"Inventory":{"allOf":[{"$ref":"#/components/schemas/Inventory"}]},"DefaultSupplierID":{"type":"string","description":"Used for forwarding orders to suppliers."},"AllSuppliersCanSell":{"type":"boolean","description":"If true, all suppliers are eligible to opt into selling this product."},"Returnable":{"type":"boolean"},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"xp":{"type":"object"}}},"ProductAssignment":{"type":"object","example":{"SellerID":"","ProductID":"","BuyerID":"","UserGroupID":"","PriceScheduleID":""},"properties":{"SellerID":{"type":"string","description":"Only the marketplace owner can override the SellerID on create. A price schedule owned by the supplier is required in order to write to this property."},"ProductID":{"type":"string"},"BuyerID":{"type":"string"},"UserGroupID":{"type":"string"},"PriceScheduleID":{"type":"string"}}},"ProductCatalogAssignment":{"type":"object","example":{"CatalogID":"","ProductID":""},"properties":{"CatalogID":{"type":"string"},"ProductID":{"type":"string"}}},"ProductCollection":{"type":"object","example":{"ID":"","Name":"","xp":{},"AccessLevel":"Private"},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100},"xp":{"type":"object"},"AccessLevel":{"$ref":"#/components/schemas/AccessLevel"}}},"ProductCollectionBuyerProduct":{"type":"object","example":{"ListOrder":0,"DateAdded":"2018-01-01T00:00:00-06:00","PriceSchedule":{"PriceBreaks":[{"Discounted":{"Price":0,"SalePrice":0,"SubscriptionPrice":0,"BundlePrice":0},"Quantity":0,"Price":0,"SalePrice":0,"SubscriptionPrice":0,"BundlePrice":0}],"Discount":{"ID":"","Description":"","DiscountBreaks":[{"Quantity":0,"Amount":0}],"ProductFilter":"","CatalogID":"","CategoryID":"","ProductID":"","xp":{}},"OwnerID":"","ID":"","Name":"","ApplyTax":false,"ApplyShipping":false,"MinQuantity":0,"MaxQuantity":0,"UseCumulativeQuantity":false,"RestrictedQuantity":false,"Currency":"","SaleStart":"2018-01-01T00:00:00-06:00","SaleEnd":"2018-01-01T00:00:00-06:00","IsOnSale":false,"xp":{}},"ID":"","ParentID":"","IsParent":false,"IsBundle":false,"Name":"","Description":"","QuantityMultiplier":0,"ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"Active":false,"SpecCount":0,"VariantCount":0,"ShipFromAddressID":"","Inventory":{"Enabled":false,"NotificationPoint":0,"VariantLevelTracking":false,"OrderCanExceed":false,"QuantityAvailable":0,"LastUpdated":"2018-01-01T00:00:00-06:00"},"DefaultSupplierID":"","AllSuppliersCanSell":false,"Returnable":false,"DateCreated":"2018-01-01T00:00:00-06:00","xp":{}},"properties":{"ListOrder":{"type":"integer","format":"int32"},"DateAdded":{"type":"string","format":"date-time"},"PriceSchedule":{"allOf":[{"$ref":"#/components/schemas/BuyerPriceSchedule"}],"readOnly":true},"ID":{"type":"string","maxLength":100},"ParentID":{"type":"string","description":"ID of the parent product. If not null, IsParent should be false"},"IsParent":{"type":"boolean","description":"If true, ParentID must be null, as a parent product cannot have a parent itself."},"IsBundle":{"type":"boolean","readOnly":true,"description":"If true, IsParent must be false, as a parent product cannot be a bundle."},"Name":{"type":"string","maxLength":100},"Description":{"type":"string","maxLength":2000},"QuantityMultiplier":{"type":"integer","format":"int32","default":1,"description":"For reference only, does not influence any OrderCloud behavior. Used to indicate an amount per Quantity.","minimum":1},"ShipWeight":{"type":"number","format":"float"},"ShipHeight":{"type":"number","format":"float"},"ShipWidth":{"type":"number","format":"float"},"ShipLength":{"type":"number","format":"float"},"Active":{"type":"boolean","description":"If false, product is not visible or purchasable from a buyer's perspective."},"SpecCount":{"type":"integer","format":"int32","readOnly":true,"description":"Count of specs assigned to the product."},"VariantCount":{"type":"integer","format":"int32","readOnly":true,"description":"Count of variants generated from the product/spec combinations."},"ShipFromAddressID":{"type":"string","description":"Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs."},"Inventory":{"allOf":[{"$ref":"#/components/schemas/Inventory"}]},"DefaultSupplierID":{"type":"string","description":"Used for forwarding orders to suppliers."},"AllSuppliersCanSell":{"type":"boolean","description":"If true, all suppliers are eligible to opt into selling this product."},"Returnable":{"type":"boolean"},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"xp":{"type":"object"}}},"ProductCollectionEntry":{"type":"object","example":{"ProductID":"","ListOrder":0},"properties":{"ProductID":{"type":"string"},"ListOrder":{"type":"integer","format":"int32"}}},"ProductCollectionInvitation":{"type":"object","example":{"ID":"","Name":"","Admin":false,"Accepted":false,"ExpirationDate":"2018-01-01T00:00:00-06:00","xp":{}},"properties":{"ID":{"type":"string","readOnly":true,"maxLength":100},"Name":{"type":"string","maxLength":100},"Admin":{"type":"boolean","default":false},"Accepted":{"type":"boolean","default":false,"readOnly":true,"description":"Updated when accepted."},"ExpirationDate":{"type":"string","format":"date-time","description":"ExpirationDate defaults to 30 days from create, maximum 1 year."},"xp":{"type":"object"}}},"ProductCollectionProduct":{"type":"object","example":{"ListOrder":0,"DateAdded":"2018-01-01T00:00:00-06:00","OwnerID":"","DefaultPriceScheduleID":"","AutoForward":false,"ID":"","ParentID":"","IsParent":false,"IsBundle":false,"Name":"","Description":"","QuantityMultiplier":0,"ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"Active":false,"SpecCount":0,"VariantCount":0,"ShipFromAddressID":"","Inventory":{"Enabled":false,"NotificationPoint":0,"VariantLevelTracking":false,"OrderCanExceed":false,"QuantityAvailable":0,"LastUpdated":"2018-01-01T00:00:00-06:00"},"DefaultSupplierID":"","AllSuppliersCanSell":false,"Returnable":false,"DateCreated":"2018-01-01T00:00:00-06:00","xp":{}},"properties":{"ListOrder":{"type":"integer","format":"int32"},"DateAdded":{"type":"string","format":"date-time"},"OwnerID":{"type":"string","description":"ID of the organization that owns the product. Only the marketplace owner can override the OwnerID on create."},"DefaultPriceScheduleID":{"type":"string","description":"When provided, no explicit price schedule assignment is required. When a price schedule assignment exists, it will override any default provided."},"AutoForward":{"type":"boolean","description":"If true, when this product is ordered by a buyer, it will automatically be added to a new order from the marketplace owner to the default supplier and submitted. Requires a valid DefaultSupplierID."},"ID":{"type":"string","maxLength":100},"ParentID":{"type":"string","description":"ID of the parent product. If not null, IsParent should be false"},"IsParent":{"type":"boolean","description":"If true, ParentID must be null, as a parent product cannot have a parent itself."},"IsBundle":{"type":"boolean","readOnly":true,"description":"If true, IsParent must be false, as a parent product cannot be a bundle."},"Name":{"type":"string","maxLength":100},"Description":{"type":"string","maxLength":2000},"QuantityMultiplier":{"type":"integer","format":"int32","default":1,"description":"For reference only, does not influence any OrderCloud behavior. Used to indicate an amount per Quantity.","minimum":1},"ShipWeight":{"type":"number","format":"float"},"ShipHeight":{"type":"number","format":"float"},"ShipWidth":{"type":"number","format":"float"},"ShipLength":{"type":"number","format":"float"},"Active":{"type":"boolean","description":"If false, product is not visible or purchasable from a buyer's perspective."},"SpecCount":{"type":"integer","format":"int32","readOnly":true,"description":"Count of specs assigned to the product."},"VariantCount":{"type":"integer","format":"int32","readOnly":true,"description":"Count of variants generated from the product/spec combinations."},"ShipFromAddressID":{"type":"string","description":"Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs."},"Inventory":{"allOf":[{"$ref":"#/components/schemas/Inventory"}]},"DefaultSupplierID":{"type":"string","description":"Used for forwarding orders to suppliers."},"AllSuppliersCanSell":{"type":"boolean","description":"If true, all suppliers are eligible to opt into selling this product."},"Returnable":{"type":"boolean"},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"xp":{"type":"object"}}},"ProductFacet":{"type":"object","example":{"ID":"","Name":"","XpPath":"","ListOrder":1,"MinCount":0,"xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100},"XpPath":{"type":"string","description":"Identifies full path to XP field used for this facet. If not provided, facet value assumed to be stored at product.XP.{facet ID}.","maxLength":200},"ListOrder":{"type":"integer","format":"int32"},"MinCount":{"type":"integer","format":"int32","default":1,"description":"Minimum count required or a facet value to be returned in list metadata. If you want zero-count values returned, set this to 0."},"xp":{"type":"object"}}},"ProductSeller":{"type":"object","example":{"PriceSchedule":{"PriceBreaks":[{"Discounted":{"Price":0,"SalePrice":0,"SubscriptionPrice":0,"BundlePrice":0},"Quantity":0,"Price":0,"SalePrice":0,"SubscriptionPrice":0,"BundlePrice":0}],"Discount":{"ID":"","Description":"","DiscountBreaks":[{"Quantity":0,"Amount":0}],"ProductFilter":"","CatalogID":"","CategoryID":"","ProductID":"","xp":{}},"OwnerID":"","ID":"","Name":"","ApplyTax":false,"ApplyShipping":false,"MinQuantity":0,"MaxQuantity":0,"UseCumulativeQuantity":false,"RestrictedQuantity":false,"Currency":"","SaleStart":"2018-01-01T00:00:00-06:00","SaleEnd":"2018-01-01T00:00:00-06:00","IsOnSale":false,"xp":{}},"ID":"","Name":""},"properties":{"PriceSchedule":{"allOf":[{"$ref":"#/components/schemas/BuyerPriceSchedule"}]},"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100}}},"ProductSupplier":{"type":"object","example":{"DefaultPriceScheduleID":"","ID":"","Name":"","Active":false,"DateCreated":"2018-01-01T00:00:00-06:00","AllBuyersCanOrder":false,"xp":{}},"properties":{"DefaultPriceScheduleID":{"type":"string"},"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100},"Active":{"type":"boolean","description":"If false, all user authentication is blocked."},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"AllBuyersCanOrder":{"type":"boolean","description":"If false, buyers will only be able to set ToCompanyID on an order to the marketplace owner, or suppliers they have an explicit relationship to."},"xp":{"type":"object"}}},"ProductSyncConfig":{"type":"object","example":{"SyncProductChanged":false,"SyncProductDeleted":false,"DeliveryConfigID":"","ConfigData":{},"Paused":false,"ExcludePriceSchedules":false},"properties":{"SyncProductChanged":{"type":"boolean"},"SyncProductDeleted":{"type":"boolean"},"DeliveryConfigID":{"type":"string"},"ConfigData":{"type":"object"},"Paused":{"type":"boolean"},"ExcludePriceSchedules":{"type":"boolean"}}},"Promotion":{"type":"object","example":{"ID":"","LineItemLevel":false,"Code":"","Name":"","RedemptionLimit":0,"RedemptionLimitPerUser":0,"RedemptionCount":0,"QuantityLimitPerOrder":0,"ItemLimitPerOrder":0,"ItemSortBy":"","Description":"","FinePrint":"","StartDate":"2018-01-01T00:00:00-06:00","ExpirationDate":"2018-01-01T00:00:00-06:00","EligibleExpression":"","ValueExpression":"","CanCombine":false,"AllowAllBuyers":false,"OwnerID":"","AutoApply":false,"Active":false,"UseIntegration":false,"Priority":0,"xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"LineItemLevel":{"type":"boolean","description":"If true, certain eligible expression requirements must be met, and the PromotionDiscount will be applied at the line item level."},"Code":{"type":"string","description":"Must be unique. Entered by buyer when adding promo to order.","maxLength":100},"Name":{"type":"string","maxLength":100},"RedemptionLimit":{"type":"integer","format":"int32","description":"Limit the total number of orders this promotion can be applied to across all users."},"RedemptionLimitPerUser":{"type":"integer","format":"int32","description":"Limit the total number of orders this promotion can be applied to per user."},"RedemptionCount":{"type":"integer","format":"int32","readOnly":true,"description":"The number of times this promotion has been applied to an order."},"QuantityLimitPerOrder":{"type":"integer","format":"int32","description":"Can only be used when LineItemLevel is true and ItemLimitPerOrder does not have a value. When defined the ValueExpression will be the discount applied to each qualifying quantity of eligible items. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.","minimum":1},"ItemLimitPerOrder":{"type":"integer","format":"int32","description":"Can only be used when LineItemLevel is true and QuantityLimitPerOrder does not have a value. Limits the number of items the promotion will apply to when eligible. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.","minimum":1},"ItemSortBy":{"type":"string","description":"Comma delimited list of properties to sort by. Can only be used when ItemLimitPerOrder is true. Used to determine the order in which the promotion is applied to the specified limit of items. Use ! to reverse sort order on a property.","maxLength":200},"Description":{"type":"string","maxLength":2000},"FinePrint":{"type":"string","description":"For reference only. Terms, conditions, and other legal jargon.","maxLength":2000},"StartDate":{"type":"string","format":"date-time"},"ExpirationDate":{"type":"string","format":"date-time"},"EligibleExpression":{"type":"string","description":"The expression evaluated to determine if an item or order is eligible for a promotion. See rules engine documentation for formatting details.","maxLength":400},"ValueExpression":{"type":"string","description":"The expression evaluated to determine the discount amount of an eligible promotion. See rules engine documentation for formatting details.","maxLength":1000},"CanCombine":{"type":"boolean","description":"If true, the promotion can be applied to an order that already other promotions applied, as long as they can also be combined."},"AllowAllBuyers":{"type":"boolean","description":"Allow promo to be used by all buyers without creating explicit assignments."},"OwnerID":{"type":"string","description":"ID of the organization that owns the promotion. Only the marketplace owner can override the OwnerID on create."},"AutoApply":{"type":"boolean","default":false},"Active":{"type":"boolean","default":true},"UseIntegration":{"type":"boolean"},"Priority":{"type":"integer","format":"int32","description":"Used to control the order in which promotions are applied when calling the auto apply or refresh endpoint."},"xp":{"type":"object"}}},"PromotionAssignment":{"type":"object","example":{"PromotionID":"","BuyerID":"","UserGroupID":""},"properties":{"PromotionID":{"type":"string"},"BuyerID":{"type":"string"},"UserGroupID":{"type":"string"}}},"PromotionIntegration":{"type":"object","example":{"HashKey":"","Url":"","CustomAuthHeaderName":"","CustomAuthHeaderValue":""},"properties":{"HashKey":{"type":"string","description":"Security feature that allows your middleware to verify the digital signature in the request header to ensure you only accept trusted data.","maxLength":50},"Url":{"type":"string"},"CustomAuthHeaderName":{"type":"string","description":"The header name that can be passed to your middleware."},"CustomAuthHeaderValue":{"type":"string","description":"The header value that can be passed to your middleware."}}},"PromotionOverride":{"type":"object","example":{"PromotionID":"","Amount":0},"properties":{"PromotionID":{"type":"string"},"Amount":{"type":"number","format":"float","description":"Overrides the promotion's calculated discount to this amount."}}},"RefreshPromosResponse":{"type":"object","example":{"PromosAdded":[{"LineItemID":"","Amount":0,"ID":"","LineItemLevel":false,"Code":"","Name":"","RedemptionLimit":0,"RedemptionLimitPerUser":0,"RedemptionCount":0,"QuantityLimitPerOrder":0,"ItemLimitPerOrder":0,"ItemSortBy":"","Description":"","FinePrint":"","StartDate":"2018-01-01T00:00:00-06:00","ExpirationDate":"2018-01-01T00:00:00-06:00","EligibleExpression":"","ValueExpression":"","CanCombine":false,"AllowAllBuyers":false,"OwnerID":"","AutoApply":false,"Active":false,"UseIntegration":false,"Priority":0,"xp":{}}],"PromosRemoved":[{"ErrorCode":"","Reason":"","LineItemID":"","Amount":0,"ID":"","LineItemLevel":false,"Code":"","Name":"","RedemptionLimit":0,"RedemptionLimitPerUser":0,"RedemptionCount":0,"QuantityLimitPerOrder":0,"ItemLimitPerOrder":0,"ItemSortBy":"","Description":"","FinePrint":"","StartDate":"2018-01-01T00:00:00-06:00","ExpirationDate":"2018-01-01T00:00:00-06:00","EligibleExpression":"","ValueExpression":"","CanCombine":false,"AllowAllBuyers":false,"OwnerID":"","AutoApply":false,"Active":false,"UseIntegration":false,"Priority":0,"xp":{}}]},"properties":{"PromosAdded":{"type":"array","items":{"$ref":"#/components/schemas/AddedPromo"},"description":"Promotions that were auto-applied."},"PromosRemoved":{"type":"array","items":{"$ref":"#/components/schemas/RemovedPromo"},"description":"Promotions that were removed due to ineligibility or other reasons."}}},"RemovedPromo":{"type":"object","example":{"ErrorCode":"","Reason":"","LineItemID":"","Amount":0,"ID":"","LineItemLevel":false,"Code":"","Name":"","RedemptionLimit":0,"RedemptionLimitPerUser":0,"RedemptionCount":0,"QuantityLimitPerOrder":0,"ItemLimitPerOrder":0,"ItemSortBy":"","Description":"","FinePrint":"","StartDate":"2018-01-01T00:00:00-06:00","ExpirationDate":"2018-01-01T00:00:00-06:00","EligibleExpression":"","ValueExpression":"","CanCombine":false,"AllowAllBuyers":false,"OwnerID":"","AutoApply":false,"Active":false,"UseIntegration":false,"Priority":0,"xp":{}},"properties":{"ErrorCode":{"type":"string"},"Reason":{"type":"string"},"LineItemID":{"type":"string","maxLength":100},"Amount":{"type":"number","format":"float"},"ID":{"type":"string","maxLength":100},"LineItemLevel":{"type":"boolean","description":"If true, certain eligible expression requirements must be met, and the PromotionDiscount will be applied at the line item level."},"Code":{"type":"string","description":"Must be unique. Entered by buyer when adding promo to order.","maxLength":100},"Name":{"type":"string","maxLength":100},"RedemptionLimit":{"type":"integer","format":"int32","description":"Limit the total number of orders this promotion can be applied to across all users."},"RedemptionLimitPerUser":{"type":"integer","format":"int32","description":"Limit the total number of orders this promotion can be applied to per user."},"RedemptionCount":{"type":"integer","format":"int32","readOnly":true,"description":"The number of times this promotion has been applied to an order."},"QuantityLimitPerOrder":{"type":"integer","format":"int32","description":"Can only be used when LineItemLevel is true and ItemLimitPerOrder does not have a value. When defined the ValueExpression will be the discount applied to each qualifying quantity of eligible items. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.","minimum":1},"ItemLimitPerOrder":{"type":"integer","format":"int32","description":"Can only be used when LineItemLevel is true and QuantityLimitPerOrder does not have a value. Limits the number of items the promotion will apply to when eligible. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.","minimum":1},"ItemSortBy":{"type":"string","description":"Comma delimited list of properties to sort by. Can only be used when ItemLimitPerOrder is true. Used to determine the order in which the promotion is applied to the specified limit of items. Use ! to reverse sort order on a property.","maxLength":200},"Description":{"type":"string","maxLength":2000},"FinePrint":{"type":"string","description":"For reference only. Terms, conditions, and other legal jargon.","maxLength":2000},"StartDate":{"type":"string","format":"date-time"},"ExpirationDate":{"type":"string","format":"date-time"},"EligibleExpression":{"type":"string","description":"The expression evaluated to determine if an item or order is eligible for a promotion. See rules engine documentation for formatting details.","maxLength":400},"ValueExpression":{"type":"string","description":"The expression evaluated to determine the discount amount of an eligible promotion. See rules engine documentation for formatting details.","maxLength":1000},"CanCombine":{"type":"boolean","description":"If true, the promotion can be applied to an order that already other promotions applied, as long as they can also be combined."},"AllowAllBuyers":{"type":"boolean","description":"Allow promo to be used by all buyers without creating explicit assignments."},"OwnerID":{"type":"string","description":"ID of the organization that owns the promotion. Only the marketplace owner can override the OwnerID on create."},"AutoApply":{"type":"boolean","default":false},"Active":{"type":"boolean","default":true},"UseIntegration":{"type":"boolean"},"Priority":{"type":"integer","format":"int32","description":"Used to control the order in which promotions are applied when calling the auto apply or refresh endpoint."},"xp":{"type":"object"}}},"SearchIngestion":{"type":"object","example":{"Domain":"","Source":"","Endpoint":"","Entity":"","ApiKey":"","Content":{"Locales":[""],"Http":{"Endpoint":"","CustomAuthHeaderName":"","CustomAuthHeaderValue":""}}},"properties":{"Domain":{"type":"string"},"Source":{"type":"string"},"Endpoint":{"type":"string"},"Entity":{"type":"string"},"ApiKey":{"type":"string"},"Content":{"allOf":[{"$ref":"#/components/schemas/SearchIngestionContent"}]}}},"SearchIngestionContent":{"type":"object","example":{"Locales":[""],"Http":{"Endpoint":"","CustomAuthHeaderName":"","CustomAuthHeaderValue":""}},"properties":{"Locales":{"type":"array","items":{"type":"string"},"description":"Supported search ingestion locales."},"Http":{"allOf":[{"$ref":"#/components/schemas/SearchIngestionHttpContent"}]}}},"SearchIngestionHttpContent":{"type":"object","example":{"Endpoint":"","CustomAuthHeaderName":"","CustomAuthHeaderValue":""},"properties":{"Endpoint":{"type":"string"},"CustomAuthHeaderName":{"type":"string","description":"Security feature that allows your middleware to verify the digital signature in the request header to ensure you only accept trusted data.","maxLength":50},"CustomAuthHeaderValue":{"type":"string","description":"The header value that can be passed to your middleware."}}},"SearchType":{"type":"string","enum":["AnyTerm","AllTermsAnyField","AllTermsSameField","ExactPhrase","ExactPhrasePrefix"],"description":""},"SecurityProfile":{"type":"object","example":{"ID":"","Name":"","Roles":["ApiClientAdmin"],"CustomRoles":[""],"PasswordConfig":{"LimitPasswordReuse":0,"MaxConsecutiveDupeChars":0,"MaximumPasswordAge":0,"MinimumPasswordAge":0,"AllowedFailedAttempts":0,"LockoutDuration":0,"UpperCaseRequired":false,"LowerCaseRequired":false,"SpecialCharacterRequired":false,"NumericRequired":false,"MinimumCharacterCount":0}},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100},"Roles":{"type":"array","items":{"$ref":"#/components/schemas/ApiRole"}},"CustomRoles":{"type":"array","items":{"type":"string"}},"PasswordConfig":{"allOf":[{"$ref":"#/components/schemas/PasswordConfig"}]}}},"SecurityProfileAssignment":{"type":"object","example":{"SecurityProfileID":"","BuyerID":"","SupplierID":"","UserID":"","UserGroupID":""},"properties":{"SecurityProfileID":{"type":"string"},"BuyerID":{"type":"string"},"SupplierID":{"type":"string"},"UserID":{"type":"string"},"UserGroupID":{"type":"string"}}},"SellerApprovalRule":{"type":"object","example":{"OwnerID":"","ApprovalType":"Order","ID":"","Name":"","Description":"","ApprovingGroupID":"","RuleExpression":"","xp":{}},"properties":{"OwnerID":{"type":"string","description":"ID of the organization who owns the rule. Only the marketplace owner can write a value other than their own organization ID. The value is used to look up the ApprovingGroupID."},"ApprovalType":{"$ref":"#/components/schemas/ApprovalType","description":"OrderReturn is the only ApprovalType supported currently."},"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100},"Description":{"type":"string","maxLength":2000},"ApprovingGroupID":{"type":"string"},"RuleExpression":{"type":"string","description":"The expression evaluated to determine an order requires approval. See rules engine documentation for formatting details.","maxLength":400},"xp":{"type":"object"}}},"SendEvent":{"type":"object","example":{"SiteID":"","ServiceEndpoint":""},"properties":{"SiteID":{"type":"string"},"ServiceEndpoint":{"type":"string"}}},"ShipEstimate":{"type":"object","example":{"ID":"","xp":{},"SelectedShipMethodID":"","ShipEstimateItems":[{"LineItemID":"","Quantity":0}],"ShipMethods":[{"ID":"","Name":"","Cost":0,"EstimatedTransitDays":0,"xp":{}}]},"properties":{"ID":{"type":"string"},"xp":{"type":"object"},"SelectedShipMethodID":{"type":"string"},"ShipEstimateItems":{"type":"array","items":{"$ref":"#/components/schemas/ShipEstimateItem"}},"ShipMethods":{"type":"array","items":{"$ref":"#/components/schemas/ShipMethod"}}}},"ShipEstimateItem":{"type":"object","example":{"LineItemID":"","Quantity":0},"properties":{"LineItemID":{"type":"string"},"Quantity":{"type":"integer","format":"int32"}}},"ShipEstimateResponse":{"type":"object","example":{"ShipEstimates":[{"ID":"","xp":{},"SelectedShipMethodID":"","ShipEstimateItems":[{"LineItemID":"","Quantity":0}],"ShipMethods":[{"ID":"","Name":"","Cost":0,"EstimatedTransitDays":0,"xp":{}}]}],"HttpStatusCode":0,"UnhandledErrorBody":"","xp":{},"Succeeded":false},"properties":{"ShipEstimates":{"type":"array","items":{"$ref":"#/components/schemas/ShipEstimate"}},"HttpStatusCode":{"type":"integer","format":"int32"},"UnhandledErrorBody":{"type":"string"},"xp":{"type":"object"},"Succeeded":{"type":"boolean"}}},"Shipment":{"type":"object","example":{"ID":"","BuyerID":"","Shipper":"","DateShipped":"2018-01-01T00:00:00-06:00","DateDelivered":"2018-01-01T00:00:00-06:00","TrackingNumber":"","Cost":0,"OwnerID":"","xp":{},"Account":"","FromAddressID":"","ToAddressID":"","FromAddress":{"ID":"","DateCreated":"2018-01-01T00:00:00-06:00","CompanyName":"","FirstName":"","LastName":"","Street1":"","Street2":"","City":"","State":"","Zip":"","Country":"","Phone":"","AddressName":"","xp":{}},"ToAddress":{"ID":"","DateCreated":"2018-01-01T00:00:00-06:00","CompanyName":"","FirstName":"","LastName":"","Street1":"","Street2":"","City":"","State":"","Zip":"","Country":"","Phone":"","AddressName":"","xp":{}}},"properties":{"ID":{"type":"string","maxLength":100},"BuyerID":{"type":"string"},"Shipper":{"type":"string","description":"For reference only, does not influence any OrderCloud behavior."},"DateShipped":{"type":"string","format":"date-time","description":"In order to properly trigger OrderShipped emails, this date must be NULL on initial create. Update with the date only when all of the Shipment items have been created. Once all of an order's items exist on a shipment that has a DateShipped populated the OrderShipped message sender will trigger and Order.Status will be updated to Complete."},"DateDelivered":{"type":"string","format":"date-time"},"TrackingNumber":{"type":"string","maxLength":3000},"Cost":{"type":"number","format":"float","description":"For reference only, does not influence any OrderCloud behavior."},"OwnerID":{"type":"string","description":"ID of the organization that owns the shipment. Only the marketplace owner can override the OwnerID on create."},"xp":{"type":"object"},"Account":{"type":"string"},"FromAddressID":{"type":"string","description":"Marketplace owner or supplier AddressID where the product will be shipped from."},"ToAddressID":{"type":"string"},"FromAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"readOnly":true},"ToAddress":{"allOf":[{"$ref":"#/components/schemas/Address"}],"readOnly":true}}},"ShipmentItem":{"type":"object","example":{"OrderID":"","LineItemID":"","QuantityShipped":0,"UnitPrice":0,"CostCenter":"","DateNeeded":"2018-01-01T00:00:00-06:00","Product":{"ID":"","Name":"","Description":"","Returnable":false,"QuantityMultiplier":0,"ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"DefaultSupplierID":"","ParentID":"","xp":{}},"Variant":{"ID":"","Name":"","Description":"","ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"xp":{}},"Specs":[{"SpecID":"","Name":"","OptionID":"","Value":"","PriceMarkupType":"NoMarkup","PriceMarkup":0}],"xp":{}},"properties":{"OrderID":{"type":"string"},"LineItemID":{"type":"string"},"QuantityShipped":{"type":"integer","format":"int32"},"UnitPrice":{"type":"number","format":"float","readOnly":true},"CostCenter":{"type":"string","readOnly":true},"DateNeeded":{"type":"string","format":"date-time","readOnly":true},"Product":{"allOf":[{"$ref":"#/components/schemas/LineItemProduct"}],"readOnly":true},"Variant":{"allOf":[{"$ref":"#/components/schemas/LineItemVariant"}],"readOnly":true},"Specs":{"type":"array","items":{"$ref":"#/components/schemas/LineItemSpec"},"readOnly":true},"xp":{"type":"object","readOnly":true,"description":"For reference only, represents line item XP from the given line item ID"}}},"ShipMethod":{"type":"object","example":{"ID":"","Name":"","Cost":0,"EstimatedTransitDays":0,"xp":{}},"properties":{"ID":{"type":"string"},"Name":{"type":"string"},"Cost":{"type":"number","format":"float"},"EstimatedTransitDays":{"type":"integer","format":"int32"},"xp":{"type":"object"}}},"ShipMethodSelection":{"type":"object","example":{"ShipEstimateID":"","ShipMethodID":""},"properties":{"ShipEstimateID":{"type":"string"},"ShipMethodID":{"type":"string"}}},"Spec":{"type":"object","example":{"OwnerID":"","ID":"","ListOrder":1,"Name":"","DefaultValue":"","Required":false,"AllowOpenText":false,"DefaultOptionID":"","DefinesVariant":false,"xp":{},"OptionCount":0,"Options":[{"ID":"","Value":"","ListOrder":1,"IsOpenText":false,"PriceMarkupType":"NoMarkup","PriceMarkup":0,"xp":{}}]},"properties":{"OwnerID":{"type":"string","description":"ID of the organization that owns the spec. Only the marketplace owner can override the OwnerID on create."},"ID":{"type":"string","maxLength":100},"ListOrder":{"type":"integer","format":"int32"},"Name":{"type":"string"},"DefaultValue":{"type":"string","description":"If no value is passed in the line item spec, this value will be used.","maxLength":2000},"Required":{"type":"boolean"},"AllowOpenText":{"type":"boolean","description":"For spec options that are not pre-defined, such as FirstName for a business card."},"DefaultOptionID":{"type":"string","description":"This property can only be written to after both the spec and options have been created. If no Spec.OptionID is passed in the line item spec, this option will be used."},"DefinesVariant":{"type":"boolean","description":"If true, each unique combinations of this spec's options should map to a unique product variant."},"xp":{"type":"object"},"OptionCount":{"type":"integer","format":"int32","readOnly":true},"Options":{"type":"array","items":{"$ref":"#/components/schemas/SpecOption"},"readOnly":true}}},"SpecOption":{"type":"object","example":{"ID":"","Value":"","ListOrder":1,"IsOpenText":false,"PriceMarkupType":"NoMarkup","PriceMarkup":0,"xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"Value":{"type":"string","maxLength":2000},"ListOrder":{"type":"integer","format":"int32"},"IsOpenText":{"type":"boolean"},"PriceMarkupType":{"$ref":"#/components/schemas/PriceMarkupType","description":"Used to change the price of a product when a specific spec option is selected."},"PriceMarkup":{"type":"number","format":"float"},"xp":{"type":"object"}}},"SpecProductAssignment":{"type":"object","example":{"SpecID":"","ProductID":"","DefaultValue":"","DefaultOptionID":""},"properties":{"SpecID":{"type":"string"},"ProductID":{"type":"string"},"DefaultValue":{"type":"string","description":"When defined, overrides the DefaultValue set on the spec for this product only.","maxLength":2000},"DefaultOptionID":{"type":"string","description":"When defined, overrides the DefaultOptionID set on the spec for this product only."}}},"SpendingAccount":{"type":"object","example":{"ID":"","Name":"","Balance":0,"AllowAsPaymentMethod":false,"StartDate":"2018-01-01T00:00:00-06:00","EndDate":"2018-01-01T00:00:00-06:00","xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100},"Balance":{"type":"number","format":"float"},"AllowAsPaymentMethod":{"type":"boolean","description":"If true, a payment can be created referencing the SpendingAccountID."},"StartDate":{"type":"string","format":"date-time"},"EndDate":{"type":"string","format":"date-time"},"xp":{"type":"object"}}},"SpendingAccountAssignment":{"type":"object","example":{"SpendingAccountID":"","UserID":"","UserGroupID":"","AllowExceed":false},"properties":{"SpendingAccountID":{"type":"string"},"UserID":{"type":"string"},"UserGroupID":{"type":"string"},"AllowExceed":{"type":"boolean","description":"If true, a user can place an order for an amount greater than the available balance, causing the balance to go negative."}}},"Subscription":{"type":"object","example":{"ID":"","Frequency":0,"Interval":"Days","NextOrderDate":"2018-01-01T00:00:00-06:00","LastOrderDate":"2018-01-01T00:00:00-06:00","NotificationDate":"2018-01-01T00:00:00-06:00","DateCreated":"2018-01-01T00:00:00-06:00","EndDate":"2018-01-01T00:00:00-06:00","Active":false,"FromCompanyID":"","FromUserID":"","ToCompanyID":"","Payment":{"Type":"PurchaseOrder","CreditCardID":"","SpendingAccountID":""},"BillingAddressID":"","ShippingAddressID":"","ProjectedSubtotal":0,"xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"Frequency":{"type":"integer","format":"int32","description":"Used to define how often to process the subscription. The subscription will process once every {Frequency} {Interval}."},"Interval":{"$ref":"#/components/schemas/SubscriptionInterval","description":"Used to define how often to process the subscription. The subscription will process once every {Frequency} {Interval}."},"NextOrderDate":{"type":"string","format":"date-time","description":"Next order date of the subscription. The hourly process that creates subscription orders will query for subscriptions with a NextOrderDate between now and five hours ago."},"LastOrderDate":{"type":"string","format":"date-time","readOnly":true},"NotificationDate":{"type":"string","format":"date-time","readOnly":true,"description":"Date that subscription order reminder message sender will be triggered if used. Value is the result of NextOrderDate less NotificationDays on the subscription integration."},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"EndDate":{"type":"string","format":"date-time"},"Active":{"type":"boolean","default":true},"FromCompanyID":{"type":"string","description":"Only use when creating a subscription on behalf of another user. ID of the buyer or marketplace owner placing the order."},"FromUserID":{"type":"string","description":"Only use when creating a subscription on behalf of a another user."},"ToCompanyID":{"type":"string","description":"ID of the marketplace owner or supplier receiving the order created by this subscription, only writable on create."},"Payment":{"allOf":[{"$ref":"#/components/schemas/SubscriptionPayment"}]},"BillingAddressID":{"type":"string"},"ShippingAddressID":{"type":"string"},"ProjectedSubtotal":{"type":"number","format":"float","readOnly":true,"description":"Tentative subtotal of next subscription order. Based on current known pricing; avoid if product or pricing is provided by an external integration."},"xp":{"type":"object"}}},"SubscriptionIntegration":{"type":"object","example":{"ApiClientID":"","HashKey":"","ElevatedRoles":["ApiClientAdmin"],"Active":false,"NotificationDays":0,"Url":"","xp":{},"CustomAuthHeaderName":"","CustomAuthHeaderValue":""},"properties":{"ApiClientID":{"type":"string","description":"ID of the API client that will be used to generate the token passed to your hosted application via subscription integration."},"HashKey":{"type":"string","description":"Security feature that allows your middleware to verify the digital signature in the request header to ensure you only accept trusted data.","maxLength":50},"ElevatedRoles":{"type":"array","items":{"$ref":"#/components/schemas/ApiRole"}},"Active":{"type":"boolean"},"NotificationDays":{"type":"integer","format":"int32","minimum":1},"Url":{"type":"string"},"xp":{"type":"object"},"CustomAuthHeaderName":{"type":"string","description":"The header name that can be passed to your middleware."},"CustomAuthHeaderValue":{"type":"string","description":"The header value that can be passed to your middleware."}}},"SubscriptionIntegrationResponse":{"type":"object","example":{"HttpStatusCode":0,"UnhandledErrorBody":"","xp":{},"Succeeded":false},"properties":{"HttpStatusCode":{"type":"integer","format":"int32"},"UnhandledErrorBody":{"type":"string"},"xp":{"type":"object"},"Succeeded":{"type":"boolean"}}},"SubscriptionInterval":{"type":"string","enum":["Days","Weeks","Months"],"description":""},"SubscriptionPayment":{"type":"object","example":{"Type":"PurchaseOrder","CreditCardID":"","SpendingAccountID":""},"properties":{"Type":{"$ref":"#/components/schemas/PaymentType"},"CreditCardID":{"type":"string"},"SpendingAccountID":{"type":"string"}}},"Supplier":{"type":"object","example":{"ID":"","Name":"","Active":false,"DateCreated":"2018-01-01T00:00:00-06:00","AllBuyersCanOrder":false,"xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100},"Active":{"type":"boolean","description":"If false, all user authentication is blocked."},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"AllBuyersCanOrder":{"type":"boolean","description":"If false, buyers will only be able to set ToCompanyID on an order to the marketplace owner, or suppliers they have an explicit relationship to."},"xp":{"type":"object"}}},"SupplierBuyer":{"type":"object","example":{"ID":"","Name":""},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100}}},"SyncAdminUser":{"type":"object","example":{"UserID":""},"properties":{"UserID":{"type":"string"}}},"SyncBuyer":{"type":"object","example":{"BuyerID":""},"properties":{"BuyerID":{"type":"string"}}},"SyncBuyerUser":{"type":"object","example":{"BuyerID":"","UserID":""},"properties":{"BuyerID":{"type":"string"},"UserID":{"type":"string"}}},"SyncBuyerUserGroup":{"type":"object","example":{"BuyerID":"","UserGroupID":""},"properties":{"BuyerID":{"type":"string"},"UserGroupID":{"type":"string"}}},"SyncCategory":{"type":"object","example":{"CatalogID":"","CategoryID":""},"properties":{"CatalogID":{"type":"string"},"CategoryID":{"type":"string"}}},"SyncInventoryRecord":{"type":"object","example":{"ProductID":"","InventoryRecordID":""},"properties":{"ProductID":{"type":"string"},"InventoryRecordID":{"type":"string"}}},"SyncProduct":{"type":"object","example":{"ProductID":""},"properties":{"ProductID":{"type":"string"}}},"SyncSupplier":{"type":"object","example":{"SupplierID":""},"properties":{"SupplierID":{"type":"string"}}},"SyncSupplierUser":{"type":"object","example":{"SupplierID":"","UserID":""},"properties":{"SupplierID":{"type":"string"},"UserID":{"type":"string"}}},"TokenPasswordReset":{"type":"object","example":{"NewPassword":""},"properties":{"NewPassword":{"type":"string","format":"password"}}},"TrackingEvent":{"type":"object","example":{"ID":"","EventType":"UserLoggedIn","ClientID":"","Name":"","ConfigData":{},"DeliveryConfigID":""},"properties":{"ID":{"type":"string","maxLength":100},"EventType":{"$ref":"#/components/schemas/TrackingEventType"},"ClientID":{"type":"string"},"Name":{"type":"string"},"ConfigData":{"type":"object"},"DeliveryConfigID":{"type":"string"}}},"TrackingEventType":{"type":"string","enum":["UserLoggedIn","LineItemAdded","LineItemUpdated","OrderSubmitted"],"description":""},"UnavailableLineItem":{"type":"object","example":{"ProductID":"","Error":{"ErrorCode":"","Message":"","Data":{}}},"properties":{"ProductID":{"type":"string","description":"ID of the product or bundle that could not be added to the new order."},"Error":{"allOf":[{"$ref":"#/components/schemas/ApiError"}],"description":"The error indicating why the item could not be added."}}},"User":{"type":"object","example":{"FailedLoginAttempts":0,"ID":"","CompanyID":"","Username":"","Password":"","FirstName":"","LastName":"","Email":"","Phone":"","TermsAccepted":"2018-01-01T00:00:00-06:00","Active":false,"xp":{},"AvailableRoles":[""],"Locale":{"ID":"","OwnerID":"","Currency":"","Language":""},"DateCreated":"2018-01-01T00:00:00-06:00","LastActive":"2018-01-01T00:00:00-06:00","PasswordLastSetDate":"2018-01-01T00:00:00-06:00"},"properties":{"FailedLoginAttempts":{"type":"integer","format":"int32","readOnly":true,"description":"Number of times the user failed authentication due to incorrect password since last successful attempt, or since being unlocked."},"ID":{"type":"string","maxLength":100},"CompanyID":{"type":"string","readOnly":true},"Username":{"type":"string","description":"Must be unique across all organizations.","maxLength":100},"Password":{"type":"string","format":"password"},"FirstName":{"type":"string","maxLength":100},"LastName":{"type":"string","maxLength":100},"Email":{"type":"string","maxLength":200},"Phone":{"type":"string","maxLength":100},"TermsAccepted":{"type":"string","format":"date-time"},"Active":{"type":"boolean","description":"If false, authentication is prohibited."},"xp":{"type":"object"},"AvailableRoles":{"type":"array","items":{"type":"string"},"readOnly":true,"description":"List of roles currently available to the user via all security profile assignments."},"Locale":{"allOf":[{"$ref":"#/components/schemas/Locale"}],"readOnly":true,"description":"Most specific locale assigned to the user, if any."},"DateCreated":{"type":"string","format":"date-time","readOnly":true},"LastActive":{"type":"string","format":"date-time","readOnly":true,"description":"Accurate within a few minutes. Includes impersonation activity."},"PasswordLastSetDate":{"type":"string","format":"date-time","readOnly":true,"description":"Can be used in conjunction with SecurityProfile.PasswordConfig to enforce password reset schedules."}}},"UserGroup":{"type":"object","example":{"ID":"","Name":"","Description":"","xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100},"Description":{"type":"string","maxLength":2000},"xp":{"type":"object"}}},"UserGroupAssignment":{"type":"object","example":{"UserGroupID":"","UserID":""},"properties":{"UserGroupID":{"type":"string"},"UserID":{"type":"string"}}},"UserOrderMoveOption":{"type":"string","enum":["None","Unsubmitted","All"],"description":""},"Variant":{"type":"object","example":{"ID":"","Name":"","Description":"","Active":false,"ShipWeight":0,"ShipHeight":0,"ShipWidth":0,"ShipLength":0,"Inventory":{"QuantityAvailable":0,"NotificationPoint":0,"LastUpdated":"2018-01-01T00:00:00-06:00"},"Specs":[{"SpecID":"","Name":"","OptionID":"","Value":"","PriceMarkupType":"NoMarkup","PriceMarkup":0}],"xp":{}},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string","maxLength":100},"Description":{"type":"string","maxLength":2000},"Active":{"type":"boolean","description":"If false, variant is not visible or purchasable from a buyer's perspective."},"ShipWeight":{"type":"number","format":"float"},"ShipHeight":{"type":"number","format":"float"},"ShipWidth":{"type":"number","format":"float"},"ShipLength":{"type":"number","format":"float"},"Inventory":{"allOf":[{"$ref":"#/components/schemas/VariantInventory"}]},"Specs":{"type":"array","items":{"$ref":"#/components/schemas/VariantSpec"},"readOnly":true},"xp":{"type":"object"}}},"VariantInventory":{"type":"object","example":{"QuantityAvailable":0,"NotificationPoint":0,"LastUpdated":"2018-01-01T00:00:00-06:00"},"properties":{"QuantityAvailable":{"type":"integer","format":"int32"},"NotificationPoint":{"type":"integer","format":"int32"},"LastUpdated":{"type":"string","format":"date-time","readOnly":true}}},"VariantOverrides":{"type":"object","example":{"Active":false},"properties":{"Active":{"type":"boolean","default":true,"description":"Overrides the Active value inherited from the product when generating variants."}}},"VariantSpec":{"type":"object","example":{"SpecID":"","Name":"","OptionID":"","Value":"","PriceMarkupType":"NoMarkup","PriceMarkup":0},"properties":{"SpecID":{"type":"string"},"Name":{"type":"string","readOnly":true},"OptionID":{"type":"string"},"Value":{"type":"string","maxLength":2000},"PriceMarkupType":{"$ref":"#/components/schemas/PriceMarkupType"},"PriceMarkup":{"type":"number","format":"float"}}},"Webhook":{"type":"object","example":{"ID":"","Name":"","Description":"","Url":"","HashKey":"","ElevatedRoles":["ApiClientAdmin"],"ConfigData":{},"BeforeProcessRequest":false,"ApiClientIDs":[""],"WebhookRoutes":[{"Route":"","Verb":""}],"DeliveryConfigID":"","CustomAuthHeaderName":"","CustomAuthHeaderValue":""},"properties":{"ID":{"type":"string","maxLength":100},"Name":{"type":"string"},"Description":{"type":"string","maxLength":2000},"Url":{"type":"string","description":"URL the webhook will POST data to, likely a route within your middleware. Required unless there is a valid DeliveryConfig."},"HashKey":{"type":"string","description":"Security feature that allows your middleware to verify the digital signature in the request header to ensure you only accept trusted data.","maxLength":50},"ElevatedRoles":{"type":"array","items":{"$ref":"#/components/schemas/ApiRole"},"description":"If you need additional data not provided by the webhook payload, you can request any elevated roles needed to make additional calls."},"ConfigData":{"type":"object"},"BeforeProcessRequest":{"type":"boolean","description":"If true, the webhook is processed prior to the call being made and OrderCloud waits for a response before proceeding."},"ApiClientIDs":{"type":"array","items":{"type":"string"},"description":"List of API client IDs the webhook will be triggered for."},"WebhookRoutes":{"type":"array","items":{"$ref":"#/components/schemas/WebhookRoute"},"description":"List of routes the webhook will be triggered for."},"DeliveryConfigID":{"type":"string"},"CustomAuthHeaderName":{"type":"string","description":"The header name that can be passed to your middleware."},"CustomAuthHeaderValue":{"type":"string","description":"The header value that can be passed to your middleware."}}},"WebhookRoute":{"type":"object","example":{"Route":"","Verb":""},"properties":{"Route":{"type":"string"},"Verb":{"type":"string"}}},"XpIndex":{"type":"object","example":{"ThingType":"Address","Key":""},"properties":{"ThingType":{"$ref":"#/components/schemas/XpThingType"},"Key":{"type":"string"}}},"XpThingType":{"type":"string","enum":["Address","Variant","Order","OrderReturn","LineItem","CostCenter","CreditCard","Payment","Spec","SpecOption","UserGroup","Company","Category","PriceSchedule","Shipment","SpendingAccount","User","Promotion","ApprovalRule","SellerApprovalRule","Catalog","ProductFacet","MessageSender","InventoryRecord","ProductCollection","Subscription","GroupOrderInvitation","BuyerGroup","Discount"],"description":""}}},"paths":{"/addresses":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminAddresses.List","tags":["Admin addresses"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","AddressName","CompanyName","City","Street1","Street2","LastName","FirstName","State","Zip"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["AddressName","ID","DateCreated","CompanyName","FirstName","LastName","Street1","Street2","City","State","Zip","Country","Phone","!AddressName","!ID","!DateCreated","!CompanyName","!FirstName","!LastName","!Street1","!Street2","!City","!State","!Zip","!Country","!Phone"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List admin addresses","description":"","security":[{"OAuth2":["FullAccess","AdminAddressAdmin","AdminAddressReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminAddresses.Create","tags":["Admin addresses"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}],"required":["Street1","City","Country"]}}}},"summary":"Create an admin address","description":"","security":[{"OAuth2":["FullAccess","AdminAddressAdmin"]}]}},"/addresses/{addressID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminAddresses.Get","tags":["Admin addresses"],"parameters":[{"name":"addressID","in":"path","description":"ID of the address.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve an admin address","description":"","security":[{"OAuth2":["FullAccess","AdminAddressAdmin","AdminAddressReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminAddresses.Save","tags":["Admin addresses"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}],"required":["Street1","City","Country"]}}}},"parameters":[{"name":"addressID","in":"path","description":"ID of the address.","required":true,"schema":{"type":"string"}}],"summary":"Create or update an admin address","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","AdminAddressAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminAddresses.Delete","tags":["Admin addresses"],"parameters":[{"name":"addressID","in":"path","description":"ID of the address.","required":true,"schema":{"type":"string"}}],"summary":"Delete an admin address","description":"","security":[{"OAuth2":["FullAccess","AdminAddressAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminAddresses.Patch","tags":["Admin addresses"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}]}}}},"parameters":[{"name":"addressID","in":"path","description":"ID of the address.","required":true,"schema":{"type":"string"}}],"summary":"Partially update an admin address","description":"","security":[{"OAuth2":["FullAccess","AdminAddressAdmin"]}]}},"/adminusers":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminUsers.List","tags":["Admin users"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Username","LastName","FirstName","Email"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["LastName","FirstName","Username","ID","Email","DateCreated","LastActive","PasswordLastSetDate","!LastName","!FirstName","!Username","!ID","!Email","!DateCreated","!LastActive","!PasswordLastSetDate"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List admin users","description":"","security":[{"OAuth2":["FullAccess","AdminUserAdmin","AdminUserReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminUsers.Create","tags":["Admin users"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/User"}],"required":["Username","FirstName","LastName","Email","Active"]}}}},"summary":"Create an admin user","description":"","security":[{"OAuth2":["FullAccess","AdminUserAdmin"]}]}},"/adminusers/{userID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminUsers.Get","tags":["Admin users"],"parameters":[{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve an admin user","description":"","security":[{"OAuth2":["FullAccess","AdminUserAdmin","AdminUserReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminUsers.Save","tags":["Admin users"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/User"}],"required":["Username","FirstName","LastName","Email","Active"]}}}},"parameters":[{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Create or update an admin user","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","AdminUserAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminUsers.Delete","tags":["Admin users"],"parameters":[{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Delete an admin user","description":"","security":[{"OAuth2":["FullAccess","AdminUserAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminUsers.Patch","tags":["Admin users"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/User"}]}}}},"parameters":[{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Partially update an admin user","description":"","security":[{"OAuth2":["FullAccess","AdminUserAdmin"]}]}},"/adminusers/{userID}/tokens":{"delete":{"responses":{"204":{"description":"Revokes all security tokens of specified user."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminUsers.RevokeUserTokens","tags":["Admin users"],"parameters":[{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Revoke a user tokens","description":"Revokes all security tokens of specified user.","security":[{"OAuth2":["FullAccess","AdminUserAdmin"]}],"x-limitAnonUser":true}},"/adminusers/{userID}/unlock":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminUsers.UnlockUserAccount","tags":["Admin users"],"parameters":[{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Unlock a user account","description":"","security":[{"OAuth2":["FullAccess","AdminUserAdmin"]}]}},"/apiclients":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ApiClient"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApiClients.List","tags":["API clients"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","AppName","DefaultContextUserName"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","AppName","DefaultContextUserName","!ID","!AppName","!DefaultContextUserName"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List API clients","description":"","security":[{"OAuth2":["FullAccess","ApiClientAdmin","ApiClientReader"]}],"x-authorizedUserTypes":["Seller"]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiClient"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApiClients.Create","tags":["API clients"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiClient"}],"required":["AccessTokenDuration","AppName"]}}}},"summary":"Create an API client","description":"","security":[{"OAuth2":["FullAccess","ApiClientAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/apiclients/{apiClientID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiClient"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApiClients.Get","tags":["API clients"],"parameters":[{"name":"apiClientID","in":"path","description":"ID of the api client.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve an API client","description":"","security":[{"OAuth2":["FullAccess","ApiClientAdmin","ApiClientReader"]}],"x-authorizedUserTypes":["Seller"]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiClient"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApiClients.Save","tags":["API clients"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiClient"}],"required":["AccessTokenDuration","AppName"]}}}},"parameters":[{"name":"apiClientID","in":"path","description":"ID of the api client.","required":true,"schema":{"type":"string"}}],"summary":"Create or update an API client","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","ApiClientAdmin"]}],"x-authorizedUserTypes":["Seller"]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApiClients.Delete","tags":["API clients"],"parameters":[{"name":"apiClientID","in":"path","description":"ID of the api client.","required":true,"schema":{"type":"string"}}],"summary":"Delete an API client","description":"","security":[{"OAuth2":["FullAccess","ApiClientAdmin"]}],"x-authorizedUserTypes":["Seller"]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiClient"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApiClients.Patch","tags":["API clients"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiClient"}]}}}},"parameters":[{"name":"apiClientID","in":"path","description":"ID of the api client.","required":true,"schema":{"type":"string"}}],"summary":"Partially update an API client","description":"","security":[{"OAuth2":["FullAccess","ApiClientAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/apiclients/{apiClientID}/secrets":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ApiClientSecret"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApiClients.ListSecrets","tags":["API clients"],"parameters":[{"name":"apiClientID","in":"path","description":"ID of the api client.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List API client secrets","description":"","security":[{"OAuth2":["FullAccess","ApiClientAdmin"]}],"x-authorizedUserTypes":["Seller"]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiClientSecretCreateResponse"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApiClients.CreateSecret","tags":["API clients"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiClientSecret"}],"required":["Name"]}}}},"parameters":[{"name":"apiClientID","in":"path","description":"ID of the api client.","required":true,"schema":{"type":"string"}}],"summary":"Create an API client secret","description":"","security":[{"OAuth2":["FullAccess","ApiClientAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/apiclients/{apiClientID}/secrets/{apiClientSecretID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiClientSecret"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApiClients.GetSecret","tags":["API clients"],"parameters":[{"name":"apiClientID","in":"path","description":"ID of the api client.","required":true,"schema":{"type":"string"}},{"name":"apiClientSecretID","in":"path","description":"ID of the api client secret.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve an API client secret","description":"","security":[{"OAuth2":["FullAccess","ApiClientAdmin"]}],"x-authorizedUserTypes":["Seller"]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApiClients.DeleteSecret","tags":["API clients"],"parameters":[{"name":"apiClientID","in":"path","description":"ID of the api client.","required":true,"schema":{"type":"string"}},{"name":"apiClientSecretID","in":"path","description":"ID of the api client secret.","required":true,"schema":{"type":"string"}}],"summary":"Delete an API client secret","description":"","security":[{"OAuth2":["FullAccess","ApiClientAdmin"]}],"x-authorizedUserTypes":["Seller"]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiClientSecret"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApiClients.PatchSecret","tags":["API clients"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiClientSecret"}]}}}},"parameters":[{"name":"apiClientID","in":"path","description":"ID of the api client.","required":true,"schema":{"type":"string"}},{"name":"apiClientSecretID","in":"path","description":"ID of the api client secret.","required":true,"schema":{"type":"string"}}],"summary":"Partially update an API client secret","description":"","security":[{"OAuth2":["FullAccess","ApiClientAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/apiclients/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ApiClientAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApiClients.ListAssignments","tags":["API clients"],"parameters":[{"name":"apiClientID","in":"query","description":"ID of the api client.","required":false,"schema":{"type":"string"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":false,"schema":{"type":"string"}},{"name":"supplierID","in":"query","description":"ID of the supplier.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20}}],"summary":"List API client assignments","description":"","security":[{"OAuth2":["FullAccess","ApiClientAdmin","ApiClientReader"]}],"x-authorizedUserTypes":["Seller"]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApiClients.SaveAssignment","tags":["API clients"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApiClientAssignment"}],"required":["ApiClientID"]}}}},"summary":"Create or update an API client assignment","description":"","security":[{"OAuth2":["FullAccess","ApiClientAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/approvalrules":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/SellerApprovalRule"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SellerApprovalRules.List","tags":["Seller approval rules"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Description","RuleExpression"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","ApprovingGroupID","RuleExpression","!Name","!ID","!ApprovingGroupID","!RuleExpression"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List seller approval rules","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","ApprovalRuleReader"]}],"x-authorizedUserTypes":["Seller","Supplier"]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerApprovalRule"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SellerApprovalRules.Create","tags":["Seller approval rules"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SellerApprovalRule"}],"required":["ApprovalType","ApprovingGroupID","RuleExpression"]}}}},"summary":"Create a seller approval rule","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin"]}],"x-authorizedUserTypes":["Seller","Supplier"]}},"/approvalrules/{approvalRuleID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerApprovalRule"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SellerApprovalRules.Get","tags":["Seller approval rules"],"parameters":[{"name":"approvalRuleID","in":"path","description":"ID of the approval rule.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a seller approval rule","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","ApprovalRuleReader"]}],"x-authorizedUserTypes":["Seller","Supplier"]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerApprovalRule"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SellerApprovalRules.Save","tags":["Seller approval rules"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SellerApprovalRule"}],"required":["ApprovalType","ApprovingGroupID","RuleExpression"]}}}},"parameters":[{"name":"approvalRuleID","in":"path","description":"ID of the approval rule.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a seller approval rule","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","OrderAdmin"]}],"x-authorizedUserTypes":["Seller","Supplier"]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SellerApprovalRules.Delete","tags":["Seller approval rules"],"parameters":[{"name":"approvalRuleID","in":"path","description":"ID of the approval rule.","required":true,"schema":{"type":"string"}}],"summary":"Delete a seller approval rule","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin"]}],"x-authorizedUserTypes":["Seller","Supplier"]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SellerApprovalRule"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SellerApprovalRules.Patch","tags":["Seller approval rules"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SellerApprovalRule"}]}}}},"parameters":[{"name":"approvalRuleID","in":"path","description":"ID of the approval rule.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a seller approval rule","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin"]}],"x-authorizedUserTypes":["Seller","Supplier"]}},"/bundles":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Bundle"}},"Meta":{"$ref":"#/components/schemas/MetaWithFacets"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Bundles.List","tags":["Bundles"],"parameters":[{"name":"catalogID","in":"query","description":"ID of the catalog.","required":false,"schema":{"type":"string"}},{"name":"categoryID","in":"query","description":"ID of the category.","required":false,"schema":{"type":"string"}},{"name":"supplierID","in":"query","description":"ID of the supplier.","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Description"]}}},{"name":"searchType","in":"query","description":"Type of search to perform.","required":false,"schema":{"$ref":"#/components/schemas/SearchType","default":"AnyTerm"}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["OwnerID","Name","ID","!OwnerID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List bundles","description":"","security":[{"OAuth2":["FullAccess","BundleAdmin","BundleReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bundle"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Bundles.Create","tags":["Bundles"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Bundle"}],"required":["Name"]}}}},"summary":"Create a bundle","description":"","security":[{"OAuth2":["FullAccess","BundleAdmin"]}]}},"/bundles/{bundleID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bundle"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Bundles.Get","tags":["Bundles"],"parameters":[{"name":"bundleID","in":"path","description":"ID of the bundle.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a bundle","description":"","security":[{"OAuth2":["FullAccess","BundleAdmin","BundleReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bundle"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Bundles.Save","tags":["Bundles"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Bundle"}],"required":["Name"]}}}},"parameters":[{"name":"bundleID","in":"path","description":"ID of the bundle.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a bundle","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","BundleAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Bundles.Delete","tags":["Bundles"],"parameters":[{"name":"bundleID","in":"path","description":"ID of the bundle.","required":true,"schema":{"type":"string"}}],"summary":"Delete a bundle","description":"","security":[{"OAuth2":["FullAccess","BundleAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bundle"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Bundles.Patch","tags":["Bundles"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Bundle"}]}}}},"parameters":[{"name":"bundleID","in":"path","description":"ID of the bundle.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a bundle","description":"","security":[{"OAuth2":["FullAccess","BundleAdmin"]}]}},"/bundles/{bundleID}/assignments/{buyerID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Bundles.DeleteAssignment","tags":["Bundles"],"parameters":[{"name":"bundleID","in":"path","description":"ID of the bundle.","required":true,"schema":{"type":"string"}},{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"sellerID","in":"query","description":"ID of the seller.","required":false,"schema":{"type":"string"}}],"summary":"Delete a bundle assignment","description":"","security":[{"OAuth2":["FullAccess","BundleAdmin","BundleAssignmentAdmin"]}]}},"/bundles/{bundleID}/productassignments/{productID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Bundles.DeleteProductAssignment","tags":["Bundles"],"parameters":[{"name":"bundleID","in":"path","description":"ID of the bundle.","required":true,"schema":{"type":"string"}},{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}}],"summary":"Delete a bundle product assignment","description":"","security":[{"OAuth2":["FullAccess","BundleAdmin","BundleAssignmentAdmin"]}]}},"/bundles/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/BundleAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Bundles.ListAssignments","tags":["Bundles"],"parameters":[{"name":"bundleID","in":"query","description":"ID of the bundle.","required":false,"schema":{"type":"string"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Level of the bundle assignment. Possible values: Group, Company, BuyerGroup.","required":false,"schema":{"type":"string","enum":["Group","Company"]}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}}],"summary":"List bundle assignments","description":"","security":[{"OAuth2":["FullAccess","BundleAdmin","BundleAssignmentAdmin"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Bundles.SaveAssignment","tags":["Bundles"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BundleAssignment"}],"required":["BundleID","BuyerID"]}}}},"summary":"Create or update a bundle assignment","description":"","security":[{"OAuth2":["FullAccess","BundleAdmin","BundleAssignmentAdmin"]}]}},"/bundles/productassignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/BundleProductAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Bundles.ListProductAssignments","tags":["Bundles"],"parameters":[{"name":"bundleID","in":"query","description":"ID of the bundle.","required":false,"schema":{"type":"string"}},{"name":"productID","in":"query","description":"ID of the product.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20}}],"summary":"List bundle product assignments","description":"","security":[{"OAuth2":["FullAccess","BundleAdmin"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Bundles.SaveProductAssignment","tags":["Bundles"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BundleProductAssignment"}],"required":["ProductID","BundleID","Required"]}}}},"summary":"Create or update a bundle product assignment","description":"","security":[{"OAuth2":["FullAccess","BundleAdmin","BundleAssignmentAdmin"]}]}},"/buyergroups":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/BuyerGroup"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"BuyerGroups.List","tags":["Buyer groups"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Description"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List buyer groups","description":"","security":[{"OAuth2":["FullAccess","BuyerAdmin","BuyerReader"]}],"x-authorizedUserTypes":["Seller"]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerGroup"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"BuyerGroups.Create","tags":["Buyer groups"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BuyerGroup"}],"required":["Name"]}}}},"summary":"Create a buyer group","description":"","security":[{"OAuth2":["FullAccess","BuyerAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/buyergroups/{buyerGroupID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerGroup"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"BuyerGroups.Get","tags":["Buyer groups"],"parameters":[{"name":"buyerGroupID","in":"path","description":"ID of the buyer group.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a buyer group","description":"","security":[{"OAuth2":["FullAccess","BuyerAdmin","BuyerReader"]}],"x-authorizedUserTypes":["Seller"]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerGroup"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"BuyerGroups.Save","tags":["Buyer groups"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BuyerGroup"}],"required":["Name"]}}}},"parameters":[{"name":"buyerGroupID","in":"path","description":"ID of the buyer group.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a buyer group","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","BuyerAdmin"]}],"x-authorizedUserTypes":["Seller"]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"BuyerGroups.Delete","tags":["Buyer groups"],"parameters":[{"name":"buyerGroupID","in":"path","description":"ID of the buyer group.","required":true,"schema":{"type":"string"}}],"summary":"Delete a buyer group","description":"","security":[{"OAuth2":["FullAccess","BuyerAdmin"]}],"x-authorizedUserTypes":["Seller"]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerGroup"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"BuyerGroups.Patch","tags":["Buyer groups"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BuyerGroup"}]}}}},"parameters":[{"name":"buyerGroupID","in":"path","description":"ID of the buyer group.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a buyer group","description":"","security":[{"OAuth2":["FullAccess","BuyerAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/buyers":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Buyer"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Buyers.List","tags":["Buyers"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","GroupID","DateCreated","!ID","!Name","!GroupID","!DateCreated"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List buyers","description":"","security":[{"OAuth2":["FullAccess","BuyerAdmin","BuyerReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Buyer"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Buyers.Create","tags":["Buyers"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Buyer"}],"required":["Name"]}}}},"summary":"Create a buyer","description":"","security":[{"OAuth2":["FullAccess","BuyerAdmin"]}]}},"/buyers/{buyerID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Buyer"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Buyers.Get","tags":["Buyers"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a buyer","description":"","security":[{"OAuth2":["FullAccess","BuyerAdmin","BuyerReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Buyer"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Buyers.Save","tags":["Buyers"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Buyer"}],"required":["Name"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a buyer","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","BuyerAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Buyers.Delete","tags":["Buyers"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Delete a buyer","description":"","security":[{"OAuth2":["FullAccess","BuyerAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Buyer"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Buyers.Patch","tags":["Buyers"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Buyer"}]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a buyer","description":"","security":[{"OAuth2":["FullAccess","BuyerAdmin"]}]}},"/buyers/{buyerID}/addresses":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Addresses.List","tags":["Addresses"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","AddressName","CompanyName","City","Street1","Street2","LastName","FirstName","State","Zip"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["AddressName","ID","DateCreated","CompanyName","FirstName","LastName","Street1","Street2","City","State","Zip","Country","Phone","!AddressName","!ID","!DateCreated","!CompanyName","!FirstName","!LastName","!Street1","!Street2","!City","!State","!Zip","!Country","!Phone"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List addresses","description":"","security":[{"OAuth2":["FullAccess","AddressAdmin","AddressReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Addresses.Create","tags":["Addresses"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}],"required":["Street1","City","Country"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Create an address","description":"","security":[{"OAuth2":["FullAccess","AddressAdmin"]}]}},"/buyers/{buyerID}/addresses/{addressID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Addresses.Get","tags":["Addresses"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"addressID","in":"path","description":"ID of the address.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve an address","description":"","security":[{"OAuth2":["FullAccess","AddressAdmin","AddressReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Addresses.Save","tags":["Addresses"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}],"required":["Street1","City","Country"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"addressID","in":"path","description":"ID of the address.","required":true,"schema":{"type":"string"}}],"summary":"Create or update an address","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","AddressAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Addresses.Delete","tags":["Addresses"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"addressID","in":"path","description":"ID of the address.","required":true,"schema":{"type":"string"}}],"summary":"Delete an address","description":"","security":[{"OAuth2":["FullAccess","AddressAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Addresses.Patch","tags":["Addresses"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"addressID","in":"path","description":"ID of the address.","required":true,"schema":{"type":"string"}}],"summary":"Partially update an address","description":"","security":[{"OAuth2":["FullAccess","AddressAdmin"]}]}},"/buyers/{buyerID}/addresses/{addressID}/assignments":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Addresses.DeleteAssignment","tags":["Addresses"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"addressID","in":"path","description":"ID of the address.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}}],"summary":"Delete an address assignment","description":"","security":[{"OAuth2":["FullAccess","AddressAdmin"]}]}},"/buyers/{buyerID}/addresses/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/AddressAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Addresses.ListAssignments","tags":["Addresses"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"addressID","in":"query","description":"ID of the address.","required":false,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Level of the address assignment. Possible values: User, Group, Company, BuyerGroup.","required":false,"schema":{"$ref":"#/components/schemas/PartyType"}},{"name":"isShipping","in":"query","description":"Is shipping of the address assignment.","required":false,"schema":{"type":"boolean"}},{"name":"isBilling","in":"query","description":"Is billing of the address assignment.","required":false,"schema":{"type":"boolean"}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}}],"summary":"List address assignments","description":"","security":[{"OAuth2":["FullAccess","AddressAdmin","AddressReader"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Addresses.SaveAssignment","tags":["Addresses"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AddressAssignment"}],"required":["AddressID"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Create or update an address assignment","description":"","security":[{"OAuth2":["FullAccess","AddressAdmin"]}]}},"/buyers/{buyerID}/ApiClients/Assignments/{apiClientID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApiClients.DeleteBuyerAssignment","tags":["API clients"],"parameters":[{"name":"apiClientID","in":"path","description":"ID of the api client.","required":true,"schema":{"type":"string"}},{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Delete an API client buyer assignment","description":"","security":[{"OAuth2":["FullAccess","ApiClientAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/buyers/{buyerID}/approvalrules":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ApprovalRule"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApprovalRules.List","tags":["Approval rules"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Description","RuleExpression"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","ApprovingGroupID","RuleExpression","!Name","!ID","!ApprovingGroupID","!RuleExpression"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List approval rules","description":"","security":[{"OAuth2":["FullAccess","ApprovalRuleAdmin","ApprovalRuleReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovalRule"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApprovalRules.Create","tags":["Approval rules"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApprovalRule"}],"required":["ApprovingGroupID","RuleExpression"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Create an approval rule","description":"","security":[{"OAuth2":["FullAccess","ApprovalRuleAdmin"]}]}},"/buyers/{buyerID}/approvalrules/{approvalRuleID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovalRule"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApprovalRules.Get","tags":["Approval rules"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"approvalRuleID","in":"path","description":"ID of the approval rule.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve an approval rule","description":"","security":[{"OAuth2":["FullAccess","ApprovalRuleAdmin","ApprovalRuleReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovalRule"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApprovalRules.Save","tags":["Approval rules"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApprovalRule"}],"required":["ApprovingGroupID","RuleExpression"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"approvalRuleID","in":"path","description":"ID of the approval rule.","required":true,"schema":{"type":"string"}}],"summary":"Create or update an approval rule","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","ApprovalRuleAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApprovalRules.Delete","tags":["Approval rules"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"approvalRuleID","in":"path","description":"ID of the approval rule.","required":true,"schema":{"type":"string"}}],"summary":"Delete an approval rule","description":"","security":[{"OAuth2":["FullAccess","ApprovalRuleAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovalRule"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApprovalRules.Patch","tags":["Approval rules"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApprovalRule"}]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"approvalRuleID","in":"path","description":"ID of the approval rule.","required":true,"schema":{"type":"string"}}],"summary":"Partially update an approval rule","description":"","security":[{"OAuth2":["FullAccess","ApprovalRuleAdmin"]}]}},"/buyers/{buyerID}/costcenters":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/CostCenter"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"CostCenters.List","tags":["Cost centers"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Description"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List cost centers","description":"","security":[{"OAuth2":["FullAccess","CostCenterAdmin","CostCenterReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostCenter"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"CostCenters.Create","tags":["Cost centers"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CostCenter"}],"required":["Name"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Create a cost center","description":"","security":[{"OAuth2":["FullAccess","CostCenterAdmin"]}]}},"/buyers/{buyerID}/costcenters/{costCenterID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostCenter"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"CostCenters.Get","tags":["Cost centers"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"costCenterID","in":"path","description":"ID of the cost center.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a cost center","description":"","security":[{"OAuth2":["FullAccess","CostCenterAdmin","CostCenterReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostCenter"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"CostCenters.Save","tags":["Cost centers"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CostCenter"}],"required":["Name"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"costCenterID","in":"path","description":"ID of the cost center.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a cost center","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","CostCenterAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"CostCenters.Delete","tags":["Cost centers"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"costCenterID","in":"path","description":"ID of the cost center.","required":true,"schema":{"type":"string"}}],"summary":"Delete a cost center","description":"","security":[{"OAuth2":["FullAccess","CostCenterAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostCenter"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"CostCenters.Patch","tags":["Cost centers"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CostCenter"}]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"costCenterID","in":"path","description":"ID of the cost center.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a cost center","description":"","security":[{"OAuth2":["FullAccess","CostCenterAdmin"]}]}},"/buyers/{buyerID}/costcenters/{costCenterID}/assignments":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"CostCenters.DeleteAssignment","tags":["Cost centers"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"costCenterID","in":"path","description":"ID of the cost center.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}}],"summary":"Delete a cost center assignment","description":"","security":[{"OAuth2":["FullAccess","CostCenterAdmin"]}]}},"/buyers/{buyerID}/costcenters/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/CostCenterAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"CostCenters.ListAssignments","tags":["Cost centers"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"costCenterID","in":"query","description":"ID of the cost center.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Level of the cost center assignment. Possible values: Group, Company, BuyerGroup.","required":false,"schema":{"type":"string","enum":["Group","Company"]}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}}],"summary":"List cost center assignments","description":"","security":[{"OAuth2":["FullAccess","CostCenterAdmin","CostCenterReader"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"CostCenters.SaveAssignment","tags":["Cost centers"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CostCenterAssignment"}],"required":["CostCenterID"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a cost center assignment","description":"","security":[{"OAuth2":["FullAccess","CostCenterAdmin"]}]}},"/buyers/{buyerID}/creditcards":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/CreditCard"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"CreditCards.List","tags":["Credit cards"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","CardholderName","CardType","ExpirationDate"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","CardholderName","CardType","ExpirationDate","DateCreated","!ID","!CardholderName","!CardType","!ExpirationDate","!DateCreated"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List credit cards","description":"","security":[{"OAuth2":["FullAccess","CreditCardAdmin","CreditCardReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditCard"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"CreditCards.Create","tags":["Credit cards"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CreditCard"}]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Create a credit card","description":"","security":[{"OAuth2":["FullAccess","CreditCardAdmin"]}]}},"/buyers/{buyerID}/creditcards/{creditCardID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditCard"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"CreditCards.Get","tags":["Credit cards"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"creditCardID","in":"path","description":"ID of the credit card.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a credit card","description":"","security":[{"OAuth2":["FullAccess","CreditCardAdmin","CreditCardReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditCard"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"CreditCards.Save","tags":["Credit cards"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CreditCard"}]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"creditCardID","in":"path","description":"ID of the credit card.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a credit card","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","CreditCardAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"CreditCards.Delete","tags":["Credit cards"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"creditCardID","in":"path","description":"ID of the credit card.","required":true,"schema":{"type":"string"}}],"summary":"Delete a credit card","description":"","security":[{"OAuth2":["FullAccess","CreditCardAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditCard"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"CreditCards.Patch","tags":["Credit cards"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CreditCard"}]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"creditCardID","in":"path","description":"ID of the credit card.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a credit card","description":"","security":[{"OAuth2":["FullAccess","CreditCardAdmin"]}]}},"/buyers/{buyerID}/creditcards/{creditCardID}/assignments":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"CreditCards.DeleteAssignment","tags":["Credit cards"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"creditCardID","in":"path","description":"ID of the credit card.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}}],"summary":"Delete a credit card assignment","description":"","security":[{"OAuth2":["FullAccess","CreditCardAdmin"]}]}},"/buyers/{buyerID}/creditcards/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/CreditCardAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"CreditCards.ListAssignments","tags":["Credit cards"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"creditCardID","in":"query","description":"ID of the credit card.","required":false,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Level of the credit card assignment. Possible values: User, Group, Company, BuyerGroup.","required":false,"schema":{"$ref":"#/components/schemas/PartyType"}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}}],"summary":"List credit card assignments","description":"","security":[{"OAuth2":["FullAccess","CreditCardAdmin","CreditCardReader"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"CreditCards.SaveAssignment","tags":["Credit cards"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CreditCardAssignment"}],"required":["CreditCardID"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a credit card assignment","description":"","security":[{"OAuth2":["FullAccess","CreditCardAdmin"]}]}},"/buyers/{buyerID}/productcollections":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ProductCollection"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ProductCollections.List","tags":["Product collections"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List product collections","description":"","security":[{"OAuth2":["FullAccess","ProductCollectionReader"]}]}},"/buyers/{buyerID}/productcollections/{productCollectionID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCollection"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ProductCollections.Get","tags":["Product collections"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"productCollectionID","in":"path","description":"ID of the product collection.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a product collection","description":"","security":[{"OAuth2":["FullAccess","ProductCollectionReader"]}]}},"/buyers/{buyerID}/productcollections/{productCollectionID}/products":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ProductCollectionProduct"}},"Meta":{"$ref":"#/components/schemas/MetaWithFacets"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ProductCollections.ListEntries","tags":["Product collections"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"productCollectionID","in":"path","description":"ID of the product collection.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","ParentID","Name","Description"]}}},{"name":"searchType","in":"query","description":"Type of search to perform.","required":false,"schema":{"$ref":"#/components/schemas/SearchType","default":"AnyTerm"}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["OwnerID","Name","ID","ParentID","!OwnerID","!Name","!ID","!ParentID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List product collection entries","description":"","security":[{"OAuth2":["FullAccess","ProductCollectionReader"]}]}},"/buyers/{buyerID}/sellers":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/BuyerSupplier"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Buyers.ListBuyerSellers","tags":["Buyers"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List sellers this buyer can purchase from","description":"","security":[{"OAuth2":["FullAccess","BuyerAdmin","BuyerReader"]}]}},"/buyers/{buyerID}/spendingaccounts":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/SpendingAccount"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SpendingAccounts.List","tags":["Spending accounts"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List spending accounts","description":"","security":[{"OAuth2":["FullAccess","SpendingAccountAdmin","SpendingAccountReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpendingAccount"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SpendingAccounts.Create","tags":["Spending accounts"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SpendingAccount"}],"required":["Name","Balance"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Create a spending account","description":"","security":[{"OAuth2":["FullAccess","SpendingAccountAdmin"]}]}},"/buyers/{buyerID}/spendingaccounts/{spendingAccountID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpendingAccount"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SpendingAccounts.Get","tags":["Spending accounts"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"spendingAccountID","in":"path","description":"ID of the spending account.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a spending account","description":"","security":[{"OAuth2":["FullAccess","SpendingAccountAdmin","SpendingAccountReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpendingAccount"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SpendingAccounts.Save","tags":["Spending accounts"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SpendingAccount"}],"required":["Name","Balance"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"spendingAccountID","in":"path","description":"ID of the spending account.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a spending account","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","SpendingAccountAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SpendingAccounts.Delete","tags":["Spending accounts"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"spendingAccountID","in":"path","description":"ID of the spending account.","required":true,"schema":{"type":"string"}}],"summary":"Delete a spending account","description":"","security":[{"OAuth2":["FullAccess","SpendingAccountAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpendingAccount"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SpendingAccounts.Patch","tags":["Spending accounts"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SpendingAccount"}]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"spendingAccountID","in":"path","description":"ID of the spending account.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a spending account","description":"","security":[{"OAuth2":["FullAccess","SpendingAccountAdmin"]}]}},"/buyers/{buyerID}/spendingaccounts/{spendingAccountID}/assignments":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SpendingAccounts.DeleteAssignment","tags":["Spending accounts"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"spendingAccountID","in":"path","description":"ID of the spending account.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}}],"summary":"Delete a spending account assignment","description":"","security":[{"OAuth2":["FullAccess","SpendingAccountAdmin"]}]}},"/buyers/{buyerID}/spendingaccounts/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/SpendingAccountAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SpendingAccounts.ListAssignments","tags":["Spending accounts"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"spendingAccountID","in":"query","description":"ID of the spending account.","required":false,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Level of the spending account assignment. Possible values: User, Group, Company, BuyerGroup.","required":false,"schema":{"$ref":"#/components/schemas/PartyType"}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}}],"summary":"List spending account assignments","description":"","security":[{"OAuth2":["FullAccess","SpendingAccountAdmin","SpendingAccountReader"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SpendingAccounts.SaveAssignment","tags":["Spending accounts"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SpendingAccountAssignment"}],"required":["SpendingAccountID"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a spending account assignment","description":"","security":[{"OAuth2":["FullAccess","SpendingAccountAdmin"]}]}},"/buyers/{buyerID}/usergroups":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/UserGroup"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"UserGroups.List","tags":["User groups"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Description"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List user groups","description":"","security":[{"OAuth2":["FullAccess","UserGroupAdmin","UserGroupReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"UserGroups.Create","tags":["User groups"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UserGroup"}],"required":["Name"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Create a user group","description":"","security":[{"OAuth2":["FullAccess","UserGroupAdmin"]}]}},"/buyers/{buyerID}/usergroups/{userGroupID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"UserGroups.Get","tags":["User groups"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userGroupID","in":"path","description":"ID of the user group.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a user group","description":"","security":[{"OAuth2":["FullAccess","UserGroupAdmin","UserGroupReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"UserGroups.Save","tags":["User groups"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UserGroup"}],"required":["Name"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userGroupID","in":"path","description":"ID of the user group.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a user group","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","UserGroupAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"UserGroups.Delete","tags":["User groups"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userGroupID","in":"path","description":"ID of the user group.","required":true,"schema":{"type":"string"}}],"summary":"Delete a user group","description":"","security":[{"OAuth2":["FullAccess","UserGroupAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"UserGroups.Patch","tags":["User groups"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UserGroup"}]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userGroupID","in":"path","description":"ID of the user group.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a user group","description":"","security":[{"OAuth2":["FullAccess","UserGroupAdmin"]}]}},"/buyers/{buyerID}/usergroups/{userGroupID}/assignments/{userID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"UserGroups.DeleteUserAssignment","tags":["User groups"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userGroupID","in":"path","description":"ID of the user group.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Delete a user group user assignment","description":"","security":[{"OAuth2":["FullAccess","UserGroupAdmin"]}]}},"/buyers/{buyerID}/usergroups/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/UserGroupAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"UserGroups.ListUserAssignments","tags":["User groups"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20}}],"summary":"List user group user assignments","description":"","security":[{"OAuth2":["FullAccess","UserGroupAdmin","UserGroupReader"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"UserGroups.SaveUserAssignment","tags":["User groups"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UserGroupAssignment"}],"required":["UserGroupID","UserID"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a user group user assignment","description":"","security":[{"OAuth2":["FullAccess","UserGroupAdmin"]}]}},"/buyers/{buyerID}/users":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Users.List","tags":["Users"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Username","LastName","FirstName","Email"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["LastName","FirstName","Username","ID","Email","DateCreated","LastActive","PasswordLastSetDate","!LastName","!FirstName","!Username","!ID","!Email","!DateCreated","!LastActive","!PasswordLastSetDate"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List users","description":"","security":[{"OAuth2":["FullAccess","BuyerUserAdmin","BuyerUserReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Users.Create","tags":["Users"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/User"}],"required":["Username","FirstName","LastName","Email","Active"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Create a user","description":"","security":[{"OAuth2":["FullAccess","BuyerUserAdmin"]}]}},"/buyers/{buyerID}/users/{userID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Users.Get","tags":["Users"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a user","description":"","security":[{"OAuth2":["FullAccess","BuyerUserAdmin","BuyerUserReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Users.Save","tags":["Users"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/User"}],"required":["Username","FirstName","LastName","Email","Active"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a user","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","BuyerUserAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Users.Delete","tags":["Users"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Delete a user","description":"","security":[{"OAuth2":["FullAccess","BuyerUserAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Users.Patch","tags":["Users"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/User"}]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a user","description":"","security":[{"OAuth2":["FullAccess","BuyerUserAdmin"]}]}},"/buyers/{buyerID}/users/{userID}/accesstoken":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessToken"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Users.GetAccessToken","tags":["Users"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ImpersonateTokenRequest"}],"required":["ClientID","Roles"]}}}},"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a user access token","description":"","security":[{"OAuth2":["FullAccess","BuyerImpersonation"]}]}},"/buyers/{buyerID}/users/{userID}/moveto/{newBuyerID}":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Users.Move","tags":["Users"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}},{"name":"newBuyerID","in":"path","description":"ID of the new buyer.","required":true,"schema":{"type":"string"}},{"name":"orders","in":"query","description":"Orders of the user. Possible values: None, Unsubmitted, All.","required":true,"schema":{"$ref":"#/components/schemas/UserOrderMoveOption"}}],"summary":"Move a user to a different buyer","description":"","security":[{"OAuth2":["FullAccess","BuyerUserAdmin"]}]}},"/buyers/{buyerID}/users/{userID}/tokens":{"delete":{"responses":{"204":{"description":"Revokes all security tokens of specified buyer user."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Users.RevokeUserTokens","tags":["Users"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Revoke a user tokens","description":"Revokes all security tokens of specified buyer user.","security":[{"OAuth2":["FullAccess","BuyerUserAdmin"]}],"x-limitAnonUser":true}},"/buyers/{buyerID}/users/{userID}/unlock":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Users.UnlockUserAccount","tags":["Users"],"parameters":[{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Unlock a user account","description":"","security":[{"OAuth2":["FullAccess","BuyerUserAdmin"]}]}},"/buyerusers":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Users.ListAcrossBuyers","tags":["Users"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Username","LastName","FirstName","Email"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["LastName","FirstName","Username","ID","Email","DateCreated","LastActive","PasswordLastSetDate","!LastName","!FirstName","!Username","!ID","!Email","!DateCreated","!LastActive","!PasswordLastSetDate"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List user across buyers","description":"","security":[{"OAuth2":["FullAccess","BuyerUserReader"]}]}},"/cart":{"get":{"responses":{"200":{"description":"If the ID of the Order returned is null, the cart has not yet been interacted with. Once an item is added, the Order.ID will be populated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.Get","tags":["Cart"],"summary":"Retrieve a cart","description":"If the ID of the Order returned is null, the cart has not yet been interacted with. Once an item is added, the Order.ID will be populated.","security":[{"OAuth2":["FullAccess","OrderContributor","Shopper"]}],"x-authorizedUserTypes":["Buyer"]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten..The recommended way to initiate a new cart is to add a line item. If there is a specific reason an order needs to exist prior to adding a line item, this method can be used to initiate a new cart.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.Save","tags":["Cart"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Order"}]}}}},"summary":"Create or update a cart","description":"If an object with the same ID already exists, it will be overwritten.<br/></br>The recommended way to initiate a new cart is to add a line item. If there is a specific reason an order needs to exist prior to adding a line item, this method can be used to initiate a new cart.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]},"delete":{"responses":{"204":{"description":"Empties the cart. Any promotions, payments or other items associated with the cart will also be removed."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.Delete","tags":["Cart"],"summary":"Delete a cart","description":"Empties the cart. Any promotions, payments or other items associated with the cart will also be removed.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.Patch","tags":["Cart"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Order"}]}}}},"summary":"Partially update a cart","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/{orderID}":{"put":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.SetActiveCart","tags":["Cart"],"parameters":[{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Set an active cart","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/applypromotions":{"post":{"responses":{"201":{"description":"Apply up to 100 eligible promotions where AutoApply=true.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.ApplyPromotions","tags":["Cart"],"summary":"Auto-apply promotions to the cart","description":"Apply up to 100 eligible promotions where AutoApply=true.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/billto":{"put":{"responses":{"200":{"description":"Use only when the address is not to be saved/reused..To use a saved address (i.e. from the Addresses resource), PATCH the order's BillingAddressID property instead.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.SetBillingAddress","tags":["Cart"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}],"required":["Street1","City","Country"]}}}},"summary":"Set a billing address","description":"Use only when the address is not to be saved/reused.<br/></br>To use a saved address (i.e. from the Addresses resource), PATCH the order's BillingAddressID property instead.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]},"patch":{"responses":{"200":{"description":"Not allowed on carts where BillingAddressID has been set. In that case, use the Addresses resource to update the saved address.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.PatchBillingAddress","tags":["Cart"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}]}}}},"summary":"Partially update a cart billing address","description":"Not allowed on carts where BillingAddressID has been set. In that case, use the Addresses resource to update the saved address.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/bundles/{bundleID}":{"post":{"responses":{"201":{"description":"Adds bundle line items to the cart","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.CreateBundleItem","tags":["Cart"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BundleItems"}]}}}},"parameters":[{"name":"bundleID","in":"path","description":"ID of the bundle.","required":true,"schema":{"type":"string"}}],"summary":"Create a cart bundle item","description":"Adds bundle line items to the cart","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/bundles/{bundleID}/{bundleItemID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.DeleteBundleItem","tags":["Cart"],"parameters":[{"name":"bundleID","in":"path","description":"ID of the bundle.","required":true,"schema":{"type":"string"}},{"name":"bundleItemID","in":"path","description":"ID of the bundle item.","required":true,"schema":{"type":"string"}}],"summary":"Delete a cart bundle item","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/calculate":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderWorksheet"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.Calculate","tags":["Cart"],"summary":"Calculate the cart","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/eligiblepromotions":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/EligiblePromotion"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.ListEligiblePromotions","tags":["Cart"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Code","Description","FinePrint","EligibleExpression","ValueExpression"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","Code","StartDate","ExpirationDate","EligibleExpression","ValueExpression","CanCombine","AutoApply","Active","Priority","!Name","!ID","!Code","!StartDate","!ExpirationDate","!EligibleExpression","!ValueExpression","!CanCombine","!AutoApply","!Active","!Priority"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List eligible promotions for the cart","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/estimateshipping":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderWorksheet"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.EstimateShipping","tags":["Cart"],"summary":"Estimate shipping cost","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/fromuser":{"patch":{"responses":{"200":{"description":"Only FirstName, LastName, and Email can be updated..Primarily used to facilitate guest checkout scenarios.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.PatchFromUser","tags":["Cart"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/User"}]}}}},"summary":"Partially update a cart from user","description":"Only FirstName, LastName, and Email can be updated.<br/></br>Primarily used to facilitate guest checkout scenarios.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/lineitems":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.ListLineItems","tags":["Cart"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","ProductID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DateAdded","ID","ProductID","!DateAdded","!ID","!ProductID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List cart line items","description":"","security":[{"OAuth2":["FullAccess","OrderContributor","Shopper"]}],"x-authorizedUserTypes":["Buyer"]},"post":{"responses":{"201":{"description":"Adds a line item to the cart","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.CreateLineItem","tags":["Cart"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/LineItem"}],"required":["ProductID"]}}}},"summary":"Create a cart line item","description":"Adds a line item to the cart","security":[{"OAuth2":["FullAccess","OrderContributor","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/lineitems/{lineItemID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.GetLineItem","tags":["Cart"],"parameters":[{"name":"lineItemID","in":"path","description":"ID of the line item.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a cart line item","description":"","security":[{"OAuth2":["FullAccess","OrderContributor","Shopper"]}],"x-authorizedUserTypes":["Buyer"]},"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.SaveLineItem","tags":["Cart"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/LineItem"}],"required":["ProductID"]}}}},"parameters":[{"name":"lineItemID","in":"path","description":"ID of the line item.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a cart line item","description":"","security":[{"OAuth2":["FullAccess","OrderContributor","Shopper"]}],"x-authorizedUserTypes":["Buyer"]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.DeleteLineItem","tags":["Cart"],"parameters":[{"name":"lineItemID","in":"path","description":"ID of the line item.","required":true,"schema":{"type":"string"}}],"summary":"Delete a cart line item","description":"","security":[{"OAuth2":["FullAccess","OrderContributor","Shopper"]}],"x-authorizedUserTypes":["Buyer"]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.PatchLineItem","tags":["Cart"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/LineItem"}]}}}},"parameters":[{"name":"lineItemID","in":"path","description":"ID of the line item.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a cart line item","description":"","security":[{"OAuth2":["FullAccess","OrderContributor","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/payments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.ListPayments","tags":["Cart"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Description"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DateCreated","ID","Type","CreditCardID","SpendingAccountID","!DateCreated","!ID","!Type","!CreditCardID","!SpendingAccountID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List cart payments","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.CreatePayment","tags":["Cart"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Payment"}]}}}},"summary":"Create a cart payment","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/payments/{paymentID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.GetPayment","tags":["Cart"],"parameters":[{"name":"paymentID","in":"path","description":"ID of the payment.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a cart payment","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.DeletePayment","tags":["Cart"],"parameters":[{"name":"paymentID","in":"path","description":"ID of the payment.","required":true,"schema":{"type":"string"}}],"summary":"Delete a cart payment","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.PatchPayment","tags":["Cart"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Payment"}]}}}},"parameters":[{"name":"paymentID","in":"path","description":"ID of the payment.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a cart payment","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/payments/{paymentID}/transactions":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.CreatePaymentTransaction","tags":["Cart"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaymentTransaction"}],"required":["Type","DateExecuted"]}}}},"parameters":[{"name":"paymentID","in":"path","description":"ID of the payment.","required":true,"schema":{"type":"string"}}],"summary":"Create a cart payment transaction","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/payments/{paymentID}/transactions/{transactionID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.DeletePaymentTransaction","tags":["Cart"],"parameters":[{"name":"paymentID","in":"path","description":"ID of the payment.","required":true,"schema":{"type":"string"}},{"name":"transactionID","in":"path","description":"ID of the transaction.","required":true,"schema":{"type":"string"}}],"summary":"Delete a cart payment transaction","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/promotions":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/OrderPromotion"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.ListPromotions","tags":["Cart"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Code","Description","FinePrint","EligibleExpression","ValueExpression"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","Code","DateApplied","StartDate","ExpirationDate","EligibleExpression","ValueExpression","CanCombine","AutoApply","Active","Priority","!Name","!ID","!Code","!DateApplied","!StartDate","!ExpirationDate","!EligibleExpression","!ValueExpression","!CanCombine","!AutoApply","!Active","!Priority"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List cart promotions","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/promotions/{promoCode}":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderPromotion"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.AddPromotion","tags":["Cart"],"parameters":[{"name":"promoCode","in":"path","description":"Promo code of the order promotion.","required":true,"schema":{"type":"string"}}],"summary":"Add a promotion","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.DeletePromotion","tags":["Cart"],"parameters":[{"name":"promoCode","in":"path","description":"Promo code of the cart.","required":true,"schema":{"type":"string"}}],"summary":"Delete a cart promotion","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/refreshpromotions":{"post":{"responses":{"200":{"description":"Re-calculates promotion discounts, removes promotions that are no longer valid, and adds eligible promotions where AutoApply=true (up to limit of 100)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshPromosResponse"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.RefreshPromotions","tags":["Cart"],"summary":"Refresh promotions on the cart","description":"Re-calculates promotion discounts, removes promotions that are no longer valid, and adds eligible promotions where AutoApply=true (up to limit of 100)","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/shipmethods":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderWorksheet"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.SelectShipMethods","tags":["Cart"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OrderShipMethodSelection"}]}}}},"summary":"Select a ship method","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/shipto":{"put":{"responses":{"200":{"description":"Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the order's ShippingAddressID property instead. The address used will be populated on the ShippingAddress property of each LineItem.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.SetShippingAddress","tags":["Cart"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}],"required":["Street1","City","Country"]}}}},"summary":"Set a shipping address","description":"Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the order's ShippingAddressID property instead. The address used will be populated on the ShippingAddress property of each LineItem.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]},"patch":{"responses":{"200":{"description":"Not allowed on carts where ShippingAddressID has been set. In that case, use the Addresses resource to update the saved address.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.PatchShippingAddress","tags":["Cart"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}]}}}},"summary":"Partially update a cart shipping address","description":"Not allowed on carts where ShippingAddressID has been set. In that case, use the Addresses resource to update the saved address.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/submit":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.Submit","tags":["Cart"],"summary":"Submit the cart","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/validate":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.Validate","tags":["Cart"],"summary":"Validate the cart in it's current state","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/cart/worksheet":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderWorksheet"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Cart.GetOrderWorksheet","tags":["Cart"],"summary":"Retrieve a cart order worksheet","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-authorizedUserTypes":["Buyer"]}},"/catalogs":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Catalog"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Catalogs.List","tags":["Catalogs"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Description"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["OwnerID","Name","ID","!OwnerID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List catalogs","description":"","security":[{"OAuth2":["FullAccess","CatalogAdmin","CatalogReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Catalog"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Catalogs.Create","tags":["Catalogs"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Catalog"}],"required":["Name"]}}}},"summary":"Create a catalog","description":"","security":[{"OAuth2":["FullAccess","CatalogAdmin"]}]}},"/catalogs/{catalogID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Catalog"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Catalogs.Get","tags":["Catalogs"],"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a catalog","description":"","security":[{"OAuth2":["FullAccess","CatalogAdmin","CatalogReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Catalog"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Catalogs.Save","tags":["Catalogs"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Catalog"}],"required":["Name"]}}}},"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a catalog","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","CatalogAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Catalogs.Delete","tags":["Catalogs"],"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}}],"summary":"Delete a catalog","description":"","security":[{"OAuth2":["FullAccess","CatalogAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Catalog"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Catalogs.Patch","tags":["Catalogs"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Catalog"}]}}}},"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a catalog","description":"","security":[{"OAuth2":["FullAccess","CatalogAdmin"]}]}},"/catalogs/{catalogID}/assignments":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Catalogs.DeleteAssignment","tags":["Catalogs"],"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":false,"schema":{"type":"string"}},{"name":"buyerGroupID","in":"query","description":"ID of the buyer group.","required":false,"schema":{"type":"string"}}],"summary":"Delete a catalog assignment","description":"","security":[{"OAuth2":["FullAccess","CatalogAdmin"]}]}},"/catalogs/{catalogID}/bundleassignments/{bundleID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Catalogs.DeleteBundleAssignment","tags":["Catalogs"],"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}},{"name":"bundleID","in":"path","description":"ID of the bundle.","required":true,"schema":{"type":"string"}}],"summary":"Delete a catalog bundle assignment","description":"","security":[{"OAuth2":["FullAccess","CatalogAdmin"]}]}},"/catalogs/{catalogID}/categories":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Categories.List","tags":["Categories"],"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}},{"name":"depth","in":"query","description":"Depth of the category.","required":false,"schema":{"type":"string","default":"1"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Description"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","!ID","!Name"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List categories","description":"","security":[{"OAuth2":["FullAccess","CategoryAdmin","CategoryReader"]}]},"post":{"responses":{"201":{"description":"Setting adjustListOrders to true will increase ListOrder for all categories with the same or higher ListOrder.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Categories.Create","tags":["Categories"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Category"}],"required":["Name"]}}}},"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}},{"name":"adjustListOrders","in":"query","description":"Adjust list orders of the category.","required":false,"schema":{"type":"boolean","default":false}}],"summary":"Create a category","description":"Setting adjustListOrders to true will increase ListOrder for all categories with the same or higher ListOrder.","security":[{"OAuth2":["FullAccess","CategoryAdmin"]}]}},"/catalogs/{catalogID}/categories/{categoryID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Categories.Get","tags":["Categories"],"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}},{"name":"categoryID","in":"path","description":"ID of the category.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a category","description":"","security":[{"OAuth2":["FullAccess","CategoryAdmin","CategoryReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten..Setting adjustListOrders to true will increase ListOrder for all categories with the same or higher ListOrder.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Categories.Save","tags":["Categories"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Category"}],"required":["Name"]}}}},"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}},{"name":"categoryID","in":"path","description":"ID of the category.","required":true,"schema":{"type":"string"}},{"name":"adjustListOrders","in":"query","description":"Adjust list orders of the category.","required":false,"schema":{"type":"boolean","default":false}}],"summary":"Create or update a category","description":"If an object with the same ID already exists, it will be overwritten.<br/></br>Setting adjustListOrders to true will increase ListOrder for all categories with the same or higher ListOrder.","security":[{"OAuth2":["FullAccess","CategoryAdmin"]}]},"delete":{"responses":{"204":{"description":"Deleting a parent category will also delete all of that category's children."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Categories.Delete","tags":["Categories"],"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}},{"name":"categoryID","in":"path","description":"ID of the category.","required":true,"schema":{"type":"string"}}],"summary":"Delete a category","description":"Deleting a parent category will also delete all of that category's children.","security":[{"OAuth2":["FullAccess","CategoryAdmin"]}]},"patch":{"responses":{"200":{"description":"Setting adjustListOrders to true will increase ListOrder for all categories with the same or higher ListOrder.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Categories.Patch","tags":["Categories"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Category"}]}}}},"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}},{"name":"categoryID","in":"path","description":"ID of the category.","required":true,"schema":{"type":"string"}},{"name":"adjustListOrders","in":"query","description":"Adjust list orders of the partial 1.","required":false,"schema":{"type":"boolean","default":false}}],"summary":"Partially update a category","description":"Setting adjustListOrders to true will increase ListOrder for all categories with the same or higher ListOrder.","security":[{"OAuth2":["FullAccess","CategoryAdmin"]}]}},"/catalogs/{catalogID}/categories/{categoryID}/assignments":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Categories.DeleteAssignment","tags":["Categories"],"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}},{"name":"categoryID","in":"path","description":"ID of the category.","required":true,"schema":{"type":"string"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}}],"summary":"Delete a category assignment","description":"","security":[{"OAuth2":["FullAccess","CategoryAdmin"]}]}},"/catalogs/{catalogID}/categories/{categoryID}/bundleassignments/{bundleID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Categories.DeleteBundleAssignment","tags":["Categories"],"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}},{"name":"categoryID","in":"path","description":"ID of the category.","required":true,"schema":{"type":"string"}},{"name":"bundleID","in":"path","description":"ID of the bundle.","required":true,"schema":{"type":"string"}}],"summary":"Delete a category bundle assignment","description":"","security":[{"OAuth2":["FullAccess","CategoryAdmin"]}]}},"/catalogs/{catalogID}/categories/{categoryID}/productassignments/{productID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Categories.DeleteProductAssignment","tags":["Categories"],"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}},{"name":"categoryID","in":"path","description":"ID of the category.","required":true,"schema":{"type":"string"}},{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}}],"summary":"Delete a category product assignment","description":"","security":[{"OAuth2":["FullAccess","CategoryAdmin"]}]}},"/catalogs/{catalogID}/categories/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/CategoryAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Categories.ListAssignments","tags":["Categories"],"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}},{"name":"categoryID","in":"query","description":"ID of the category.","required":false,"schema":{"type":"string"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Level of the category assignment. Possible values: Group, Company, BuyerGroup.","required":false,"schema":{"type":"string","enum":["Group","Company"]}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}}],"summary":"List category assignments","description":"","security":[{"OAuth2":["FullAccess","CategoryAdmin","CategoryReader"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Categories.SaveAssignment","tags":["Categories"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CategoryAssignment"}],"required":["CategoryID","BuyerID"]}}}},"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a category assignment","description":"","security":[{"OAuth2":["FullAccess","CategoryAdmin"]}]}},"/catalogs/{catalogID}/categories/bundleassignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/CategoryBundleAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Categories.ListBundleAssignments","tags":["Categories"],"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}},{"name":"categoryID","in":"query","description":"ID of the category.","required":false,"schema":{"type":"string"}},{"name":"bundleID","in":"query","description":"ID of the bundle.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20}}],"summary":"List category bundle assignments","description":"","security":[{"OAuth2":["FullAccess","CategoryAdmin"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Categories.SaveBundleAssignment","tags":["Categories"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CategoryBundleAssignment"}],"required":["CategoryID","BundleID"]}}}},"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a category bundle assignment","description":"","security":[{"OAuth2":["FullAccess","CategoryAdmin"]}]}},"/catalogs/{catalogID}/categories/productassignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/CategoryProductAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Categories.ListProductAssignments","tags":["Categories"],"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}},{"name":"categoryID","in":"query","description":"ID of the category.","required":false,"schema":{"type":"string"}},{"name":"productID","in":"query","description":"ID of the product.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20}}],"summary":"List category product assignments","description":"","security":[{"OAuth2":["FullAccess","CategoryAdmin","CategoryReader"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Categories.SaveProductAssignment","tags":["Categories"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CategoryProductAssignment"}],"required":["CategoryID","ProductID"]}}}},"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a category product assignment","description":"","security":[{"OAuth2":["FullAccess","CategoryAdmin"]}]}},"/catalogs/{catalogID}/productassignments/{productID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Catalogs.DeleteProductAssignment","tags":["Catalogs"],"parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}},{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}}],"summary":"Delete a catalog product assignment","description":"","security":[{"OAuth2":["FullAccess","CatalogAdmin"]}]}},"/catalogs/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/CatalogAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Catalogs.ListAssignments","tags":["Catalogs"],"parameters":[{"name":"catalogID","in":"query","description":"ID of the catalog.","required":false,"schema":{"type":"string"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":false,"schema":{"type":"string"}},{"name":"buyerGroupID","in":"query","description":"ID of the buyer group.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20}}],"summary":"List catalog assignments","description":"","security":[{"OAuth2":["FullAccess","CatalogAdmin","CatalogReader"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Catalogs.SaveAssignment","tags":["Catalogs"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CatalogAssignment"}],"required":["CatalogID"]}}}},"summary":"Create or update a catalog assignment","description":"","security":[{"OAuth2":["FullAccess","CatalogAdmin"]}]}},"/catalogs/bundleassignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/BundleCatalogAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Catalogs.ListBundleAssignments","tags":["Catalogs"],"parameters":[{"name":"catalogID","in":"query","description":"ID of the catalog.","required":false,"schema":{"type":"string"}},{"name":"bundleID","in":"query","description":"ID of the bundle.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20}}],"summary":"List catalog bundle assignments","description":"","security":[{"OAuth2":["FullAccess","CatalogAdmin"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Catalogs.SaveBundleAssignment","tags":["Catalogs"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BundleCatalogAssignment"}],"required":["CatalogID","BundleID"]}}}},"summary":"Create or update a catalog bundle assignment","description":"","security":[{"OAuth2":["FullAccess","CatalogAdmin"]}]}},"/catalogs/productassignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ProductCatalogAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Catalogs.ListProductAssignments","tags":["Catalogs"],"parameters":[{"name":"catalogID","in":"query","description":"ID of the catalog.","required":false,"schema":{"type":"string"}},{"name":"productID","in":"query","description":"ID of the product.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20}}],"summary":"List catalog product assignments","description":"","security":[{"OAuth2":["FullAccess","CatalogAdmin","CatalogReader"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Catalogs.SaveProductAssignment","tags":["Catalogs"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ProductCatalogAssignment"}],"required":["CatalogID","ProductID"]}}}},"summary":"Create or update a catalog product assignment","description":"","security":[{"OAuth2":["FullAccess","CatalogAdmin"]}]}},"/discounts":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Discounts.List","tags":["Discounts"],"parameters":[{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","CatalogID","CategoryID","ProductID","!ID","!CatalogID","!CategoryID","!ProductID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List discounts","description":"","security":[{"OAuth2":["FullAccess","PriceScheduleAdmin","PriceScheduleReader"]}],"x-authorizedUserTypes":["Seller"],"x-lifecycle":"Beta"},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Discount"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Discounts.Create","tags":["Discounts"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Discount"}],"required":["DiscountBreaks"]}}}},"summary":"Create a discount","description":"","security":[{"OAuth2":["FullAccess","PriceScheduleAdmin"]}],"x-authorizedUserTypes":["Seller"],"x-lifecycle":"Beta"}},"/discounts/{discountID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Discount"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Discounts.Get","tags":["Discounts"],"parameters":[{"name":"discountID","in":"path","description":"ID of the discount.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a discount","description":"","security":[{"OAuth2":["FullAccess","PriceScheduleAdmin","PriceScheduleReader"]}],"x-authorizedUserTypes":["Seller"],"x-lifecycle":"Beta"},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Discount"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Discounts.Save","tags":["Discounts"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Discount"}],"required":["DiscountBreaks"]}}}},"parameters":[{"name":"discountID","in":"path","description":"ID of the discount.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a discount","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","PriceScheduleAdmin"]}],"x-authorizedUserTypes":["Seller"],"x-lifecycle":"Beta"},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Discounts.Delete","tags":["Discounts"],"parameters":[{"name":"discountID","in":"path","description":"ID of the discount.","required":true,"schema":{"type":"string"}}],"summary":"Delete a discount","description":"","security":[{"OAuth2":["FullAccess","PriceScheduleAdmin"]}],"x-authorizedUserTypes":["Seller"],"x-lifecycle":"Beta"},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Discount"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Discounts.Patch","tags":["Discounts"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Discount"}]}}}},"parameters":[{"name":"discountID","in":"path","description":"ID of the discount.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a discount","description":"","security":[{"OAuth2":["FullAccess","PriceScheduleAdmin"]}],"x-authorizedUserTypes":["Seller"],"x-lifecycle":"Beta"}},"/discounts/{discountID}/assignments":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Discounts.DeleteAssignment","tags":["Discounts"],"parameters":[{"name":"discountID","in":"path","description":"ID of the discount.","required":true,"schema":{"type":"string"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"buyerGroupID","in":"query","description":"ID of the buyer group.","required":false,"schema":{"type":"string"}}],"summary":"Delete a discount assignment","description":"","security":[{"OAuth2":["FullAccess","PriceScheduleAdmin"]}],"x-authorizedUserTypes":["Seller"],"x-lifecycle":"Beta"}},"/discounts/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/DiscountAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Discounts.ListAssignments","tags":["Discounts"],"parameters":[{"name":"discountID","in":"query","description":"ID of the discount.","required":false,"schema":{"type":"string"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"buyerGroupID","in":"query","description":"ID of the buyer group.","required":false,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Level of the discount assignment. Possible values: Group, Company, BuyerGroup.","required":false,"schema":{"type":"string","enum":["Group","Company"]}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}}],"summary":"List discount assignments","description":"","security":[{"OAuth2":["FullAccess","PriceScheduleAdmin","PriceScheduleReader"]}],"x-authorizedUserTypes":["Seller"],"x-lifecycle":"Beta"},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Discounts.SaveAssignment","tags":["Discounts"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/DiscountAssignment"}],"required":["DiscountID"]}}}},"summary":"Create or update a discount assignment","description":"","security":[{"OAuth2":["FullAccess","PriceScheduleAdmin"]}],"x-authorizedUserTypes":["Seller"],"x-lifecycle":"Beta"}},"/grouporders/{invitationID}/token":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessToken"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"GroupOrders.GetToken","tags":["Group orders"],"parameters":[{"name":"invitationID","in":"path","description":"ID of the invitation.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a group order token","description":"","security":[{"OAuth2":[]}],"x-lifecycle":"Beta"}},"/impersonationconfig":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ImpersonationConfig"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ImpersonationConfigs.List","tags":["Impersonation configs"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ImpersonationBuyerID","ImpersonationGroupID","ImpersonationUserID","BuyerID","GroupID","UserID","SecurityProfileID","ClientID","ID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ImpersonationBuyerID","ImpersonationGroupID","ImpersonationUserID","BuyerID","GroupID","UserID","SecurityProfileID","ClientID","ID","!ImpersonationBuyerID","!ImpersonationGroupID","!ImpersonationUserID","!BuyerID","!GroupID","!UserID","!SecurityProfileID","!ClientID","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List impersonation configs","description":"","security":[{"OAuth2":["FullAccess","SetSecurityProfile"]}],"x-authorizedUserTypes":["Seller"]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImpersonationConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ImpersonationConfigs.Create","tags":["Impersonation configs"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ImpersonationConfig"}],"required":["SecurityProfileID","ClientID"]}}}},"summary":"Create an impersonation config","description":"","security":[{"OAuth2":["FullAccess","SetSecurityProfile"]}],"x-authorizedUserTypes":["Seller"]}},"/impersonationconfig/{impersonationConfigID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImpersonationConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ImpersonationConfigs.Get","tags":["Impersonation configs"],"parameters":[{"name":"impersonationConfigID","in":"path","description":"ID of the impersonation config.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve an impersonation config","description":"","security":[{"OAuth2":["FullAccess","SetSecurityProfile"]}],"x-authorizedUserTypes":["Seller"]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImpersonationConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ImpersonationConfigs.Save","tags":["Impersonation configs"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ImpersonationConfig"}],"required":["SecurityProfileID","ClientID"]}}}},"parameters":[{"name":"impersonationConfigID","in":"path","description":"ID of the impersonation config.","required":true,"schema":{"type":"string"}}],"summary":"Create or update an impersonation config","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","SetSecurityProfile"]}],"x-authorizedUserTypes":["Seller"]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ImpersonationConfigs.Delete","tags":["Impersonation configs"],"parameters":[{"name":"impersonationConfigID","in":"path","description":"ID of the impersonation config.","required":true,"schema":{"type":"string"}}],"summary":"Delete an impersonation config","description":"","security":[{"OAuth2":["FullAccess","SetSecurityProfile"]}],"x-authorizedUserTypes":["Seller"]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImpersonationConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ImpersonationConfigs.Patch","tags":["Impersonation configs"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ImpersonationConfig"}]}}}},"parameters":[{"name":"impersonationConfigID","in":"path","description":"ID of the impersonation config.","required":true,"schema":{"type":"string"}}],"summary":"Partially update an impersonation config","description":"","security":[{"OAuth2":["FullAccess","SetSecurityProfile"]}],"x-authorizedUserTypes":["Seller"]}},"/incrementors":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Incrementor"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Incrementors.List","tags":["Incrementors"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","!ID","!Name"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List incrementors","description":"","security":[{"OAuth2":["FullAccess","IncrementorAdmin","IncrementorReader"]}],"x-authorizedUserTypes":["Seller"]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Incrementor"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Incrementors.Create","tags":["Incrementors"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Incrementor"}],"required":["LastNumber","LeftPaddingCount"]}}}},"summary":"Create an incrementor","description":"","security":[{"OAuth2":["FullAccess","IncrementorAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/incrementors/{incrementorID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Incrementor"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Incrementors.Get","tags":["Incrementors"],"parameters":[{"name":"incrementorID","in":"path","description":"ID of the incrementor.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve an incrementor","description":"","security":[{"OAuth2":["FullAccess","IncrementorAdmin","IncrementorReader"]}],"x-authorizedUserTypes":["Seller"]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Incrementor"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Incrementors.Save","tags":["Incrementors"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Incrementor"}],"required":["LastNumber","LeftPaddingCount"]}}}},"parameters":[{"name":"incrementorID","in":"path","description":"ID of the incrementor.","required":true,"schema":{"type":"string"}}],"summary":"Create or update an incrementor","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","IncrementorAdmin"]}],"x-authorizedUserTypes":["Seller"]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Incrementors.Delete","tags":["Incrementors"],"parameters":[{"name":"incrementorID","in":"path","description":"ID of the incrementor.","required":true,"schema":{"type":"string"}}],"summary":"Delete an incrementor","description":"","security":[{"OAuth2":["FullAccess","IncrementorAdmin"]}],"x-authorizedUserTypes":["Seller"]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Incrementor"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Incrementors.Patch","tags":["Incrementors"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Incrementor"}]}}}},"parameters":[{"name":"incrementorID","in":"path","description":"ID of the incrementor.","required":true,"schema":{"type":"string"}}],"summary":"Partially update an incrementor","description":"","security":[{"OAuth2":["FullAccess","IncrementorAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/integrationEvents":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationEvent"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"IntegrationEvents.List","tags":["Integration events"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","EventType","Name"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","EventType","Name","!ID","!EventType","!Name"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List integration events","description":"","security":[{"OAuth2":["FullAccess","IntegrationEventAdmin","IntegrationEventReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationEvent"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"IntegrationEvents.Create","tags":["Integration events"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/IntegrationEvent"}],"required":["CustomImplementationUrl","Name","HashKey"]}}}},"summary":"Create an integration event","description":"","security":[{"OAuth2":["FullAccess","IntegrationEventAdmin"]}]}},"/integrationEvents/{integrationEventID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationEvent"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"IntegrationEvents.Get","tags":["Integration events"],"parameters":[{"name":"integrationEventID","in":"path","description":"ID of the integration event.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve an integration event","description":"","security":[{"OAuth2":["FullAccess","IntegrationEventAdmin","IntegrationEventReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationEvent"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"IntegrationEvents.Save","tags":["Integration events"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/IntegrationEvent"}],"required":["CustomImplementationUrl","Name","HashKey"]}}}},"parameters":[{"name":"integrationEventID","in":"path","description":"ID of the integration event.","required":true,"schema":{"type":"string"}}],"summary":"Create or update an integration event","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","IntegrationEventAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"IntegrationEvents.Delete","tags":["Integration events"],"parameters":[{"name":"integrationEventID","in":"path","description":"ID of the integration event.","required":true,"schema":{"type":"string"}}],"summary":"Delete an integration event","description":"","security":[{"OAuth2":["FullAccess","IntegrationEventAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationEvent"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"IntegrationEvents.Patch","tags":["Integration events"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/IntegrationEvent"}]}}}},"parameters":[{"name":"integrationEventID","in":"path","description":"ID of the integration event.","required":true,"schema":{"type":"string"}}],"summary":"Partially update an integration event","description":"","security":[{"OAuth2":["FullAccess","IntegrationEventAdmin"]}]}},"/integrations/deliveryconfig":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryConfig"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"DeliveryConfigurations.List","tags":["Delivery configurations"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","!ID","!Name"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List delivery configurations","description":"","security":[{"OAuth2":["FullAccess","DeliveryConfigAdmin"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"DeliveryConfigurations.Create","tags":["Delivery configurations"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/DeliveryConfig"}],"required":["Name","DeliveryTargets"]}}}},"summary":"Create a delivery configuration","description":"","security":[{"OAuth2":["FullAccess","DeliveryConfigAdmin"]}]}},"/integrations/deliveryconfig/{deliveryConfigID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"DeliveryConfigurations.Get","tags":["Delivery configurations"],"parameters":[{"name":"deliveryConfigID","in":"path","description":"ID of the delivery config.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a delivery configuration","description":"","security":[{"OAuth2":["FullAccess","DeliveryConfigAdmin"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"DeliveryConfigurations.Save","tags":["Delivery configurations"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/DeliveryConfig"}],"required":["Name","DeliveryTargets"]}}}},"parameters":[{"name":"deliveryConfigID","in":"path","description":"ID of the delivery config.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a delivery configuration","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","DeliveryConfigAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"DeliveryConfigurations.Delete","tags":["Delivery configurations"],"parameters":[{"name":"deliveryConfigID","in":"path","description":"ID of the delivery config.","required":true,"schema":{"type":"string"}}],"summary":"Delete a delivery configuration","description":"","security":[{"OAuth2":["FullAccess","DeliveryConfigAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"DeliveryConfigurations.Patch","tags":["Delivery configurations"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/DeliveryConfig"}]}}}},"parameters":[{"name":"deliveryConfigID","in":"path","description":"ID of the delivery config. Required.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a delivery configuration","description":"","security":[{"OAuth2":["FullAccess","DeliveryConfigAdmin"]}]}},"/integrations/entitysync/adminusers":{"get":{"responses":{"200":{"description":"Get the entity sync delivery configuration for AdminUsers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.GetAdminUsers","tags":["Entity synchronization"],"summary":"Retrieve the entity sync delivery configuration for admin users","description":"Get the entity sync delivery configuration for AdminUsers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"put":{"responses":{"200":{"description":"Create or update the entity sync delivery configuration for AdminUsers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.SaveAdminUsers","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntitySyncConfig"}],"required":["DeliveryConfigID","SyncEntityChanged","SyncEntityDeleted"]}}}},"summary":"Create or update the entity sync delivery configuration for admin users","description":"Create or update the entity sync delivery configuration for AdminUsers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"delete":{"responses":{"204":{"description":"Delete the entity sync delivery configuration for AdminUsers"},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.DeleteAdminUsers","tags":["Entity synchronization"],"summary":"Delete the entity sync delivery configuration for admin users","description":"Delete the entity sync delivery configuration for AdminUsers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"patch":{"responses":{"200":{"description":"Partially update the entity sync delivery configuration for AdminUsers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.PatchAdminUsers","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntitySyncConfig"}]}}}},"summary":"Partially update the entity sync delivery configuration for admin users","description":"Partially update the entity sync delivery configuration for AdminUsers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]}},"/integrations/entitysync/adminusers/sync":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.SyncAdminUser","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SyncAdminUser"}],"required":["UserID"]}}}},"summary":"Sync an admin user","description":"","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]}},"/integrations/entitysync/buyers":{"get":{"responses":{"200":{"description":"Get the entity sync delivery configuration for Buyers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.GetBuyers","tags":["Entity synchronization"],"summary":"Retrieve the entity sync delivery configuration for buyers","description":"Get the entity sync delivery configuration for Buyers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"put":{"responses":{"200":{"description":"Create or update the entity sync delivery configuration for Buyers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.SaveBuyers","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntitySyncConfig"}],"required":["DeliveryConfigID","SyncEntityChanged","SyncEntityDeleted"]}}}},"summary":"Create or update the entity sync delivery configuration for buyers","description":"Create or update the entity sync delivery configuration for Buyers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"delete":{"responses":{"204":{"description":"Delete the entity sync delivery configuration for Buyers"},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.DeleteBuyers","tags":["Entity synchronization"],"summary":"Delete the entity sync delivery configuration for buyers","description":"Delete the entity sync delivery configuration for Buyers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"patch":{"responses":{"200":{"description":"Partially update the entity sync delivery configuration for Buyers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.PatchBuyers","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntitySyncConfig"}]}}}},"summary":"Partially update the entity sync delivery configuration for buyers","description":"Partially update the entity sync delivery configuration for Buyers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]}},"/integrations/entitysync/buyers/sync":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.SyncBuyer","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SyncBuyer"}],"required":["BuyerID"]}}}},"summary":"Sync a buyer","description":"","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]}},"/integrations/entitysync/buyers/usergroups":{"get":{"responses":{"200":{"description":"Get the entity sync delivery configuration for BuyerUserGroups","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.GetBuyerUserGroups","tags":["Entity synchronization"],"summary":"Retrieve the entity sync delivery configuration for buyer user groups","description":"Get the entity sync delivery configuration for BuyerUserGroups","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"put":{"responses":{"200":{"description":"Create or update the entity sync delivery configuration for BuyerUserGroups","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.SaveUserGroups","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntitySyncConfig"}],"required":["DeliveryConfigID","SyncEntityChanged","SyncEntityDeleted"]}}}},"summary":"Create or update the entity sync delivery configuration for buyer user groups","description":"Create or update the entity sync delivery configuration for BuyerUserGroups","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"delete":{"responses":{"204":{"description":"Delete the entity sync delivery configuration for BuyerUserGroups"},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.DeleteUserGroups","tags":["Entity synchronization"],"summary":"Delete the entity sync delivery configuration for buyer user groups","description":"Delete the entity sync delivery configuration for BuyerUserGroups","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"patch":{"responses":{"200":{"description":"Partially update the entity sync delivery configuration for BuyerUserGroups","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.PatchBuyerUserGroups","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntitySyncConfig"}]}}}},"summary":"Partially update the entity sync delivery configuration for buyer user groups","description":"Partially update the entity sync delivery configuration for BuyerUserGroups","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]}},"/integrations/entitysync/buyers/usergroups/sync":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.SyncBuyerUserGroup","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SyncBuyerUserGroup"}],"required":["BuyerID","UserGroupID"]}}}},"summary":"Sync a buyer user group","description":"","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]}},"/integrations/entitysync/buyers/users":{"get":{"responses":{"200":{"description":"Get the entity sync delivery configuration for BuyerUsers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.GetBuyerUsers","tags":["Entity synchronization"],"summary":"Retrieve the entity sync delivery configuration for buyer users","description":"Get the entity sync delivery configuration for BuyerUsers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"put":{"responses":{"200":{"description":"Create or update the entity sync delivery configuration for BuyerUsers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.SaveBuyerUsers","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntitySyncConfig"}],"required":["DeliveryConfigID","SyncEntityChanged","SyncEntityDeleted"]}}}},"summary":"Create or update the entity sync delivery configuration for buyer users","description":"Create or update the entity sync delivery configuration for BuyerUsers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"delete":{"responses":{"204":{"description":"Delete the entity sync delivery configuration for BuyerUsers"},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.DeleteBuyerUsers","tags":["Entity synchronization"],"summary":"Delete the entity sync delivery configuration for buyer users","description":"Delete the entity sync delivery configuration for BuyerUsers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"patch":{"responses":{"200":{"description":"Partially update the entity sync delivery configuration for BuyerUsers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.PatchBuyerUsers","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntitySyncConfig"}]}}}},"summary":"Partially update the entity sync delivery configuration for buyer users","description":"Partially update the entity sync delivery configuration for BuyerUsers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]}},"/integrations/entitysync/buyers/users/sync":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.SyncBuyerUser","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SyncBuyerUser"}],"required":["BuyerID","UserID"]}}}},"summary":"Sync a buyer user","description":"","security":[{"OAuth2":["FullAccess","BuyerUserAdmin","EntitySyncConfigAdmin"]}]}},"/integrations/entitysync/categories":{"get":{"responses":{"200":{"description":"Get the entity sync delivery configuration for Categories","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.GetCategories","tags":["Entity synchronization"],"summary":"Retrieve the entity sync delivery configuration for categories","description":"Get the entity sync delivery configuration for Categories","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"put":{"responses":{"200":{"description":"Create or update the entity sync delivery configuration for Categories","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.SaveCategories","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntitySyncConfig"}],"required":["DeliveryConfigID","SyncEntityChanged","SyncEntityDeleted"]}}}},"summary":"Create or update the entity sync delivery configuration for categories","description":"Create or update the entity sync delivery configuration for Categories","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"delete":{"responses":{"204":{"description":"Delete the entity sync delivery configuration for Categories"},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.DeleteCategories","tags":["Entity synchronization"],"summary":"Delete the entity sync delivery configuration for categories","description":"Delete the entity sync delivery configuration for Categories","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"patch":{"responses":{"200":{"description":"Partially update the entity sync delivery configuration for Categories","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.PatchCategories","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntitySyncConfig"}]}}}},"summary":"Partially update the entity sync delivery configuration for categories","description":"Partially update the entity sync delivery configuration for Categories","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]}},"/integrations/entitysync/categories/sync":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.SyncCategory","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SyncCategory"}],"required":["CatalogID","CategoryID"]}}}},"summary":"Sync a category","description":"","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]}},"/integrations/entitysync/products/inventoryrecords":{"get":{"responses":{"200":{"description":"Get the entity sync delivery configuration for InventoryRecords","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.GetInventoryRecords","tags":["Entity synchronization"],"summary":"Retrieve the entity sync delivery configuration for inventory records","description":"Get the entity sync delivery configuration for InventoryRecords","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"put":{"responses":{"200":{"description":"Create or update the entity sync delivery configuration for InventoryRecords","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.SaveInventoryRecords","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntitySyncConfig"}],"required":["DeliveryConfigID","SyncEntityChanged","SyncEntityDeleted"]}}}},"summary":"Create or update the entity sync delivery configuration for inventory records","description":"Create or update the entity sync delivery configuration for InventoryRecords","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"delete":{"responses":{"204":{"description":"Delete the entity sync delivery configuration for InventoryRecords"},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.DeleteInventoryRecords","tags":["Entity synchronization"],"summary":"Delete the entity sync delivery configuration for inventory records","description":"Delete the entity sync delivery configuration for InventoryRecords","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"patch":{"responses":{"200":{"description":"Partially update the entity sync delivery configuration for InventoryRecords","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.PatchInventoryRecords","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntitySyncConfig"}]}}}},"summary":"Partially update the entity sync delivery configuration for inventory records","description":"Partially update the entity sync delivery configuration for InventoryRecords","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]}},"/integrations/entitysync/products/inventoryrecords/sync":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.SyncInventoryRecord","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SyncInventoryRecord"}],"required":["ProductID","InventoryRecordID"]}}}},"summary":"Sync an inventory record","description":"","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]}},"/integrations/entitysync/supplier/sync":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.SyncSupplier","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SyncSupplier"}],"required":["SupplierID"]}}}},"summary":"Sync a supplier","description":"","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]}},"/integrations/entitysync/suppliers":{"get":{"responses":{"200":{"description":"Get the entity sync delivery configuration for Suppliers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.GetSuppliers","tags":["Entity synchronization"],"summary":"Retrieve the entity sync delivery configuration for suppliers","description":"Get the entity sync delivery configuration for Suppliers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"put":{"responses":{"200":{"description":"Create or update the entity sync delivery configuration for Suppliers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.SaveSuppliers","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntitySyncConfig"}],"required":["DeliveryConfigID","SyncEntityChanged","SyncEntityDeleted"]}}}},"summary":"Create or update the entity sync delivery configuration for suppliers","description":"Create or update the entity sync delivery configuration for Suppliers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"delete":{"responses":{"204":{"description":"Delete the entity sync delivery configuration for Suppliers"},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.DeleteSuppliers","tags":["Entity synchronization"],"summary":"Delete the entity sync delivery configuration for suppliers","description":"Delete the entity sync delivery configuration for Suppliers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"patch":{"responses":{"200":{"description":"Partially update the entity sync delivery configuration for Suppliers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.PatchSuppliers","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntitySyncConfig"}]}}}},"summary":"Partially update the entity sync delivery configuration for suppliers","description":"Partially update the entity sync delivery configuration for Suppliers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]}},"/integrations/entitysync/suppliers/users":{"get":{"responses":{"200":{"description":"Get the entity sync delivery configuration for SupplierUsers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.GetSupplierUsers","tags":["Entity synchronization"],"summary":"Retrieve the entity sync delivery configuration for supplier users","description":"Get the entity sync delivery configuration for SupplierUsers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"put":{"responses":{"200":{"description":"Create or update the entity sync delivery configuration for SupplierUsers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.SaveSupplierUsers","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntitySyncConfig"}],"required":["DeliveryConfigID","SyncEntityChanged","SyncEntityDeleted"]}}}},"summary":"Create or update the entity sync delivery configuration for supplier users","description":"Create or update the entity sync delivery configuration for SupplierUsers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"delete":{"responses":{"204":{"description":"Delete the entity sync delivery configuration for SupplierUsers"},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.DeleteSupplierUsers","tags":["Entity synchronization"],"summary":"Delete the entity sync delivery configuration for supplier users","description":"Delete the entity sync delivery configuration for SupplierUsers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]},"patch":{"responses":{"200":{"description":"Partially update the entity sync delivery configuration for SupplierUsers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.PatchSupplierUsers","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EntitySyncConfig"}]}}}},"summary":"Partially update the entity sync delivery configuration for supplier users","description":"Partially update the entity sync delivery configuration for SupplierUsers","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin"]}]}},"/integrations/entitysync/suppliers/users/sync":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"EntitySyncs.SyncSupplierUser","tags":["Entity synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SyncSupplierUser"}],"required":["SupplierID","UserID"]}}}},"summary":"Sync a supplier user","description":"","security":[{"OAuth2":["FullAccess","EntitySyncConfigAdmin","SupplierUserGroupAdmin"]}]}},"/integrations/ErrorConfig":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ErrorConfigs.Get","tags":["Error configs"],"summary":"Retrieve an error config","description":"","security":[{"OAuth2":["FullAccess","ErrorConfigAdmin"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ErrorConfigs.Save","tags":["Error configs"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorConfig"}],"required":["DeliveryConfigID"]}}}},"summary":"Create or update an error config","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","ErrorConfigAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ErrorConfigs.Delete","tags":["Error configs"],"summary":"Delete an error config","description":"","security":[{"OAuth2":["FullAccess","ErrorConfigAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ErrorConfigs.Patch","tags":["Error configs"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorConfig"}]}}}},"summary":"Partially update an error config","description":"","security":[{"OAuth2":["FullAccess","ErrorConfigAdmin"]}]}},"/integrations/ErrorConfig/validate":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ErrorConfigs.Validate","tags":["Error configs"],"summary":"Validates an error config","description":"","security":[{"OAuth2":["FullAccess","ErrorConfigAdmin"]}]}},"/integrations/inventory":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryIntegration"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryIntegrations.Get","tags":["Inventory"],"summary":"Retrieve an inventory integration","description":"","security":[{"OAuth2":["FullAccess","InventoryAdmin"]}],"x-authorizedUserTypes":["Seller"]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryIntegration"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryIntegrations.Save","tags":["Inventory"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InventoryIntegration"}],"required":["DeliveryConfigID"]}}}},"summary":"Create or update an inventory integration","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","InventoryAdmin"]}],"x-authorizedUserTypes":["Seller"]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryIntegrations.Delete","tags":["Inventory"],"summary":"Delete an inventory integration","description":"","security":[{"OAuth2":["FullAccess","InventoryAdmin"]}],"x-authorizedUserTypes":["Seller"]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryIntegration"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryIntegrations.Patch","tags":["Inventory"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InventoryIntegration"}]}}}},"summary":"Partially update an inventory integration","description":"","security":[{"OAuth2":["FullAccess","InventoryAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/integrations/OrderSync":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderSyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OrderSyncs.Get","tags":["Order synchronization"],"summary":"Retrieve an order sync","description":"","security":[{"OAuth2":["FullAccess","OrderSyncConfigAdmin"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderSyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OrderSyncs.Save","tags":["Order synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OrderSyncConfig"}],"required":["DeliveryConfigID"]}}}},"summary":"Create or update an order sync","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","OrderSyncConfigAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OrderSyncs.Delete","tags":["Order synchronization"],"summary":"Delete an order sync","description":"","security":[{"OAuth2":["FullAccess","OrderSyncConfigAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderSyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OrderSyncs.Patch","tags":["Order synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OrderSyncConfig"}]}}}},"summary":"Partially update an order sync","description":"","security":[{"OAuth2":["FullAccess","OrderSyncConfigAdmin"]}]}},"/integrations/productsync":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ProductSyncs.Get","tags":["Product synchronization"],"summary":"Retrieve a product sync","description":"","security":[{"OAuth2":["FullAccess","ProductSyncConfigAdmin"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ProductSyncs.Save","tags":["Product synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ProductSyncConfig"}],"required":["SyncProductChanged","SyncProductDeleted","DeliveryConfigID"]}}}},"summary":"Create or update a product sync","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","ProductSyncConfigAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ProductSyncs.Delete","tags":["Product synchronization"],"summary":"Delete a product sync","description":"","security":[{"OAuth2":["FullAccess","ProductSyncConfigAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSyncConfig"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ProductSyncs.Patch","tags":["Product synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ProductSyncConfig"}]}}}},"summary":"Partially update a product sync","description":"","security":[{"OAuth2":["FullAccess","ProductSyncConfigAdmin"]}]}},"/integrations/productsync/sync":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ProductSyncs.Sync","tags":["Product synchronization"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SyncProduct"}],"required":["ProductID"]}}}},"summary":"Sync a product","description":"","security":[{"OAuth2":["FullAccess","ProductSyncConfigAdmin"]}]}},"/integrations/promotion":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionIntegration"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"PromotionIntegrations.Get","tags":["Promotion"],"summary":"Retrieve a promotion integration","description":"","security":[{"OAuth2":["FullAccess","PromotionAdmin"]}],"x-authorizedUserTypes":["Seller"]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionIntegration"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"PromotionIntegrations.Save","tags":["Promotion"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PromotionIntegration"}],"required":["HashKey"]}}}},"summary":"Create or update a promotion integration","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","PromotionAdmin"]}],"x-authorizedUserTypes":["Seller"]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"PromotionIntegrations.Delete","tags":["Promotion"],"summary":"Delete a promotion integration","description":"","security":[{"OAuth2":["FullAccess","PromotionAdmin"]}],"x-authorizedUserTypes":["Seller"]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionIntegration"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"PromotionIntegrations.Patch","tags":["Promotion"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PromotionIntegration"}]}}}},"summary":"Partially update a promotion integration","description":"","security":[{"OAuth2":["FullAccess","PromotionAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/integrations/subscription":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionIntegration"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SubscriptionIntegrations.Get","tags":["Subscription"],"summary":"Retrieve a subscription integration","description":"","security":[{"OAuth2":["FullAccess","SubscriptionAdmin"]}],"x-authorizedUserTypes":["Seller"]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionIntegration"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SubscriptionIntegrations.Save","tags":["Subscription"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SubscriptionIntegration"}],"required":["ApiClientID","HashKey"]}}}},"summary":"Create or update a subscription integration","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","SubscriptionAdmin"]}],"x-authorizedUserTypes":["Seller"]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SubscriptionIntegrations.Delete","tags":["Subscription"],"summary":"Delete a subscription integration","description":"","security":[{"OAuth2":["FullAccess","SubscriptionAdmin"]}],"x-authorizedUserTypes":["Seller"]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionIntegration"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SubscriptionIntegrations.Patch","tags":["Subscription"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SubscriptionIntegration"}]}}}},"summary":"Partially update a subscription integration","description":"","security":[{"OAuth2":["FullAccess","SubscriptionAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/integrations/trackingEvents":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/TrackingEvent"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"TrackingEvents.List","tags":["Tracking events"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","EventType"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","EventType","!ID","!EventType"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List tracking events","description":"","security":[{"OAuth2":["FullAccess","TrackingEventAdmin","TrackingEventReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingEvent"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"TrackingEvents.Create","tags":["Tracking events"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TrackingEvent"}],"required":["EventType","ClientID","Name","DeliveryConfigID"]}}}},"summary":"Create a tracking event","description":"","security":[{"OAuth2":["FullAccess","TrackingEventAdmin"]}]}},"/integrations/trackingEvents/{eventID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingEvent"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"TrackingEvents.Get","tags":["Tracking events"],"parameters":[{"name":"eventID","in":"path","description":"ID of the event.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a tracking event","description":"","security":[{"OAuth2":["FullAccess","TrackingEventAdmin","TrackingEventReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingEvent"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"TrackingEvents.Save","tags":["Tracking events"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TrackingEvent"}],"required":["EventType","ClientID","Name","DeliveryConfigID"]}}}},"parameters":[{"name":"eventID","in":"path","description":"ID of the event.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a tracking event","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","TrackingEventAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"TrackingEvents.Delete","tags":["Tracking events"],"parameters":[{"name":"eventID","in":"path","description":"ID of the event.","required":true,"schema":{"type":"string"}}],"summary":"Delete a tracking event","description":"","security":[{"OAuth2":["FullAccess","TrackingEventAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingEvent"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"TrackingEvents.Patch","tags":["Tracking events"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TrackingEvent"}]}}}},"parameters":[{"name":"eventID","in":"path","description":"ID of the event.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a tracking event","description":"","security":[{"OAuth2":["FullAccess","TrackingEventAdmin"]}]}},"/lineitems/{direction}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ExtendedLineItem"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"LineItems.ListAcrossOrders","tags":["Line items"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":false,"schema":{"type":"string"}},{"name":"supplierID","in":"query","description":"ID of the supplier.","required":false,"schema":{"type":"string"}},{"name":"from","in":"query","description":"Lower bound of date range that the order was created.","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","description":"Upper bound of date range that the order was created.","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","ProductID"]}}},{"name":"searchType","in":"query","description":"Type of search to perform.","required":false,"schema":{"$ref":"#/components/schemas/SearchType","default":"AnyTerm"}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DateAdded","ID","ProductID","!DateAdded","!ID","!ProductID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List line item across orders","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","OrderReader"]}]}},"/locales":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Locale"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Locales.List","tags":["Locales"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Currency"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List locales","description":"","security":[{"OAuth2":["FullAccess","LocaleAdmin","LocaleReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Locale"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Locales.Create","tags":["Locales"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Locale"}],"required":["Currency"]}}}},"summary":"Create a locale","description":"","security":[{"OAuth2":["FullAccess","LocaleAdmin"]}]}},"/locales/{localeID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Locale"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Locales.Get","tags":["Locales"],"parameters":[{"name":"localeID","in":"path","description":"ID of the locale.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a locale","description":"","security":[{"OAuth2":["FullAccess","LocaleAdmin","LocaleReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Locale"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Locales.Save","tags":["Locales"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Locale"}],"required":["Currency"]}}}},"parameters":[{"name":"localeID","in":"path","description":"ID of the locale.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a locale","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","LocaleAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Locales.Delete","tags":["Locales"],"parameters":[{"name":"localeID","in":"path","description":"ID of the locale.","required":true,"schema":{"type":"string"}}],"summary":"Delete a locale","description":"","security":[{"OAuth2":["FullAccess","LocaleAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Locale"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Locales.Patch","tags":["Locales"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Locale"}]}}}},"parameters":[{"name":"localeID","in":"path","description":"ID of the locale.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a locale","description":"","security":[{"OAuth2":["FullAccess","LocaleAdmin"]}]}},"/locales/{localeID}/assignments":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Locales.DeleteAssignment","tags":["Locales"],"parameters":[{"name":"localeID","in":"path","description":"ID of the locale.","required":true,"schema":{"type":"string"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}}],"summary":"Delete a locale assignment","description":"","security":[{"OAuth2":["FullAccess","LocaleAdmin","PromotionAdmin"]}]}},"/locales/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/LocaleAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Locales.ListAssignments","tags":["Locales"],"parameters":[{"name":"buyerID","in":"query","description":"ID of the buyer.","required":false,"schema":{"type":"string"}},{"name":"localeID","in":"query","description":"ID of the locale.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Level of the locale assignment. Possible values: Group, Company, BuyerGroup.","required":false,"schema":{"type":"string","enum":["Group","Company"]}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}}],"summary":"List locale assignments","description":"","security":[{"OAuth2":["FullAccess","LocaleAdmin","LocaleReader"]}]},"post":{"responses":{"204":{"description":"Do not assign a user multiple groups with different assigned locales. That is considered a misconfiguration, and will yield unexpected results."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Locales.SaveAssignment","tags":["Locales"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/LocaleAssignment"}],"required":["LocaleID","BuyerID"]}}}},"summary":"Create or update a locale assignment","description":"Do not assign a user multiple groups with different assigned locales. That is considered a misconfiguration, and will yield unexpected results.","security":[{"OAuth2":["FullAccess","LocaleAdmin"]}]}},"/me":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeUser"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.Get","tags":["Me"],"x-me-subsection":"Me","summary":"Get the currently authenticated user","description":"","security":[{"OAuth2":[]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeUser"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.Save","tags":["Me"],"x-me-subsection":"Me","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MeUser"}],"required":["Username","FirstName","LastName","Email","Active"]}}}},"summary":"Update the currently authenticated user","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","MeAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeUser"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.Patch","tags":["Me"],"x-me-subsection":"Me","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MeUser"}]}}}},"summary":"Patch the currently authenticated user","description":"","security":[{"OAuth2":["FullAccess","MeAdmin"]}]}},"/me/addresses":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/BuyerAddress"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListAddresses","tags":["Me"],"x-me-subsection":"Addresses","parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","AddressName","CompanyName","City","Street1","Street2","LastName","FirstName","State","Zip"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["AddressName","ID","DateCreated","CompanyName","FirstName","LastName","Street1","Street2","City","State","Zip","Country","Phone","!AddressName","!ID","!DateCreated","!CompanyName","!FirstName","!LastName","!Street1","!Street2","!City","!State","!Zip","!Country","!Phone"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List addresses visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","MeAddressAdmin","Shopper"]}]},"post":{"responses":{"201":{"description":"Only available to Buyer Users. Addresses created using this endpoint are considered private, and only accessible to the user who created them.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerAddress"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.CreateAddress","tags":["Me"],"x-me-subsection":"Addresses","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BuyerAddress"}],"required":["Street1","City","Country"]}}}},"summary":"Create an address","description":"Only available to Buyer Users. Addresses created using this endpoint are considered private, and only accessible to the user who created them.","security":[{"OAuth2":["FullAccess","MeAddressAdmin"]}],"x-limitAnonUser":true}},"/me/addresses/{addressID}":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerAddress"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.GetAddress","tags":["Me"],"x-me-subsection":"Addresses","parameters":[{"name":"addressID","in":"path","description":"ID of the address.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve an address","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","MeAddressAdmin","Shopper"]}]},"put":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerAddress"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.SaveAddress","tags":["Me"],"x-me-subsection":"Addresses","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BuyerAddress"}],"required":["Street1","City","Country"]}}}},"parameters":[{"name":"addressID","in":"path","description":"ID of the address.","required":true,"schema":{"type":"string"}}],"summary":"Update an address","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","MeAddressAdmin"]}],"x-limitAnonUser":true},"delete":{"responses":{"204":{"description":"Only available to Buyer Users."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.DeleteAddress","tags":["Me"],"x-me-subsection":"Addresses","parameters":[{"name":"addressID","in":"path","description":"ID of the address.","required":true,"schema":{"type":"string"}}],"summary":"Delete an address","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","MeAddressAdmin"]}],"x-limitAnonUser":true},"patch":{"responses":{"204":{"description":"Only available to Buyer Users."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.PatchAddress","tags":["Me"],"x-me-subsection":"Addresses","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BuyerAddress"}]}}}},"parameters":[{"name":"addressID","in":"path","description":"ID of the address.","required":true,"schema":{"type":"string"}}],"summary":"Partially update an address","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","MeAddressAdmin"]}],"x-limitAnonUser":true}},"/me/catalogs":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Catalog"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListCatalogs","tags":["Me"],"x-me-subsection":"Catalogs","parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Description"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["OwnerID","Name","ID","!OwnerID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}},{"name":"sellerID","in":"query","description":"ID of the seller.","required":false,"schema":{"type":"string"}}],"summary":"List catalogs visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","OrderContributor","Shopper"]}]}},"/me/catalogs/{catalogID}":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Catalog"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.GetCatalog","tags":["Me"],"x-me-subsection":"Catalogs","parameters":[{"name":"catalogID","in":"path","description":"ID of the catalog.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a catalog","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","OrderContributor","Shopper"]}]}},"/me/categories":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListCategories","tags":["Me"],"x-me-subsection":"Categories","parameters":[{"name":"depth","in":"query","description":"Indicates how deep down the hierarchy to return results. Valid values are a number of 1 or greater, or 'all'. Relative to ParentID if specified. Default is 1.","required":false,"schema":{"type":"string","default":"1"}},{"name":"catalogID","in":"query","description":"The user’s default CatalogID will be used to return categories if you do not pass another CatalogID explicitly. Listing categories across multiple catalogs is not supported.","required":false,"schema":{"type":"string"}},{"name":"productID","in":"query","description":"ID of the product.","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Description"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","!ID","!Name"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List categories visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}]}},"/me/categories/{categoryID}":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.GetCategory","tags":["Me"],"x-me-subsection":"Categories","parameters":[{"name":"categoryID","in":"path","description":"ID of the category.","required":true,"schema":{"type":"string"}},{"name":"catalogID","in":"query","description":"ID of the catalog.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a category","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}]}},"/me/costcenters":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/CostCenter"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListCostCenters","tags":["Me"],"x-me-subsection":"Cost centers","parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Description"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List cost centers visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}]}},"/me/creditcards":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/BuyerCreditCard"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListCreditCards","tags":["Me"],"x-me-subsection":"Credit cards","parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","CardholderName","CardType","ExpirationDate","Editable"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","CardholderName","CardType","ExpirationDate","DateCreated","!ID","!CardholderName","!CardType","!ExpirationDate","!DateCreated"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List credit cards visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","MeCreditCardAdmin","Shopper"]}]},"post":{"responses":{"201":{"description":"Only available to Buyer Users. Credit Cards created using this endpoint are considered private, and only accessible to the user who created them.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerCreditCard"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.CreateCreditCard","tags":["Me"],"x-me-subsection":"Credit cards","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BuyerCreditCard"}]}}}},"summary":"Create a credit card","description":"Only available to Buyer Users. Credit Cards created using this endpoint are considered private, and only accessible to the user who created them.","security":[{"OAuth2":["FullAccess","MeCreditCardAdmin"]}],"x-limitAnonUser":true}},"/me/creditcards/{creditcardID}":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerCreditCard"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.GetCreditCard","tags":["Me"],"x-me-subsection":"Credit cards","parameters":[{"name":"creditcardID","in":"path","description":"ID of the creditcard.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a credit card","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","MeCreditCardAdmin","Shopper"]}]},"put":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerCreditCard"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.SaveCreditCard","tags":["Me"],"x-me-subsection":"Credit cards","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BuyerCreditCard"}]}}}},"parameters":[{"name":"creditcardID","in":"path","description":"ID of the creditcard.","required":true,"schema":{"type":"string"}}],"summary":"Update a credit card","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","MeCreditCardAdmin"]}],"x-limitAnonUser":true},"delete":{"responses":{"204":{"description":"Only available to Buyer Users."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.DeleteCreditCard","tags":["Me"],"x-me-subsection":"Credit cards","parameters":[{"name":"creditcardID","in":"path","description":"ID of the creditcard.","required":true,"schema":{"type":"string"}}],"summary":"Delete a credit card","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","MeCreditCardAdmin"]}],"x-limitAnonUser":true},"patch":{"responses":{"204":{"description":"Only available to Buyer Users."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.PatchCreditCard","tags":["Me"],"x-me-subsection":"Credit cards","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BuyerCreditCard"}]}}}},"parameters":[{"name":"creditcardID","in":"path","description":"ID of the creditcard.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a credit card","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","MeCreditCardAdmin"]}],"x-limitAnonUser":true}},"/me/orderinvitations":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/GroupOrderInvitation"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListGroupOrderInvitations","tags":["Me"],"x-me-subsection":"Orders","parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","OrderID","OrderStatus"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","OrderID","OrderStatus","!ID","!Name","!OrderID","!OrderStatus"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List group order invitations visible to this user","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-lifecycle":"Beta"},"post":{"responses":{"201":{"description":"A group order invitation allows other users to contribute to an existing order. Contributors may request an access token with the invitation ID that allows them to add line items and modify those line items.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupOrderInvitation"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.CreateGroupOrderInvitation","tags":["Me"],"x-me-subsection":"Orders","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/GroupOrderInvitation"}],"required":["ExpirationDate","OrderID"]}}}},"summary":"Create a group order invitation","description":"A group order invitation allows other users to contribute to an existing order. Contributors may request an access token with the invitation ID that allows them to add line items and modify those line items.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-lifecycle":"Beta"}},"/me/orderinvitations/{invitationID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupOrderInvitation"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.GetGroupOrderInvitation","tags":["Me"],"x-me-subsection":"Orders","parameters":[{"name":"invitationID","in":"path","description":"ID of the invitation.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a group order invitation","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-lifecycle":"Beta"},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.DeleteGroupOrderInvitation","tags":["Me"],"x-me-subsection":"Orders","parameters":[{"name":"invitationID","in":"path","description":"ID of the invitation.","required":true,"schema":{"type":"string"}}],"summary":"Delete a group order invitation","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-lifecycle":"Beta"},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupOrderInvitation"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.PatchGroupOrderInvitation","tags":["Me"],"x-me-subsection":"Orders","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/GroupOrderInvitation"}]}}}},"parameters":[{"name":"invitationID","in":"path","description":"ID of the invitation.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a group order invitation","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-lifecycle":"Beta"}},"/me/orders":{"get":{"responses":{"200":{"description":"List orders created by this user.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListOrders","tags":["Me"],"x-me-subsection":"Orders","parameters":[{"name":"from","in":"query","description":"Lower bound of date range that the order was created (if outgoing) or submitted (if incoming).","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","description":"Upper bound of date range that the order was created (if outgoing) or submitted (if incoming).","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","FromCompanyID","ToCompanyID","Comments"]}}},{"name":"searchType","in":"query","description":"Type of search to perform.","required":false,"schema":{"$ref":"#/components/schemas/SearchType","default":"AnyTerm"}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DateSubmitted","DateCreated","ID","FromCompanyID","ToCompanyID","FromUserID","Status","DateApproved","DateDeclined","DateCanceled","DateCompleted","LastUpdated","Subtotal","ShippingCost","TaxCost","Gratuity","Fees","BaseDiscount","PromotionDiscount","Total","IsSubmitted","!DateSubmitted","!DateCreated","!ID","!FromCompanyID","!ToCompanyID","!FromUserID","!Status","!DateApproved","!DateDeclined","!DateCanceled","!DateCompleted","!LastUpdated","!Subtotal","!ShippingCost","!TaxCost","!Gratuity","!Fees","!BaseDiscount","!PromotionDiscount","!Total","!IsSubmitted"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List orders visible to this user","description":"List orders created by this user.","security":[{"OAuth2":["FullAccess","Shopper"]}]},"put":{"responses":{"204":{"description":"If a user begins an order as the anonymous shopper and later logs in, use this endpoint to transfer that order to them."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.TransferAnonUserOrder","tags":["Me"],"x-me-subsection":"Orders","parameters":[{"name":"anonUserToken","in":"query","description":"Anon user token of the me.","required":true,"schema":{"type":"string"}}],"summary":"Transfer an anon user order","description":"If a user begins an order as the anonymous shopper and later logs in, use this endpoint to transfer that order to them.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-limitAnonUser":true}},"/me/orders/approvable":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListApprovableOrders","tags":["Me"],"x-me-subsection":"Orders","parameters":[{"name":"from","in":"query","description":"Lower bound of date range that the order was created (if outgoing) or submitted (if incoming).","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","description":"Upper bound of date range that the order was created (if outgoing) or submitted (if incoming).","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","FromCompanyID","ToCompanyID","Comments"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DateSubmitted","DateCreated","ID","FromCompanyID","ToCompanyID","FromUserID","Status","DateApproved","DateDeclined","DateCanceled","DateCompleted","LastUpdated","Subtotal","ShippingCost","TaxCost","Gratuity","Fees","BaseDiscount","PromotionDiscount","Total","IsSubmitted","!DateSubmitted","!DateCreated","!ID","!FromCompanyID","!ToCompanyID","!FromUserID","!Status","!DateApproved","!DateDeclined","!DateCanceled","!DateCompleted","!LastUpdated","!Subtotal","!ShippingCost","!TaxCost","!Gratuity","!Fees","!BaseDiscount","!PromotionDiscount","!Total","!IsSubmitted"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"Get a list of orders that this user can approve","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}]}},"/me/password":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ResetPasswordByToken","tags":["Me"],"x-me-subsection":"Me","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TokenPasswordReset"}],"required":["NewPassword"]}}}},"summary":"Reset a password by token","description":"","security":[{"OAuth2":["FullAccess","PasswordReset"]}]}},"/me/productcollections":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ProductCollection"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListProductCollections","tags":["Me"],"x-me-subsection":"Product collections","parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List product collections visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}]},"post":{"responses":{"201":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCollection"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.CreateProductCollection","tags":["Me"],"x-me-subsection":"Product collections","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ProductCollection"}],"required":["Name"]}}}},"summary":"Create a product collection","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-limitAnonUser":true}},"/me/productcollections/{productCollectionID}":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCollection"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.GetProductCollection","tags":["Me"],"x-me-subsection":"Product collections","parameters":[{"name":"productCollectionID","in":"path","description":"ID of the product collection.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a product collection","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}]},"put":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCollection"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.SaveProductCollection","tags":["Me"],"x-me-subsection":"Product collections","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ProductCollection"}],"required":["Name"]}}}},"parameters":[{"name":"productCollectionID","in":"path","description":"ID of the product collection.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a product collection","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-limitAnonUser":true},"delete":{"responses":{"204":{"description":"Only available to Buyer Users."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.DeleteProductCollection","tags":["Me"],"x-me-subsection":"Product collections","parameters":[{"name":"productCollectionID","in":"path","description":"ID of the product collection.","required":true,"schema":{"type":"string"}}],"summary":"Delete a product collection","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-limitAnonUser":true},"patch":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCollection"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.PatchProductCollection","tags":["Me"],"x-me-subsection":"Product collections","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ProductCollection"}]}}}},"parameters":[{"name":"productCollectionID","in":"path","description":"ID of the product collection.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a product collection","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-limitAnonUser":true}},"/me/productcollections/{productCollectionID}/{productID}":{"put":{"responses":{"204":{"description":"Only available to Buyer Users."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.CreateProductCollectionEntry","tags":["Me"],"x-me-subsection":"Product collections","parameters":[{"name":"productCollectionID","in":"path","description":"ID of the product collection.","required":true,"schema":{"type":"string"}},{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}}],"summary":"Create a product collection entry","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-limitAnonUser":true},"delete":{"responses":{"204":{"description":"Only available to Buyer Users."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.DeleteProductCollectionEntry","tags":["Me"],"x-me-subsection":"Product collections","parameters":[{"name":"productCollectionID","in":"path","description":"ID of the product collection.","required":true,"schema":{"type":"string"}},{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}}],"summary":"Delete a product collection entry","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-limitAnonUser":true}},"/me/productcollections/{productCollectionID}/invitations":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ProductCollectionInvitation"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListProductCollectionInvitations","tags":["Me"],"x-me-subsection":"Product collections","parameters":[{"name":"productCollectionID","in":"path","description":"ID of the product collection.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name"]}}},{"name":"searchType","in":"query","description":"Type of search to perform.","required":false,"schema":{"$ref":"#/components/schemas/SearchType","default":"AnyTerm"}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List product collection invitations visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-limitAnonUser":true},"post":{"responses":{"201":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCollectionInvitation"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.CreateProductCollectionInvitation","tags":["Me"],"x-me-subsection":"Product collections","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ProductCollectionInvitation"}],"required":["Name"]}}}},"parameters":[{"name":"productCollectionID","in":"path","description":"ID of the product collection.","required":true,"schema":{"type":"string"}}],"summary":"Create a product collection invitation","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-limitAnonUser":true}},"/me/productcollections/{productCollectionID}/invitations/{invitationID}":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCollectionInvitation"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.GetProductCollectionInvitation","tags":["Me"],"x-me-subsection":"Product collections","parameters":[{"name":"productCollectionID","in":"path","description":"ID of the product collection.","required":true,"schema":{"type":"string"}},{"name":"invitationID","in":"path","description":"ID of the invitation.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a product collection invitation","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-limitAnonUser":true},"delete":{"responses":{"204":{"description":"Only available to Buyer Users."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.DeleteProductCollectionInvitation","tags":["Me"],"x-me-subsection":"Product collections","parameters":[{"name":"productCollectionID","in":"path","description":"ID of the product collection.","required":true,"schema":{"type":"string"}},{"name":"invitationID","in":"path","description":"ID of the invitation.","required":true,"schema":{"type":"string"}}],"summary":"Delete a product collection invitation","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-limitAnonUser":true},"patch":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCollectionInvitation"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.PatchProductCollectionInvitation","tags":["Me"],"x-me-subsection":"Product collections","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ProductCollectionInvitation"}]}}}},"parameters":[{"name":"productCollectionID","in":"path","description":"ID of the product collection.","required":true,"schema":{"type":"string"}},{"name":"invitationID","in":"path","description":"ID of the invitation.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a product collection invitation","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-limitAnonUser":true}},"/me/productcollections/{productCollectionID}/invitations/accept/{invitationID}":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.AcceptProductCollectionInvitation","tags":["Me"],"x-me-subsection":"Product collections","parameters":[{"name":"productCollectionID","in":"path","description":"ID of the product collection.","required":true,"schema":{"type":"string"}},{"name":"invitationID","in":"path","description":"ID of the invitation.","required":true,"schema":{"type":"string"}}],"summary":"Accept a product collection invitation","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-limitAnonUser":true}},"/me/productcollections/{productCollectionID}/invitations/decline/{invitationID}":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.DeclineProductCollectionInvitation","tags":["Me"],"x-me-subsection":"Product collections","parameters":[{"name":"productCollectionID","in":"path","description":"ID of the product collection.","required":true,"schema":{"type":"string"}},{"name":"invitationID","in":"path","description":"ID of the invitation.","required":true,"schema":{"type":"string"}}],"summary":"Decline a product collection invitation","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-limitAnonUser":true}},"/me/productcollections/{productCollectionID}/products":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ProductCollectionBuyerProduct"}},"Meta":{"$ref":"#/components/schemas/MetaWithFacets"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListProductCollectionEntries","tags":["Me"],"x-me-subsection":"Product collections","parameters":[{"name":"productCollectionID","in":"path","description":"ID of the product collection.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","ParentID","Name","Description"]}}},{"name":"searchType","in":"query","description":"Type of search to perform.","required":false,"schema":{"$ref":"#/components/schemas/SearchType","default":"AnyTerm"}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","ParentID","!Name","!ID","!ParentID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List product collection entries visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}]},"post":{"responses":{"204":{"description":"Only available to Buyer Users."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.SaveProductCollectionEntry","tags":["Me"],"x-me-subsection":"Product collections","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ProductCollectionEntry"}],"required":["ProductID"]}}}},"parameters":[{"name":"productCollectionID","in":"path","description":"ID of the product collection.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a product collection entry","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}],"x-limitAnonUser":true}},"/me/products":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/BuyerProduct"}},"Meta":{"$ref":"#/components/schemas/MetaWithFacets"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListProducts","tags":["Me"],"x-me-subsection":"Products","parameters":[{"name":"catalogID","in":"query","description":"ID of the catalog.","required":false,"schema":{"type":"string"}},{"name":"categoryID","in":"query","description":"ID of the category.","required":false,"schema":{"type":"string"}},{"name":"depth","in":"query","description":"Indicates how deep down the category hierarchy to return results. Valid values are a number of 1 or greater, or 'all'. Relative to CategoryID if specified, otherwise top level of the Catalog. Default is 'all'.","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","ParentID","Name","Description"]}}},{"name":"searchType","in":"query","description":"Type of search to perform.","required":false,"schema":{"$ref":"#/components/schemas/SearchType","default":"AnyTerm"}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","ParentID","!Name","!ID","!ParentID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}},{"name":"sellerID","in":"query","description":"ID of the seller.","required":false,"schema":{"type":"string"}}],"summary":"List products visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","OrderContributor","Shopper"]}]}},"/me/products/{productID}":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerProduct"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.GetProduct","tags":["Me"],"x-me-subsection":"Products","parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"sellerID","in":"query","description":"ID of the seller.","required":false,"schema":{"type":"string"}}],"summary":"Retrieve a product","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","OrderContributor","Shopper"]}]}},"/me/products/{productID}/inventoryrecords":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/InventoryRecord"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListProductInventoryRecords","tags":["Me"],"x-me-subsection":"Products","parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","AddressID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","AddressID","!ID","!AddressID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}},{"name":"includeAddress","in":"query","description":"Include address of the inventory record.","required":false,"schema":{"type":"boolean"}}],"summary":"List product inventory records visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}]}},"/me/products/{productID}/sellers":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ProductSeller"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListProductSellers","tags":["Me"],"x-me-subsection":"Products","parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List product sellers visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}]}},"/me/products/{productID}/specs":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Spec"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListSpecs","tags":["Me"],"x-me-subsection":"Products","parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"catalogID","in":"query","description":"ID of the catalog.","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ListOrder","Name","ID","!ListOrder","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List specs visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","OrderContributor","Shopper"]}]}},"/me/products/{productID}/specs/{specID}":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Spec"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.GetSpec","tags":["Me"],"x-me-subsection":"Products","parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"specID","in":"path","description":"ID of the spec.","required":true,"schema":{"type":"string"}},{"name":"catalogID","in":"query","description":"ID of the catalog.","required":false,"schema":{"type":"string"}}],"summary":"Retrieve a spec","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","OrderContributor","Shopper"]}]}},"/me/products/{productID}/variants":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Variant"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListVariants","tags":["Me"],"x-me-subsection":"Products","parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Description"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","!ID","!Name"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List variants visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","OrderContributor","Shopper"]}]}},"/me/products/{productID}/variants/{variantID}":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variant"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.GetVariant","tags":["Me"],"x-me-subsection":"Products","parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"variantID","in":"path","description":"ID of the variant.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a variant","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","OrderContributor","Shopper"]}]}},"/me/products/{productID}/variants/{variantID}/inventoryrecords":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/InventoryRecord"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListVariantInventoryRecords","tags":["Me"],"x-me-subsection":"Products","parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"variantID","in":"path","description":"ID of the variant.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","AddressID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","AddressID","!ID","!AddressID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}},{"name":"includeAddress","in":"query","description":"Include address of the inventory record.","required":false,"schema":{"type":"boolean"}}],"summary":"List variant inventory records visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}]}},"/me/promotions":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Promotion"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListPromotions","tags":["Me"],"x-me-subsection":"Promotions","parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Code","Description","FinePrint","EligibleExpression","ValueExpression"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","Code","StartDate","ExpirationDate","EligibleExpression","ValueExpression","CanCombine","AutoApply","Active","Priority","!Name","!ID","!Code","!StartDate","!ExpirationDate","!EligibleExpression","!ValueExpression","!CanCombine","!AutoApply","!Active","!Priority"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List promotions visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}]}},"/me/promotions/{promotionID}":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Promotion"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.GetPromotion","tags":["Me"],"x-me-subsection":"Promotions","parameters":[{"name":"promotionID","in":"path","description":"ID of the promotion.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a promotion","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}]}},"/me/register":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessTokenBasic"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.Register","tags":["Me"],"x-me-subsection":"Me","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MeUser"}],"required":["Username","FirstName","LastName","Email","Active"]}}}},"parameters":[{"name":"anonUserToken","in":"query","description":"Anon user token of the user.","required":true,"schema":{"type":"string"}}],"summary":"Register a user","description":"","security":[{"OAuth2":["FullAccess","Shopper"]}]}},"/me/sellers":{"get":{"responses":{"200":{"description":"Organizations you can place orders directly to.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/BuyerSupplier"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListBuyerSellers","tags":["Me"],"x-me-subsection":"Sellers","parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"Get a list of sellers this user can purchase from","description":"Organizations you can place orders directly to.","security":[{"OAuth2":["FullAccess","Shopper"]}]}},"/me/shipments":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Shipment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListShipments","tags":["Me"],"x-me-subsection":"Shipments","parameters":[{"name":"orderID","in":"query","description":"ID of the order.","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","BuyerID","Shipper","DateShipped","DateDelivered","TrackingNumber"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DateShipped","OwnerID","ID","BuyerID","Shipper","DateDelivered","Cost","!DateShipped","!OwnerID","!ID","!BuyerID","!Shipper","!DateDelivered","!Cost"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List shipments visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}]}},"/me/shipments/{shipmentID}":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shipment"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.GetShipment","tags":["Me"],"x-me-subsection":"Shipments","parameters":[{"name":"shipmentID","in":"path","description":"ID of the shipment.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a shipment","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}]}},"/me/shipments/{shipmentID}/items":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentItem"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListShipmentItems","tags":["Me"],"x-me-subsection":"Shipments","parameters":[{"name":"shipmentID","in":"path","description":"ID of the shipment.","required":true,"schema":{"type":"string"}},{"name":"orderID","in":"query","description":"ID of the order.","required":false,"schema":{"type":"string"}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["OrderID","LineItemID","!OrderID","!LineItemID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List shipment items visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}]}},"/me/spendingAccounts":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/SpendingAccount"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListSpendingAccounts","tags":["Me"],"x-me-subsection":"Spending accounts","parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List spending accounts visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}]}},"/me/spendingaccounts/{spendingAccountID}":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpendingAccount"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.GetSpendingAccount","tags":["Me"],"x-me-subsection":"Spending accounts","parameters":[{"name":"spendingAccountID","in":"path","description":"ID of the spending account.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a spending account","description":"Only available to Buyer Users.","security":[{"OAuth2":["FullAccess","Shopper"]}]}},"/me/subscriptions":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Subscription"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListSubscriptions","tags":["Me"],"x-me-subsection":"Subscriptions","parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","FromCompanyID","ToCompanyID","Interval"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Interval","NextOrderDate","LastOrderDate","DateCreated","EndDate","FromCompanyID","FromUserID","ToCompanyID","!ID","!Interval","!NextOrderDate","!LastOrderDate","!DateCreated","!EndDate","!FromCompanyID","!FromUserID","!ToCompanyID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List subscriptions visible to this user","description":"","security":[{"OAuth2":["FullAccess","MeSubscriptionAdmin","Shopper"]}],"x-limitAnonUser":true},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.CreateSubscription","tags":["Me"],"x-me-subsection":"Subscriptions","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Subscription"}],"required":["Frequency","Interval","NextOrderDate"]}}}},"summary":"Create a subscription","description":"","security":[{"OAuth2":["FullAccess","MeSubscriptionAdmin"]}],"x-limitAnonUser":true}},"/me/subscriptions/{subscriptionID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.GetSubscription","tags":["Me"],"x-me-subsection":"Subscriptions","parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a subscription","description":"","security":[{"OAuth2":["FullAccess","MeSubscriptionAdmin","Shopper"]}],"x-limitAnonUser":true},"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.SaveSubscription","tags":["Me"],"x-me-subsection":"Subscriptions","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Subscription"}],"required":["Frequency","Interval","NextOrderDate"]}}}},"parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a subscription","description":"","security":[{"OAuth2":["FullAccess","MeSubscriptionAdmin"]}],"x-limitAnonUser":true},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.DeleteSubscription","tags":["Me"],"x-me-subsection":"Subscriptions","parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}}],"summary":"Delete a subscription","description":"","security":[{"OAuth2":["FullAccess","MeSubscriptionAdmin"]}],"x-limitAnonUser":true},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.PatchSubscription","tags":["Me"],"x-me-subsection":"Subscriptions","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Subscription"}]}}}},"parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a subscription","description":"","security":[{"OAuth2":["FullAccess","MeSubscriptionAdmin"]}],"x-limitAnonUser":true}},"/me/subscriptions/{subscriptionID}/items":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListSubscriptionItems","tags":["Me"],"x-me-subsection":"Subscriptions","parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","ProductID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DateAdded","ID","ProductID","!DateAdded","!ID","!ProductID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List subscription items visible to this user","description":"","security":[{"OAuth2":["FullAccess","MeSubscriptionAdmin","Shopper"]}],"x-limitAnonUser":true},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.CreateSubscriptionItem","tags":["Me"],"x-me-subsection":"Subscriptions","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/LineItem"}],"required":["ProductID"]}}}},"parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}}],"summary":"Create a subscription item","description":"","security":[{"OAuth2":["FullAccess","MeSubscriptionAdmin"]}],"x-limitAnonUser":true}},"/me/subscriptions/{subscriptionID}/items/{subscriptionItemID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.GetSubscriptionItem","tags":["Me"],"x-me-subsection":"Subscriptions","parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}},{"name":"subscriptionItemID","in":"path","description":"ID of the subscription item.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a subscription item","description":"","security":[{"OAuth2":["FullAccess","MeSubscriptionAdmin","Shopper"]}],"x-limitAnonUser":true},"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.SaveSubscriptionItem","tags":["Me"],"x-me-subsection":"Subscriptions","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/LineItem"}],"required":["ProductID"]}}}},"parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}},{"name":"subscriptionItemID","in":"path","description":"ID of the subscription item.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a subscription item","description":"","security":[{"OAuth2":["FullAccess","MeSubscriptionAdmin"]}],"x-limitAnonUser":true},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.DeleteSubscriptionItem","tags":["Me"],"x-me-subsection":"Subscriptions","parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}},{"name":"subscriptionItemID","in":"path","description":"ID of the subscription item.","required":true,"schema":{"type":"string"}}],"summary":"Delete a subscription item","description":"","security":[{"OAuth2":["FullAccess","MeSubscriptionAdmin"]}],"x-limitAnonUser":true},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.PatchSubscriptionItem","tags":["Me"],"x-me-subsection":"Subscriptions","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/LineItem"}]}}}},"parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}},{"name":"subscriptionItemID","in":"path","description":"ID of the subscription item.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a subscription item","description":"","security":[{"OAuth2":["FullAccess","MeSubscriptionAdmin"]}],"x-limitAnonUser":true}},"/me/subscriptions/{subscriptionID}/items/bundles/{bundleID}":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.CreateSubscriptionBundleItem","tags":["Me"],"x-me-subsection":"Subscriptions","requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BundleItems"}]}}}},"parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}},{"name":"bundleID","in":"path","description":"ID of the bundle.","required":true,"schema":{"type":"string"}}],"summary":"Create a subscription bundle item","description":"","security":[{"OAuth2":["FullAccess","MeSubscriptionAdmin"]}],"x-limitAnonUser":true}},"/me/subscriptions/{subscriptionID}/items/bundles/{bundleID}/{bundleItemID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.DeleteSubscriptionBundleItem","tags":["Me"],"x-me-subsection":"Subscriptions","parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}},{"name":"bundleID","in":"path","description":"ID of the bundle.","required":true,"schema":{"type":"string"}},{"name":"bundleItemID","in":"path","description":"ID of the bundle item.","required":true,"schema":{"type":"string"}}],"summary":"Delete a subscription bundle item","description":"","security":[{"OAuth2":["FullAccess","MeSubscriptionAdmin"]}],"x-limitAnonUser":true}},"/me/tokens":{"delete":{"responses":{"204":{"description":"Revokes all tokens previously issued to the current user and forces them to reauthenticate."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.RevokeTokens","tags":["Me"],"x-me-subsection":"Me","summary":"Revoke tokens","description":"Revokes all tokens previously issued to the current user and forces them to reauthenticate.","security":[{"OAuth2":[]}],"x-limitAnonUser":true}},"/me/usergroups":{"get":{"responses":{"200":{"description":"Only available to Buyer Users.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/UserGroup"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Me.ListUserGroups","tags":["Me"],"x-me-subsection":"User groups","parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Description"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List user groups visible to this user","description":"Only available to Buyer Users.","security":[{"OAuth2":[]}]}},"/messagesenders":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/MessageSender"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"MessageSenders.List","tags":["Message senders"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","!ID","!Name"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List message senders","description":"","security":[{"OAuth2":["FullAccess","MessageSenderAdmin","MessageSenderReader"]}],"x-authorizedUserTypes":["Seller"]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageSender"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"MessageSenders.Create","tags":["Message senders"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MessageSender"}],"required":["Name","MessageTypes","DeliveryConfigID"]}}}},"summary":"Create a message sender","description":"","security":[{"OAuth2":["FullAccess","MessageSenderAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/messagesenders/{messageSenderID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageSender"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"MessageSenders.Get","tags":["Message senders"],"parameters":[{"name":"messageSenderID","in":"path","description":"ID of the message sender.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a message sender","description":"","security":[{"OAuth2":["FullAccess","MessageSenderAdmin","MessageSenderReader"]}],"x-authorizedUserTypes":["Seller"]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageSender"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"MessageSenders.Save","tags":["Message senders"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MessageSender"}],"required":["Name","MessageTypes","DeliveryConfigID"]}}}},"parameters":[{"name":"messageSenderID","in":"path","description":"ID of the message sender.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a message sender","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","MessageSenderAdmin"]}],"x-authorizedUserTypes":["Seller"]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"MessageSenders.Delete","tags":["Message senders"],"parameters":[{"name":"messageSenderID","in":"path","description":"ID of the message sender.","required":true,"schema":{"type":"string"}}],"summary":"Delete a message sender","description":"","security":[{"OAuth2":["FullAccess","MessageSenderAdmin"]}],"x-authorizedUserTypes":["Seller"]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageSender"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"MessageSenders.Patch","tags":["Message senders"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MessageSender"}]}}}},"parameters":[{"name":"messageSenderID","in":"path","description":"ID of the message sender.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a message sender","description":"","security":[{"OAuth2":["FullAccess","MessageSenderAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/messagesenders/{messageSenderID}/assignments":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"MessageSenders.DeleteAssignment","tags":["Message senders"],"parameters":[{"name":"messageSenderID","in":"path","description":"ID of the message sender.","required":true,"schema":{"type":"string"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":false,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"supplierID","in":"query","description":"ID of the supplier.","required":false,"schema":{"type":"string"}}],"summary":"Delete a message sender assignment","description":"","security":[{"OAuth2":["FullAccess","MessageConfigAssignmentAdmin","MessageSenderAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/messagesenders/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/MessageSenderAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"MessageSenders.ListAssignments","tags":["Message senders"],"parameters":[{"name":"buyerID","in":"query","description":"ID of the buyer.","required":false,"schema":{"type":"string"}},{"name":"messageSenderID","in":"query","description":"ID of the message sender.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Level of the message sender assignment. Possible values: Group, Company, BuyerGroup.","required":false,"schema":{"type":"string","enum":["Group","Company"]}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}},{"name":"supplierID","in":"query","description":"ID of the supplier.","required":false,"schema":{"type":"string"}}],"summary":"List message sender assignments","description":"","security":[{"OAuth2":["FullAccess","MessageConfigAssignmentAdmin","MessageSenderAdmin"]}],"x-authorizedUserTypes":["Seller"]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"MessageSenders.SaveAssignment","tags":["Message senders"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MessageSenderAssignment"}],"required":["MessageSenderID"]}}}},"summary":"Create or update a message sender assignment","description":"","security":[{"OAuth2":["FullAccess","MessageConfigAssignmentAdmin","MessageSenderAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/messagesenders/CCListenerAssignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/MessageCCListenerAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"MessageSenders.ListCCListenerAssignments","tags":["Message senders"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["BuyerID","UserGroupID","UserID","MessageConfigName","SupplierID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["BuyerID","UserGroupID","UserID","MessageConfigName","SupplierID","!BuyerID","!UserGroupID","!UserID","!MessageConfigName","!SupplierID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List message sender cc listener assignments","description":"","security":[{"OAuth2":["FullAccess","MessageConfigAssignmentAdmin","MessageSenderAdmin"]}],"x-authorizedUserTypes":["Seller"]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"MessageSenders.SaveCCListenerAssignment","tags":["Message senders"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MessageCCListenerAssignment"}],"required":["MessageSenderAssignment","MessageType"]}}}},"summary":"Create or update a message sender cc listener assignment","description":"","security":[{"OAuth2":["FullAccess","MessageConfigAssignmentAdmin","MessageSenderAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/openidconnects":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/OpenIdConnect"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OpenIdConnects.List","tags":["Open ID connects"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List OpenID Connects","description":"","security":[{"OAuth2":["FullAccess","OpenIDConnectAdmin","OpenIDConnectReader"]}],"x-authorizedUserTypes":["Seller"]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenIdConnect"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OpenIdConnects.Create","tags":["Open ID connects"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OpenIdConnect"}],"required":["OrderCloudApiClientID","ConnectClientID","ConnectClientSecret","AppStartUrl","AuthorizationEndpoint","TokenEndpoint"]}}}},"summary":"Create an OpenID Connect","description":"","security":[{"OAuth2":["FullAccess","OpenIDConnectAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/openidconnects/{openidconnectID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenIdConnect"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OpenIdConnects.Get","tags":["Open ID connects"],"parameters":[{"name":"openidconnectID","in":"path","description":"ID of the openidconnect.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve an OpenID Connect","description":"","security":[{"OAuth2":["FullAccess","OpenIDConnectAdmin","OpenIDConnectReader"]}],"x-authorizedUserTypes":["Seller"]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenIdConnect"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OpenIdConnects.Save","tags":["Open ID connects"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OpenIdConnect"}],"required":["OrderCloudApiClientID","ConnectClientID","ConnectClientSecret","AppStartUrl","AuthorizationEndpoint","TokenEndpoint"]}}}},"parameters":[{"name":"openidconnectID","in":"path","description":"ID of the openidconnect.","required":true,"schema":{"type":"string"}}],"summary":"Create or update an OpenID Connect","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","OpenIDConnectAdmin"]}],"x-authorizedUserTypes":["Seller"]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OpenIdConnects.Delete","tags":["Open ID connects"],"parameters":[{"name":"openidconnectID","in":"path","description":"ID of the openidconnect.","required":true,"schema":{"type":"string"}}],"summary":"Delete an OpenID Connect","description":"","security":[{"OAuth2":["FullAccess","OpenIDConnectAdmin"]}],"x-authorizedUserTypes":["Seller"]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenIdConnect"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OpenIdConnects.Patch","tags":["Open ID connects"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OpenIdConnect"}]}}}},"parameters":[{"name":"openidconnectID","in":"path","description":"ID of the openidconnect.","required":true,"schema":{"type":"string"}}],"summary":"Partially update an OpenID Connect","description":"","security":[{"OAuth2":["FullAccess","OpenIDConnectAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/orderreturns":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/OrderReturn"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OrderReturns.List","tags":["Order returns"],"parameters":[{"name":"approvable","in":"query","description":"Only returns orders awaiting the user's approval if true.","required":false,"schema":{"type":"boolean","default":false}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","OrderID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DateSubmitted","DateCreated","ID","OrderID","DateApproved","DateDeclined","DateCanceled","DateCompleted","LastUpdated","!DateSubmitted","!DateCreated","!ID","!OrderID","!DateApproved","!DateDeclined","!DateCanceled","!DateCompleted","!LastUpdated"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List order returns","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper","OrderReader"]}],"x-limitAnonUser":true},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderReturn"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OrderReturns.Create","tags":["Order returns"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OrderReturn"}],"required":["OrderID"]}}}},"summary":"Create an order return","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}],"x-limitAnonUser":true}},"/orderreturns/{returnID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderReturn"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OrderReturns.Get","tags":["Order returns"],"parameters":[{"name":"returnID","in":"path","description":"ID of the return.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve an order return","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper","OrderReader"]}],"x-limitAnonUser":true},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderReturn"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OrderReturns.Save","tags":["Order returns"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OrderReturn"}],"required":["OrderID"]}}}},"parameters":[{"name":"returnID","in":"path","description":"ID of the return.","required":true,"schema":{"type":"string"}}],"summary":"Create or update an order return","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}],"x-limitAnonUser":true},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OrderReturns.Delete","tags":["Order returns"],"parameters":[{"name":"returnID","in":"path","description":"ID of the return.","required":true,"schema":{"type":"string"}}],"summary":"Delete an order return","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}],"x-limitAnonUser":true},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderReturn"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OrderReturns.Patch","tags":["Order returns"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OrderReturn"}]}}}},"parameters":[{"name":"returnID","in":"path","description":"ID of the return.","required":true,"schema":{"type":"string"}}],"summary":"Partially update an order return","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}],"x-limitAnonUser":true}},"/orderreturns/{returnID}/approvals":{"get":{"responses":{"200":{"description":"Returns all Approvals associated with the Order Return.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/OrderReturnApproval"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OrderReturns.ListApprovals","tags":["Order returns"],"parameters":[{"name":"returnID","in":"path","description":"ID of the return.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ApprovalRuleID","ApprovingGroupID","Approver","Comments"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DateCreated","ApprovalRuleID","ApprovingGroupID","Status","DateCompleted","Approver","!DateCreated","!ApprovalRuleID","!ApprovingGroupID","!Status","!DateCompleted","!Approver"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List order return approvals","description":"Returns all Approvals associated with the Order Return.","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper","OrderReader"]}],"x-limitAnonUser":true}},"/orderreturns/{returnID}/approve":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderReturn"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OrderReturns.Approve","tags":["Order returns"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApprovalInfo"}]}}}},"parameters":[{"name":"returnID","in":"path","description":"ID of the return.","required":true,"schema":{"type":"string"}}],"summary":"Approve an order return","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin"]}],"x-limitAnonUser":true}},"/orderreturns/{returnID}/cancel":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderReturn"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OrderReturns.Cancel","tags":["Order returns"],"parameters":[{"name":"returnID","in":"path","description":"ID of the return.","required":true,"schema":{"type":"string"}}],"summary":"Cancel an order return","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}],"x-limitAnonUser":true}},"/orderreturns/{returnID}/complete":{"post":{"responses":{"201":{"description":"Use only when an order return won't have an associated payment. You will not to reopen an order return after completing it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderReturn"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OrderReturns.Complete","tags":["Order returns"],"parameters":[{"name":"returnID","in":"path","description":"ID of the return.","required":true,"schema":{"type":"string"}}],"summary":"Complete an order return","description":"Use only when an order return won't have an associated payment. You will not to reopen an order return after completing it.","security":[{"OAuth2":["FullAccess","OrderAdmin"]}],"x-limitAnonUser":true}},"/orderreturns/{returnID}/decline":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderReturn"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OrderReturns.Decline","tags":["Order returns"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ApprovalInfo"}]}}}},"parameters":[{"name":"returnID","in":"path","description":"ID of the return.","required":true,"schema":{"type":"string"}}],"summary":"Decline an order return","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin"]}],"x-limitAnonUser":true}},"/orderreturns/{returnID}/eligibleapprovers":{"get":{"responses":{"200":{"description":"Returns all Users who can approve or decline this order return (but have not done so).","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OrderReturns.ListEligibleApprovers","tags":["Order returns"],"parameters":[{"name":"returnID","in":"path","description":"ID of the return.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Username","LastName","FirstName","Email"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["LastName","FirstName","Username","ID","Email","DateCreated","LastActive","PasswordLastSetDate","!LastName","!FirstName","!Username","!ID","!Email","!DateCreated","!LastActive","!PasswordLastSetDate"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List order return eligible approvers","description":"Returns all Users who can approve or decline this order return (but have not done so).","security":[{"OAuth2":["FullAccess","OrderAdmin","OrderReader"]}],"x-limitAnonUser":true}},"/orderreturns/{returnID}/items/{lineItemID}":{"delete":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderReturn"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OrderReturns.DeleteItem","tags":["Order returns"],"parameters":[{"name":"returnID","in":"path","description":"ID of the return.","required":true,"schema":{"type":"string"}},{"name":"lineItemID","in":"path","description":"ID of the line item.","required":true,"schema":{"type":"string"}}],"summary":"Delete an order return item","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}],"x-limitAnonUser":true}},"/orderreturns/{returnID}/submit":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderReturn"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"OrderReturns.Submit","tags":["Order returns"],"parameters":[{"name":"returnID","in":"path","description":"ID of the return.","required":true,"schema":{"type":"string"}}],"summary":"Submit an order return","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}],"x-limitAnonUser":true}},"/orders/{direction}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.List","tags":["Orders"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":false,"schema":{"type":"string"}},{"name":"supplierID","in":"query","description":"ID of the supplier.","required":false,"schema":{"type":"string"}},{"name":"from","in":"query","description":"Lower bound of date range that the order was created.","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","description":"Upper bound of date range that the order was created.","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","FromCompanyID","ToCompanyID","Comments"]}}},{"name":"searchType","in":"query","description":"Type of search to perform.","required":false,"schema":{"$ref":"#/components/schemas/SearchType","default":"AnyTerm"}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DateSubmitted","DateCreated","ID","FromCompanyID","ToCompanyID","FromUserID","Status","DateApproved","DateDeclined","DateCanceled","DateCompleted","LastUpdated","Subtotal","ShippingCost","TaxCost","Gratuity","Fees","BaseDiscount","PromotionDiscount","Total","IsSubmitted","!DateSubmitted","!DateCreated","!ID","!FromCompanyID","!ToCompanyID","!FromUserID","!Status","!DateApproved","!DateDeclined","!DateCanceled","!DateCompleted","!LastUpdated","!Subtotal","!ShippingCost","!TaxCost","!Gratuity","!Fees","!BaseDiscount","!PromotionDiscount","!Total","!IsSubmitted"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List orders","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","OrderReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.Create","tags":["Orders"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Order"}]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}}],"summary":"Create an order","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.Get","tags":["Orders"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve an order","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper","OrderReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.Save","tags":["Orders"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Order"}]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Create or update an order","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.Delete","tags":["Orders"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Delete an order","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.Patch","tags":["Orders"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Order"}]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Partially update an order","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/applypromotions":{"post":{"responses":{"201":{"description":"Apply up to 100 eligible promotions where AutoApply=true.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.ApplyPromotions","tags":["Orders"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Auto-apply promotions to an order","description":"Apply up to 100 eligible promotions where AutoApply=true.","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/approvals":{"get":{"responses":{"200":{"description":"Returns all Approvals associated with the Order.","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/OrderApproval"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.ListApprovals","tags":["Orders"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ApprovalRuleID","ApprovingGroupID","Approver","Comments"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DateCreated","AllowResubmit","ApprovalRuleID","ApprovingGroupID","Status","DateCompleted","Approver","!DateCreated","!AllowResubmit","!ApprovalRuleID","!ApprovingGroupID","!Status","!DateCompleted","!Approver"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List order approvals","description":"Returns all Approvals associated with the Order.","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper","OrderReader"]}]}},"/orders/{direction}/{orderID}/approve":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.Approve","tags":["Orders"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OrderApprovalInfo"}]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Approve an order","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/billto":{"put":{"responses":{"200":{"description":"Use only when the address is not to be saved/reused..To use a saved address (i.e. from the Addresses resource), PATCH the order's BillingAddressID property instead.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.SetBillingAddress","tags":["Orders"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}],"required":["Street1","City","Country"]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Set a billing address","description":"Use only when the address is not to be saved/reused.<br/></br>To use a saved address (i.e. from the Addresses resource), PATCH the order's BillingAddressID property instead.","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]},"patch":{"responses":{"200":{"description":"Not allowed on unsubmitted orders where BillingAddressID has been set. In that case, use the Addresses resource to update the saved address.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.PatchBillingAddress","tags":["Orders"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Partially update an order billing address","description":"Not allowed on unsubmitted orders where BillingAddressID has been set. In that case, use the Addresses resource to update the saved address.","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/bundles/{bundleID}":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"BundleLineItems.Create","tags":["Bundle line items"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BundleItems"}]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"bundleID","in":"path","description":"ID of the bundle.","required":true,"schema":{"type":"string"}}],"summary":"Create a bundle line item","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/bundles/{bundleID}/{bundleItemID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"BundleLineItems.Delete","tags":["Bundle line items"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"bundleID","in":"path","description":"ID of the bundle.","required":true,"schema":{"type":"string"}},{"name":"bundleItemID","in":"path","description":"ID of the bundle item.","required":true,"schema":{"type":"string"}}],"summary":"Delete a bundle line item","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/calculate":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderWorksheet"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"IntegrationEvents.Calculate","tags":["Integration events"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Calculate an order","description":"","security":[{"OAuth2":["FullAccess","IntegrationEventAdmin","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/cancel":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.Cancel","tags":["Orders"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Cancel an order","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/complete":{"post":{"responses":{"201":{"description":"Use only when an order doesn't need a shipment. You will not be able to ship or reopen an order after completing it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.Complete","tags":["Orders"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Complete an order","description":"Use only when an order doesn't need a shipment. You will not be able to ship or reopen an order after completing it.","security":[{"OAuth2":["FullAccess","OrderAdmin"]}]}},"/orders/{direction}/{orderID}/decline":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.Decline","tags":["Orders"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OrderApprovalInfo"}]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Decline an order","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/eligibleapprovers":{"get":{"responses":{"200":{"description":"Returns all Users who can approve or decline this order (but have not done so).","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.ListEligibleApprovers","tags":["Orders"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Username","LastName","FirstName","Email"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["LastName","FirstName","Username","ID","Email","DateCreated","LastActive","PasswordLastSetDate","!LastName","!FirstName","!Username","!ID","!Email","!DateCreated","!LastActive","!PasswordLastSetDate"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List order eligible approvers","description":"Returns all Users who can approve or decline this order (but have not done so).","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper","OrderReader"]}]}},"/orders/{direction}/{orderID}/eligiblepromotions":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/EligiblePromotion"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.ListEligiblePromotions","tags":["Orders"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Code","Description","FinePrint","EligibleExpression","ValueExpression"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","Code","StartDate","ExpirationDate","EligibleExpression","ValueExpression","CanCombine","AutoApply","Active","Priority","!Name","!ID","!Code","!StartDate","!ExpirationDate","!EligibleExpression","!ValueExpression","!CanCombine","!AutoApply","!Active","!Priority"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List eligible promotions for an order","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/estimateshipping":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderWorksheet"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"IntegrationEvents.EstimateShipping","tags":["Integration events"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Estimate shipping cost","description":"","security":[{"OAuth2":["FullAccess","IntegrationEventAdmin","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/forward":{"post":{"responses":{"200":{"description":"Creates and submits 0 or more outgoing Orders to Suppliers, one for each unique Product.DefaultSupplierID on this Order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderSplitResult"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.Forward","tags":["Orders"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Forward an order","description":"Creates and submits 0 or more outgoing Orders to Suppliers, one for each unique Product.DefaultSupplierID on this Order.","security":[{"OAuth2":["FullAccess","OrderAdmin"]}]}},"/orders/{direction}/{orderID}/fromuser":{"patch":{"responses":{"200":{"description":"Only FirstName, LastName, and Email can be updated..Primarily used to facilitate guest checkout scenarios.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.PatchFromUser","tags":["Orders"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/User"}]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Partially update an order from user","description":"Only FirstName, LastName, and Email can be updated.<br/></br>Primarily used to facilitate guest checkout scenarios.","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/lineitems":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"LineItems.List","tags":["Line items"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","ProductID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DateAdded","ID","ProductID","!DateAdded","!ID","!ProductID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List line items","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper","OrderReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"LineItems.Create","tags":["Line items"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/LineItem"}],"required":["ProductID"]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Create a line item","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/lineitems/{lineItemID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"LineItems.Get","tags":["Line items"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"lineItemID","in":"path","description":"ID of the line item.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a line item","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper","OrderReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"LineItems.Save","tags":["Line items"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/LineItem"}],"required":["ProductID"]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"lineItemID","in":"path","description":"ID of the line item.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a line item","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"LineItems.Delete","tags":["Line items"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"lineItemID","in":"path","description":"ID of the line item.","required":true,"schema":{"type":"string"}}],"summary":"Delete a line item","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"LineItems.Patch","tags":["Line items"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/LineItem"}]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"lineItemID","in":"path","description":"ID of the line item.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a line item","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/lineitems/{lineItemID}/shipto":{"put":{"responses":{"200":{"description":"Set the Shipping Address of the Line Item. Appropriate only when the Address is not to be saved/reused. To use a Saved Address (i.e. from the Addresses resource), PATCH the Line Item's ShippingAddressID property instead.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"LineItems.SetShippingAddress","tags":["Line items"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}],"required":["Street1","City","Country"]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"lineItemID","in":"path","description":"ID of the line item.","required":true,"schema":{"type":"string"}}],"summary":"Set a shipping address","description":"Set the Shipping Address of the Line Item. Appropriate only when the Address is not to be saved/reused. To use a Saved Address (i.e. from the Addresses resource), PATCH the Line Item's ShippingAddressID property instead.","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]},"patch":{"responses":{"200":{"description":"Partially update the Shipping Address of the Line Item. Not allowed on unsubmitted Line Items where ShippingAddressID has been set. In that case, use the Addresses resource to update the Saved Address.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"LineItems.PatchShippingAddress","tags":["Line items"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"lineItemID","in":"path","description":"ID of the line item.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a line item shipping address","description":"Partially update the Shipping Address of the Line Item. Not allowed on unsubmitted Line Items where ShippingAddressID has been set. In that case, use the Addresses resource to update the Saved Address.","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/payments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Payments.List","tags":["Payments"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Description"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DateCreated","ID","Type","CreditCardID","SpendingAccountID","!DateCreated","!ID","!Type","!CreditCardID","!SpendingAccountID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List payments","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper","OrderReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Payments.Create","tags":["Payments"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Payment"}]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Create a payment","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/payments/{paymentID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Payments.Get","tags":["Payments"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"paymentID","in":"path","description":"ID of the payment.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a payment","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper","OrderReader"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Payments.Delete","tags":["Payments"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"paymentID","in":"path","description":"ID of the payment.","required":true,"schema":{"type":"string"}}],"summary":"Delete a payment","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]},"patch":{"responses":{"200":{"description":"PUT is not a supported method for payments due to the implications associated with modifying certain properties. Patch is only permitted on certain properties that vary depending on order status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Payments.Patch","tags":["Payments"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Payment"}]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"paymentID","in":"path","description":"ID of the payment.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a payment","description":"PUT is not a supported method for payments due to the implications associated with modifying certain properties. Patch is only permitted on certain properties that vary depending on order status","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/payments/{paymentID}/transactions":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Payments.CreateTransaction","tags":["Payments"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaymentTransaction"}],"required":["Type","DateExecuted"]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"paymentID","in":"path","description":"ID of the payment.","required":true,"schema":{"type":"string"}}],"summary":"Create a payment transaction","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin"]}]}},"/orders/{direction}/{orderID}/payments/{paymentID}/transactions/{transactionID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Payments.DeleteTransaction","tags":["Payments"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"paymentID","in":"path","description":"ID of the payment.","required":true,"schema":{"type":"string"}},{"name":"transactionID","in":"path","description":"ID of the transaction.","required":true,"schema":{"type":"string"}}],"summary":"Delete a payment transaction","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin"]}]}},"/orders/{direction}/{orderID}/promotions":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/OrderPromotion"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.ListPromotions","tags":["Orders"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Code","Description","FinePrint","EligibleExpression","ValueExpression"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","Code","DateApplied","StartDate","ExpirationDate","EligibleExpression","ValueExpression","CanCombine","AutoApply","Active","Priority","!Name","!ID","!Code","!DateApplied","!StartDate","!ExpirationDate","!EligibleExpression","!ValueExpression","!CanCombine","!AutoApply","!Active","!Priority"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List order promotions","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper","OrderReader"]}]}},"/orders/{direction}/{orderID}/promotions/{promoCode}":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderPromotion"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.AddPromotion","tags":["Orders"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"promoCode","in":"path","description":"Promo code of the order promotion.","required":true,"schema":{"type":"string"}}],"summary":"Add a promotion to an order","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]},"delete":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.RemovePromotion","tags":["Orders"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"promoCode","in":"path","description":"Promo code of the order.","required":true,"schema":{"type":"string"}}],"summary":"Remove a promotion from an order","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/refreshpromotions":{"post":{"responses":{"200":{"description":"Re-calculates promotion discounts, removes promotions that are no longer valid, and adds eligible promotions where AutoApply=true (up to limit of 100)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshPromosResponse"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.RefreshPromotions","tags":["Orders"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Refresh promotions on an order","description":"Re-calculates promotion discounts, removes promotions that are no longer valid, and adds eligible promotions where AutoApply=true (up to limit of 100)","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/repeat":{"post":{"responses":{"200":{"description":"Creates a new unsubmitted order from a previously submitted order, copying available line items with recalculated prices.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRepeatResponse"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.Repeat","tags":["Orders"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Order"}]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Repeat an order","description":"Creates a new unsubmitted order from a previously submitted order, copying available line items with recalculated prices.","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/ship":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.Ship","tags":["Orders"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Shipment"}]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Create a new shipment containing all items on an order","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","ShipmentAdmin"]}]}},"/orders/{direction}/{orderID}/shipments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Shipment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.ListShipments","tags":["Orders"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","BuyerID","Shipper","DateShipped","DateDelivered","TrackingNumber"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DateShipped","OwnerID","ID","BuyerID","Shipper","DateDelivered","Cost","!DateShipped","!OwnerID","!ID","!BuyerID","!Shipper","!DateDelivered","!Cost"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List shipments for an order","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","ShipmentReader"]}]}},"/orders/{direction}/{orderID}/shipmethods":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderWorksheet"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"IntegrationEvents.SelectShipmethods","tags":["Integration events"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OrderShipMethodSelection"}]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Select a ship method","description":"","security":[{"OAuth2":["FullAccess","IntegrationEventAdmin","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/shipto":{"put":{"responses":{"200":{"description":"Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the order's ShippingAddressID property instead. The address used will be populated on the ShippingAddress property of each LineItem.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.SetShippingAddress","tags":["Orders"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}],"required":["Street1","City","Country"]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Set a shipping address","description":"Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the order's ShippingAddressID property instead. The address used will be populated on the ShippingAddress property of each LineItem.","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]},"patch":{"responses":{"200":{"description":"Not allowed on unsubmitted orders where ShippingAddressID has been set. In that case, use the Addresses resource to update the saved address.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.PatchShippingAddress","tags":["Orders"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}]}}}},"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Partially update an order shipping address","description":"Not allowed on unsubmitted orders where ShippingAddressID has been set. In that case, use the Addresses resource to update the saved address.","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/split":{"post":{"responses":{"200":{"description":"Creates, but does not submit, 0 or more outgoing Orders to Suppliers, one for each unique Product.DefaultSupplierID on this Order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderSplitResult"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.Split","tags":["Orders"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Split an order","description":"Creates, but does not submit, 0 or more outgoing Orders to Suppliers, one for each unique Product.DefaultSupplierID on this Order.","security":[{"OAuth2":["FullAccess","OrderAdmin"]}]}},"/orders/{direction}/{orderID}/submit":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.Submit","tags":["Orders"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Submit an order","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper"]}]}},"/orders/{direction}/{orderID}/validate":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Orders.Validate","tags":["Orders"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Validate an order in its current state","description":"","security":[{"OAuth2":["FullAccess","OrderAdmin","Shopper","OrderReader"]}]}},"/orders/{direction}/{orderID}/worksheet":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderWorksheet"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"IntegrationEvents.GetWorksheet","tags":["Integration events"],"parameters":[{"name":"direction","in":"path","description":"Direction of the order, from the current user's perspective.","required":true,"schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}}],"summary":"Get a single order worksheet","description":"","security":[{"OAuth2":["FullAccess","IntegrationEventAdmin","OrderAdmin","Shopper","OrderReader"]}]}},"/password/onetimepassword":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ForgottenCredentials.SendOneTimePassword","tags":["Forgotten credentials"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/OneTimePasswordRequest"}],"required":["ClientID"]}}}},"summary":"Send an one time password","description":"","security":[{"OAuth2":[]}]}},"/password/reset":{"post":{"responses":{"204":{"description":"Sends a temporary verification code via email, which must subsequently be passed in a Reset Password call. The verification code expires in 120 minutes."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ForgottenCredentials.SendVerificationCode","tags":["Forgotten credentials"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PasswordResetRequest"}],"required":["ClientID"]}}}},"summary":"Send a verification code","description":"Sends a temporary verification code via email, which must subsequently be passed in a Reset Password call. The verification code expires in 120 minutes.","security":[{"OAuth2":[]}]}},"/password/reset/{verificationCode}":{"put":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ForgottenCredentials.ResetPasswordByVerificationCode","tags":["Forgotten credentials"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PasswordReset"}],"required":["ClientID","Username"]}}}},"parameters":[{"name":"verificationCode","in":"path","description":"Verification code of the password reset.","required":true,"schema":{"type":"string"}}],"summary":"Reset a password by verification code","description":"","security":[{"OAuth2":[]}]}},"/priceschedules":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/PriceSchedule"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"PriceSchedules.List","tags":["Price schedules"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","ApplyTax","Currency"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","OwnerID","!Name","!ID","!OwnerID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List price schedules","description":"","security":[{"OAuth2":["FullAccess","PriceScheduleAdmin","PriceScheduleReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceSchedule"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"PriceSchedules.Create","tags":["Price schedules"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PriceSchedule"}],"required":["Name"]}}}},"summary":"Create a price schedule","description":"","security":[{"OAuth2":["FullAccess","PriceScheduleAdmin"]}]}},"/priceschedules/{priceScheduleID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceSchedule"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"PriceSchedules.Get","tags":["Price schedules"],"parameters":[{"name":"priceScheduleID","in":"path","description":"ID of the price schedule.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a price schedule","description":"","security":[{"OAuth2":["FullAccess","PriceScheduleAdmin","PriceScheduleReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceSchedule"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"PriceSchedules.Save","tags":["Price schedules"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PriceSchedule"}],"required":["Name"]}}}},"parameters":[{"name":"priceScheduleID","in":"path","description":"ID of the price schedule.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a price schedule","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","PriceScheduleAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"PriceSchedules.Delete","tags":["Price schedules"],"parameters":[{"name":"priceScheduleID","in":"path","description":"ID of the price schedule.","required":true,"schema":{"type":"string"}}],"summary":"Delete a price schedule","description":"","security":[{"OAuth2":["FullAccess","PriceScheduleAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceSchedule"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"PriceSchedules.Patch","tags":["Price schedules"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PriceSchedule"}]}}}},"parameters":[{"name":"priceScheduleID","in":"path","description":"ID of the price schedule.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a price schedule","description":"","security":[{"OAuth2":["FullAccess","PriceScheduleAdmin"]}]}},"/priceschedules/{priceScheduleID}/PriceBreaks":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceSchedule"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"PriceSchedules.SavePriceBreak","tags":["Price schedules"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PriceBreak"}],"required":["Quantity","Price"]}}}},"parameters":[{"name":"priceScheduleID","in":"path","description":"ID of the price schedule.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a price schedule price break","description":"","security":[{"OAuth2":["FullAccess","PriceScheduleAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"PriceSchedules.DeletePriceBreak","tags":["Price schedules"],"parameters":[{"name":"priceScheduleID","in":"path","description":"ID of the price schedule.","required":true,"schema":{"type":"string"}},{"name":"quantity","in":"query","description":"Quantity of the price schedule.","required":true,"schema":{"type":"integer"}}],"summary":"Delete a price schedule price break","description":"","security":[{"OAuth2":["FullAccess","PriceScheduleAdmin"]}]}},"/productfacets":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ProductFacet"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ProductFacets.List","tags":["Product facets"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","XpPath"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ListOrder","ID","Name","XpPath","!ListOrder","!ID","!Name","!XpPath"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List product facets","description":"","security":[{"OAuth2":["FullAccess","ProductFacetAdmin","ProductFacetReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductFacet"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ProductFacets.Create","tags":["Product facets"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ProductFacet"}],"required":["Name"]}}}},"summary":"Create a product facet","description":"","security":[{"OAuth2":["FullAccess","ProductFacetAdmin"]}]}},"/productfacets/{productFacetID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductFacet"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ProductFacets.Get","tags":["Product facets"],"parameters":[{"name":"productFacetID","in":"path","description":"ID of the product facet.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a product facet","description":"","security":[{"OAuth2":["FullAccess","ProductFacetAdmin","ProductFacetReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductFacet"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ProductFacets.Save","tags":["Product facets"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ProductFacet"}],"required":["Name"]}}}},"parameters":[{"name":"productFacetID","in":"path","description":"ID of the product facet.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a product facet","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","ProductFacetAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ProductFacets.Delete","tags":["Product facets"],"parameters":[{"name":"productFacetID","in":"path","description":"ID of the product facet.","required":true,"schema":{"type":"string"}}],"summary":"Delete a product facet","description":"","security":[{"OAuth2":["FullAccess","ProductFacetAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductFacet"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ProductFacets.Patch","tags":["Product facets"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ProductFacet"}]}}}},"parameters":[{"name":"productFacetID","in":"path","description":"ID of the product facet.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a product facet","description":"","security":[{"OAuth2":["FullAccess","ProductFacetAdmin"]}]}},"/products":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"Meta":{"$ref":"#/components/schemas/MetaWithFacets"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Products.List","tags":["Products"],"parameters":[{"name":"catalogID","in":"query","description":"ID of the catalog.","required":false,"schema":{"type":"string"}},{"name":"categoryID","in":"query","description":"ID of the category.","required":false,"schema":{"type":"string"}},{"name":"supplierID","in":"query","description":"ID of the supplier.","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","ParentID","Name","Description"]}}},{"name":"searchType","in":"query","description":"Type of search to perform.","required":false,"schema":{"$ref":"#/components/schemas/SearchType","default":"AnyTerm"}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["OwnerID","Name","ID","ParentID","!OwnerID","!Name","!ID","!ParentID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List products","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Products.Create","tags":["Products"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Product"}],"required":["Name"]}}}},"summary":"Create a product","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]}},"/products/{productID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Products.Get","tags":["Products"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a product","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Products.Save","tags":["Products"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Product"}],"required":["Name"]}}}},"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a product","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Products.Delete","tags":["Products"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}}],"summary":"Delete a product","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Products.Patch","tags":["Products"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Product"}]}}}},"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a product","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]}},"/products/{productID}/assignments/{buyerID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Products.DeleteAssignment","tags":["Products"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"sellerID","in":"query","description":"ID of the seller.","required":false,"schema":{"type":"string"}}],"summary":"Delete a product assignment","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductAssignmentAdmin"]}]}},"/products/{productID}/inventoryrecords":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/InventoryRecord"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryRecords.List","tags":["Inventory records"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","AddressID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","AddressID","!ID","!AddressID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}},{"name":"includeAddress","in":"query","description":"Include address of the inventory record.","required":false,"schema":{"type":"boolean"}}],"summary":"List inventory records","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryRecord"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryRecords.Create","tags":["Inventory records"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InventoryRecord"}],"required":["AddressID"]}}}},"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}}],"summary":"Create an inventory record","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]}},"/products/{productID}/inventoryrecords/{inventoryRecordID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryRecord"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryRecords.Get","tags":["Inventory records"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"inventoryRecordID","in":"path","description":"ID of the inventory record.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve an inventory record","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryRecord"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryRecords.Save","tags":["Inventory records"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InventoryRecord"}],"required":["AddressID"]}}}},"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"inventoryRecordID","in":"path","description":"ID of the inventory record.","required":true,"schema":{"type":"string"}}],"summary":"Create or update an inventory record","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryRecords.Delete","tags":["Inventory records"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"inventoryRecordID","in":"path","description":"ID of the inventory record.","required":true,"schema":{"type":"string"}}],"summary":"Delete an inventory record","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryRecord"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryRecords.Patch","tags":["Inventory records"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InventoryRecord"}]}}}},"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"inventoryRecordID","in":"path","description":"ID of the inventory record.","required":true,"schema":{"type":"string"}}],"summary":"Partially update an inventory record","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]}},"/products/{productID}/inventoryrecords/{inventoryRecordID}/assignments":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryRecords.DeleteAssignment","tags":["Inventory records"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"inventoryRecordID","in":"path","description":"ID of the inventory record.","required":true,"schema":{"type":"string"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}}],"summary":"Delete an inventory record assignment","description":"","security":[{"OAuth2":["FullAccess","InventoryAdmin","ProductAdmin"]}]}},"/products/{productID}/inventoryrecords/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/InventoryRecordAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryRecords.ListAssignments","tags":["Inventory records"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":false,"schema":{"type":"string"}},{"name":"inventoryRecordID","in":"query","description":"ID of the inventory record.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Level of the inventory record assignment. Possible values: Group, Company, BuyerGroup.","required":false,"schema":{"type":"string","enum":["Group","Company"]}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}}],"summary":"List inventory record assignments","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductReader"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryRecords.SaveAssignment","tags":["Inventory records"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InventoryRecordAssignment"}],"required":["InventoryRecordID","BuyerID"]}}}},"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}}],"summary":"Create or update an inventory record assignment","description":"","security":[{"OAuth2":["FullAccess","InventoryAdmin","ProductAdmin"]}]}},"/products/{productID}/specs":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Spec"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Products.ListSpecs","tags":["Products"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ListOrder","Name","ID","!ListOrder","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List product specs","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductReader"]}]}},"/products/{productID}/suppliers":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ProductSupplier"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Products.ListSuppliers","tags":["Products"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","DateCreated","!ID","!Name","!DateCreated"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List product suppliers","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductReader"]}]}},"/products/{productID}/suppliers/{supplierID}":{"put":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Products.SaveSupplier","tags":["Products"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"defaultPriceScheduleID","in":"query","description":"ID of the default price schedule.","required":false,"schema":{"type":"string"}}],"summary":"Create or update a product supplier","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Products.RemoveSupplier","tags":["Products"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}}],"summary":"Remove a product supplier","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]}},"/products/{productID}/variants":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Variant"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Products.ListVariants","tags":["Products"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Description"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","!ID","!Name"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List product variants","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductReader"]}]}},"/products/{productID}/variants/{variantID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variant"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Products.GetVariant","tags":["Products"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"variantID","in":"path","description":"ID of the variant.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a product variant","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductReader"]}]},"put":{"responses":{"200":{"description":"Update a product variant.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variant"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Products.SaveVariant","tags":["Products"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Variant"}]}}}},"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"variantID","in":"path","description":"ID of the variant.","required":true,"schema":{"type":"string"}}],"summary":"Update a product variant","description":"Update a product variant.","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variant"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Products.PatchVariant","tags":["Products"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Variant"}]}}}},"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"variantID","in":"path","description":"ID of the variant.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a product variant","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]}},"/products/{productID}/variants/{variantID}/inventoryrecords":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/InventoryRecord"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryRecords.ListVariant","tags":["Inventory records"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"variantID","in":"path","description":"ID of the variant.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","AddressID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","AddressID","!ID","!AddressID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}},{"name":"includeAddress","in":"query","description":"Include address of the inventory record.","required":false,"schema":{"type":"boolean"}}],"summary":"Get a list of variant inventory records","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryRecord"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryRecords.CreateVariant","tags":["Inventory records"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InventoryRecord"}],"required":["AddressID"]}}}},"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"variantID","in":"path","description":"ID of the variant.","required":true,"schema":{"type":"string"}}],"summary":"Create a new variant inventory record","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]}},"/products/{productID}/variants/{variantID}/inventoryrecords/{inventoryRecordID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryRecord"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryRecords.GetVariant","tags":["Inventory records"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"variantID","in":"path","description":"ID of the variant.","required":true,"schema":{"type":"string"}},{"name":"inventoryRecordID","in":"path","description":"ID of the inventory record.","required":true,"schema":{"type":"string"}}],"summary":"Get a single variant inventory record","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductReader"]}]},"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryRecord"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryRecords.SaveVariant","tags":["Inventory records"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InventoryRecord"}],"required":["AddressID"]}}}},"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"variantID","in":"path","description":"ID of the variant.","required":true,"schema":{"type":"string"}},{"name":"inventoryRecordID","in":"path","description":"ID of the inventory record.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a variant inventory record","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryRecords.DeleteVariant","tags":["Inventory records"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"variantID","in":"path","description":"ID of the variant.","required":true,"schema":{"type":"string"}},{"name":"inventoryRecordID","in":"path","description":"ID of the inventory record.","required":true,"schema":{"type":"string"}}],"summary":"Delete a variant inventory record","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryRecord"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryRecords.PatchVariant","tags":["Inventory records"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InventoryRecord"}]}}}},"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"variantID","in":"path","description":"ID of the variant.","required":true,"schema":{"type":"string"}},{"name":"inventoryRecordID","in":"path","description":"ID of the inventory record.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a variant inventory record","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]}},"/products/{productID}/variants/{variantID}/inventoryrecords/{inventoryRecordID}/assignments":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryRecords.DeleteVariantAssignment","tags":["Inventory records"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"variantID","in":"path","description":"ID of the variant.","required":true,"schema":{"type":"string"}},{"name":"inventoryRecordID","in":"path","description":"ID of the inventory record.","required":true,"schema":{"type":"string"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}}],"summary":"Delete an inventory record variant assignment","description":"","security":[{"OAuth2":["FullAccess","InventoryAdmin","ProductAdmin"]}]}},"/products/{productID}/variants/{variantID}/inventoryrecords/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/InventoryRecordAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryRecords.ListVariantAssignments","tags":["Inventory records"],"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"variantID","in":"path","description":"ID of the variant.","required":true,"schema":{"type":"string"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":false,"schema":{"type":"string"}},{"name":"inventoryRecordID","in":"query","description":"ID of the inventory record.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Level of the inventory record assignment. Possible values: Group, Company, BuyerGroup.","required":false,"schema":{"type":"string","enum":["Group","Company"]}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}}],"summary":"List inventory record variant assignments","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductReader"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"InventoryRecords.SaveVariantAssignment","tags":["Inventory records"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InventoryRecordAssignment"}],"required":["InventoryRecordID","BuyerID"]}}}},"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"variantID","in":"path","description":"ID of the variant.","required":true,"schema":{"type":"string"}}],"summary":"Create or update an inventory record variant assignment","description":"","security":[{"OAuth2":["FullAccess","InventoryAdmin","ProductAdmin"]}]}},"/products/{productID}/variants/generate":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Products.GenerateVariants","tags":["Products"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/VariantOverrides"}]}}}},"parameters":[{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}},{"name":"overwriteExisting","in":"query","description":"Overwrite existing of the product.","required":false,"schema":{"type":"boolean","default":false}}],"summary":"Generate variants","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]}},"/products/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ProductAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Products.ListAssignments","tags":["Products"],"parameters":[{"name":"productID","in":"query","description":"ID of the product.","required":false,"schema":{"type":"string"}},{"name":"priceScheduleID","in":"query","description":"ID of the price schedule.","required":false,"schema":{"type":"string"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Level of the product assignment. Possible values: Group, Company, BuyerGroup.","required":false,"schema":{"type":"string","enum":["Group","Company"]}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}}],"summary":"List product assignments","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductAssignmentAdmin","ProductReader"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Products.SaveAssignment","tags":["Products"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ProductAssignment"}],"required":["ProductID","BuyerID"]}}}},"summary":"Create or update a product assignment","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductAssignmentAdmin"]}]}},"/promotions":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Promotion"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Promotions.List","tags":["Promotions"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Code","Description","FinePrint","EligibleExpression","ValueExpression"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","Code","StartDate","ExpirationDate","EligibleExpression","ValueExpression","CanCombine","AutoApply","Active","Priority","!Name","!ID","!Code","!StartDate","!ExpirationDate","!EligibleExpression","!ValueExpression","!CanCombine","!AutoApply","!Active","!Priority"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List promotions","description":"","security":[{"OAuth2":["FullAccess","PromotionAdmin","PromotionReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Promotion"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Promotions.Create","tags":["Promotions"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Promotion"}],"required":["Code","EligibleExpression"]}}}},"summary":"Create a promotion","description":"","security":[{"OAuth2":["FullAccess","PromotionAdmin"]}]}},"/promotions/{promotionID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Promotion"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Promotions.Get","tags":["Promotions"],"parameters":[{"name":"promotionID","in":"path","description":"ID of the promotion.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a promotion","description":"","security":[{"OAuth2":["FullAccess","PromotionAdmin","PromotionReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Promotion"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Promotions.Save","tags":["Promotions"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Promotion"}],"required":["Code","EligibleExpression"]}}}},"parameters":[{"name":"promotionID","in":"path","description":"ID of the promotion.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a promotion","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","PromotionAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Promotions.Delete","tags":["Promotions"],"parameters":[{"name":"promotionID","in":"path","description":"ID of the promotion.","required":true,"schema":{"type":"string"}}],"summary":"Delete a promotion","description":"","security":[{"OAuth2":["FullAccess","PromotionAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Promotion"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Promotions.Patch","tags":["Promotions"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Promotion"}]}}}},"parameters":[{"name":"promotionID","in":"path","description":"ID of the promotion.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a promotion","description":"","security":[{"OAuth2":["FullAccess","PromotionAdmin"]}]}},"/promotions/{promotionID}/assignments":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Promotions.DeleteAssignment","tags":["Promotions"],"parameters":[{"name":"promotionID","in":"path","description":"ID of the promotion.","required":true,"schema":{"type":"string"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}}],"summary":"Delete a promotion assignment","description":"","security":[{"OAuth2":["FullAccess","PromotionAdmin"]}]}},"/promotions/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/PromotionAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Promotions.ListAssignments","tags":["Promotions"],"parameters":[{"name":"buyerID","in":"query","description":"ID of the buyer.","required":false,"schema":{"type":"string"}},{"name":"promotionID","in":"query","description":"ID of the promotion.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Level of the promotion assignment. Possible values: Group, Company, BuyerGroup.","required":false,"schema":{"type":"string","enum":["Group","Company"]}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}}],"summary":"List promotion assignments","description":"","security":[{"OAuth2":["FullAccess","PromotionAdmin","PromotionReader"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Promotions.SaveAssignment","tags":["Promotions"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PromotionAssignment"}],"required":["PromotionID","BuyerID"]}}}},"summary":"Create or update a promotion assignment","description":"","security":[{"OAuth2":["FullAccess","PromotionAdmin"]}]}},"/securityprofiles":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/SecurityProfile"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SecurityProfiles.List","tags":["Security profiles"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","!ID","!Name"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List security profiles","description":"","security":[{"OAuth2":["FullAccess","SecurityProfileAdmin","SetSecurityProfile","SecurityProfileReader"]}],"x-authorizedUserTypes":["Seller"]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityProfile"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SecurityProfiles.Create","tags":["Security profiles"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SecurityProfile"}],"required":["Name"]}}}},"summary":"Create a security profile","description":"","security":[{"OAuth2":["FullAccess","SecurityProfileAdmin","SetSecurityProfile"]}],"x-authorizedUserTypes":["Seller"]}},"/securityprofiles/{securityProfileID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityProfile"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SecurityProfiles.Get","tags":["Security profiles"],"parameters":[{"name":"securityProfileID","in":"path","description":"ID of the security profile.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a security profile","description":"","security":[{"OAuth2":["FullAccess","SecurityProfileAdmin","SetSecurityProfile","SecurityProfileReader"]}],"x-authorizedUserTypes":["Seller"]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityProfile"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SecurityProfiles.Save","tags":["Security profiles"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SecurityProfile"}],"required":["Name"]}}}},"parameters":[{"name":"securityProfileID","in":"path","description":"ID of the security profile.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a security profile","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","SecurityProfileAdmin","SetSecurityProfile"]}],"x-authorizedUserTypes":["Seller"]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SecurityProfiles.Delete","tags":["Security profiles"],"parameters":[{"name":"securityProfileID","in":"path","description":"ID of the security profile.","required":true,"schema":{"type":"string"}}],"summary":"Delete a security profile","description":"","security":[{"OAuth2":["FullAccess","SecurityProfileAdmin","SetSecurityProfile"]}],"x-authorizedUserTypes":["Seller"]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityProfile"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SecurityProfiles.Patch","tags":["Security profiles"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SecurityProfile"}]}}}},"parameters":[{"name":"securityProfileID","in":"path","description":"ID of the security profile.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a security profile","description":"","security":[{"OAuth2":["FullAccess","SecurityProfileAdmin","SetSecurityProfile"]}],"x-authorizedUserTypes":["Seller"]}},"/securityprofiles/{securityProfileID}/assignments":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SecurityProfiles.DeleteAssignment","tags":["Security profiles"],"parameters":[{"name":"securityProfileID","in":"path","description":"ID of the security profile.","required":true,"schema":{"type":"string"}},{"name":"buyerID","in":"query","description":"ID of the buyer.","required":false,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"supplierID","in":"query","description":"ID of the supplier.","required":false,"schema":{"type":"string"}}],"summary":"Delete a security profile assignment","description":"","security":[{"OAuth2":["FullAccess","SecurityProfileAdmin","SetSecurityProfile"]}],"x-authorizedUserTypes":["Seller"]}},"/securityprofiles/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/SecurityProfileAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SecurityProfiles.ListAssignments","tags":["Security profiles"],"parameters":[{"name":"buyerID","in":"query","description":"ID of the buyer.","required":false,"schema":{"type":"string"}},{"name":"supplierID","in":"query","description":"ID of the supplier.","required":false,"schema":{"type":"string"}},{"name":"securityProfileID","in":"query","description":"ID of the security profile.","required":false,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"commerceRole","in":"query","description":"Commerce role of the security profile assignment. Possible values: Buyer, Seller, Supplier.","required":false,"schema":{"$ref":"#/components/schemas/CommerceRole"}},{"name":"level","in":"query","description":"Level of the security profile assignment. Possible values: User, Group, Company, BuyerGroup.","required":false,"schema":{"$ref":"#/components/schemas/PartyType"}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer"}}],"summary":"List security profile assignments","description":"","security":[{"OAuth2":["FullAccess","SecurityProfileAdmin","SetSecurityProfile"]}],"x-authorizedUserTypes":["Seller"]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SecurityProfiles.SaveAssignment","tags":["Security profiles"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SecurityProfileAssignment"}],"required":["SecurityProfileID"]}}}},"summary":"Create or update a security profile assignment","description":"","security":[{"OAuth2":["FullAccess","SecurityProfileAdmin","SetSecurityProfile"]}],"x-authorizedUserTypes":["Seller"]}},"/shipments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Shipment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Shipments.List","tags":["Shipments"],"parameters":[{"name":"orderID","in":"query","description":"ID of the order.","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","BuyerID","Shipper","DateShipped","DateDelivered","TrackingNumber"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DateShipped","OwnerID","ID","BuyerID","Shipper","DateDelivered","Cost","!DateShipped","!OwnerID","!ID","!BuyerID","!Shipper","!DateDelivered","!Cost"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List shipments","description":"","security":[{"OAuth2":["FullAccess","ShipmentAdmin","ShipmentReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shipment"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Shipments.Create","tags":["Shipments"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Shipment"}]}}}},"summary":"Create a shipment","description":"","security":[{"OAuth2":["FullAccess","ShipmentAdmin"]}]}},"/shipments/{shipmentID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shipment"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Shipments.Get","tags":["Shipments"],"parameters":[{"name":"shipmentID","in":"path","description":"ID of the shipment.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a shipment","description":"","security":[{"OAuth2":["FullAccess","ShipmentAdmin","ShipmentReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shipment"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Shipments.Save","tags":["Shipments"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Shipment"}]}}}},"parameters":[{"name":"shipmentID","in":"path","description":"ID of the shipment.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a shipment","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","ShipmentAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Shipments.Delete","tags":["Shipments"],"parameters":[{"name":"shipmentID","in":"path","description":"ID of the shipment.","required":true,"schema":{"type":"string"}}],"summary":"Delete a shipment","description":"","security":[{"OAuth2":["FullAccess","ShipmentAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shipment"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Shipments.Patch","tags":["Shipments"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Shipment"}]}}}},"parameters":[{"name":"shipmentID","in":"path","description":"ID of the shipment.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a shipment","description":"","security":[{"OAuth2":["FullAccess","ShipmentAdmin"]}]}},"/shipments/{shipmentID}/items":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentItem"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Shipments.ListItems","tags":["Shipments"],"parameters":[{"name":"shipmentID","in":"path","description":"ID of the shipment.","required":true,"schema":{"type":"string"}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["OrderID","LineItemID","!OrderID","!LineItemID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List shipment items","description":"","security":[{"OAuth2":["FullAccess","ShipmentAdmin","ShipmentReader"]}]},"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Shipments.SaveItem","tags":["Shipments"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ShipmentItem"}],"required":["OrderID","LineItemID","QuantityShipped"]}}}},"parameters":[{"name":"shipmentID","in":"path","description":"ID of the shipment.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a shipment item","description":"","security":[{"OAuth2":["FullAccess","ShipmentAdmin"]}]}},"/shipments/{shipmentID}/items/{orderID}/{lineItemID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Shipments.GetItem","tags":["Shipments"],"parameters":[{"name":"shipmentID","in":"path","description":"ID of the shipment.","required":true,"schema":{"type":"string"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"lineItemID","in":"path","description":"ID of the line item.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a shipment item","description":"","security":[{"OAuth2":["FullAccess","ShipmentAdmin","ShipmentReader"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Shipments.DeleteItem","tags":["Shipments"],"parameters":[{"name":"shipmentID","in":"path","description":"ID of the shipment.","required":true,"schema":{"type":"string"}},{"name":"orderID","in":"path","description":"ID of the order.","required":true,"schema":{"type":"string"}},{"name":"lineItemID","in":"path","description":"ID of the line item.","required":true,"schema":{"type":"string"}}],"summary":"Delete a shipment item","description":"","security":[{"OAuth2":["FullAccess","ShipmentAdmin"]}]}},"/shipments/{shipmentID}/shipfrom":{"put":{"responses":{"200":{"description":"Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the shipment's FromAddressID property instead.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shipment"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Shipments.SetShipFromAddress","tags":["Shipments"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}],"required":["Street1","City","Country"]}}}},"parameters":[{"name":"shipmentID","in":"path","description":"ID of the shipment.","required":true,"schema":{"type":"string"}}],"summary":"Set a ship from address","description":"Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the shipment's FromAddressID property instead.","security":[{"OAuth2":["FullAccess","ShipmentAdmin"]}]}},"/shipments/{shipmentID}/shipto":{"put":{"responses":{"200":{"description":"Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the shipment's ToAddressID property instead.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shipment"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Shipments.SetShipToAddress","tags":["Shipments"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}],"required":["Street1","City","Country"]}}}},"parameters":[{"name":"shipmentID","in":"path","description":"ID of the shipment.","required":true,"schema":{"type":"string"}}],"summary":"Set a ship to address","description":"Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the shipment's ToAddressID property instead.","security":[{"OAuth2":["FullAccess","ShipmentAdmin"]}]}},"/specs":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Spec"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Specs.List","tags":["Specs"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ListOrder","Name","ID","!ListOrder","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List specs","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Spec"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Specs.Create","tags":["Specs"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Spec"}],"required":["Name"]}}}},"summary":"Create a spec","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]}},"/specs/{specID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Spec"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Specs.Get","tags":["Specs"],"parameters":[{"name":"specID","in":"path","description":"ID of the spec.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a spec","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Spec"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Specs.Save","tags":["Specs"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Spec"}],"required":["Name"]}}}},"parameters":[{"name":"specID","in":"path","description":"ID of the spec.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a spec","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Specs.Delete","tags":["Specs"],"parameters":[{"name":"specID","in":"path","description":"ID of the spec.","required":true,"schema":{"type":"string"}}],"summary":"Delete a spec","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Spec"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Specs.Patch","tags":["Specs"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Spec"}]}}}},"parameters":[{"name":"specID","in":"path","description":"ID of the spec.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a spec","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]}},"/specs/{specID}/options":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/SpecOption"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Specs.ListOptions","tags":["Specs"],"parameters":[{"name":"specID","in":"path","description":"ID of the spec.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Value","ID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ListOrder","ID","!ListOrder","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List spec options","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductReader"]}]},"post":{"responses":{"201":{"description":"A Spec can have multiple Options-- for example, if the spec is called 'Color', the options might be 'Blue', 'Red', and 'Green'. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpecOption"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Specs.CreateOption","tags":["Specs"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SpecOption"}],"required":["Value"]}}}},"parameters":[{"name":"specID","in":"path","description":"ID of the spec.","required":true,"schema":{"type":"string"}}],"summary":"Create a spec option","description":"A Spec can have multiple Options-- for example, if the spec is called 'Color', the options might be 'Blue', 'Red', and 'Green'. ","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]}},"/specs/{specID}/options/{optionID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpecOption"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Specs.GetOption","tags":["Specs"],"parameters":[{"name":"specID","in":"path","description":"ID of the spec.","required":true,"schema":{"type":"string"}},{"name":"optionID","in":"path","description":"ID of the option.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a spec option","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductReader"]}]},"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpecOption"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Specs.SaveOption","tags":["Specs"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SpecOption"}],"required":["Value"]}}}},"parameters":[{"name":"specID","in":"path","description":"ID of the spec.","required":true,"schema":{"type":"string"}},{"name":"optionID","in":"path","description":"ID of the option.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a spec option","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Specs.DeleteOption","tags":["Specs"],"parameters":[{"name":"specID","in":"path","description":"ID of the spec.","required":true,"schema":{"type":"string"}},{"name":"optionID","in":"path","description":"ID of the option.","required":true,"schema":{"type":"string"}}],"summary":"Delete a spec option","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpecOption"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Specs.PatchOption","tags":["Specs"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SpecOption"}]}}}},"parameters":[{"name":"specID","in":"path","description":"ID of the spec.","required":true,"schema":{"type":"string"}},{"name":"optionID","in":"path","description":"ID of the option.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a spec option","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]}},"/specs/{specID}/productassignments/{productID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Specs.DeleteProductAssignment","tags":["Specs"],"parameters":[{"name":"specID","in":"path","description":"ID of the spec.","required":true,"schema":{"type":"string"}},{"name":"productID","in":"path","description":"ID of the product.","required":true,"schema":{"type":"string"}}],"summary":"Delete a spec product assignment","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]}},"/specs/productassignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/SpecProductAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Specs.ListProductAssignments","tags":["Specs"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["SpecID","ProductID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["SpecID","ProductID","DefaultOptionID","DefaultValue","!SpecID","!ProductID","!DefaultOptionID","!DefaultValue"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List spec product assignments","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin","ProductReader"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Specs.SaveProductAssignment","tags":["Specs"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SpecProductAssignment"}],"required":["SpecID","ProductID"]}}}},"summary":"Create or update a spec product assignment","description":"","security":[{"OAuth2":["FullAccess","ProductAdmin"]}]}},"/subscriptions":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Subscription"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Subscriptions.List","tags":["Subscriptions"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","FromCompanyID","ToCompanyID","Interval"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Interval","NextOrderDate","LastOrderDate","DateCreated","EndDate","FromCompanyID","FromUserID","ToCompanyID","!ID","!Interval","!NextOrderDate","!LastOrderDate","!DateCreated","!EndDate","!FromCompanyID","!FromUserID","!ToCompanyID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List subscriptions","description":"","security":[{"OAuth2":["FullAccess","SubscriptionAdmin","SubscriptionReader"]}],"x-authorizedUserTypes":["Seller","Buyer"]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Subscriptions.Create","tags":["Subscriptions"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Subscription"}],"required":["Frequency","Interval","NextOrderDate"]}}}},"summary":"Create a subscription","description":"","security":[{"OAuth2":["FullAccess","SubscriptionAdmin"]}],"x-authorizedUserTypes":["Seller","Buyer"]}},"/subscriptions/{subscriptionID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Subscriptions.Get","tags":["Subscriptions"],"parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a subscription","description":"","security":[{"OAuth2":["FullAccess","SubscriptionAdmin","SubscriptionReader"]}],"x-authorizedUserTypes":["Seller","Buyer"]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Subscriptions.Save","tags":["Subscriptions"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Subscription"}],"required":["Frequency","Interval","NextOrderDate"]}}}},"parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a subscription","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","SubscriptionAdmin"]}],"x-authorizedUserTypes":["Seller","Buyer"]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Subscriptions.Delete","tags":["Subscriptions"],"parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}}],"summary":"Delete a subscription","description":"","security":[{"OAuth2":["FullAccess","SubscriptionAdmin"]}],"x-authorizedUserTypes":["Seller","Buyer"]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Subscriptions.Patch","tags":["Subscriptions"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Subscription"}]}}}},"parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a subscription","description":"","security":[{"OAuth2":["FullAccess","SubscriptionAdmin"]}],"x-authorizedUserTypes":["Seller","Buyer"]}},"/subscriptions/{subscriptionID}/bundles/{bundleID}":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"BundleSubscriptionItems.Create","tags":["Bundle subscription items"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BundleItems"}]}}}},"parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}},{"name":"bundleID","in":"path","description":"ID of the bundle.","required":true,"schema":{"type":"string"}}],"summary":"Create a bundle subscription item","description":"","security":[{"OAuth2":["FullAccess","SubscriptionAdmin"]}],"x-authorizedUserTypes":["Seller","Buyer"]}},"/subscriptions/{subscriptionID}/bundles/{bundleID}/{bundleItemID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"BundleSubscriptionItems.Delete","tags":["Bundle subscription items"],"parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}},{"name":"bundleID","in":"path","description":"ID of the bundle.","required":true,"schema":{"type":"string"}},{"name":"bundleItemID","in":"path","description":"ID of the bundle item.","required":true,"schema":{"type":"string"}}],"summary":"Delete a bundle subscription item","description":"","security":[{"OAuth2":["FullAccess","SubscriptionAdmin"]}],"x-authorizedUserTypes":["Seller","Buyer"]}},"/subscriptions/{subscriptionID}/items":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SubscriptionItems.List","tags":["Subscription items"],"parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","ProductID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["DateAdded","ID","ProductID","!DateAdded","!ID","!ProductID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List subscription items","description":"","security":[{"OAuth2":["FullAccess","SubscriptionAdmin","SubscriptionReader"]}],"x-authorizedUserTypes":["Seller","Buyer"]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SubscriptionItems.Create","tags":["Subscription items"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/LineItem"}],"required":["ProductID"]}}}},"parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}}],"summary":"Create a subscription item","description":"","security":[{"OAuth2":["FullAccess","SubscriptionAdmin"]}],"x-authorizedUserTypes":["Seller","Buyer"]}},"/subscriptions/{subscriptionID}/items/{subscriptionItemID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SubscriptionItems.Get","tags":["Subscription items"],"parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}},{"name":"subscriptionItemID","in":"path","description":"ID of the subscription item.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a subscription item","description":"","security":[{"OAuth2":["FullAccess","SubscriptionAdmin","SubscriptionReader"]}],"x-authorizedUserTypes":["Seller","Buyer"]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SubscriptionItems.Save","tags":["Subscription items"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/LineItem"}],"required":["ProductID"]}}}},"parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}},{"name":"subscriptionItemID","in":"path","description":"ID of the subscription item.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a subscription item","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","SubscriptionAdmin"]}],"x-authorizedUserTypes":["Seller","Buyer"]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SubscriptionItems.Delete","tags":["Subscription items"],"parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}},{"name":"subscriptionItemID","in":"path","description":"ID of the subscription item.","required":true,"schema":{"type":"string"}}],"summary":"Delete a subscription item","description":"","security":[{"OAuth2":["FullAccess","SubscriptionAdmin"]}],"x-authorizedUserTypes":["Seller","Buyer"]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SubscriptionItems.Patch","tags":["Subscription items"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/LineItem"}]}}}},"parameters":[{"name":"subscriptionID","in":"path","description":"ID of the subscription.","required":true,"schema":{"type":"string"}},{"name":"subscriptionItemID","in":"path","description":"ID of the subscription item.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a subscription item","description":"","security":[{"OAuth2":["FullAccess","SubscriptionAdmin"]}],"x-authorizedUserTypes":["Seller","Buyer"]}},"/suppliers":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Supplier"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Suppliers.List","tags":["Suppliers"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","DateCreated","!ID","!Name","!DateCreated"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List suppliers","description":"","security":[{"OAuth2":["FullAccess","SupplierAdmin","SupplierReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Suppliers.Create","tags":["Suppliers"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Supplier"}],"required":["Name"]}}}},"summary":"Create a supplier","description":"","security":[{"OAuth2":["FullAccess","SupplierAdmin"]}]}},"/suppliers/{supplierID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Suppliers.Get","tags":["Suppliers"],"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a supplier","description":"","security":[{"OAuth2":["FullAccess","SupplierAdmin","SupplierReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Suppliers.Save","tags":["Suppliers"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Supplier"}],"required":["Name"]}}}},"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a supplier","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","SupplierAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Suppliers.Delete","tags":["Suppliers"],"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}}],"summary":"Delete a supplier","description":"","security":[{"OAuth2":["FullAccess","SupplierAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Suppliers.Patch","tags":["Suppliers"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Supplier"}]}}}},"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a supplier","description":"","security":[{"OAuth2":["FullAccess","SupplierAdmin"]}]}},"/suppliers/{supplierID}/addresses":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierAddresses.List","tags":["Supplier addresses"],"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","AddressName","CompanyName","City","Street1","Street2","LastName","FirstName","State","Zip"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["AddressName","ID","DateCreated","CompanyName","FirstName","LastName","Street1","Street2","City","State","Zip","Country","Phone","!AddressName","!ID","!DateCreated","!CompanyName","!FirstName","!LastName","!Street1","!Street2","!City","!State","!Zip","!Country","!Phone"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List supplier addresses","description":"","security":[{"OAuth2":["FullAccess","SupplierAddressAdmin","SupplierAddressReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierAddresses.Create","tags":["Supplier addresses"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}],"required":["Street1","City","Country"]}}}},"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}}],"summary":"Create a supplier address","description":"","security":[{"OAuth2":["FullAccess","SupplierAddressAdmin"]}]}},"/suppliers/{supplierID}/addresses/{addressID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierAddresses.Get","tags":["Supplier addresses"],"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"addressID","in":"path","description":"ID of the address.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a supplier address","description":"","security":[{"OAuth2":["FullAccess","SupplierAddressAdmin","SupplierAddressReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierAddresses.Save","tags":["Supplier addresses"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}],"required":["Street1","City","Country"]}}}},"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"addressID","in":"path","description":"ID of the address.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a supplier address","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","SupplierAddressAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierAddresses.Delete","tags":["Supplier addresses"],"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"addressID","in":"path","description":"ID of the address.","required":true,"schema":{"type":"string"}}],"summary":"Delete a supplier address","description":"","security":[{"OAuth2":["FullAccess","SupplierAddressAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierAddresses.Patch","tags":["Supplier addresses"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Address"}]}}}},"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"addressID","in":"path","description":"ID of the address.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a supplier address","description":"","security":[{"OAuth2":["FullAccess","SupplierAddressAdmin"]}]}},"/suppliers/{supplierID}/ApiClients/Assignments/{apiClientID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ApiClients.DeleteSupplierAssignment","tags":["API clients"],"parameters":[{"name":"apiClientID","in":"path","description":"ID of the api client.","required":true,"schema":{"type":"string"}},{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}}],"summary":"Delete an API client supplier assignment","description":"","security":[{"OAuth2":["FullAccess","ApiClientAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/suppliers/{supplierID}/buyers":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/SupplierBuyer"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Suppliers.ListBuyers","tags":["Suppliers"],"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List supplier buyers","description":"","security":[{"OAuth2":["FullAccess","SupplierAdmin","SupplierReader"]}]}},"/suppliers/{supplierID}/buyers/{buyerID}":{"put":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Suppliers.SaveBuyer","tags":["Suppliers"],"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a supplier buyer","description":"","security":[{"OAuth2":["FullAccess","SupplierAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Suppliers.DeleteBuyer","tags":["Suppliers"],"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"buyerID","in":"path","description":"ID of the buyer.","required":true,"schema":{"type":"string"}}],"summary":"Delete a supplier buyer","description":"","security":[{"OAuth2":["FullAccess","SupplierAdmin"]}]}},"/suppliers/{supplierID}/usergroups":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/UserGroup"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierUserGroups.List","tags":["Supplier user groups"],"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Description"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List supplier user groups","description":"","security":[{"OAuth2":["FullAccess","SupplierUserGroupAdmin","SupplierUserGroupReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierUserGroups.Create","tags":["Supplier user groups"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UserGroup"}],"required":["Name"]}}}},"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}}],"summary":"Create a supplier user group","description":"","security":[{"OAuth2":["FullAccess","SupplierUserGroupAdmin"]}]}},"/suppliers/{supplierID}/usergroups/{userGroupID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierUserGroups.Get","tags":["Supplier user groups"],"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"userGroupID","in":"path","description":"ID of the user group.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a supplier user group","description":"","security":[{"OAuth2":["FullAccess","SupplierUserGroupAdmin","SupplierUserGroupReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierUserGroups.Save","tags":["Supplier user groups"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UserGroup"}],"required":["Name"]}}}},"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"userGroupID","in":"path","description":"ID of the user group.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a supplier user group","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","SupplierUserGroupAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierUserGroups.Delete","tags":["Supplier user groups"],"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"userGroupID","in":"path","description":"ID of the user group.","required":true,"schema":{"type":"string"}}],"summary":"Delete a supplier user group","description":"","security":[{"OAuth2":["FullAccess","SupplierUserGroupAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierUserGroups.Patch","tags":["Supplier user groups"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UserGroup"}]}}}},"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"userGroupID","in":"path","description":"ID of the user group.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a supplier user group","description":"","security":[{"OAuth2":["FullAccess","SupplierUserGroupAdmin"]}]}},"/suppliers/{supplierID}/usergroups/{userGroupID}/assignments/{userID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierUserGroups.DeleteUserAssignment","tags":["Supplier user groups"],"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"userGroupID","in":"path","description":"ID of the user group.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Delete a supplier user group user assignment","description":"","security":[{"OAuth2":["FullAccess","SupplierUserGroupAdmin"]}]}},"/suppliers/{supplierID}/usergroups/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/UserGroupAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierUserGroups.ListUserAssignments","tags":["Supplier user groups"],"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20}}],"summary":"List supplier user group user assignments","description":"","security":[{"OAuth2":["FullAccess","SupplierUserGroupAdmin","SupplierUserGroupReader"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierUserGroups.SaveUserAssignment","tags":["Supplier user groups"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UserGroupAssignment"}],"required":["UserGroupID","UserID"]}}}},"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a supplier user group user assignment","description":"","security":[{"OAuth2":["FullAccess","SupplierUserGroupAdmin"]}]}},"/suppliers/{supplierID}/users":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierUsers.List","tags":["Supplier users"],"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Username","LastName","FirstName","Email"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["LastName","FirstName","Username","ID","Email","DateCreated","LastActive","PasswordLastSetDate","!LastName","!FirstName","!Username","!ID","!Email","!DateCreated","!LastActive","!PasswordLastSetDate"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List supplier users","description":"","security":[{"OAuth2":["FullAccess","SupplierUserAdmin","SupplierUserReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierUsers.Create","tags":["Supplier users"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/User"}],"required":["Username","FirstName","LastName","Email","Active"]}}}},"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}}],"summary":"Create a supplier user","description":"","security":[{"OAuth2":["FullAccess","SupplierUserAdmin"]}]}},"/suppliers/{supplierID}/users/{userID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierUsers.Get","tags":["Supplier users"],"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a supplier user","description":"","security":[{"OAuth2":["FullAccess","SupplierUserAdmin","SupplierUserReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierUsers.Save","tags":["Supplier users"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/User"}],"required":["Username","FirstName","LastName","Email","Active"]}}}},"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a supplier user","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","SupplierUserAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierUsers.Delete","tags":["Supplier users"],"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Delete a supplier user","description":"","security":[{"OAuth2":["FullAccess","SupplierUserAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierUsers.Patch","tags":["Supplier users"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/User"}]}}}},"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a supplier user","description":"","security":[{"OAuth2":["FullAccess","SupplierUserAdmin"]}]}},"/suppliers/{supplierID}/users/{userID}/tokens":{"delete":{"responses":{"204":{"description":"Revokes all security tokens of specified supplier user."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierUsers.RevokeUserTokens","tags":["Supplier users"],"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Revoke a user tokens","description":"Revokes all security tokens of specified supplier user.","security":[{"OAuth2":["FullAccess","SupplierUserAdmin"]}],"x-limitAnonUser":true}},"/suppliers/{supplierID}/users/{userID}/unlock":{"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"SupplierUsers.UnlockUserAccount","tags":["Supplier users"],"parameters":[{"name":"supplierID","in":"path","description":"ID of the supplier.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Unlock a user account","description":"","security":[{"OAuth2":["FullAccess","SupplierUserAdmin"]}]}},"/usergroups":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/UserGroup"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminUserGroups.List","tags":["Admin user groups"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Description"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List admin user groups","description":"","security":[{"OAuth2":["FullAccess","AdminUserGroupAdmin","AdminUserGroupReader"]}]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminUserGroups.Create","tags":["Admin user groups"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UserGroup"}],"required":["Name"]}}}},"summary":"Create an admin user group","description":"","security":[{"OAuth2":["FullAccess","AdminUserGroupAdmin"]}]}},"/usergroups/{userGroupID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminUserGroups.Get","tags":["Admin user groups"],"parameters":[{"name":"userGroupID","in":"path","description":"ID of the user group.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve an admin user group","description":"","security":[{"OAuth2":["FullAccess","AdminUserGroupAdmin","AdminUserGroupReader"]}]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminUserGroups.Save","tags":["Admin user groups"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UserGroup"}],"required":["Name"]}}}},"parameters":[{"name":"userGroupID","in":"path","description":"ID of the user group.","required":true,"schema":{"type":"string"}}],"summary":"Create or update an admin user group","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","AdminUserGroupAdmin"]}]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminUserGroups.Delete","tags":["Admin user groups"],"parameters":[{"name":"userGroupID","in":"path","description":"ID of the user group.","required":true,"schema":{"type":"string"}}],"summary":"Delete an admin user group","description":"","security":[{"OAuth2":["FullAccess","AdminUserGroupAdmin"]}]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroup"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminUserGroups.Patch","tags":["Admin user groups"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UserGroup"}]}}}},"parameters":[{"name":"userGroupID","in":"path","description":"ID of the user group.","required":true,"schema":{"type":"string"}}],"summary":"Partially update an admin user group","description":"","security":[{"OAuth2":["FullAccess","AdminUserGroupAdmin"]}]}},"/usergroups/{userGroupID}/assignments/{userID}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminUserGroups.DeleteUserAssignment","tags":["Admin user groups"],"parameters":[{"name":"userGroupID","in":"path","description":"ID of the user group.","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"ID of the user.","required":true,"schema":{"type":"string"}}],"summary":"Delete an admin user group user assignment","description":"","security":[{"OAuth2":["FullAccess","AdminUserGroupAdmin"]}]}},"/usergroups/assignments":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/UserGroupAssignment"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminUserGroups.ListUserAssignments","tags":["Admin user groups"],"parameters":[{"name":"userGroupID","in":"query","description":"ID of the user group.","required":false,"schema":{"type":"string"}},{"name":"userID","in":"query","description":"ID of the user.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20}}],"summary":"List admin user group user assignments","description":"","security":[{"OAuth2":["FullAccess","AdminUserGroupAdmin","AdminUserGroupReader"]}]},"post":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"AdminUserGroups.SaveUserAssignment","tags":["Admin user groups"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/UserGroupAssignment"}],"required":["UserGroupID","UserID"]}}}},"summary":"Create or update an admin user group user assignment","description":"","security":[{"OAuth2":["FullAccess","AdminUserGroupAdmin"]}]}},"/username/retrieve":{"post":{"responses":{"204":{"description":"Sends an email with username for every username associated with an email. Always returns a 200 success regardless of if email doesn’t exist in the clientID."},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"ForgottenCredentials.RetrieveUsername","tags":["Forgotten credentials"],"parameters":[{"name":"clientID","in":"query","description":"ID of the client.","required":true,"schema":{"type":"string"}},{"name":"email","in":"query","description":"Email of the forgotten credentials.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a username","description":"Sends an email with username for every username associated with an email. Always returns a 200 success regardless of if email doesn’t exist in the clientID.","security":[{"OAuth2":[]}]}},"/webhooks":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Webhooks.List","tags":["Webhooks"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ID","Name","Description","Url"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Name","ID","!Name","!ID"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List webhooks","description":"","security":[{"OAuth2":["FullAccess","WebhookAdmin","WebhookReader"]}],"x-authorizedUserTypes":["Seller"]},"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Webhooks.Create","tags":["Webhooks"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Webhook"}],"required":["Name"]}}}},"summary":"Create a webhook","description":"","security":[{"OAuth2":["FullAccess","WebhookAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/webhooks/{webhookID}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Webhooks.Get","tags":["Webhooks"],"parameters":[{"name":"webhookID","in":"path","description":"ID of the webhook.","required":true,"schema":{"type":"string"}}],"summary":"Retrieve a webhook","description":"","security":[{"OAuth2":["FullAccess","WebhookAdmin","WebhookReader"]}],"x-authorizedUserTypes":["Seller"]},"put":{"responses":{"200":{"description":"If an object with the same ID already exists, it will be overwritten.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Webhooks.Save","tags":["Webhooks"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Webhook"}],"required":["Name"]}}}},"parameters":[{"name":"webhookID","in":"path","description":"ID of the webhook.","required":true,"schema":{"type":"string"}}],"summary":"Create or update a webhook","description":"If an object with the same ID already exists, it will be overwritten.","security":[{"OAuth2":["FullAccess","WebhookAdmin"]}],"x-authorizedUserTypes":["Seller"]},"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Webhooks.Delete","tags":["Webhooks"],"parameters":[{"name":"webhookID","in":"path","description":"ID of the webhook.","required":true,"schema":{"type":"string"}}],"summary":"Delete a webhook","description":"","security":[{"OAuth2":["FullAccess","WebhookAdmin"]}],"x-authorizedUserTypes":["Seller"]},"patch":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"Webhooks.Patch","tags":["Webhooks"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Webhook"}]}}}},"parameters":[{"name":"webhookID","in":"path","description":"ID of the webhook.","required":true,"schema":{"type":"string"}}],"summary":"Partially update a webhook","description":"","security":[{"OAuth2":["FullAccess","WebhookAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/xpindices":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"Items":{"type":"array","items":{"$ref":"#/components/schemas/XpIndex"}},"Meta":{"$ref":"#/components/schemas/Meta"}}}}}},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"XpIndices.List","tags":["XP indices"],"parameters":[{"name":"search","in":"query","description":"Word or phrase to search for.","required":false,"schema":{"type":"string"}},{"name":"searchOn","in":"query","description":"Comma-delimited list of fields to search on.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ThingType","Key"]}}},{"name":"sortBy","in":"query","description":"Comma-delimited list of fields to sort by.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ThingType","Key","!ThingType","!Key"]}}},{"name":"page","in":"query","description":"Page of results to return. When paginating through many items (> page 30), we recommend the \"Last ID\" method, as outlined in the Advanced Querying documentation.","required":false,"schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","description":"Number of results to return per page.","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"filters","in":"query","description":"An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'","required":false,"schema":{"type":"object"}}],"summary":"List XP indices","description":"","security":[{"OAuth2":["FullAccess","XpIndexAdmin"]}],"x-authorizedUserTypes":["Seller"]},"put":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"XpIndices.Put","tags":["XP indices"],"requestBody":{"required":true,"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/XpIndex"}]}}}},"summary":"Create or update an xp index","description":"","security":[{"OAuth2":["FullAccess","XpIndexAdmin"]}],"x-authorizedUserTypes":["Seller"]}},"/xpindices/{thingType}/{key}":{"delete":{"responses":{"204":{"description":""},"4XX":{"description":"Expected errors range from 400-409. Anything in the 5XX range indicates a server issue and should be reported to support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"operationId":"XpIndices.Delete","tags":["XP indices"],"parameters":[{"name":"thingType","in":"path","description":"Thing type of the xp index. Possible values: Address, Variant, Order, OrderReturn, LineItem, CostCenter, CreditCard, Payment, Spec, SpecOption, UserGroup, Company, Category, PriceSchedule, Shipment, SpendingAccount, User, Promotion, ApprovalRule, SellerApprovalRule, Catalog, ProductFacet, MessageSender, InventoryRecord, ProductCollection, Subscription, GroupOrderInvitation, BuyerGroup, Discount.","required":true,"schema":{"$ref":"#/components/schemas/XpThingType"}},{"name":"key","in":"path","description":"Key of the xp index.","required":true,"schema":{"type":"string"}}],"summary":"Delete a XP index","description":"","security":[{"OAuth2":["FullAccess","XpIndexAdmin"]}],"x-authorizedUserTypes":["Seller"]}}}}