{ "swagger": "2.0", "info": { "title": "OrderCloud", "description": "", "version": "1.0", "contact": { "name": "OrderCloud", "url": "http://ordercloud.io", "email": "ordercloud@four51.com" } }, "host": "api.ordercloud.io", "basePath": "/v1", "schemes": [ "https" ], "consumes": [ "application/json", "text/plain; charset=utf-8" ], "produces": [ "application/json" ], "security": [ { "oauth2": [ ] } ], "securityDefinitions": { "oauth2": { "type": "oauth2", "tokenUrl": "https://auth.ordercloud.io/oauth/token", "flow": "password", "scopes": { "AddressAdmin": "", "AddressReader": "", "AdminAddressAdmin": "", "AdminAddressReader": "", "AdminUserAdmin": "", "AdminUserGroupAdmin": "", "AdminUserGroupReader": "", "AdminUserReader": "", "ApprovalRuleAdmin": "", "ApprovalRuleReader": "", "BuyerAdmin": "", "BuyerImpersonation": "", "BuyerReader": "", "BuyerUserAdmin": "", "BuyerUserReader": "", "CatalogAdmin": "", "CatalogReader": "", "CategoryAdmin": "", "CategoryReader": "", "CostCenterAdmin": "", "CostCenterReader": "", "CreditCardAdmin": "", "CreditCardReader": "", "FullAccess": "", "GrantForAnyRole": "", "IncrementorAdmin": "", "IncrementorReader": "", "InventoryAdmin": "", "MeAddressAdmin": "", "MeAdmin": "", "MeCreditCardAdmin": "", "MessageConfigAssignmentAdmin": "", "MeXpAdmin": "", "OrderAdmin": "", "OrderReader": "", "OverrideShipping": "", "OverrideTax": "", "OverrideUnitPrice": "", "PasswordReset": "", "PriceScheduleAdmin": "", "PriceScheduleReader": "", "ProductAdmin": "", "ProductAssignmentAdmin": "", "ProductReader": "", "PromotionAdmin": "", "PromotionReader": "", "SetSecurityProfile": "", "ShipmentAdmin": "", "ShipmentReader": "", "Shopper": "", "SpendingAccountAdmin": "", "SpendingAccountReader": "", "SupplierAdmin": "", "SupplierReader": "", "SupplierUserAdmin": "", "SupplierUserGroupAdmin": "", "SupplierUserGroupReader": "", "SupplierUserReader": "", "UnsubmittedOrderReader": "", "UserGroupAdmin": "", "UserGroupReader": "" } } }, "definitions": { "AccessToken": { "type": "object", "properties": { "access_token": { "type": "string" }, "expires_in": { "type": "integer" }, "token_type": { "type": "string" }, "refresh_token": { "type": "string" } } }, "Address": { "type": "object", "properties": { "ID": { "type": "string" }, "DateCreated": { "type": "string" }, "CompanyName": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Street1": { "type": "string" }, "Street2": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "Zip": { "type": "string" }, "Country": { "type": "string" }, "Phone": { "type": "string" }, "AddressName": { "type": "string" }, "xp": { "type": "object" } } }, "AddressAssignment": { "type": "object", "properties": { "AddressID": { "type": "string" }, "UserID": { "type": "string" }, "UserGroupID": { "type": "string" }, "IsShipping": { "type": "boolean" }, "IsBilling": { "type": "boolean" } } }, "ApprovalRule": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "ApprovingGroupID": { "type": "string" }, "RuleExpression": { "type": "string" }, "xp": { "type": "object" } } }, "Buyer": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "DefaultCatalogID": { "type": "string" }, "Active": { "type": "boolean" }, "xp": { "type": "object" } } }, "BuyerAddress": { "type": "object", "properties": { "ID": { "type": "string" }, "Shipping": { "type": "boolean" }, "Billing": { "type": "boolean" }, "Editable": { "type": "boolean" }, "DateCreated": { "type": "string" }, "CompanyName": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Street1": { "type": "string" }, "Street2": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "Zip": { "type": "string" }, "Country": { "type": "string" }, "Phone": { "type": "string" }, "AddressName": { "type": "string" }, "xp": { "type": "object" } } }, "BuyerCreditCard": { "type": "object", "properties": { "ID": { "type": "string" }, "Editable": { "type": "boolean" }, "Token": { "type": "string" }, "DateCreated": { "type": "string" }, "CardType": { "type": "string" }, "PartialAccountNumber": { "type": "string" }, "CardholderName": { "type": "string" }, "ExpirationDate": { "type": "string" }, "xp": { "type": "object" } } }, "BuyerProduct": { "type": "object", "properties": { "PriceSchedule": { "$ref": "#/definitions/PriceSchedule" }, "ID": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "QuantityMultiplier": { "type": "integer" }, "ShipWeight": { "type": "number" }, "ShipHeight": { "type": "number" }, "ShipWidth": { "type": "number" }, "ShipLength": { "type": "number" }, "Active": { "type": "boolean" }, "SpecCount": { "type": "integer" }, "xp": { "type": "object" }, "VariantCount": { "type": "integer" }, "ShipFromAddressID": { "type": "string" }, "Inventory": { "$ref": "#/definitions/Inventory" }, "AutoForwardSupplierID": { "type": "string" } } }, "BuyerSpec": { "type": "object", "properties": { "Options": { "type": "array", "items": { "$ref": "#/definitions/SpecOption" } }, "ID": { "type": "string" }, "ListOrder": { "type": "integer" }, "Name": { "type": "string" }, "DefaultValue": { "type": "string" }, "Required": { "type": "boolean" }, "AllowOpenText": { "type": "boolean" }, "DefaultOptionID": { "type": "string" }, "DefinesVariant": { "type": "boolean" }, "xp": { "type": "object" } } }, "Catalog": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "Active": { "type": "boolean" }, "CategoryCount": { "type": "integer" }, "xp": { "type": "object" } } }, "CatalogAssignment": { "type": "object", "properties": { "CatalogID": { "type": "string" }, "BuyerID": { "type": "string" }, "ViewAllCategories": { "type": "boolean" }, "ViewAllProducts": { "type": "boolean" } } }, "Category": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "ListOrder": { "type": "integer" }, "Active": { "type": "boolean" }, "ParentID": { "type": "string" }, "ChildCount": { "type": "integer" }, "xp": { "type": "object" } } }, "CategoryAssignment": { "type": "object", "properties": { "CategoryID": { "type": "string" }, "BuyerID": { "type": "string" }, "UserGroupID": { "type": "string" }, "Visible": { "type": "boolean" }, "ViewAllProducts": { "type": "boolean" } } }, "CategoryProductAssignment": { "type": "object", "properties": { "CategoryID": { "type": "string" }, "ProductID": { "type": "string" }, "ListOrder": { "type": "integer" } } }, "CostCenter": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "xp": { "type": "object" } } }, "CostCenterAssignment": { "type": "object", "properties": { "CostCenterID": { "type": "string" }, "UserGroupID": { "type": "string" } } }, "CreditCard": { "type": "object", "properties": { "ID": { "type": "string" }, "Token": { "type": "string" }, "DateCreated": { "type": "string" }, "CardType": { "type": "string" }, "PartialAccountNumber": { "type": "string" }, "CardholderName": { "type": "string" }, "ExpirationDate": { "type": "string" }, "xp": { "type": "object" } } }, "CreditCardAssignment": { "type": "object", "properties": { "CreditCardID": { "type": "string" }, "UserID": { "type": "string" }, "UserGroupID": { "type": "string" } } }, "ImpersonateTokenRequest": { "type": "object", "properties": { "ClientID": { "type": "string" }, "Roles": { "type": "array", "items": { "type": "string" } } } }, "ImpersonationConfig": { "type": "object", "properties": { "ID": { "type": "string" }, "ImpersonationBuyerID": { "type": "string" }, "ImpersonationGroupID": { "type": "string" }, "ImpersonationUserID": { "type": "string" }, "BuyerID": { "type": "string" }, "GroupID": { "type": "string" }, "UserID": { "type": "string" }, "SecurityProfileID": { "type": "string" }, "ClientID": { "type": "string" } } }, "Incrementor": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "LastNumber": { "type": "integer" }, "LeftPaddingCount": { "type": "integer" } } }, "Inventory": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "NotificationPoint": { "type": "integer" }, "VariantLevelTracking": { "type": "boolean" }, "OrderCanExceed": { "type": "boolean" }, "QuantityAvailable": { "type": "integer" }, "LastUpdated": { "type": "string" } } }, "LineItem": { "type": "object", "properties": { "ID": { "type": "string" }, "ProductID": { "type": "string" }, "Quantity": { "type": "integer" }, "DateAdded": { "type": "string" }, "QuantityShipped": { "type": "integer" }, "UnitPrice": { "type": "number" }, "LineTotal": { "type": "number" }, "CostCenter": { "type": "string" }, "DateNeeded": { "type": "string" }, "ShippingAccount": { "type": "string" }, "ShippingAddressID": { "type": "string" }, "ShipFromAddressID": { "type": "string" }, "Product": { "$ref": "#/definitions/LineItemProduct" }, "ShippingAddress": { "$ref": "#/definitions/Address" }, "ShipFromAddress": { "$ref": "#/definitions/Address" }, "Specs": { "type": "array", "items": { "$ref": "#/definitions/LineItemSpec" } }, "xp": { "type": "object" } } }, "LineItemProduct": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "QuantityMultiplier": { "type": "integer" }, "ShipWeight": { "type": "number" }, "ShipHeight": { "type": "number" }, "ShipWidth": { "type": "number" }, "ShipLength": { "type": "number" }, "xp": { "type": "object" } } }, "LineItemSpec": { "type": "object", "properties": { "SpecID": { "type": "string" }, "Name": { "type": "string" }, "OptionID": { "type": "string" }, "Value": { "type": "string" } } }, "ListAddress": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Address" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListAddressAssignment": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/AddressAssignment" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListApprovalRule": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/ApprovalRule" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListBuyer": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Buyer" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListBuyerAddress": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/BuyerAddress" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListBuyerCreditCard": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/BuyerCreditCard" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListBuyerProduct": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/BuyerProduct" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListBuyerSpec": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/BuyerSpec" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListCatalog": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Catalog" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListCatalogAssignment": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/CatalogAssignment" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListCategory": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Category" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListCategoryAssignment": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/CategoryAssignment" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListCategoryProductAssignment": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/CategoryProductAssignment" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListCostCenter": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/CostCenter" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListCostCenterAssignment": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/CostCenterAssignment" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListCreditCard": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/CreditCard" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListCreditCardAssignment": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/CreditCardAssignment" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListImpersonationConfig": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/ImpersonationConfig" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListIncrementor": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Incrementor" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListLineItem": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/LineItem" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListMessageCCListenerAssignment": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/MessageCCListenerAssignment" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListMessageSender": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/MessageSender" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListMessageSenderAssignment": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/MessageSenderAssignment" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListOrder": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Order" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListOrderApproval": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/OrderApproval" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListOrderPromotion": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/OrderPromotion" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListPayment": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Payment" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListPriceSchedule": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/PriceSchedule" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListProduct": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Product" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListProductAssignment": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/ProductAssignment" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListProductCatalogAssignment": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/ProductCatalogAssignment" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListPromotion": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Promotion" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListPromotionAssignment": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/PromotionAssignment" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListSecurityProfile": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/SecurityProfile" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListSecurityProfileAssignment": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/SecurityProfileAssignment" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListShipment": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Shipment" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListShipmentItem": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/ShipmentItem" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListSpec": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Spec" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListSpecOption": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/SpecOption" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListSpecProductAssignment": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/SpecProductAssignment" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListSpendingAccount": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/SpendingAccount" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListSpendingAccountAssignment": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/SpendingAccountAssignment" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListSupplier": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Supplier" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListUser": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/User" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListUserGroup": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/UserGroup" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListUserGroupAssignment": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/UserGroupAssignment" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "ListVariant": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/Variant" } }, "Meta": { "$ref": "#/definitions/Meta" } } }, "MeBuyer": { "type": "object", "properties": { "ID": { "type": "string" }, "DefaultCatalogID": { "type": "string" } } }, "MessageCCListenerAssignment": { "type": "object", "properties": { "MessageSenderAssignment": { "$ref": "#/definitions/MessageSenderAssignment" }, "MessageConfigName": { "type": "string" }, "MessageConfigDescription": { "type": "string" }, "MessageType": { "type": "string" }, "BuyerID": { "type": "string" }, "UserGroupID": { "type": "string" }, "UserID": { "type": "string" } } }, "MessageSender": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "MessageTypes": { "type": "array", "items": { "type": "string" } }, "Description": { "type": "string" } } }, "MessageSenderAssignment": { "type": "object", "properties": { "MessageSenderID": { "type": "string" }, "BuyerID": { "type": "string" }, "UserGroupID": { "type": "string" }, "MessageConfigName": { "type": "string" }, "MessageConfigDescription": { "type": "string" } } }, "Meta": { "type": "object", "properties": { "Page": { "type": "integer" }, "PageSize": { "type": "integer" }, "TotalCount": { "type": "integer" }, "TotalPages": { "type": "integer" }, "ItemRange": { "type": "array", "items": { "type": "integer" } } } }, "MeUser": { "type": "object", "properties": { "Buyer": { "$ref": "#/definitions/MeBuyer" }, "ID": { "type": "string" }, "Username": { "type": "string" }, "Password": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Email": { "type": "string" }, "Phone": { "type": "string" }, "TermsAccepted": { "type": "string" }, "Active": { "type": "boolean" }, "xp": { "type": "object" }, "AvailableRoles": { "type": "array", "items": { "type": "string" } } } }, "Order": { "type": "object", "properties": { "xp": { "type": "object" }, "ID": { "type": "string" }, "FromUser": { "$ref": "#/definitions/User" }, "FromCompanyID": { "type": "string" }, "FromUserID": { "type": "string" }, "BillingAddressID": { "type": "string" }, "BillingAddress": { "$ref": "#/definitions/Address" }, "ShippingAddressID": { "type": "string" }, "Comments": { "type": "string" }, "LineItemCount": { "type": "integer" }, "Status": { "type": "string" }, "DateCreated": { "type": "string" }, "DateSubmitted": { "type": "string" }, "DateApproved": { "type": "string" }, "DateDeclined": { "type": "string" }, "DateCanceled": { "type": "string" }, "DateCompleted": { "type": "string" }, "Subtotal": { "type": "number" }, "ShippingCost": { "type": "number" }, "TaxCost": { "type": "number" }, "PromotionDiscount": { "type": "number" }, "Total": { "type": "number" }, "IsSubmitted": { "type": "boolean" } } }, "OrderApproval": { "type": "object", "properties": { "ApprovalRuleID": { "type": "string" }, "ApprovingGroupID": { "type": "string" }, "Status": { "type": "string" }, "DateCreated": { "type": "string" }, "DateCompleted": { "type": "string" }, "Approver": { "$ref": "#/definitions/User" }, "Comments": { "type": "string" } } }, "OrderApprovalInfo": { "type": "object", "properties": { "Comments": { "type": "string" }, "AllowResubmit": { "type": "boolean" } } }, "OrderPromotion": { "type": "object", "properties": { "Amount": { "type": "number" }, "ID": { "type": "string" }, "Code": { "type": "string" }, "Name": { "type": "string" }, "RedemptionLimit": { "type": "integer" }, "RedemptionLimitPerUser": { "type": "integer" }, "RedemptionCount": { "type": "integer" }, "Description": { "type": "string" }, "FinePrint": { "type": "string" }, "StartDate": { "type": "string" }, "ExpirationDate": { "type": "string" }, "EligibleExpression": { "type": "string" }, "ValueExpression": { "type": "string" }, "CanCombine": { "type": "boolean" }, "xp": { "type": "object" } } }, "PartialAddress": { "type": "object", "properties": { "ID": { "type": "string" }, "DateCreated": { "type": "string" }, "CompanyName": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Street1": { "type": "string" }, "Street2": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "Zip": { "type": "string" }, "Country": { "type": "string" }, "Phone": { "type": "string" }, "AddressName": { "type": "string" }, "xp": { "type": "object" } } }, "PartialApprovalRule": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "ApprovingGroupID": { "type": "string" }, "RuleExpression": { "type": "string" }, "xp": { "type": "object" } } }, "PartialBuyer": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "DefaultCatalogID": { "type": "string" }, "Active": { "type": "boolean" }, "xp": { "type": "object" } } }, "PartialBuyerAddress": { "type": "object", "properties": { "ID": { "type": "string" }, "Shipping": { "type": "boolean" }, "Billing": { "type": "boolean" }, "Editable": { "type": "boolean" }, "DateCreated": { "type": "string" }, "CompanyName": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Street1": { "type": "string" }, "Street2": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "Zip": { "type": "string" }, "Country": { "type": "string" }, "Phone": { "type": "string" }, "AddressName": { "type": "string" }, "xp": { "type": "object" } } }, "PartialBuyerCreditCard": { "type": "object", "properties": { "ID": { "type": "string" }, "Editable": { "type": "boolean" }, "Token": { "type": "string" }, "DateCreated": { "type": "string" }, "CardType": { "type": "string" }, "PartialAccountNumber": { "type": "string" }, "CardholderName": { "type": "string" }, "ExpirationDate": { "type": "string" }, "xp": { "type": "object" } } }, "PartialCatalog": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "Active": { "type": "boolean" }, "CategoryCount": { "type": "integer" }, "xp": { "type": "object" } } }, "PartialCategory": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "ListOrder": { "type": "integer" }, "Active": { "type": "boolean" }, "ParentID": { "type": "string" }, "ChildCount": { "type": "integer" }, "xp": { "type": "object" } } }, "PartialCostCenter": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "xp": { "type": "object" } } }, "PartialCreditCard": { "type": "object", "properties": { "ID": { "type": "string" }, "Token": { "type": "string" }, "DateCreated": { "type": "string" }, "CardType": { "type": "string" }, "PartialAccountNumber": { "type": "string" }, "CardholderName": { "type": "string" }, "ExpirationDate": { "type": "string" }, "xp": { "type": "object" } } }, "PartialImpersonationConfig": { "type": "object", "properties": { "ID": { "type": "string" }, "ImpersonationBuyerID": { "type": "string" }, "ImpersonationGroupID": { "type": "string" }, "ImpersonationUserID": { "type": "string" }, "BuyerID": { "type": "string" }, "GroupID": { "type": "string" }, "UserID": { "type": "string" }, "SecurityProfileID": { "type": "string" }, "ClientID": { "type": "string" } } }, "PartialIncrementor": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "LastNumber": { "type": "integer" }, "LeftPaddingCount": { "type": "integer" } } }, "PartialInventory": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "NotificationPoint": { "type": "integer" }, "VariantLevelTracking": { "type": "boolean" }, "OrderCanExceed": { "type": "boolean" }, "QuantityAvailable": { "type": "integer" }, "LastUpdated": { "type": "string" } } }, "PartialLineItem": { "type": "object", "properties": { "ID": { "type": "string" }, "ProductID": { "type": "string" }, "Quantity": { "type": "integer" }, "DateAdded": { "type": "string" }, "QuantityShipped": { "type": "integer" }, "UnitPrice": { "type": "number" }, "LineTotal": { "type": "number" }, "CostCenter": { "type": "string" }, "DateNeeded": { "type": "string" }, "ShippingAccount": { "type": "string" }, "ShippingAddressID": { "type": "string" }, "ShipFromAddressID": { "type": "string" }, "Product": { "$ref": "#/definitions/LineItemProduct" }, "ShippingAddress": { "$ref": "#/definitions/Address" }, "ShipFromAddress": { "$ref": "#/definitions/Address" }, "Specs": { "type": "array", "items": { "$ref": "#/definitions/LineItemSpec" } }, "xp": { "type": "object" } } }, "PartialLineItemProduct": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "QuantityMultiplier": { "type": "integer" }, "ShipWeight": { "type": "number" }, "ShipHeight": { "type": "number" }, "ShipWidth": { "type": "number" }, "ShipLength": { "type": "number" }, "xp": { "type": "object" } } }, "PartialLineItemSpec": { "type": "object", "properties": { "SpecID": { "type": "string" }, "Name": { "type": "string" }, "OptionID": { "type": "string" }, "Value": { "type": "string" } } }, "PartialMeBuyer": { "type": "object", "properties": { "ID": { "type": "string" }, "DefaultCatalogID": { "type": "string" } } }, "PartialMeUser": { "type": "object", "properties": { "Buyer": { "$ref": "#/definitions/MeBuyer" }, "ID": { "type": "string" }, "Username": { "type": "string" }, "Password": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Email": { "type": "string" }, "Phone": { "type": "string" }, "TermsAccepted": { "type": "string" }, "Active": { "type": "boolean" }, "xp": { "type": "object" }, "AvailableRoles": { "type": "array", "items": { "type": "string" } } } }, "PartialOrder": { "type": "object", "properties": { "xp": { "type": "object" }, "ID": { "type": "string" }, "FromUser": { "$ref": "#/definitions/User" }, "FromCompanyID": { "type": "string" }, "FromUserID": { "type": "string" }, "BillingAddressID": { "type": "string" }, "BillingAddress": { "$ref": "#/definitions/Address" }, "ShippingAddressID": { "type": "string" }, "Comments": { "type": "string" }, "LineItemCount": { "type": "integer" }, "Status": { "type": "string" }, "DateCreated": { "type": "string" }, "DateSubmitted": { "type": "string" }, "DateApproved": { "type": "string" }, "DateDeclined": { "type": "string" }, "DateCanceled": { "type": "string" }, "DateCompleted": { "type": "string" }, "Subtotal": { "type": "number" }, "ShippingCost": { "type": "number" }, "TaxCost": { "type": "number" }, "PromotionDiscount": { "type": "number" }, "Total": { "type": "number" }, "IsSubmitted": { "type": "boolean" } } }, "PartialPayment": { "type": "object", "properties": { "ID": { "type": "string" }, "Type": { "type": "string" }, "DateCreated": { "type": "string" }, "CreditCardID": { "type": "string" }, "SpendingAccountID": { "type": "string" }, "Description": { "type": "string" }, "Amount": { "type": "number" }, "Accepted": { "type": "boolean" }, "xp": { "type": "object" }, "Transactions": { "type": "array", "items": { "$ref": "#/definitions/PaymentTransaction" } } } }, "PartialPaymentTransaction": { "type": "object", "properties": { "ID": { "type": "string" }, "Type": { "type": "string" }, "DateExecuted": { "type": "string" }, "Amount": { "type": "number" }, "Succeeded": { "type": "boolean" }, "ResultCode": { "type": "string" }, "ResultMessage": { "type": "string" }, "xp": { "type": "object" } } }, "PartialPriceBreak": { "type": "object", "properties": { "Quantity": { "type": "integer" }, "Price": { "type": "number" } } }, "PartialPriceSchedule": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "ApplyTax": { "type": "boolean" }, "ApplyShipping": { "type": "boolean" }, "MinQuantity": { "type": "integer" }, "MaxQuantity": { "type": "integer" }, "UseCumulativeQuantity": { "type": "boolean" }, "RestrictedQuantity": { "type": "boolean" }, "PriceBreaks": { "type": "array", "items": { "$ref": "#/definitions/PriceBreak" } }, "xp": { "type": "object" } } }, "PartialProduct": { "type": "object", "properties": { "DefaultPriceScheduleID": { "type": "string" }, "ID": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "QuantityMultiplier": { "type": "integer" }, "ShipWeight": { "type": "number" }, "ShipHeight": { "type": "number" }, "ShipWidth": { "type": "number" }, "ShipLength": { "type": "number" }, "Active": { "type": "boolean" }, "SpecCount": { "type": "integer" }, "xp": { "type": "object" }, "VariantCount": { "type": "integer" }, "ShipFromAddressID": { "type": "string" }, "Inventory": { "$ref": "#/definitions/Inventory" }, "AutoForwardSupplierID": { "type": "string" } } }, "PartialPromotion": { "type": "object", "properties": { "ID": { "type": "string" }, "Code": { "type": "string" }, "Name": { "type": "string" }, "RedemptionLimit": { "type": "integer" }, "RedemptionLimitPerUser": { "type": "integer" }, "RedemptionCount": { "type": "integer" }, "Description": { "type": "string" }, "FinePrint": { "type": "string" }, "StartDate": { "type": "string" }, "ExpirationDate": { "type": "string" }, "EligibleExpression": { "type": "string" }, "ValueExpression": { "type": "string" }, "CanCombine": { "type": "boolean" }, "xp": { "type": "object" } } }, "PartialShipment": { "type": "object", "properties": { "xp": { "type": "object" }, "ID": { "type": "string" }, "BuyerID": { "type": "string" }, "Shipper": { "type": "string" }, "DateShipped": { "type": "string" }, "DateDelivered": { "type": "string" }, "TrackingNumber": { "type": "string" }, "Cost": { "type": "number" }, "Account": { "type": "string" }, "FromAddressID": { "type": "string" }, "ToAddressID": { "type": "string" }, "FromAddress": { "$ref": "#/definitions/Address" }, "ToAddress": { "$ref": "#/definitions/Address" } } }, "PartialSpec": { "type": "object", "properties": { "OptionCount": { "type": "integer" }, "ID": { "type": "string" }, "ListOrder": { "type": "integer" }, "Name": { "type": "string" }, "DefaultValue": { "type": "string" }, "Required": { "type": "boolean" }, "AllowOpenText": { "type": "boolean" }, "DefaultOptionID": { "type": "string" }, "DefinesVariant": { "type": "boolean" }, "xp": { "type": "object" } } }, "PartialSpecOption": { "type": "object", "properties": { "ID": { "type": "string" }, "Value": { "type": "string" }, "ListOrder": { "type": "integer" }, "IsOpenText": { "type": "boolean" }, "PriceMarkupType": { "type": "string" }, "PriceMarkup": { "type": "number" }, "xp": { "type": "object" } } }, "PartialSpendingAccount": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Balance": { "type": "number" }, "AllowAsPaymentMethod": { "type": "boolean" }, "RedemptionCode": { "type": "string" }, "StartDate": { "type": "string" }, "EndDate": { "type": "string" }, "xp": { "type": "object" } } }, "PartialSupplier": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Active": { "type": "boolean" }, "xp": { "type": "object" } } }, "PartialUser": { "type": "object", "properties": { "ID": { "type": "string" }, "Username": { "type": "string" }, "Password": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Email": { "type": "string" }, "Phone": { "type": "string" }, "TermsAccepted": { "type": "string" }, "Active": { "type": "boolean" }, "xp": { "type": "object" }, "AvailableRoles": { "type": "array", "items": { "type": "string" } } } }, "PartialUserGroup": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "xp": { "type": "object" } } }, "PartialVariant": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "Active": { "type": "boolean" }, "xp": { "type": "object" } } }, "PasswordReset": { "type": "object", "properties": { "ClientID": { "type": "string" }, "Username": { "type": "string" }, "Password": { "type": "string" } } }, "PasswordResetRequest": { "type": "object", "properties": { "ClientID": { "type": "string" }, "Email": { "type": "string" }, "Username": { "type": "string" }, "URL": { "type": "string" } } }, "Payment": { "type": "object", "properties": { "ID": { "type": "string" }, "Type": { "type": "string" }, "DateCreated": { "type": "string" }, "CreditCardID": { "type": "string" }, "SpendingAccountID": { "type": "string" }, "Description": { "type": "string" }, "Amount": { "type": "number" }, "Accepted": { "type": "boolean" }, "xp": { "type": "object" }, "Transactions": { "type": "array", "items": { "$ref": "#/definitions/PaymentTransaction" } } } }, "PaymentTransaction": { "type": "object", "properties": { "ID": { "type": "string" }, "Type": { "type": "string" }, "DateExecuted": { "type": "string" }, "Amount": { "type": "number" }, "Succeeded": { "type": "boolean" }, "ResultCode": { "type": "string" }, "ResultMessage": { "type": "string" }, "xp": { "type": "object" } } }, "PriceBreak": { "type": "object", "properties": { "Quantity": { "type": "integer" }, "Price": { "type": "number" } } }, "PriceSchedule": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "ApplyTax": { "type": "boolean" }, "ApplyShipping": { "type": "boolean" }, "MinQuantity": { "type": "integer" }, "MaxQuantity": { "type": "integer" }, "UseCumulativeQuantity": { "type": "boolean" }, "RestrictedQuantity": { "type": "boolean" }, "PriceBreaks": { "type": "array", "items": { "$ref": "#/definitions/PriceBreak" } }, "xp": { "type": "object" } } }, "Product": { "type": "object", "properties": { "DefaultPriceScheduleID": { "type": "string" }, "ID": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "QuantityMultiplier": { "type": "integer" }, "ShipWeight": { "type": "number" }, "ShipHeight": { "type": "number" }, "ShipWidth": { "type": "number" }, "ShipLength": { "type": "number" }, "Active": { "type": "boolean" }, "SpecCount": { "type": "integer" }, "xp": { "type": "object" }, "VariantCount": { "type": "integer" }, "ShipFromAddressID": { "type": "string" }, "Inventory": { "$ref": "#/definitions/Inventory" }, "AutoForwardSupplierID": { "type": "string" } } }, "ProductAssignment": { "type": "object", "properties": { "ProductID": { "type": "string" }, "BuyerID": { "type": "string" }, "UserGroupID": { "type": "string" }, "PriceScheduleID": { "type": "string" } } }, "ProductCatalogAssignment": { "type": "object", "properties": { "CatalogID": { "type": "string" }, "ProductID": { "type": "string" } } }, "Promotion": { "type": "object", "properties": { "ID": { "type": "string" }, "Code": { "type": "string" }, "Name": { "type": "string" }, "RedemptionLimit": { "type": "integer" }, "RedemptionLimitPerUser": { "type": "integer" }, "RedemptionCount": { "type": "integer" }, "Description": { "type": "string" }, "FinePrint": { "type": "string" }, "StartDate": { "type": "string" }, "ExpirationDate": { "type": "string" }, "EligibleExpression": { "type": "string" }, "ValueExpression": { "type": "string" }, "CanCombine": { "type": "boolean" }, "xp": { "type": "object" } } }, "PromotionAssignment": { "type": "object", "properties": { "PromotionID": { "type": "string" }, "BuyerID": { "type": "string" }, "UserGroupID": { "type": "string" } } }, "SecurityProfile": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Roles": { "type": "array", "items": { "type": "string" } } } }, "SecurityProfileAssignment": { "type": "object", "properties": { "SecurityProfileID": { "type": "string" }, "BuyerID": { "type": "string" }, "SupplierID": { "type": "string" }, "UserID": { "type": "string" }, "UserGroupID": { "type": "string" } } }, "Shipment": { "type": "object", "properties": { "xp": { "type": "object" }, "ID": { "type": "string" }, "BuyerID": { "type": "string" }, "Shipper": { "type": "string" }, "DateShipped": { "type": "string" }, "DateDelivered": { "type": "string" }, "TrackingNumber": { "type": "string" }, "Cost": { "type": "number" }, "Account": { "type": "string" }, "FromAddressID": { "type": "string" }, "ToAddressID": { "type": "string" }, "FromAddress": { "$ref": "#/definitions/Address" }, "ToAddress": { "$ref": "#/definitions/Address" } } }, "ShipmentItem": { "type": "object", "properties": { "OrderID": { "type": "string" }, "LineItemID": { "type": "string" }, "QuantityShipped": { "type": "integer" }, "UnitPrice": { "type": "number" }, "CostCenter": { "type": "string" }, "DateNeeded": { "type": "string" }, "Product": { "$ref": "#/definitions/LineItemProduct" }, "Specs": { "type": "array", "items": { "$ref": "#/definitions/LineItemSpec" } }, "xp": { "type": "object" } } }, "Spec": { "type": "object", "properties": { "OptionCount": { "type": "integer" }, "ID": { "type": "string" }, "ListOrder": { "type": "integer" }, "Name": { "type": "string" }, "DefaultValue": { "type": "string" }, "Required": { "type": "boolean" }, "AllowOpenText": { "type": "boolean" }, "DefaultOptionID": { "type": "string" }, "DefinesVariant": { "type": "boolean" }, "xp": { "type": "object" } } }, "SpecOption": { "type": "object", "properties": { "ID": { "type": "string" }, "Value": { "type": "string" }, "ListOrder": { "type": "integer" }, "IsOpenText": { "type": "boolean" }, "PriceMarkupType": { "type": "string" }, "PriceMarkup": { "type": "number" }, "xp": { "type": "object" } } }, "SpecProductAssignment": { "type": "object", "properties": { "SpecID": { "type": "string" }, "ProductID": { "type": "string" }, "DefaultValue": { "type": "string" }, "DefaultOptionID": { "type": "string" } } }, "SpendingAccount": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Balance": { "type": "number" }, "AllowAsPaymentMethod": { "type": "boolean" }, "RedemptionCode": { "type": "string" }, "StartDate": { "type": "string" }, "EndDate": { "type": "string" }, "xp": { "type": "object" } } }, "SpendingAccountAssignment": { "type": "object", "properties": { "SpendingAccountID": { "type": "string" }, "UserID": { "type": "string" }, "UserGroupID": { "type": "string" }, "AllowExceed": { "type": "boolean" } } }, "Supplier": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Active": { "type": "boolean" }, "xp": { "type": "object" } } }, "TokenPasswordReset": { "type": "object", "properties": { "NewPassword": { "type": "string" } } }, "User": { "type": "object", "properties": { "ID": { "type": "string" }, "Username": { "type": "string" }, "Password": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Email": { "type": "string" }, "Phone": { "type": "string" }, "TermsAccepted": { "type": "string" }, "Active": { "type": "boolean" }, "xp": { "type": "object" }, "AvailableRoles": { "type": "array", "items": { "type": "string" } } } }, "UserGroup": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "xp": { "type": "object" } } }, "UserGroupAssignment": { "type": "object", "properties": { "UserGroupID": { "type": "string" }, "UserID": { "type": "string" } } }, "Variant": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "Active": { "type": "boolean" }, "xp": { "type": "object" } } } }, "paths": { "/addresses": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListAddress" } } }, "operationId": "List", "tags": [ "AdminAddress" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "AdminAddressAdmin", "AdminAddressReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/Address" } } }, "operationId": "Create", "tags": [ "AdminAddress" ], "parameters": [ { "name": "address", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Address" } } ], "security": [ { "oauth2": [ "FullAccess", "AdminAddressAdmin" ] } ] } }, "/addresses/{addressID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Address" } } }, "operationId": "Get", "tags": [ "AdminAddress" ], "parameters": [ { "name": "addressID", "in": "path", "description": "ID of the address.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "AdminAddressAdmin", "AdminAddressReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/Address" } } }, "operationId": "Save", "tags": [ "AdminAddress" ], "parameters": [ { "name": "addressID", "in": "path", "description": "ID of the address.", "required": true, "type": "string" }, { "name": "address", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Address" } } ], "security": [ { "oauth2": [ "FullAccess", "AdminAddressAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "AdminAddress" ], "parameters": [ { "name": "addressID", "in": "path", "description": "ID of the address.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "AdminAddressAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Address" } } }, "operationId": "Patch", "tags": [ "AdminAddress" ], "parameters": [ { "name": "addressID", "in": "path", "description": "ID of the address.", "required": true, "type": "string" }, { "name": "partialAddress", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Address" } } ], "security": [ { "oauth2": [ "FullAccess", "AdminAddressAdmin" ] } ] } }, "/adminusers": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListUser" } } }, "operationId": "List", "tags": [ "AdminUser" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "AdminUserAdmin", "AdminUserReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/User" } } }, "operationId": "Create", "tags": [ "AdminUser" ], "parameters": [ { "name": "user", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/User" } } ], "security": [ { "oauth2": [ "FullAccess", "AdminUserAdmin" ] } ] } }, "/adminusers/{userID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/User" } } }, "operationId": "Get", "tags": [ "AdminUser" ], "parameters": [ { "name": "userID", "in": "path", "description": "ID of the user.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "AdminUserAdmin", "AdminUserReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/User" } } }, "operationId": "Save", "tags": [ "AdminUser" ], "parameters": [ { "name": "userID", "in": "path", "description": "ID of the user.", "required": true, "type": "string" }, { "name": "user", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/User" } } ], "security": [ { "oauth2": [ "FullAccess", "AdminUserAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "AdminUser" ], "parameters": [ { "name": "userID", "in": "path", "description": "ID of the user.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "AdminUserAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/User" } } }, "operationId": "Patch", "tags": [ "AdminUser" ], "parameters": [ { "name": "userID", "in": "path", "description": "ID of the user.", "required": true, "type": "string" }, { "name": "partialUser", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/User" } } ], "security": [ { "oauth2": [ "FullAccess", "AdminUserAdmin" ] } ] } }, "/buyers": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListBuyer" } } }, "operationId": "List", "tags": [ "Buyer" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "BuyerAdmin", "BuyerReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/Buyer" } } }, "operationId": "Create", "tags": [ "Buyer" ], "parameters": [ { "name": "buyer", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Buyer" } } ], "security": [ { "oauth2": [ "FullAccess", "BuyerAdmin" ] } ] } }, "/buyers/{buyerID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Buyer" } } }, "operationId": "Get", "tags": [ "Buyer" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "BuyerAdmin", "BuyerReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/Buyer" } } }, "operationId": "Save", "tags": [ "Buyer" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "buyer", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Buyer" } } ], "security": [ { "oauth2": [ "FullAccess", "BuyerAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "Buyer" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "BuyerAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Buyer" } } }, "operationId": "Patch", "tags": [ "Buyer" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "partialBuyer", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Buyer" } } ], "security": [ { "oauth2": [ "FullAccess", "BuyerAdmin" ] } ] } }, "/buyers/{buyerID}/addresses": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListAddress" } } }, "operationId": "List", "tags": [ "Address" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "AddressAdmin", "AddressReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/Address" } } }, "operationId": "Create", "tags": [ "Address" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "address", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Address" } } ], "security": [ { "oauth2": [ "FullAccess", "AddressAdmin" ] } ] } }, "/buyers/{buyerID}/addresses/{addressID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Address" } } }, "operationId": "Get", "tags": [ "Address" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "addressID", "in": "path", "description": "ID of the address.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "AddressAdmin", "AddressReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/Address" } } }, "operationId": "Save", "tags": [ "Address" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "addressID", "in": "path", "description": "ID of the address.", "required": true, "type": "string" }, { "name": "address", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Address" } } ], "security": [ { "oauth2": [ "FullAccess", "AddressAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "Address" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "addressID", "in": "path", "description": "ID of the address.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "AddressAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Address" } } }, "operationId": "Patch", "tags": [ "Address" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "addressID", "in": "path", "description": "ID of the address.", "required": true, "type": "string" }, { "name": "partialAddress", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Address" } } ], "security": [ { "oauth2": [ "FullAccess", "AddressAdmin" ] } ] } }, "/buyers/{buyerID}/addresses/{addressID}/assignments": { "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteAssignment", "tags": [ "Address" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "addressID", "in": "path", "description": "ID of the address.", "required": true, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "AddressAdmin" ] } ] } }, "/buyers/{buyerID}/addresses/assignments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListAddressAssignment" } } }, "operationId": "ListAssignments", "tags": [ "Address" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "addressID", "in": "query", "description": "ID of the address.", "required": false, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" }, { "name": "level", "in": "query", "description": "Level of the address assignment. Possible values: User, Group, Company.", "required": false, "type": "string" }, { "name": "isShipping", "in": "query", "description": "Is shipping of the address assignment.", "required": false, "type": "boolean" }, { "name": "isBilling", "in": "query", "description": "Is billing of the address assignment.", "required": false, "type": "boolean" }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" } ], "security": [ { "oauth2": [ "FullAccess", "AddressAdmin", "AddressReader" ] } ] }, "post": { "responses": { "204": { "description": "" } }, "operationId": "SaveAssignment", "tags": [ "Address" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "addressAssignment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/AddressAssignment" } } ], "security": [ { "oauth2": [ "FullAccess", "AddressAdmin" ] } ] } }, "/buyers/{buyerID}/approvalrules": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListApprovalRule" } } }, "operationId": "List", "tags": [ "ApprovalRule" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "ApprovalRuleAdmin", "ApprovalRuleReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/ApprovalRule" } } }, "operationId": "Create", "tags": [ "ApprovalRule" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "approvalRule", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/ApprovalRule" } } ], "security": [ { "oauth2": [ "FullAccess", "ApprovalRuleAdmin" ] } ] } }, "/buyers/{buyerID}/approvalrules/{approvalRuleID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ApprovalRule" } } }, "operationId": "Get", "tags": [ "ApprovalRule" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "approvalRuleID", "in": "path", "description": "ID of the approval rule.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "ApprovalRuleAdmin", "ApprovalRuleReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/ApprovalRule" } } }, "operationId": "Save", "tags": [ "ApprovalRule" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "approvalRuleID", "in": "path", "description": "ID of the approval rule.", "required": true, "type": "string" }, { "name": "approvalRule", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/ApprovalRule" } } ], "security": [ { "oauth2": [ "FullAccess", "ApprovalRuleAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "ApprovalRule" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "approvalRuleID", "in": "path", "description": "ID of the approval rule.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "ApprovalRuleAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ApprovalRule" } } }, "operationId": "Patch", "tags": [ "ApprovalRule" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "approvalRuleID", "in": "path", "description": "ID of the approval rule.", "required": true, "type": "string" }, { "name": "partialApprovalRule", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/ApprovalRule" } } ], "security": [ { "oauth2": [ "FullAccess", "ApprovalRuleAdmin" ] } ] } }, "/buyers/{buyerID}/costcenters": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListCostCenter" } } }, "operationId": "List", "tags": [ "CostCenter" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "CostCenterAdmin", "CostCenterReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/CostCenter" } } }, "operationId": "Create", "tags": [ "CostCenter" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "costCenter", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/CostCenter" } } ], "security": [ { "oauth2": [ "FullAccess", "CostCenterAdmin" ] } ] } }, "/buyers/{buyerID}/costcenters/{costCenterID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/CostCenter" } } }, "operationId": "Get", "tags": [ "CostCenter" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "costCenterID", "in": "path", "description": "ID of the cost center.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "CostCenterAdmin", "CostCenterReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/CostCenter" } } }, "operationId": "Save", "tags": [ "CostCenter" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "costCenterID", "in": "path", "description": "ID of the cost center.", "required": true, "type": "string" }, { "name": "costCenter", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/CostCenter" } } ], "security": [ { "oauth2": [ "FullAccess", "CostCenterAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "CostCenter" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "costCenterID", "in": "path", "description": "ID of the cost center.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "CostCenterAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/CostCenter" } } }, "operationId": "Patch", "tags": [ "CostCenter" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "costCenterID", "in": "path", "description": "ID of the cost center.", "required": true, "type": "string" }, { "name": "partialCostCenter", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/CostCenter" } } ], "security": [ { "oauth2": [ "FullAccess", "CostCenterAdmin" ] } ] } }, "/buyers/{buyerID}/costcenters/{costCenterID}/assignments": { "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteAssignment", "tags": [ "CostCenter" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "costCenterID", "in": "path", "description": "ID of the cost center.", "required": true, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "CostCenterAdmin" ] } ] } }, "/buyers/{buyerID}/costcenters/assignments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListCostCenterAssignment" } } }, "operationId": "ListAssignments", "tags": [ "CostCenter" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "costCenterID", "in": "query", "description": "ID of the cost center.", "required": false, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" }, { "name": "level", "in": "query", "description": "Level of the cost center assignment. Possible values: User, Group, Company.", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" } ], "security": [ { "oauth2": [ "FullAccess", "CostCenterAdmin", "CostCenterReader" ] } ] }, "post": { "responses": { "204": { "description": "" } }, "operationId": "SaveAssignment", "tags": [ "CostCenter" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "costCenterAssignment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/CostCenterAssignment" } } ], "security": [ { "oauth2": [ "FullAccess", "CostCenterAdmin" ] } ] } }, "/buyers/{buyerID}/creditcards": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListCreditCard" } } }, "operationId": "List", "tags": [ "CreditCard" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "CreditCardAdmin", "CreditCardReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/CreditCard" } } }, "operationId": "Create", "tags": [ "CreditCard" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "creditCard", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/CreditCard" } } ], "security": [ { "oauth2": [ "FullAccess", "CreditCardAdmin" ] } ] } }, "/buyers/{buyerID}/creditcards/{creditCardID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/CreditCard" } } }, "operationId": "Get", "tags": [ "CreditCard" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "creditCardID", "in": "path", "description": "ID of the credit card.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "CreditCardAdmin", "CreditCardReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/CreditCard" } } }, "operationId": "Save", "tags": [ "CreditCard" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "creditCardID", "in": "path", "description": "ID of the credit card.", "required": true, "type": "string" }, { "name": "creditCard", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/CreditCard" } } ], "security": [ { "oauth2": [ "FullAccess", "CreditCardAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "CreditCard" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "creditCardID", "in": "path", "description": "ID of the credit card.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "CreditCardAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/CreditCard" } } }, "operationId": "Patch", "tags": [ "CreditCard" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "creditCardID", "in": "path", "description": "ID of the credit card.", "required": true, "type": "string" }, { "name": "partialCreditCard", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/CreditCard" } } ], "security": [ { "oauth2": [ "FullAccess", "CreditCardAdmin" ] } ] } }, "/buyers/{buyerID}/creditcards/{creditCardID}/assignments": { "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteAssignment", "tags": [ "CreditCard" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "creditCardID", "in": "path", "description": "ID of the credit card.", "required": true, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "CreditCardAdmin" ] } ] } }, "/buyers/{buyerID}/creditcards/assignments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListCreditCardAssignment" } } }, "operationId": "ListAssignments", "tags": [ "CreditCard" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "creditCardID", "in": "query", "description": "ID of the credit card.", "required": false, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" }, { "name": "level", "in": "query", "description": "Level of the credit card assignment. Possible values: User, Group, Company.", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" } ], "security": [ { "oauth2": [ "FullAccess", "CreditCardAdmin", "CreditCardReader" ] } ] }, "post": { "responses": { "204": { "description": "" } }, "operationId": "SaveAssignment", "tags": [ "CreditCard" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "creditCardAssignment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/CreditCardAssignment" } } ], "security": [ { "oauth2": [ "FullAccess", "CreditCardAdmin" ] } ] } }, "/buyers/{buyerID}/spendingaccounts": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListSpendingAccount" } } }, "operationId": "List", "tags": [ "SpendingAccount" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "SpendingAccountAdmin", "SpendingAccountReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/SpendingAccount" } } }, "operationId": "Create", "tags": [ "SpendingAccount" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "spendingAccount", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/SpendingAccount" } } ], "security": [ { "oauth2": [ "FullAccess", "SpendingAccountAdmin" ] } ] } }, "/buyers/{buyerID}/spendingaccounts/{spendingAccountID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/SpendingAccount" } } }, "operationId": "Get", "tags": [ "SpendingAccount" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "spendingAccountID", "in": "path", "description": "ID of the spending account.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "SpendingAccountAdmin", "SpendingAccountReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/SpendingAccount" } } }, "operationId": "Save", "tags": [ "SpendingAccount" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "spendingAccountID", "in": "path", "description": "ID of the spending account.", "required": true, "type": "string" }, { "name": "spendingAccount", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/SpendingAccount" } } ], "security": [ { "oauth2": [ "FullAccess", "SpendingAccountAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "SpendingAccount" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "spendingAccountID", "in": "path", "description": "ID of the spending account.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "SpendingAccountAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/SpendingAccount" } } }, "operationId": "Patch", "tags": [ "SpendingAccount" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "spendingAccountID", "in": "path", "description": "ID of the spending account.", "required": true, "type": "string" }, { "name": "partialSpendingAccount", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/SpendingAccount" } } ], "security": [ { "oauth2": [ "FullAccess", "SpendingAccountAdmin" ] } ] } }, "/buyers/{buyerID}/spendingaccounts/{spendingAccountID}/assignments": { "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteAssignment", "tags": [ "SpendingAccount" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "spendingAccountID", "in": "path", "description": "ID of the spending account.", "required": true, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "SpendingAccountAdmin" ] } ] } }, "/buyers/{buyerID}/spendingaccounts/assignments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListSpendingAccountAssignment" } } }, "operationId": "ListAssignments", "tags": [ "SpendingAccount" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "spendingAccountID", "in": "query", "description": "ID of the spending account.", "required": false, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" }, { "name": "level", "in": "query", "description": "Level of the spending account assignment. Possible values: User, Group, Company.", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" } ], "security": [ { "oauth2": [ "FullAccess", "SpendingAccountAdmin", "SpendingAccountReader" ] } ] }, "post": { "responses": { "204": { "description": "" } }, "operationId": "SaveAssignment", "tags": [ "SpendingAccount" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "spendingAccountAssignment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/SpendingAccountAssignment" } } ], "security": [ { "oauth2": [ "FullAccess", "SpendingAccountAdmin" ] } ] } }, "/buyers/{buyerID}/usergroups": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListUserGroup" } } }, "operationId": "List", "tags": [ "UserGroup" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "UserGroupAdmin", "UserGroupReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/UserGroup" } } }, "operationId": "Create", "tags": [ "UserGroup" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "userGroup", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/UserGroup" } } ], "security": [ { "oauth2": [ "FullAccess", "UserGroupAdmin" ] } ] } }, "/buyers/{buyerID}/usergroups/{userGroupID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/UserGroup" } } }, "operationId": "Get", "tags": [ "UserGroup" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "userGroupID", "in": "path", "description": "ID of the user group.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "UserGroupAdmin", "UserGroupReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/UserGroup" } } }, "operationId": "Save", "tags": [ "UserGroup" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "userGroupID", "in": "path", "description": "ID of the user group.", "required": true, "type": "string" }, { "name": "userGroup", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/UserGroup" } } ], "security": [ { "oauth2": [ "FullAccess", "UserGroupAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "UserGroup" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "userGroupID", "in": "path", "description": "ID of the user group.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "UserGroupAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/UserGroup" } } }, "operationId": "Patch", "tags": [ "UserGroup" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "userGroupID", "in": "path", "description": "ID of the user group.", "required": true, "type": "string" }, { "name": "partialUserGroup", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/UserGroup" } } ], "security": [ { "oauth2": [ "FullAccess", "UserGroupAdmin" ] } ] } }, "/buyers/{buyerID}/usergroups/{userGroupID}/assignments/{userID}": { "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteUserAssignment", "tags": [ "UserGroup" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "userGroupID", "in": "path", "description": "ID of the user group.", "required": true, "type": "string" }, { "name": "userID", "in": "path", "description": "ID of the user.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "UserGroupAdmin" ] } ] } }, "/buyers/{buyerID}/usergroups/assignments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListUserGroupAssignment" } } }, "operationId": "ListUserAssignments", "tags": [ "UserGroup" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" } ], "security": [ { "oauth2": [ "FullAccess", "UserGroupAdmin", "UserGroupReader" ] } ] }, "post": { "responses": { "204": { "description": "" } }, "operationId": "SaveUserAssignment", "tags": [ "UserGroup" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "userGroupAssignment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/UserGroupAssignment" } } ], "security": [ { "oauth2": [ "FullAccess", "UserGroupAdmin" ] } ] } }, "/buyers/{buyerID}/users": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListUser" } } }, "operationId": "List", "tags": [ "User" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "BuyerUserAdmin", "BuyerUserReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/User" } } }, "operationId": "Create", "tags": [ "User" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "user", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/User" } } ], "security": [ { "oauth2": [ "FullAccess", "BuyerUserAdmin" ] } ] } }, "/buyers/{buyerID}/users/{userID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/User" } } }, "operationId": "Get", "tags": [ "User" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "userID", "in": "path", "description": "ID of the user.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "BuyerUserAdmin", "BuyerUserReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/User" } } }, "operationId": "Save", "tags": [ "User" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "userID", "in": "path", "description": "ID of the user.", "required": true, "type": "string" }, { "name": "user", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/User" } } ], "security": [ { "oauth2": [ "FullAccess", "BuyerUserAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "User" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "userID", "in": "path", "description": "ID of the user.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "BuyerUserAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/User" } } }, "operationId": "Patch", "tags": [ "User" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "userID", "in": "path", "description": "ID of the user.", "required": true, "type": "string" }, { "name": "partialUser", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/User" } } ], "security": [ { "oauth2": [ "FullAccess", "BuyerUserAdmin" ] } ] } }, "/buyers/{buyerID}/users/{userID}/accesstoken": { "post": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AccessToken" } } }, "operationId": "GetAccessToken", "tags": [ "User" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "userID", "in": "path", "description": "ID of the user.", "required": true, "type": "string" }, { "name": "impersonateTokenRequest", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/ImpersonateTokenRequest" } } ], "security": [ { "oauth2": [ "FullAccess", "BuyerImpersonation" ] } ] } }, "/buyers/{buyerID}/users/{userID}/moveto/{newBuyerID}": { "post": { "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/User" } } }, "operationId": "Move", "tags": [ "User" ], "parameters": [ { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "userID", "in": "path", "description": "ID of the user.", "required": true, "type": "string" }, { "name": "newBuyerID", "in": "path", "description": "ID of the new buyer.", "required": true, "type": "string" }, { "name": "orders", "in": "query", "description": "Orders of the user. Possible values: None, Unsubmitted, All.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "BuyerUserAdmin" ] } ] } }, "/catalogs": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListCatalog" } } }, "operationId": "List", "tags": [ "Catalog" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "CatalogAdmin", "CatalogReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/Catalog" } } }, "operationId": "Create", "tags": [ "Catalog" ], "parameters": [ { "name": "catalog", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Catalog" } } ], "security": [ { "oauth2": [ "FullAccess", "CatalogAdmin" ] } ] } }, "/catalogs/{catalogID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Catalog" } } }, "operationId": "Get", "tags": [ "Catalog" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "CatalogAdmin", "CatalogReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/Catalog" } } }, "operationId": "Save", "tags": [ "Catalog" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" }, { "name": "catalog", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Catalog" } } ], "security": [ { "oauth2": [ "FullAccess", "CatalogAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "Catalog" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "CatalogAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Catalog" } } }, "operationId": "Patch", "tags": [ "Catalog" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" }, { "name": "partialCatalog", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Catalog" } } ], "security": [ { "oauth2": [ "FullAccess", "CatalogAdmin" ] } ] } }, "/catalogs/{catalogID}/assignments": { "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteAssignment", "tags": [ "Catalog" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" }, { "name": "buyerID", "in": "query", "description": "ID of the buyer.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "CatalogAdmin" ] } ] } }, "/catalogs/{catalogID}/categories": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListCategory" } } }, "operationId": "List", "tags": [ "Category" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" }, { "name": "depth", "in": "query", "description": "Depth of the category.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "CategoryAdmin", "CategoryReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/Category" } } }, "operationId": "Create", "tags": [ "Category" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" }, { "name": "category", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Category" } } ], "security": [ { "oauth2": [ "FullAccess", "CategoryAdmin" ] } ] } }, "/catalogs/{catalogID}/categories/{categoryID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Category" } } }, "operationId": "Get", "tags": [ "Category" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" }, { "name": "categoryID", "in": "path", "description": "ID of the category.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "CategoryAdmin", "CategoryReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/Category" } } }, "operationId": "Save", "tags": [ "Category" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" }, { "name": "categoryID", "in": "path", "description": "ID of the category.", "required": true, "type": "string" }, { "name": "category", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Category" } } ], "security": [ { "oauth2": [ "FullAccess", "CategoryAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "Deleting a parent category will also delete all of that category's children." } }, "operationId": "Delete", "tags": [ "Category" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" }, { "name": "categoryID", "in": "path", "description": "ID of the category.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "CategoryAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Category" } } }, "operationId": "Patch", "tags": [ "Category" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" }, { "name": "categoryID", "in": "path", "description": "ID of the category.", "required": true, "type": "string" }, { "name": "partialCategory", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Category" } } ], "security": [ { "oauth2": [ "FullAccess", "CategoryAdmin" ] } ] } }, "/catalogs/{catalogID}/categories/{categoryID}/assignments": { "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteAssignment", "tags": [ "Category" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" }, { "name": "categoryID", "in": "path", "description": "ID of the category.", "required": true, "type": "string" }, { "name": "buyerID", "in": "query", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "CategoryAdmin" ] } ] } }, "/catalogs/{catalogID}/categories/{categoryID}/productassignments/{productID}": { "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteProductAssignment", "tags": [ "Category" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" }, { "name": "categoryID", "in": "path", "description": "ID of the category.", "required": true, "type": "string" }, { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "CategoryAdmin" ] } ] } }, "/catalogs/{catalogID}/categories/assignments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListCategoryAssignment" } } }, "operationId": "ListAssignments", "tags": [ "Category" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" }, { "name": "categoryID", "in": "query", "description": "ID of the category.", "required": false, "type": "string" }, { "name": "buyerID", "in": "query", "description": "ID of the buyer.", "required": false, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" }, { "name": "level", "in": "query", "description": "Level of the category assignment. Possible values: User, Group, Company.", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" } ], "security": [ { "oauth2": [ "FullAccess", "CategoryAdmin", "CategoryReader" ] } ] }, "post": { "responses": { "204": { "description": "" } }, "operationId": "SaveAssignment", "tags": [ "Category" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" }, { "name": "categoryAssignment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/CategoryAssignment" } } ], "security": [ { "oauth2": [ "FullAccess", "CategoryAdmin" ] } ] } }, "/catalogs/{catalogID}/categories/productassignments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListCategoryProductAssignment" } } }, "operationId": "ListProductAssignments", "tags": [ "Category" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" }, { "name": "categoryID", "in": "query", "description": "ID of the category.", "required": false, "type": "string" }, { "name": "productID", "in": "query", "description": "ID of the product.", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" } ], "security": [ { "oauth2": [ "FullAccess", "CategoryAdmin", "CategoryReader" ] } ] }, "post": { "responses": { "204": { "description": "" } }, "operationId": "SaveProductAssignment", "tags": [ "Category" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" }, { "name": "categoryProductAssignment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/CategoryProductAssignment" } } ], "security": [ { "oauth2": [ "FullAccess", "CategoryAdmin" ] } ] } }, "/catalogs/{catalogID}/productassignments/{productID}": { "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteProductAssignment", "tags": [ "Catalog" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" }, { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "CatalogAdmin" ] } ] } }, "/catalogs/assignments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListCatalogAssignment" } } }, "operationId": "ListAssignments", "tags": [ "Catalog" ], "parameters": [ { "name": "catalogID", "in": "query", "description": "ID of the catalog.", "required": false, "type": "string" }, { "name": "buyerID", "in": "query", "description": "ID of the buyer.", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" } ], "security": [ { "oauth2": [ "FullAccess", "CatalogAdmin", "CatalogReader" ] } ] }, "post": { "responses": { "204": { "description": "" } }, "operationId": "SaveAssignment", "tags": [ "Catalog" ], "parameters": [ { "name": "catalogAssignment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/CatalogAssignment" } } ], "security": [ { "oauth2": [ "FullAccess", "CatalogAdmin" ] } ] } }, "/catalogs/productassignments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListProductCatalogAssignment" } } }, "operationId": "ListProductAssignments", "tags": [ "Catalog" ], "parameters": [ { "name": "catalogID", "in": "query", "description": "ID of the catalog.", "required": false, "type": "string" }, { "name": "productID", "in": "query", "description": "ID of the product.", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" } ], "security": [ { "oauth2": [ "FullAccess", "CatalogAdmin", "CatalogReader" ] } ] }, "post": { "responses": { "204": { "description": "" } }, "operationId": "SaveProductAssignment", "tags": [ "Catalog" ], "parameters": [ { "name": "productCatalogAssignment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/ProductCatalogAssignment" } } ], "security": [ { "oauth2": [ "FullAccess", "CatalogAdmin" ] } ] } }, "/impersonationconfig": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListImpersonationConfig" } } }, "operationId": "List", "tags": [ "ImpersonationConfig" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "SetSecurityProfile" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/ImpersonationConfig" } } }, "operationId": "Create", "tags": [ "ImpersonationConfig" ], "parameters": [ { "name": "impersonationConfig", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/ImpersonationConfig" } } ], "security": [ { "oauth2": [ "FullAccess", "SetSecurityProfile" ] } ] } }, "/impersonationconfig/{impersonationConfigID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ImpersonationConfig" } } }, "operationId": "Get", "tags": [ "ImpersonationConfig" ], "parameters": [ { "name": "impersonationConfigID", "in": "path", "description": "ID of the impersonation config.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "SetSecurityProfile" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/ImpersonationConfig" } } }, "operationId": "Save", "tags": [ "ImpersonationConfig" ], "parameters": [ { "name": "impersonationConfigID", "in": "path", "description": "ID of the impersonation config.", "required": true, "type": "string" }, { "name": "impersonationConfig", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/ImpersonationConfig" } } ], "security": [ { "oauth2": [ "FullAccess", "SetSecurityProfile" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "ImpersonationConfig" ], "parameters": [ { "name": "impersonationConfigID", "in": "path", "description": "ID of the impersonation config.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "SetSecurityProfile" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ImpersonationConfig" } } }, "operationId": "Patch", "tags": [ "ImpersonationConfig" ], "parameters": [ { "name": "impersonationConfigID", "in": "path", "description": "ID of the impersonation config.", "required": true, "type": "string" }, { "name": "partialImpersonationConfig", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/ImpersonationConfig" } } ], "security": [ { "oauth2": [ "FullAccess", "SetSecurityProfile" ] } ] } }, "/incrementors": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListIncrementor" } } }, "operationId": "List", "tags": [ "Incrementor" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "IncrementorAdmin", "IncrementorReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/Incrementor" } } }, "operationId": "Create", "tags": [ "Incrementor" ], "parameters": [ { "name": "incrementor", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Incrementor" } } ], "security": [ { "oauth2": [ "FullAccess", "IncrementorAdmin" ] } ] } }, "/incrementors/{incrementorID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Incrementor" } } }, "operationId": "Get", "tags": [ "Incrementor" ], "parameters": [ { "name": "incrementorID", "in": "path", "description": "ID of the incrementor.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "IncrementorAdmin", "IncrementorReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/Incrementor" } } }, "operationId": "Save", "tags": [ "Incrementor" ], "parameters": [ { "name": "incrementorID", "in": "path", "description": "ID of the incrementor.", "required": true, "type": "string" }, { "name": "incrementor", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Incrementor" } } ], "security": [ { "oauth2": [ "FullAccess", "IncrementorAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "Incrementor" ], "parameters": [ { "name": "incrementorID", "in": "path", "description": "ID of the incrementor.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "IncrementorAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Incrementor" } } }, "operationId": "Patch", "tags": [ "Incrementor" ], "parameters": [ { "name": "incrementorID", "in": "path", "description": "ID of the incrementor.", "required": true, "type": "string" }, { "name": "partialIncrementor", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Incrementor" } } ], "security": [ { "oauth2": [ "FullAccess", "IncrementorAdmin" ] } ] } }, "/me": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/MeUser" } } }, "operationId": "Get", "tags": [ "Me" ], "parameters": [ ], "security": [ { "oauth2": [ ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/MeUser" } } }, "operationId": "Save", "tags": [ "Me" ], "parameters": [ { "name": "meUser", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/MeUser" } } ], "security": [ { "oauth2": [ "FullAccess", "MeAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/MeUser" } } }, "operationId": "Patch", "tags": [ "Me" ], "parameters": [ { "name": "partialMeUser", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/MeUser" } } ], "security": [ { "oauth2": [ "FullAccess", "MeAdmin" ] } ] } }, "/me/addresses": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/ListBuyerAddress" } } }, "operationId": "ListAddresses", "tags": [ "Me" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "MeAddressAdmin", "Shopper" ] } ] }, "post": { "responses": { "201": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/BuyerAddress" } } }, "operationId": "CreateAddress", "tags": [ "Me" ], "parameters": [ { "name": "buyerAddress", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/BuyerAddress" } } ], "security": [ { "oauth2": [ "FullAccess", "MeAddressAdmin" ] } ] } }, "/me/addresses/{addressID}": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/BuyerAddress" } } }, "operationId": "GetAddress", "tags": [ "Me" ], "parameters": [ { "name": "addressID", "in": "path", "description": "ID of the address.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "MeAddressAdmin", "Shopper" ] } ] }, "put": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/BuyerAddress" } } }, "operationId": "SaveAddress", "tags": [ "Me" ], "parameters": [ { "name": "addressID", "in": "path", "description": "ID of the address.", "required": true, "type": "string" }, { "name": "buyerAddress", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/BuyerAddress" } } ], "security": [ { "oauth2": [ "FullAccess", "MeAddressAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "Only available to Buyer Users." } }, "operationId": "DeleteAddress", "tags": [ "Me" ], "parameters": [ { "name": "addressID", "in": "path", "description": "ID of the address.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "MeAddressAdmin" ] } ] }, "patch": { "responses": { "204": { "description": "Only available to Buyer Users." } }, "operationId": "PatchAddress", "tags": [ "Me" ], "parameters": [ { "name": "addressID", "in": "path", "description": "ID of the address.", "required": true, "type": "string" }, { "name": "partialBuyerAddress", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/BuyerAddress" } } ], "security": [ { "oauth2": [ "FullAccess", "MeAddressAdmin" ] } ] } }, "/me/catalogs": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/ListCatalog" } } }, "operationId": "ListCatalogs", "tags": [ "Me" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/catalogs/{catalogID}": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/Catalog" } } }, "operationId": "GetCatalog", "tags": [ "Me" ], "parameters": [ { "name": "catalogID", "in": "path", "description": "ID of the catalog.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/categories": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/ListCategory" } } }, "operationId": "ListCategories", "tags": [ "Me" ], "parameters": [ { "name": "depth", "in": "query", "description": "Depth of the category.", "required": false, "type": "string" }, { "name": "catalogID", "in": "query", "description": "ID of the catalog.", "required": false, "type": "string" }, { "name": "productID", "in": "query", "description": "ID of the product.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/categories/{categoryID}": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/Category" } } }, "operationId": "GetCategory", "tags": [ "Me" ], "parameters": [ { "name": "categoryID", "in": "path", "description": "ID of the category.", "required": true, "type": "string" }, { "name": "catalogID", "in": "query", "description": "ID of the catalog.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/costcenters": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/ListCostCenter" } } }, "operationId": "ListCostCenters", "tags": [ "Me" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/creditcards": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/ListBuyerCreditCard" } } }, "operationId": "ListCreditCards", "tags": [ "Me" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "MeCreditCardAdmin", "Shopper" ] } ] }, "post": { "responses": { "201": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/BuyerCreditCard" } } }, "operationId": "CreateCreditCard", "tags": [ "Me" ], "parameters": [ { "name": "buyerCreditCard", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/BuyerCreditCard" } } ], "security": [ { "oauth2": [ "FullAccess", "MeCreditCardAdmin" ] } ] } }, "/me/creditcards/{creditcardID}": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/BuyerCreditCard" } } }, "operationId": "GetCreditCard", "tags": [ "Me" ], "parameters": [ { "name": "creditcardID", "in": "path", "description": "ID of the creditcard.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "MeCreditCardAdmin", "Shopper" ] } ] }, "put": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/BuyerCreditCard" } } }, "operationId": "SaveCreditCard", "tags": [ "Me" ], "parameters": [ { "name": "creditcardID", "in": "path", "description": "ID of the creditcard.", "required": true, "type": "string" }, { "name": "buyerCreditCard", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/BuyerCreditCard" } } ], "security": [ { "oauth2": [ "FullAccess", "MeCreditCardAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "Only available to Buyer Users." } }, "operationId": "DeleteCreditCard", "tags": [ "Me" ], "parameters": [ { "name": "creditcardID", "in": "path", "description": "ID of the creditcard.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "MeCreditCardAdmin" ] } ] }, "patch": { "responses": { "204": { "description": "Only available to Buyer Users." } }, "operationId": "PatchCreditCard", "tags": [ "Me" ], "parameters": [ { "name": "creditcardID", "in": "path", "description": "ID of the creditcard.", "required": true, "type": "string" }, { "name": "partialBuyerCreditCard", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/BuyerCreditCard" } } ], "security": [ { "oauth2": [ "FullAccess", "MeCreditCardAdmin" ] } ] } }, "/me/orders": { "get": { "responses": { "200": { "description": "List orders created by this user.", "schema": { "$ref": "#/definitions/ListOrder" } } }, "operationId": "ListOrders", "tags": [ "Me" ], "parameters": [ { "name": "from", "in": "query", "description": "Lower bound of date range that the order was created (if outgoing) or submitted (if incoming).", "required": false, "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, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] }, "put": { "responses": { "204": { "description": "" } }, "operationId": "TransferAnonUserOrder", "tags": [ "Me" ], "parameters": [ { "name": "anonUserToken", "in": "query", "description": "Anon user token of the me.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/orders/approvable": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListOrder" } } }, "operationId": "ListApprovableOrders", "tags": [ "Me" ], "parameters": [ { "name": "from", "in": "query", "description": "Lower bound of date range that the order was created (if outgoing) or submitted (if incoming).", "required": false, "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, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/password": { "post": { "responses": { "204": { "description": "" } }, "operationId": "ResetPasswordByToken", "tags": [ "Me" ], "parameters": [ { "name": "tokenPasswordReset", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/TokenPasswordReset" } } ], "security": [ { "oauth2": [ "FullAccess", "PasswordReset" ] } ] } }, "/me/products": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/ListBuyerProduct" } } }, "operationId": "ListProducts", "tags": [ "Me" ], "parameters": [ { "name": "catalogID", "in": "query", "description": "ID of the catalog.", "required": false, "type": "string" }, { "name": "categoryID", "in": "query", "description": "ID of the category.", "required": false, "type": "string" }, { "name": "depth", "in": "query", "description": "Depth of the product.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/products/{productID}": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/BuyerProduct" } } }, "operationId": "GetProduct", "tags": [ "Me" ], "parameters": [ { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/products/{productID}/specs": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/ListBuyerSpec" } } }, "operationId": "ListSpecs", "tags": [ "Me" ], "parameters": [ { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" }, { "name": "catalogID", "in": "query", "description": "ID of the catalog.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/products/{productID}/specs/{specID}": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/BuyerSpec" } } }, "operationId": "GetSpec", "tags": [ "Me" ], "parameters": [ { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" }, { "name": "specID", "in": "path", "description": "ID of the spec.", "required": true, "type": "string" }, { "name": "catalogID", "in": "query", "description": "ID of the catalog.", "required": false, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/promotions": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/ListPromotion" } } }, "operationId": "ListPromotions", "tags": [ "Me" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/promotions/{promotionID}": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/Promotion" } } }, "operationId": "GetPromotion", "tags": [ "Me" ], "parameters": [ { "name": "promotionID", "in": "path", "description": "ID of the promotion.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/register": { "put": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/object" } } }, "operationId": "Register", "tags": [ "Me" ], "parameters": [ { "name": "anonUserToken", "in": "query", "description": "Anon user token of the user.", "required": true, "type": "string" }, { "name": "meUser", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/MeUser" } } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/shipments": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/ListShipment" } } }, "operationId": "ListShipments", "tags": [ "Me" ], "parameters": [ { "name": "orderID", "in": "query", "description": "ID of the order.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/shipments/{shipmentID}": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/Shipment" } } }, "operationId": "GetShipment", "tags": [ "Me" ], "parameters": [ { "name": "shipmentID", "in": "path", "description": "ID of the shipment.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/shipments/{shipmentID}/items": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/ListShipmentItem" } } }, "operationId": "ListShipmentItems", "tags": [ "Me" ], "parameters": [ { "name": "shipmentID", "in": "path", "description": "ID of the shipment.", "required": true, "type": "string" }, { "name": "orderID", "in": "query", "description": "ID of the order.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/spendingAccounts": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/ListSpendingAccount" } } }, "operationId": "ListSpendingAccounts", "tags": [ "Me" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/spendingaccounts/{spendingAccountID}": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/SpendingAccount" } } }, "operationId": "GetSpendingAccount", "tags": [ "Me" ], "parameters": [ { "name": "spendingAccountID", "in": "path", "description": "ID of the spending account.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "Shopper" ] } ] } }, "/me/usergroups": { "get": { "responses": { "200": { "description": "Only available to Buyer Users.", "schema": { "$ref": "#/definitions/ListUserGroup" } } }, "operationId": "ListUserGroups", "tags": [ "Me" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ ] } ] } }, "/messagesenders": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListMessageSender" } } }, "operationId": "List", "tags": [ "MessageSender" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "MessageConfigAssignmentAdmin" ] } ] } }, "/messagesenders/{messageSenderID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/MessageSender" } } }, "operationId": "Get", "tags": [ "MessageSender" ], "parameters": [ { "name": "messageSenderID", "in": "path", "description": "ID of the message sender.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "MessageConfigAssignmentAdmin" ] } ] } }, "/messagesenders/{messageSenderID}/assignments": { "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteAssignment", "tags": [ "MessageSender" ], "parameters": [ { "name": "messageSenderID", "in": "path", "description": "ID of the message sender.", "required": true, "type": "string" }, { "name": "buyerID", "in": "query", "description": "ID of the buyer.", "required": false, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "MessageConfigAssignmentAdmin" ] } ] } }, "/messagesenders/assignments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListMessageSenderAssignment" } } }, "operationId": "ListAssignments", "tags": [ "MessageSender" ], "parameters": [ { "name": "buyerID", "in": "query", "description": "ID of the buyer.", "required": false, "type": "string" }, { "name": "messageSenderID", "in": "query", "description": "ID of the message sender.", "required": false, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" }, { "name": "level", "in": "query", "description": "Level of the message sender assignment. Possible values: User, Group, Company.", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" } ], "security": [ { "oauth2": [ "FullAccess", "MessageConfigAssignmentAdmin" ] } ] }, "post": { "responses": { "204": { "description": "" } }, "operationId": "SaveAssignment", "tags": [ "MessageSender" ], "parameters": [ { "name": "messageSenderAssignment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/MessageSenderAssignment" } } ], "security": [ { "oauth2": [ "FullAccess", "MessageConfigAssignmentAdmin" ] } ] } }, "/messagesenders/CCListenerAssignments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListMessageCCListenerAssignment" } } }, "operationId": "ListCCListenerAssignments", "tags": [ "MessageSender" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "MessageConfigAssignmentAdmin" ] } ] }, "post": { "responses": { "204": { "description": "" } }, "operationId": "SaveCCListenerAssignment", "tags": [ "MessageSender" ], "parameters": [ { "name": "messageCCListenerAssignment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/MessageCCListenerAssignment" } } ], "security": [ { "oauth2": [ "FullAccess", "MessageConfigAssignmentAdmin" ] } ] } }, "/orders/{direction}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListOrder" } } }, "operationId": "List", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "buyerID", "in": "query", "description": "ID of the buyer.", "required": false, "type": "string" }, { "name": "supplierID", "in": "query", "description": "ID of the supplier.", "required": false, "type": "string" }, { "name": "from", "in": "query", "description": "Lower bound of date range that the order was created.", "required": false, "type": "string" }, { "name": "to", "in": "query", "description": "Upper bound of date range that the order was created.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "OrderReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/Order" } } }, "operationId": "Create", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "order", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Order" } } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper" ] } ] } }, "/orders/{direction}/{orderID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Order" } } }, "operationId": "Get", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper", "OrderReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/Order" } } }, "operationId": "Save", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "order", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Order" } } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Order" } } }, "operationId": "Patch", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "partialOrder", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Order" } } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper" ] } ] } }, "/orders/{direction}/{orderID}/approvals": { "get": { "responses": { "200": { "description": "Returns all Approvals associated with the Order.", "schema": { "$ref": "#/definitions/ListOrderApproval" } } }, "operationId": "ListApprovals", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper", "OrderReader" ] } ] } }, "/orders/{direction}/{orderID}/approve": { "post": { "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/Order" } } }, "operationId": "Approve", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "orderApprovalInfo", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/OrderApprovalInfo" } } ], "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.", "schema": { "$ref": "#/definitions/Order" } } }, "operationId": "SetBillingAddress", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "address", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Address" } } ], "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.", "schema": { "$ref": "#/definitions/Order" } } }, "operationId": "PatchBillingAddress", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "partialAddress", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Address" } } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper" ] } ] } }, "/orders/{direction}/{orderID}/cancel": { "post": { "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/Order" } } }, "operationId": "Cancel", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper" ] } ] } }, "/orders/{direction}/{orderID}/decline": { "post": { "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/Order" } } }, "operationId": "Decline", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "orderApprovalInfo", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/OrderApprovalInfo" } } ], "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).", "schema": { "$ref": "#/definitions/ListUser" } } }, "operationId": "ListEligibleApprovers", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper", "OrderReader" ] } ] } }, "/orders/{direction}/{orderID}/fromuser": { "patch": { "responses": { "200": { "description": "Only FirstName, LastName, and Email can be updated..Primarily used to facilitate guest checkout scenarios.", "schema": { "$ref": "#/definitions/Order" } } }, "operationId": "PatchFromUser", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "partialUser", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/User" } } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper" ] } ] } }, "/orders/{direction}/{orderID}/lineitems": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListLineItem" } } }, "operationId": "List", "tags": [ "LineItem" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper", "OrderReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/LineItem" } } }, "operationId": "Create", "tags": [ "LineItem" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "lineItem", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/LineItem" } } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper" ] } ] } }, "/orders/{direction}/{orderID}/lineitems/{lineItemID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/LineItem" } } }, "operationId": "Get", "tags": [ "LineItem" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "lineItemID", "in": "path", "description": "ID of the line item.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper", "OrderReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/LineItem" } } }, "operationId": "Save", "tags": [ "LineItem" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "lineItemID", "in": "path", "description": "ID of the line item.", "required": true, "type": "string" }, { "name": "lineItem", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/LineItem" } } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "LineItem" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "lineItemID", "in": "path", "description": "ID of the line item.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/LineItem" } } }, "operationId": "Patch", "tags": [ "LineItem" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "lineItemID", "in": "path", "description": "ID of the line item.", "required": true, "type": "string" }, { "name": "partialLineItem", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/LineItem" } } ], "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.", "schema": { "$ref": "#/definitions/LineItem" } } }, "operationId": "SetShippingAddress", "tags": [ "LineItem" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "lineItemID", "in": "path", "description": "ID of the line item.", "required": true, "type": "string" }, { "name": "address", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Address" } } ], "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.", "schema": { "$ref": "#/definitions/LineItem" } } }, "operationId": "PatchShippingAddress", "tags": [ "LineItem" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "lineItemID", "in": "path", "description": "ID of the line item.", "required": true, "type": "string" }, { "name": "partialAddress", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Address" } } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper" ] } ] } }, "/orders/{direction}/{orderID}/payments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListPayment" } } }, "operationId": "List", "tags": [ "Payment" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper", "OrderReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/Payment" } } }, "operationId": "Create", "tags": [ "Payment" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "payment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Payment" } } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper" ] } ] } }, "/orders/{direction}/{orderID}/payments/{paymentID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Payment" } } }, "operationId": "Get", "tags": [ "Payment" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "paymentID", "in": "path", "description": "ID of the payment.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper", "OrderReader" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "Payment" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "paymentID", "in": "path", "description": "ID of the payment.", "required": true, "type": "string" } ], "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", "schema": { "$ref": "#/definitions/Payment" } } }, "operationId": "Patch", "tags": [ "Payment" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "paymentID", "in": "path", "description": "ID of the payment.", "required": true, "type": "string" }, { "name": "partialPayment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Payment" } } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper" ] } ] } }, "/orders/{direction}/{orderID}/payments/{paymentID}/transactions": { "post": { "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/Payment" } } }, "operationId": "CreateTransaction", "tags": [ "Payment" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "paymentID", "in": "path", "description": "ID of the payment.", "required": true, "type": "string" }, { "name": "paymentTransaction", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/PaymentTransaction" } } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin" ] } ] } }, "/orders/{direction}/{orderID}/payments/{paymentID}/transactions/{transactionID}": { "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteTransaction", "tags": [ "Payment" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "paymentID", "in": "path", "description": "ID of the payment.", "required": true, "type": "string" }, { "name": "transactionID", "in": "path", "description": "ID of the transaction.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin" ] } ] } }, "/orders/{direction}/{orderID}/promotions": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListOrderPromotion" } } }, "operationId": "ListPromotions", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper", "OrderReader" ] } ] } }, "/orders/{direction}/{orderID}/promotions/{promoCode}": { "post": { "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/Promotion" } } }, "operationId": "AddPromotion", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "promoCode", "in": "path", "description": "Promo code of the promotion.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper" ] } ] }, "delete": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Order" } } }, "operationId": "RemovePromotion", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "promoCode", "in": "path", "description": "Promo code of the order.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper" ] } ] } }, "/orders/{direction}/{orderID}/ship": { "post": { "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/Order" } } }, "operationId": "Ship", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "shipment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Shipment" } } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "ShipmentAdmin" ] } ] } }, "/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.", "schema": { "$ref": "#/definitions/Order" } } }, "operationId": "SetShippingAddress", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "address", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Address" } } ], "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.", "schema": { "$ref": "#/definitions/Order" } } }, "operationId": "PatchShippingAddress", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "partialAddress", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Address" } } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper" ] } ] } }, "/orders/{direction}/{orderID}/submit": { "post": { "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/Order" } } }, "operationId": "Submit", "tags": [ "Order" ], "parameters": [ { "name": "direction", "in": "path", "description": "Direction of the order, from the current user's perspective. Possible values: incoming, outgoing.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "OrderAdmin", "Shopper" ] } ] } }, "/password/reset": { "post": { "responses": { "204": { "description": "Sends a temporary verification code via email, which must subsequently be passed in a Reset Password call." } }, "operationId": "SendVerificationCode", "tags": [ "PasswordReset" ], "parameters": [ { "name": "passwordResetRequest", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/PasswordResetRequest" } } ], "security": [ { "oauth2": [ ] } ] } }, "/password/reset/{verificationCode}": { "put": { "responses": { "204": { "description": "" } }, "operationId": "ResetPasswordByVerificationCode", "tags": [ "PasswordReset" ], "parameters": [ { "name": "verificationCode", "in": "path", "description": "Verification code of the password reset.", "required": true, "type": "string" }, { "name": "passwordReset", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/PasswordReset" } } ], "security": [ { "oauth2": [ ] } ] } }, "/priceschedules": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListPriceSchedule" } } }, "operationId": "List", "tags": [ "PriceSchedule" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "PriceScheduleAdmin", "PriceScheduleReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/PriceSchedule" } } }, "operationId": "Create", "tags": [ "PriceSchedule" ], "parameters": [ { "name": "priceSchedule", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/PriceSchedule" } } ], "security": [ { "oauth2": [ "FullAccess", "PriceScheduleAdmin" ] } ] } }, "/priceschedules/{priceScheduleID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/PriceSchedule" } } }, "operationId": "Get", "tags": [ "PriceSchedule" ], "parameters": [ { "name": "priceScheduleID", "in": "path", "description": "ID of the price schedule.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "PriceScheduleAdmin", "PriceScheduleReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/PriceSchedule" } } }, "operationId": "Save", "tags": [ "PriceSchedule" ], "parameters": [ { "name": "priceScheduleID", "in": "path", "description": "ID of the price schedule.", "required": true, "type": "string" }, { "name": "priceSchedule", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/PriceSchedule" } } ], "security": [ { "oauth2": [ "FullAccess", "PriceScheduleAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "PriceSchedule" ], "parameters": [ { "name": "priceScheduleID", "in": "path", "description": "ID of the price schedule.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "PriceScheduleAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/PriceSchedule" } } }, "operationId": "Patch", "tags": [ "PriceSchedule" ], "parameters": [ { "name": "priceScheduleID", "in": "path", "description": "ID of the price schedule.", "required": true, "type": "string" }, { "name": "partialPriceSchedule", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/PriceSchedule" } } ], "security": [ { "oauth2": [ "FullAccess", "PriceScheduleAdmin" ] } ] } }, "/priceschedules/{priceScheduleID}/PriceBreaks": { "post": { "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/PriceSchedule" } } }, "operationId": "SavePriceBreak", "tags": [ "PriceSchedule" ], "parameters": [ { "name": "priceScheduleID", "in": "path", "description": "ID of the price schedule.", "required": true, "type": "string" }, { "name": "priceBreak", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/PriceBreak" } } ], "security": [ { "oauth2": [ "FullAccess", "PriceScheduleAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeletePriceBreak", "tags": [ "PriceSchedule" ], "parameters": [ { "name": "priceScheduleID", "in": "path", "description": "ID of the price schedule.", "required": true, "type": "string" }, { "name": "quantity", "in": "query", "description": "Quantity of the price schedule.", "required": true, "type": "integer" } ], "security": [ { "oauth2": [ "FullAccess", "PriceScheduleAdmin" ] } ] } }, "/products": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListProduct" } } }, "operationId": "List", "tags": [ "Product" ], "parameters": [ { "name": "catalogID", "in": "query", "description": "ID of the catalog.", "required": false, "type": "string" }, { "name": "categoryID", "in": "query", "description": "ID of the category.", "required": false, "type": "string" }, { "name": "supplierID", "in": "query", "description": "ID of the supplier.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin", "ProductReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/Product" } } }, "operationId": "Create", "tags": [ "Product" ], "parameters": [ { "name": "product", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Product" } } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] } }, "/products/{productID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Product" } } }, "operationId": "Get", "tags": [ "Product" ], "parameters": [ { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin", "ProductReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/Product" } } }, "operationId": "Save", "tags": [ "Product" ], "parameters": [ { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" }, { "name": "product", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Product" } } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "Product" ], "parameters": [ { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Product" } } }, "operationId": "Patch", "tags": [ "Product" ], "parameters": [ { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" }, { "name": "partialProduct", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Product" } } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] } }, "/products/{productID}/assignments/{buyerID}": { "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteAssignment", "tags": [ "Product" ], "parameters": [ { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" }, { "name": "buyerID", "in": "path", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin", "ProductAssignmentAdmin" ] } ] } }, "/products/{productID}/suppliers": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListSupplier" } } }, "operationId": "ListSuppliers", "tags": [ "Product" ], "parameters": [ { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin", "ProductReader" ] } ] } }, "/products/{productID}/suppliers/{supplierID}": { "put": { "responses": { "204": { "description": "" } }, "operationId": "SaveSupplier", "tags": [ "Product" ], "parameters": [ { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" }, { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "RemoveSupplier", "tags": [ "Product" ], "parameters": [ { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" }, { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] } }, "/products/{productID}/variants": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListVariant" } } }, "operationId": "ListVariants", "tags": [ "Product" ], "parameters": [ { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin", "ProductReader" ] } ] } }, "/products/{productID}/variants/{variantID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Variant" } } }, "operationId": "GetVariant", "tags": [ "Product" ], "parameters": [ { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" }, { "name": "variantID", "in": "path", "description": "ID of the variant.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin", "ProductReader" ] } ] }, "put": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Variant" } } }, "operationId": "SaveVariant", "tags": [ "Product" ], "parameters": [ { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" }, { "name": "variantID", "in": "path", "description": "ID of the variant.", "required": true, "type": "string" }, { "name": "variant", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Variant" } } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Variant" } } }, "operationId": "PatchVariant", "tags": [ "Product" ], "parameters": [ { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" }, { "name": "variantID", "in": "path", "description": "ID of the variant.", "required": true, "type": "string" }, { "name": "partialVariant", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Variant" } } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] } }, "/products/{productID}/variants/generate": { "post": { "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/Product" } } }, "operationId": "GenerateVariants", "tags": [ "Product" ], "parameters": [ { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" }, { "name": "overwriteExisting", "in": "query", "description": "Overwrite existing of the product.", "required": false, "type": "boolean" } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] } }, "/products/assignments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListProductAssignment" } } }, "operationId": "ListAssignments", "tags": [ "Product" ], "parameters": [ { "name": "productID", "in": "query", "description": "ID of the product.", "required": false, "type": "string" }, { "name": "priceScheduleID", "in": "query", "description": "ID of the price schedule.", "required": false, "type": "string" }, { "name": "buyerID", "in": "query", "description": "ID of the buyer.", "required": false, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" }, { "name": "level", "in": "query", "description": "Level of the product assignment. Possible values: User, Group, Company.", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin", "ProductAssignmentAdmin", "ProductReader" ] } ] }, "post": { "responses": { "204": { "description": "" } }, "operationId": "SaveAssignment", "tags": [ "Product" ], "parameters": [ { "name": "productAssignment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/ProductAssignment" } } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin", "ProductAssignmentAdmin" ] } ] } }, "/promotions": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListPromotion" } } }, "operationId": "List", "tags": [ "Promotion" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "PromotionAdmin", "PromotionReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/Promotion" } } }, "operationId": "Create", "tags": [ "Promotion" ], "parameters": [ { "name": "promotion", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Promotion" } } ], "security": [ { "oauth2": [ "FullAccess", "PromotionAdmin" ] } ] } }, "/promotions/{promotionID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Promotion" } } }, "operationId": "Get", "tags": [ "Promotion" ], "parameters": [ { "name": "promotionID", "in": "path", "description": "ID of the promotion.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "PromotionAdmin", "PromotionReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/Promotion" } } }, "operationId": "Save", "tags": [ "Promotion" ], "parameters": [ { "name": "promotionID", "in": "path", "description": "ID of the promotion.", "required": true, "type": "string" }, { "name": "promotion", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Promotion" } } ], "security": [ { "oauth2": [ "FullAccess", "PromotionAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "Promotion" ], "parameters": [ { "name": "promotionID", "in": "path", "description": "ID of the promotion.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "PromotionAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Promotion" } } }, "operationId": "Patch", "tags": [ "Promotion" ], "parameters": [ { "name": "promotionID", "in": "path", "description": "ID of the promotion.", "required": true, "type": "string" }, { "name": "partialPromotion", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Promotion" } } ], "security": [ { "oauth2": [ "FullAccess", "PromotionAdmin" ] } ] } }, "/promotions/{promotionID}/assignments": { "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteAssignment", "tags": [ "Promotion" ], "parameters": [ { "name": "promotionID", "in": "path", "description": "ID of the promotion.", "required": true, "type": "string" }, { "name": "buyerID", "in": "query", "description": "ID of the buyer.", "required": true, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "PromotionAdmin" ] } ] } }, "/promotions/assignments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListPromotionAssignment" } } }, "operationId": "ListAssignments", "tags": [ "Promotion" ], "parameters": [ { "name": "buyerID", "in": "query", "description": "ID of the buyer.", "required": false, "type": "string" }, { "name": "promotionID", "in": "query", "description": "ID of the promotion.", "required": false, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" }, { "name": "level", "in": "query", "description": "Level of the promotion assignment. Possible values: User, Group, Company.", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" } ], "security": [ { "oauth2": [ "FullAccess", "PromotionAdmin", "PromotionReader" ] } ] }, "post": { "responses": { "204": { "description": "" } }, "operationId": "SaveAssignment", "tags": [ "Promotion" ], "parameters": [ { "name": "promotionAssignment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/PromotionAssignment" } } ], "security": [ { "oauth2": [ "FullAccess", "PromotionAdmin" ] } ] } }, "/securityprofiles": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListSecurityProfile" } } }, "operationId": "List", "tags": [ "SecurityProfile" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "SetSecurityProfile" ] } ] } }, "/securityprofiles/{securityProfileID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/SecurityProfile" } } }, "operationId": "Get", "tags": [ "SecurityProfile" ], "parameters": [ { "name": "securityProfileID", "in": "path", "description": "ID of the security profile.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "SetSecurityProfile" ] } ] } }, "/securityprofiles/{securityProfileID}/assignments": { "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteAssignment", "tags": [ "SecurityProfile" ], "parameters": [ { "name": "securityProfileID", "in": "path", "description": "ID of the security profile.", "required": true, "type": "string" }, { "name": "buyerID", "in": "query", "description": "ID of the buyer.", "required": false, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "SetSecurityProfile" ] } ] } }, "/securityprofiles/assignments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListSecurityProfileAssignment" } } }, "operationId": "ListAssignments", "tags": [ "SecurityProfile" ], "parameters": [ { "name": "buyerID", "in": "query", "description": "ID of the buyer.", "required": false, "type": "string" }, { "name": "supplierID", "in": "query", "description": "ID of the supplier.", "required": false, "type": "string" }, { "name": "securityProfileID", "in": "query", "description": "ID of the security profile.", "required": false, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" }, { "name": "commerceRole", "in": "query", "description": "Commerce role of the security profile assignment. Possible values: Buyer, Seller, Supplier.", "required": false, "type": "string" }, { "name": "level", "in": "query", "description": "Level of the security profile assignment. Possible values: User, Group, Company.", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" } ], "security": [ { "oauth2": [ "FullAccess", "SetSecurityProfile" ] } ] }, "post": { "responses": { "204": { "description": "" } }, "operationId": "SaveAssignment", "tags": [ "SecurityProfile" ], "parameters": [ { "name": "securityProfileAssignment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/SecurityProfileAssignment" } } ], "security": [ { "oauth2": [ "FullAccess", "SetSecurityProfile" ] } ] } }, "/shipments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListShipment" } } }, "operationId": "List", "tags": [ "Shipment" ], "parameters": [ { "name": "orderID", "in": "query", "description": "ID of the order.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "ShipmentAdmin", "ShipmentReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/Shipment" } } }, "operationId": "Create", "tags": [ "Shipment" ], "parameters": [ { "name": "shipment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Shipment" } } ], "security": [ { "oauth2": [ "FullAccess", "ShipmentAdmin" ] } ] } }, "/shipments/{shipmentID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Shipment" } } }, "operationId": "Get", "tags": [ "Shipment" ], "parameters": [ { "name": "shipmentID", "in": "path", "description": "ID of the shipment.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "ShipmentAdmin", "ShipmentReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/Shipment" } } }, "operationId": "Save", "tags": [ "Shipment" ], "parameters": [ { "name": "shipmentID", "in": "path", "description": "ID of the shipment.", "required": true, "type": "string" }, { "name": "shipment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Shipment" } } ], "security": [ { "oauth2": [ "FullAccess", "ShipmentAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "Shipment" ], "parameters": [ { "name": "shipmentID", "in": "path", "description": "ID of the shipment.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "ShipmentAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Shipment" } } }, "operationId": "Patch", "tags": [ "Shipment" ], "parameters": [ { "name": "shipmentID", "in": "path", "description": "ID of the shipment.", "required": true, "type": "string" }, { "name": "partialShipment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Shipment" } } ], "security": [ { "oauth2": [ "FullAccess", "ShipmentAdmin" ] } ] } }, "/shipments/{shipmentID}/items": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListShipmentItem" } } }, "operationId": "ListItems", "tags": [ "Shipment" ], "parameters": [ { "name": "shipmentID", "in": "path", "description": "ID of the shipment.", "required": true, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "ShipmentAdmin", "ShipmentReader" ] } ] }, "post": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ShipmentItem" } } }, "operationId": "SaveItem", "tags": [ "Shipment" ], "parameters": [ { "name": "shipmentID", "in": "path", "description": "ID of the shipment.", "required": true, "type": "string" }, { "name": "shipmentItem", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/ShipmentItem" } } ], "security": [ { "oauth2": [ "FullAccess", "ShipmentAdmin" ] } ] } }, "/shipments/{shipmentID}/items/{orderID}/{lineItemID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ShipmentItem" } } }, "operationId": "GetItem", "tags": [ "Shipment" ], "parameters": [ { "name": "shipmentID", "in": "path", "description": "ID of the shipment.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "lineItemID", "in": "path", "description": "ID of the line item.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "ShipmentAdmin", "ShipmentReader" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteItem", "tags": [ "Shipment" ], "parameters": [ { "name": "shipmentID", "in": "path", "description": "ID of the shipment.", "required": true, "type": "string" }, { "name": "orderID", "in": "path", "description": "ID of the order.", "required": true, "type": "string" }, { "name": "lineItemID", "in": "path", "description": "ID of the line item.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "ShipmentAdmin" ] } ] } }, "/specs": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListSpec" } } }, "operationId": "List", "tags": [ "Spec" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin", "ProductReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/Spec" } } }, "operationId": "Create", "tags": [ "Spec" ], "parameters": [ { "name": "spec", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Spec" } } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] } }, "/specs/{specID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Spec" } } }, "operationId": "Get", "tags": [ "Spec" ], "parameters": [ { "name": "specID", "in": "path", "description": "ID of the spec.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin", "ProductReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/Spec" } } }, "operationId": "Save", "tags": [ "Spec" ], "parameters": [ { "name": "specID", "in": "path", "description": "ID of the spec.", "required": true, "type": "string" }, { "name": "spec", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Spec" } } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "Spec" ], "parameters": [ { "name": "specID", "in": "path", "description": "ID of the spec.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Spec" } } }, "operationId": "Patch", "tags": [ "Spec" ], "parameters": [ { "name": "specID", "in": "path", "description": "ID of the spec.", "required": true, "type": "string" }, { "name": "partialSpec", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Spec" } } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] } }, "/specs/{specID}/options": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListSpecOption" } } }, "operationId": "ListOptions", "tags": [ "Spec" ], "parameters": [ { "name": "specID", "in": "path", "description": "ID of the spec.", "required": true, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "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'. ", "schema": { "$ref": "#/definitions/SpecOption" } } }, "operationId": "CreateOption", "tags": [ "Spec" ], "parameters": [ { "name": "specID", "in": "path", "description": "ID of the spec.", "required": true, "type": "string" }, { "name": "specOption", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/SpecOption" } } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] } }, "/specs/{specID}/options/{optionID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/SpecOption" } } }, "operationId": "GetOption", "tags": [ "Spec" ], "parameters": [ { "name": "specID", "in": "path", "description": "ID of the spec.", "required": true, "type": "string" }, { "name": "optionID", "in": "path", "description": "ID of the option.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin", "ProductReader" ] } ] }, "put": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/SpecOption" } } }, "operationId": "SaveOption", "tags": [ "Spec" ], "parameters": [ { "name": "specID", "in": "path", "description": "ID of the spec.", "required": true, "type": "string" }, { "name": "optionID", "in": "path", "description": "ID of the option.", "required": true, "type": "string" }, { "name": "specOption", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/SpecOption" } } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteOption", "tags": [ "Spec" ], "parameters": [ { "name": "specID", "in": "path", "description": "ID of the spec.", "required": true, "type": "string" }, { "name": "optionID", "in": "path", "description": "ID of the option.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/SpecOption" } } }, "operationId": "PatchOption", "tags": [ "Spec" ], "parameters": [ { "name": "specID", "in": "path", "description": "ID of the spec.", "required": true, "type": "string" }, { "name": "optionID", "in": "path", "description": "ID of the option.", "required": true, "type": "string" }, { "name": "partialSpecOption", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/SpecOption" } } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] } }, "/specs/{specID}/productassignments/{productID}": { "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteProductAssignment", "tags": [ "Spec" ], "parameters": [ { "name": "specID", "in": "path", "description": "ID of the spec.", "required": true, "type": "string" }, { "name": "productID", "in": "path", "description": "ID of the product.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] } }, "/specs/productassignments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListSpecProductAssignment" } } }, "operationId": "ListProductAssignments", "tags": [ "Spec" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin", "ProductReader" ] } ] }, "post": { "responses": { "204": { "description": "" } }, "operationId": "SaveProductAssignment", "tags": [ "Spec" ], "parameters": [ { "name": "specProductAssignment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/SpecProductAssignment" } } ], "security": [ { "oauth2": [ "FullAccess", "ProductAdmin" ] } ] } }, "/suppliers": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListSupplier" } } }, "operationId": "List", "tags": [ "Supplier" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "SupplierAdmin", "SupplierReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/Supplier" } } }, "operationId": "Create", "tags": [ "Supplier" ], "parameters": [ { "name": "supplier", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Supplier" } } ], "security": [ { "oauth2": [ "FullAccess", "SupplierAdmin" ] } ] } }, "/suppliers/{supplierID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Supplier" } } }, "operationId": "Get", "tags": [ "Supplier" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "SupplierAdmin", "SupplierReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/Supplier" } } }, "operationId": "Save", "tags": [ "Supplier" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" }, { "name": "supplier", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Supplier" } } ], "security": [ { "oauth2": [ "FullAccess", "SupplierAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "Supplier" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "SupplierAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Supplier" } } }, "operationId": "Patch", "tags": [ "Supplier" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" }, { "name": "partialSupplier", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/Supplier" } } ], "security": [ { "oauth2": [ "FullAccess", "SupplierAdmin" ] } ] } }, "/suppliers/{supplierID}/usergroups": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListUserGroup" } } }, "operationId": "List", "tags": [ "SupplierUserGroup" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "SupplierUserGroupAdmin", "SupplierUserGroupReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/UserGroup" } } }, "operationId": "Create", "tags": [ "SupplierUserGroup" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" }, { "name": "userGroup", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/UserGroup" } } ], "security": [ { "oauth2": [ "FullAccess", "SupplierUserGroupAdmin" ] } ] } }, "/suppliers/{supplierID}/usergroups/{userGroupID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/UserGroup" } } }, "operationId": "Get", "tags": [ "SupplierUserGroup" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" }, { "name": "userGroupID", "in": "path", "description": "ID of the user group.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "SupplierUserGroupAdmin", "SupplierUserGroupReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/UserGroup" } } }, "operationId": "Save", "tags": [ "SupplierUserGroup" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" }, { "name": "userGroupID", "in": "path", "description": "ID of the user group.", "required": true, "type": "string" }, { "name": "userGroup", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/UserGroup" } } ], "security": [ { "oauth2": [ "FullAccess", "SupplierUserGroupAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "SupplierUserGroup" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" }, { "name": "userGroupID", "in": "path", "description": "ID of the user group.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "SupplierUserGroupAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/UserGroup" } } }, "operationId": "Patch", "tags": [ "SupplierUserGroup" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" }, { "name": "userGroupID", "in": "path", "description": "ID of the user group.", "required": true, "type": "string" }, { "name": "partialUserGroup", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/UserGroup" } } ], "security": [ { "oauth2": [ "FullAccess", "SupplierUserGroupAdmin" ] } ] } }, "/suppliers/{supplierID}/usergroups/{userGroupID}/assignments/{userID}": { "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteUserAssignment", "tags": [ "SupplierUserGroup" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" }, { "name": "userGroupID", "in": "path", "description": "ID of the user group.", "required": true, "type": "string" }, { "name": "userID", "in": "path", "description": "ID of the user.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "SupplierUserGroupAdmin" ] } ] } }, "/suppliers/{supplierID}/usergroups/assignments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListUserGroupAssignment" } } }, "operationId": "ListUserAssignments", "tags": [ "SupplierUserGroup" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" } ], "security": [ { "oauth2": [ "FullAccess", "SupplierUserGroupAdmin", "SupplierUserGroupReader" ] } ] }, "post": { "responses": { "204": { "description": "" } }, "operationId": "SaveUserAssignment", "tags": [ "SupplierUserGroup" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" }, { "name": "userGroupAssignment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/UserGroupAssignment" } } ], "security": [ { "oauth2": [ "FullAccess", "SupplierUserGroupAdmin" ] } ] } }, "/suppliers/{supplierID}/users": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListUser" } } }, "operationId": "List", "tags": [ "SupplierUser" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" }, { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "SupplierUserAdmin", "SupplierUserReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/User" } } }, "operationId": "Create", "tags": [ "SupplierUser" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" }, { "name": "user", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/User" } } ], "security": [ { "oauth2": [ "FullAccess", "SupplierUserAdmin" ] } ] } }, "/suppliers/{supplierID}/users/{userID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/User" } } }, "operationId": "Get", "tags": [ "SupplierUser" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" }, { "name": "userID", "in": "path", "description": "ID of the user.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "SupplierUserAdmin", "SupplierUserReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/User" } } }, "operationId": "Save", "tags": [ "SupplierUser" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" }, { "name": "userID", "in": "path", "description": "ID of the user.", "required": true, "type": "string" }, { "name": "user", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/User" } } ], "security": [ { "oauth2": [ "FullAccess", "SupplierUserAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "SupplierUser" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" }, { "name": "userID", "in": "path", "description": "ID of the user.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "SupplierUserAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/User" } } }, "operationId": "Patch", "tags": [ "SupplierUser" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" }, { "name": "userID", "in": "path", "description": "ID of the user.", "required": true, "type": "string" }, { "name": "partialUser", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/User" } } ], "security": [ { "oauth2": [ "FullAccess", "SupplierUserAdmin" ] } ] } }, "/suppliers/{supplierID}/users/{userID}/accesstoken": { "post": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AccessToken" } } }, "operationId": "GetAccessToken", "tags": [ "SupplierUser" ], "parameters": [ { "name": "supplierID", "in": "path", "description": "ID of the supplier.", "required": true, "type": "string" }, { "name": "userID", "in": "path", "description": "ID of the user.", "required": true, "type": "string" }, { "name": "impersonateTokenRequest", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/ImpersonateTokenRequest" } } ], "security": [ { "oauth2": [ "FullAccess", "SupplierUserAdmin" ] } ] } }, "/usergroups": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListUserGroup" } } }, "operationId": "List", "tags": [ "AdminUserGroup" ], "parameters": [ { "name": "search", "in": "query", "description": "Word or phrase to search for.", "required": false, "type": "string" }, { "name": "searchOn", "in": "query", "description": "Comma-delimited list of fields to search on.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Comma-delimited list of fields to sort by.", "required": false, "type": "string", "items": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" }, { "name": "filters", "in": "query", "description": "Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'", "required": false, "type": "object" } ], "security": [ { "oauth2": [ "FullAccess", "AdminUserGroupAdmin", "AdminUserGroupReader" ] } ] }, "post": { "responses": { "201": { "description": "If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.", "schema": { "$ref": "#/definitions/UserGroup" } } }, "operationId": "Create", "tags": [ "AdminUserGroup" ], "parameters": [ { "name": "userGroup", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/UserGroup" } } ], "security": [ { "oauth2": [ "FullAccess", "AdminUserGroupAdmin" ] } ] } }, "/usergroups/{userGroupID}": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/UserGroup" } } }, "operationId": "Get", "tags": [ "AdminUserGroup" ], "parameters": [ { "name": "userGroupID", "in": "path", "description": "ID of the user group.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "AdminUserGroupAdmin", "AdminUserGroupReader" ] } ] }, "put": { "responses": { "200": { "description": "If an object with the same ID already exists, it will be overwritten.", "schema": { "$ref": "#/definitions/UserGroup" } } }, "operationId": "Save", "tags": [ "AdminUserGroup" ], "parameters": [ { "name": "userGroupID", "in": "path", "description": "ID of the user group.", "required": true, "type": "string" }, { "name": "userGroup", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/UserGroup" } } ], "security": [ { "oauth2": [ "FullAccess", "AdminUserGroupAdmin" ] } ] }, "delete": { "responses": { "204": { "description": "" } }, "operationId": "Delete", "tags": [ "AdminUserGroup" ], "parameters": [ { "name": "userGroupID", "in": "path", "description": "ID of the user group.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "AdminUserGroupAdmin" ] } ] }, "patch": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/UserGroup" } } }, "operationId": "Patch", "tags": [ "AdminUserGroup" ], "parameters": [ { "name": "userGroupID", "in": "path", "description": "ID of the user group.", "required": true, "type": "string" }, { "name": "partialUserGroup", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/UserGroup" } } ], "security": [ { "oauth2": [ "FullAccess", "AdminUserGroupAdmin" ] } ] } }, "/usergroups/{userGroupID}/assignments/{userID}": { "delete": { "responses": { "204": { "description": "" } }, "operationId": "DeleteUserAssignment", "tags": [ "AdminUserGroup" ], "parameters": [ { "name": "userGroupID", "in": "path", "description": "ID of the user group.", "required": true, "type": "string" }, { "name": "userID", "in": "path", "description": "ID of the user.", "required": true, "type": "string" } ], "security": [ { "oauth2": [ "FullAccess", "AdminUserGroupAdmin" ] } ] } }, "/usergroups/assignments": { "get": { "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ListUserGroupAssignment" } } }, "operationId": "ListUserAssignments", "tags": [ "AdminUserGroup" ], "parameters": [ { "name": "userGroupID", "in": "query", "description": "ID of the user group.", "required": false, "type": "string" }, { "name": "userID", "in": "query", "description": "ID of the user.", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "Page of results to return. Default: 1", "required": false, "type": "integer" }, { "name": "pageSize", "in": "query", "description": "Number of results to return per page. Default: 20, max: 100.", "required": false, "type": "integer" } ], "security": [ { "oauth2": [ "FullAccess", "AdminUserGroupAdmin", "AdminUserGroupReader" ] } ] }, "post": { "responses": { "204": { "description": "" } }, "operationId": "SaveUserAssignment", "tags": [ "AdminUserGroup" ], "parameters": [ { "name": "userGroupAssignment", "in": "body", "required": true, "description": "", "schema": { "$ref": "#/definitions/UserGroupAssignment" } } ], "security": [ { "oauth2": [ "FullAccess", "AdminUserGroupAdmin" ] } ] } } } }