Indeed, the tempo and luminosity are the exactly the same as the ones required for cars and motocycles by legislation. You can now exercise or commute safely everywhere, anytime, even in an urban environment.
Who said innovation had to be complex?", "UPC": "012345678901", "BuyItNowPrice": 34.99, "RetailPrice": 39.99 } }, "Creates a child product in the system. This requires an existing ParentProductID.": { "summary": "Create a child product", "description": "Creates a child product in the system. This requires an existing ParentProductID.", "value": { "ProfileID": "12345678", "Sku": "CHILD-10000001", "IsParent": "False", "IsInRelationship": "True", "ParentProductID": "24562560", "VaryBy": "Size,Color", "Title": "Text String product Title value for SKU CHILD-10000001", "Brand": "Product Brand", "Manufacturer": "Product Manufacturer", "MPN": "CHILD123", "Condition": "New", "Description": "Text String product Description value for CHILD-10000001", "UPC": "012345678902", "BuyItNowPrice": 1.99, "RetailPrice": 2.99 } }, "Will create a new bundle sku. The component items in the bundle must already exist prior to this call": { "summary": "Create a Bundle Sku", "description": "Will create a new bundle sku. The component items in the bundle must already exist prior to this call", "value": { "ProfileID": "12345678", "Sku": "BUNDLESKU_00001", "BundleType": "BundleItem", "Title": "Title for BUNDLESKU_00001", "Brand": "BUNDLESKU_00001 Brand", "Manufacturer": "BUNDLESKU_00001 Manufacturer", "MPN": "BUNDLESKU_00001_ABC123", "Condition": "New", "Description": "Description for BUNDLESKU_00001", "UPC": "123456789102", "BuyItNowPrice": 10.0, "RetailPrice": 11.0, "BundleComponents": [ { "ComponentSku": "BUNDLECOMP_00001", "Quantity": 1 }, { "ComponentSku": "BUNDLECOMP_00002", "Quantity": 2 } ] } }, "Creates a parent product. This product must be created before creating child products": { "summary": "Create a parent product", "description": "Creates a parent product. This product must be created before creating child products", "value": { "ProfileID": "12345678", "Sku": "PARENT-10000001", "IsParent": true, "IsInRelationship": true, "VaryBy": "Size,Color", "Title": "Text String product Title value for SKU PARENT-10000001", "Brand": "Product Brand", "Manufacturer": "Product Manufacturer", "MPN": "PAR123", "Condition": "New", "Description": "Text String product Description value for PARENT-10000001", "UPC": "012345678901", "BuyItNowPrice": 1.99, "RetailPrice": 2.99 } }, "Creates a new product and will add or create attributes passed in the request at the same time. This can also be used for bundle, child and parent product creation.": { "summary": "Create a product with attributes", "description": "Creates a new product and will add or create attributes passed in the request at the same time. This can also be used for bundle, child and parent product creation.", "value": { "ProfileID": "12345678", "Sku": "10000002", "Title": "WingLights Fixed - Direction Indicators for Bicycles/Turning Signals/Blinkers", "Brand": "WingLights", "Manufacturer": "Bike Products Inc.", "MPN": "wlf-di-bikes", "Condition": "New", "Description": "WingLights is not only a direction indicators for bicyles, it is the first of its kind. Produced by a multi-awarded startup, WingLights represents an important improvement for cycling safety accessories. It provides the same visual signal as cars and motocycles do when they are about to turn.
Indeed, the tempo and luminosity are the exactly the same as the ones required for cars and motocycles by legislation. You can now exercise or commute safely everywhere, anytime, even in an urban environment.
Who said innovation had to be complex?", "UPC": "012345678901", "BuyItNowPrice": 34.99, "RetailPrice": 39.99, "Attributes": [ { "Name": "Size", "Value": "XL" }, { "Name": "Color", "Value": "Black" }, { "Name": "Material", "Value": "Stainless Steel" } ] } } } } }, "required": true }, "responses": { "201": { "description": "Created entity", "content": { "application/json": { "schema": { "title": "Product", "type": "object", "properties": { "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "CreateDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "UpdateDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "QuantityUpdateDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "IsAvailableInStore": { "type": [ "null", "boolean" ] }, "IsBlocked": { "type": [ "null", "boolean" ] }, "IsBlockedFromAdvertising": { "type": [ "null", "boolean" ] }, "IsExternalQuantityBlocked": { "type": [ "null", "boolean" ] }, "InfiniteQuantity": { "type": [ "null", "boolean" ] }, "BlockComment": { "type": [ "null", "string" ] }, "BlockedDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "BlockedFromAdvertisingDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "ReceivedDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "LastSaleDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "ASIN": { "type": [ "null", "string" ] }, "Brand": { "type": [ "null", "string" ] }, "Condition": { "type": [ "null", "string" ] }, "Description": { "type": [ "null", "string" ] }, "EAN": { "type": [ "null", "string" ] }, "FlagDescription": { "type": [ "null", "string" ] }, "Flag": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.FlagType" }, "HarmonizedCode": { "type": [ "null", "string" ] }, "ISBN": { "type": [ "null", "string" ] }, "Manufacturer": { "type": [ "null", "string" ] }, "MPN": { "type": [ "null", "string" ] }, "ShortDescription": { "type": [ "null", "string" ] }, "Sku": { "type": [ "null", "string" ] }, "Subtitle": { "type": [ "null", "string" ] }, "TaxProductCode": { "type": [ "null", "string" ] }, "Title": { "type": [ "null", "string" ] }, "UPC": { "type": [ "null", "string" ] }, "WarehouseLocation": { "type": [ "null", "string" ] }, "Warranty": { "type": [ "null", "string" ] }, "MultipackQuantity": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "Height": { "type": [ "null", "number" ], "format": "decimal" }, "Length": { "type": [ "null", "number" ], "format": "decimal" }, "Width": { "type": [ "null", "number" ], "format": "decimal" }, "Weight": { "oneOf": [ { "type": [ "null", "number" ], "format": "double" }, { "type": [ "null", "string" ] }, { "$ref": "#/components/schemas/ReferenceNumeric" } ] }, "Cost": { "type": [ "null", "number" ], "format": "decimal" }, "Margin": { "type": [ "null", "number" ], "format": "decimal" }, "RetailPrice": { "type": [ "null", "number" ], "format": "decimal" }, "StartingPrice": { "type": [ "null", "number" ], "format": "decimal" }, "ReservePrice": { "type": [ "null", "number" ], "format": "decimal" }, "BuyItNowPrice": { "type": [ "null", "number" ], "format": "decimal" }, "StorePrice": { "type": [ "null", "number" ], "format": "decimal" }, "SecondChancePrice": { "type": [ "null", "number" ], "format": "decimal" }, "MinPrice": { "type": [ "null", "number" ], "format": "decimal" }, "MaxPrice": { "type": [ "null", "number" ], "format": "decimal" }, "EstimatedShippingCost": { "type": [ "null", "number" ], "format": "decimal" }, "SupplierName": { "type": [ "null", "string" ] }, "SupplierCode": { "type": [ "null", "string" ] }, "SupplierPO": { "type": [ "null", "string" ] }, "Classification": { "type": [ "null", "string" ] }, "IsDisplayInStore": { "type": [ "null", "boolean" ] }, "StoreTitle": { "type": [ "null", "string" ] }, "StoreDescription": { "type": [ "null", "string" ] }, "BundleType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.BundleType" }, "ProductType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.InventoryItemType" }, "TotalAvailableQuantity": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "OpenAllocatedQuantity": { "type": "number", "format": "int64" }, "OpenAllocatedQuantityPooled": { "type": "number", "format": "int64" }, "PendingCheckoutQuantity": { "type": "number", "format": "int64" }, "PendingCheckoutQuantityPooled": { "type": "number", "format": "int64" }, "PendingPaymentQuantity": { "type": "number", "format": "int64" }, "PendingPaymentQuantityPooled": { "type": "number", "format": "int64" }, "PendingShipmentQuantity": { "type": "number", "format": "int64" }, "PendingShipmentQuantityPooled": { "type": "number", "format": "int64" }, "TotalQuantity": { "type": [ "null", "number" ], "format": "int64" }, "TotalQuantityPooled": { "type": [ "null", "number" ], "format": "int64" }, "QuantitySoldLast7Days": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "QuantitySoldLast14Days": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "QuantitySoldLast30Days": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "QuantitySoldLast60Days": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "QuantitySoldLast90Days": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "IsParent": { "type": [ "null", "boolean" ] }, "IsInRelationship": { "type": [ "null", "boolean" ] }, "CopyToChildren": { "type": [ "null", "boolean" ] }, "CopyToAliases": { "type": [ "null", "string" ] }, "ParentProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ParentSku": { "type": [ "null", "string" ] }, "RelationshipName": { "type": [ "null", "string" ] }, "VaryBy": { "type": [ "null", "string" ] }, "AliasType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AliasType" }, "ReferenceSku": { "type": [ "null", "string" ] }, "ReferenceProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" } }, "example": { "ID": 0, "ProfileID": 0, "CreateDateUtc": "0001-01-01T00:00:00+00:00", "UpdateDateUtc": "0001-01-01T00:00:00+00:00", "QuantityUpdateDateUtc": "0001-01-01T00:00:00+00:00", "IsAvailableInStore": true, "IsBlocked": true, "IsBlockedFromAdvertising": true, "IsExternalQuantityBlocked": true, "InfiniteQuantity": true, "BlockComment": "string", "BlockedDateUtc": "0001-01-01T00:00:00+00:00", "BlockedFromAdvertisingDateUtc": "0001-01-01T00:00:00+00:00", "ReceivedDateUtc": "0001-01-01T00:00:00+00:00", "LastSaleDateUtc": "0001-01-01T00:00:00+00:00", "ASIN": "string", "Brand": "string", "Condition": "string", "Description": "string", "EAN": "string", "FlagDescription": "string", "Flag": "NoFlag", "HarmonizedCode": "string", "ISBN": "string", "Manufacturer": "string", "MPN": "string", "ShortDescription": "string", "Sku": "string", "Subtitle": "string", "TaxProductCode": "string", "Title": "string", "UPC": "string", "WarehouseLocation": "string", "Warranty": "string", "MultipackQuantity": 0, "Height": 0, "Length": 0, "Width": 0, "Weight": 0, "Cost": 0, "Margin": 0, "RetailPrice": 0, "StartingPrice": 0, "ReservePrice": 0, "BuyItNowPrice": 0, "StorePrice": 0, "SecondChancePrice": 0, "MinPrice": 0, "MaxPrice": 0, "EstimatedShippingCost": 0, "SupplierName": "string", "SupplierCode": "string", "SupplierPO": "string", "Classification": "string", "IsDisplayInStore": true, "StoreTitle": "string", "StoreDescription": "string", "BundleType": "None", "ProductType": "Item", "TotalAvailableQuantity": 0, "OpenAllocatedQuantity": 0, "OpenAllocatedQuantityPooled": 0, "PendingCheckoutQuantity": 0, "PendingCheckoutQuantityPooled": 0, "PendingPaymentQuantity": 0, "PendingPaymentQuantityPooled": 0, "PendingShipmentQuantity": 0, "PendingShipmentQuantityPooled": 0, "TotalQuantity": 0, "TotalQuantityPooled": 0, "QuantitySoldLast7Days": 0, "QuantitySoldLast14Days": 0, "QuantitySoldLast30Days": 0, "QuantitySoldLast60Days": 0, "QuantitySoldLast90Days": 0, "IsParent": true, "IsInRelationship": true, "CopyToChildren": true, "CopyToAliases": "string", "ParentProductID": 0, "ParentSku": "string", "RelationshipName": "string", "VaryBy": "string", "AliasType": "None", "ReferenceSku": "string", "ReferenceProductID": 0 } } } } }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "operation" } }, "/v1/Products({ID})": { "description": "Provides operations to manage the collection of Product entities.", "get": { "tags": [ "Products" ], "summary": "Get Products by key", "operationId": "Products.Product.GetProduct", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Product", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Product" }, { "name": "$select", "in": "query", "description": "Select properties to be returned", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ID", "ProfileID", "CreateDateUtc", "UpdateDateUtc", "QuantityUpdateDateUtc", "IsAvailableInStore", "IsBlocked", "IsBlockedFromAdvertising", "IsExternalQuantityBlocked", "InfiniteQuantity", "BlockComment", "BlockedDateUtc", "BlockedFromAdvertisingDateUtc", "ReceivedDateUtc", "LastSaleDateUtc", "ASIN", "Brand", "Condition", "Description", "EAN", "FlagDescription", "Flag", "HarmonizedCode", "ISBN", "Manufacturer", "MPN", "ShortDescription", "Sku", "Subtitle", "TaxProductCode", "Title", "UPC", "WarehouseLocation", "Warranty", "MultipackQuantity", "Height", "Length", "Width", "Weight", "Cost", "Margin", "RetailPrice", "StartingPrice", "ReservePrice", "BuyItNowPrice", "StorePrice", "SecondChancePrice", "MinPrice", "MaxPrice", "EstimatedShippingCost", "SupplierName", "SupplierCode", "SupplierPO", "Classification", "IsDisplayInStore", "StoreTitle", "StoreDescription", "BundleType", "ProductType", "TotalAvailableQuantity", "OpenAllocatedQuantity", "OpenAllocatedQuantityPooled", "PendingCheckoutQuantity", "PendingCheckoutQuantityPooled", "PendingPaymentQuantity", "PendingPaymentQuantityPooled", "PendingShipmentQuantity", "PendingShipmentQuantityPooled", "TotalQuantity", "TotalQuantityPooled", "QuantitySoldLast7Days", "QuantitySoldLast14Days", "QuantitySoldLast30Days", "QuantitySoldLast60Days", "QuantitySoldLast90Days", "IsParent", "IsInRelationship", "CopyToChildren", "CopyToAliases", "ParentProductID", "ParentSku", "RelationshipName", "VaryBy", "AliasType", "ReferenceSku", "ReferenceProductID", "AssemblyBundleDistributionCenters", "Attributes", "DCQuantities", "Images", "Labels", "BundleComponents", "Children", "AliasRelationships" ], "type": "string" } } }, { "name": "$expand", "in": "query", "description": "Expand related entities", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "*", "AssemblyBundleDistributionCenters", "Attributes", "DCQuantities", "Images", "Labels", "BundleComponents", "Children", "AliasRelationships" ], "type": "string" } } } ], "responses": { "200": { "description": "Retrieved entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Product" } } }, "links": { "AssemblyBundleDistributionCenters": { "operationId": "Products.ListAssemblyBundleDistributionCenters" }, "Attributes": { "operationId": "Products.Product.Attributes" }, "DCQuantities": { "operationId": "Products.Product.DCQuantities" }, "Images": { "operationId": "Products.Product.Images" }, "Labels": { "operationId": "Products.Product.Labels" }, "BundleComponents": { "operationId": "Products.Product.BundleComponents" }, "Children": { "operationId": "Products.Product.Children" }, "AliasRelationships": { "operationId": "Products.ListAliasRelationships" }, "RemoveChildren": { "operationId": "Products.Product.RemoveChildren" }, "UpdateAttributes": { "operationId": "Products.Product.UpdateAttributes" }, "UpdateQuantity": { "operationId": "Products.Product.UpdateQuantity" } } }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "operation" }, "patch": { "tags": [ "Products" ], "summary": "Update Products", "operationId": "Products.Product.UpdateProduct", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Product", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Product" } ], "requestBody": { "description": "New property values", "content": { "application/json": { "schema": { "title": "Product", "type": "object", "properties": { "IsAvailableInStore": { "type": [ "null", "boolean" ] }, "IsBlocked": { "type": [ "null", "boolean" ] }, "IsBlockedFromAdvertising": { "type": [ "null", "boolean" ] }, "IsExternalQuantityBlocked": { "type": [ "null", "boolean" ] }, "InfiniteQuantity": { "type": [ "null", "boolean" ] }, "ASIN": { "type": [ "null", "string" ] }, "Brand": { "type": [ "null", "string" ] }, "Condition": { "type": [ "null", "string" ] }, "Description": { "type": [ "null", "string" ] }, "EAN": { "type": [ "null", "string" ] }, "FlagDescription": { "type": [ "null", "string" ] }, "Flag": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.FlagType" }, "HarmonizedCode": { "type": [ "null", "string" ] }, "ISBN": { "type": [ "null", "string" ] }, "Manufacturer": { "type": [ "null", "string" ] }, "MPN": { "type": [ "null", "string" ] }, "ShortDescription": { "type": [ "null", "string" ] }, "Sku": { "type": [ "null", "string" ] }, "Subtitle": { "type": [ "null", "string" ] }, "TaxProductCode": { "type": [ "null", "string" ] }, "Title": { "type": [ "null", "string" ] }, "UPC": { "type": [ "null", "string" ] }, "WarehouseLocation": { "type": [ "null", "string" ] }, "Warranty": { "type": [ "null", "string" ] }, "MultipackQuantity": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "Height": { "type": [ "null", "number" ], "format": "decimal" }, "Length": { "type": [ "null", "number" ], "format": "decimal" }, "Width": { "type": [ "null", "number" ], "format": "decimal" }, "Weight": { "oneOf": [ { "type": [ "null", "number" ], "format": "double" }, { "type": [ "null", "string" ] }, { "$ref": "#/components/schemas/ReferenceNumeric" } ] }, "Cost": { "type": [ "null", "number" ], "format": "decimal" }, "Margin": { "type": [ "null", "number" ], "format": "decimal" }, "RetailPrice": { "type": [ "null", "number" ], "format": "decimal" }, "StartingPrice": { "type": [ "null", "number" ], "format": "decimal" }, "ReservePrice": { "type": [ "null", "number" ], "format": "decimal" }, "BuyItNowPrice": { "type": [ "null", "number" ], "format": "decimal" }, "StorePrice": { "type": [ "null", "number" ], "format": "decimal" }, "SecondChancePrice": { "type": [ "null", "number" ], "format": "decimal" }, "MinPrice": { "type": [ "null", "number" ], "format": "decimal" }, "MaxPrice": { "type": [ "null", "number" ], "format": "decimal" }, "EstimatedShippingCost": { "type": [ "null", "number" ], "format": "decimal" }, "SupplierName": { "type": [ "null", "string" ] }, "SupplierCode": { "type": [ "null", "string" ] }, "SupplierPO": { "type": [ "null", "string" ] }, "Classification": { "type": [ "null", "string" ] }, "IsDisplayInStore": { "type": [ "null", "boolean" ] }, "StoreTitle": { "type": [ "null", "string" ] }, "StoreDescription": { "type": [ "null", "string" ] }, "BundleType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.BundleType" }, "ProductType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.InventoryItemType" }, "IsParent": { "type": [ "null", "boolean" ] }, "IsInRelationship": { "type": [ "null", "boolean" ] }, "ParentProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ParentSku": { "type": [ "null", "string" ] }, "AliasType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AliasType" }, "ReferenceSku": { "type": [ "null", "string" ] }, "AssemblyBundleDistributionCenters": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AssemblyBundleDistributionCenter" }, "x-ms-navigationProperty": true } }, "example": { "IsAvailableInStore": true, "IsBlocked": true, "IsBlockedFromAdvertising": true, "IsExternalQuantityBlocked": true, "InfiniteQuantity": true, "ASIN": "string", "Brand": "string", "Condition": "string", "Description": "string", "EAN": "string", "FlagDescription": "string", "Flag": "NoFlag", "HarmonizedCode": "string", "ISBN": "string", "Manufacturer": "string", "MPN": "string", "ShortDescription": "string", "Sku": "string", "Subtitle": "string", "TaxProductCode": "string", "Title": "string", "UPC": "string", "WarehouseLocation": "string", "Warranty": "string", "MultipackQuantity": 0, "Height": 0, "Length": 0, "Width": 0, "Weight": 0, "Cost": 0, "Margin": 0, "RetailPrice": 0, "StartingPrice": 0, "ReservePrice": 0, "BuyItNowPrice": 0, "StorePrice": 0, "SecondChancePrice": 0, "MinPrice": 0, "MaxPrice": 0, "EstimatedShippingCost": 0, "SupplierName": "string", "SupplierCode": "string", "SupplierPO": "string", "Classification": "string", "IsDisplayInStore": true, "StoreTitle": "string", "StoreDescription": "string", "BundleType": "None", "ProductType": "Item", "IsParent": true, "IsInRelationship": true, "ParentProductID": 0, "ParentSku": "string", "AliasType": "None", "ReferenceSku": "string", "AssemblyBundleDistributionCenters": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.AssemblyBundleDistributionCenter" } ] } } } }, "required": true }, "responses": { "204": { "description": "Success" }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "operation" }, "delete": { "tags": [ "Products" ], "summary": "Delete Products", "operationId": "Products.Product.DeleteProduct", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Product", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Product" }, { "name": "If-Match", "in": "header", "description": "ETag", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "operation" } }, "/v1/Products({ID})/Attributes": { "description": "Provides operations to call the Attributes method.", "get": { "tags": [ "Products" ], "summary": "Get Attributes", "operationId": "Products.Product.Attributes", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Product", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Product" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/count" }, { "name": "$select", "in": "query", "description": "Select properties to be returned", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ProductID", "ProfileID", "Name", "Value", "Product" ], "type": "string" } } }, { "name": "$orderby", "in": "query", "description": "Order items by property values", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ProductID", "ProductID desc", "ProfileID", "ProfileID desc", "Name", "Name desc", "Value", "Value desc" ], "type": "string" } } }, { "name": "$expand", "in": "query", "description": "Expand related entities", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "*", "Product" ], "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "Collection of AttributeValue", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AttributeValue" } } } } ] } } } }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "function", "x-ms-pageable": { "nextLinkName": "@odata.nextLink", "operationName": "listMore" } } }, "/v1/Products({ID})/BundleComponents": { "description": "Provides operations to call the BundleComponents method.", "get": { "tags": [ "Products" ], "summary": "Get Bundle Components", "operationId": "Products.Product.BundleComponents", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Product", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Product" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/count" }, { "name": "$select", "in": "query", "description": "Select properties to be returned", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ProductID", "ComponentID", "ProfileID", "ComponentSku", "Quantity", "Product" ], "type": "string" } } }, { "name": "$orderby", "in": "query", "description": "Order items by property values", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ProductID", "ProductID desc", "ComponentID", "ComponentID desc", "ProfileID", "ProfileID desc", "ComponentSku", "ComponentSku desc", "Quantity", "Quantity desc" ], "type": "string" } } }, { "name": "$expand", "in": "query", "description": "Expand related entities", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "*", "Product" ], "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "Collection of ProductBundleComponent", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ProductBundleComponent" } } } } ] } } } }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "function", "x-ms-pageable": { "nextLinkName": "@odata.nextLink", "operationName": "listMore" } } }, "/v1/Products({ID})/Children": { "description": "Provides operations to call the Children method.", "get": { "tags": [ "Products" ], "summary": "Get Children", "operationId": "Products.Product.Children", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Product", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Product" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/count" }, { "name": "$select", "in": "query", "description": "Select properties to be returned", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ParentProductID", "ProfileID", "ChildProductID", "ChildProduct" ], "type": "string" } } }, { "name": "$orderby", "in": "query", "description": "Order items by property values", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ParentProductID", "ParentProductID desc", "ProfileID", "ProfileID desc", "ChildProductID", "ChildProductID desc" ], "type": "string" } } }, { "name": "$expand", "in": "query", "description": "Expand related entities", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "*", "ChildProduct" ], "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "Collection of ChildRelationship", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ChildRelationship" } } } } ] } } } }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "function", "x-ms-pageable": { "nextLinkName": "@odata.nextLink", "operationName": "listMore" } } }, "/v1/Products({ID})/DCQuantities": { "description": "Provides operations to call the DCQuantities method.", "get": { "tags": [ "Products" ], "summary": "Get DC Quantities", "operationId": "Products.Product.DCQuantities", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Product", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Product" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/count" }, { "name": "$select", "in": "query", "description": "Select properties to be returned", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ProductID", "ProfileID", "DistributionCenterID", "AvailableQuantity", "Product" ], "type": "string" } } }, { "name": "$orderby", "in": "query", "description": "Order items by property values", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ProductID", "ProductID desc", "ProfileID", "ProfileID desc", "DistributionCenterID", "DistributionCenterID desc", "AvailableQuantity", "AvailableQuantity desc" ], "type": "string" } } }, { "name": "$expand", "in": "query", "description": "Expand related entities", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "*", "Product" ], "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "Collection of DCQuantity", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.DCQuantity" } } } } ] } } } }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "function", "x-ms-pageable": { "nextLinkName": "@odata.nextLink", "operationName": "listMore" } } }, "/v1/Products({ID})/Images": { "description": "Provides operations to call the Images method.", "get": { "tags": [ "Products" ], "summary": "Get Images", "operationId": "Products.Product.Images", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Product", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Product" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/count" }, { "name": "$select", "in": "query", "description": "Select properties to be returned", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ProductID", "ProfileID", "PlacementName", "Abbreviation", "Url", "Product" ], "type": "string" } } }, { "name": "$orderby", "in": "query", "description": "Order items by property values", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ProductID", "ProductID desc", "ProfileID", "ProfileID desc", "PlacementName", "PlacementName desc", "Abbreviation", "Abbreviation desc", "Url", "Url desc" ], "type": "string" } } }, { "name": "$expand", "in": "query", "description": "Expand related entities", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "*", "Product" ], "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "Collection of Image", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Image" } } } } ] } } } }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "function", "x-ms-pageable": { "nextLinkName": "@odata.nextLink", "operationName": "listMore" } } }, "/v1/Products({ID})/Labels": { "description": "Provides operations to call the Labels method.", "get": { "tags": [ "Products" ], "summary": "Get Labels", "operationId": "Products.Product.Labels", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Product", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Product" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/count" }, { "name": "$select", "in": "query", "description": "Select properties to be returned", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ProductID", "ProfileID", "Name", "Product" ], "type": "string" } } }, { "name": "$orderby", "in": "query", "description": "Order items by property values", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ProductID", "ProductID desc", "ProfileID", "ProfileID desc", "Name", "Name desc" ], "type": "string" } } }, { "name": "$expand", "in": "query", "description": "Expand related entities", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "*", "Product" ], "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "title": "Collection of ProductLabel", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ProductLabel" } } } } ] } } } }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "function", "x-ms-pageable": { "nextLinkName": "@odata.nextLink", "operationName": "listMore" } } }, "/v1/Products({ID})/RemoveChildren": { "description": "Provides operations to call the RemoveChildren method.", "post": { "tags": [ "Products" ], "summary": "Remove Children", "operationId": "Products.Product.RemoveChildren", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Product", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Product" } ], "requestBody": { "description": "Action parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "Value": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ChildrenRemoveRequest" }, { "type": "null" } ] } } } } } }, "responses": { "204": { "description": "Success" }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "action" } }, "/v1/Products({ID})/UpdateAttributes": { "description": "Provides operations to call the UpdateAttributes method.", "post": { "tags": [ "Products" ], "summary": "Update Attributes", "operationId": "Products.Product.UpdateAttributes", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Product", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Product" } ], "requestBody": { "description": "Action parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "Value": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AttributesUpdateRequest" }, { "type": "null" } ] } } } } } }, "responses": { "204": { "description": "Success" }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "action" } }, "/v1/Products({ID})/UpdateQuantity": { "description": "Provides operations to call the UpdateQuantity method.", "post": { "tags": [ "Products" ], "summary": "Update Quantity", "operationId": "Products.Product.UpdateQuantity", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Product", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Product" } ], "requestBody": { "description": "Action parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "Value": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.QuantityUpdateRequest" }, { "type": "null" } ] } } } } } }, "responses": { "204": { "description": "Success" }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "action" } }, "/v1/Profiles": { "description": "Provides operations to manage the collection of Profile entities.", "get": { "tags": [ "Profiles" ], "summary": "Get Profiles", "operationId": "Profiles.Profile.ListProfile", "parameters": [ { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/count" }, { "name": "$orderby", "in": "query", "description": "Order items by property values", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ID", "ID desc", "AccountName", "AccountName desc", "CompanyName", "CompanyName desc", "CurrencyCode", "CurrencyCode desc", "TimeZoneRegion", "TimeZoneRegion desc", "TimeZoneDescription", "TimeZoneDescription desc", "DefaultDistributionCenterID", "DefaultDistributionCenterID desc" ], "type": "string" } } }, { "name": "$select", "in": "query", "description": "Select properties to be returned", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ID", "AccountName", "CompanyName", "CurrencyCode", "TimeZoneRegion", "TimeZoneDescription", "DefaultDistributionCenterID", "SiteAccounts", "ShippingLabelPartnerAccounts" ], "type": "string" } } }, { "name": "$expand", "in": "query", "description": "Expand related entities", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "*", "SiteAccounts", "ShippingLabelPartnerAccounts" ], "type": "string" } } } ], "responses": { "200": { "$ref": "#/components/responses/ChannelAdvisor.RestApi.V1.Models.ProfileCollectionResponse" }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-pageable": { "nextLinkName": "@odata.nextLink", "operationName": "listMore" }, "x-ms-docs-operation-type": "operation" } }, "/v1/Profiles({ID})": { "description": "Provides operations to manage the collection of Profile entities.", "get": { "tags": [ "Profiles" ], "summary": "Get Profiles by key", "operationId": "Profiles.Profile.GetProfile", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Profile", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Profile" }, { "name": "$select", "in": "query", "description": "Select properties to be returned", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ID", "AccountName", "CompanyName", "CurrencyCode", "TimeZoneRegion", "TimeZoneDescription", "DefaultDistributionCenterID", "SiteAccounts", "ShippingLabelPartnerAccounts" ], "type": "string" } } }, { "name": "$expand", "in": "query", "description": "Expand related entities", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "*", "SiteAccounts", "ShippingLabelPartnerAccounts" ], "type": "string" } } } ], "responses": { "200": { "description": "Retrieved entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Profile" } } }, "links": { "SiteAccounts": { "operationId": "Profiles.ListSiteAccounts" }, "ShippingLabelPartnerAccounts": { "operationId": "Profiles.ListShippingLabelPartnerAccounts" } } }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "operation" } }, "/v1/Sites": { "description": "Provides operations to manage the collection of Site entities.", "get": { "tags": [ "Sites" ], "summary": "Get Sites", "operationId": "Sites.Site.ListSite", "parameters": [ { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/count" }, { "name": "$orderby", "in": "query", "description": "Order items by property values", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ID", "ID desc", "SiteName", "SiteName desc", "SiteCategoryID", "SiteCategoryID desc", "SiteCategoryName", "SiteCategoryName desc", "CancellationConfiguration", "CancellationConfiguration desc", "RefundConfiguration", "RefundConfiguration desc", "AdjustmentReasons", "AdjustmentReasons desc" ], "type": "string" } } }, { "name": "$select", "in": "query", "description": "Select properties to be returned", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ID", "SiteName", "SiteCategoryID", "SiteCategoryName", "CancellationConfiguration", "RefundConfiguration", "AdjustmentReasons" ], "type": "string" } } }, { "name": "$expand", "in": "query", "description": "Expand related entities", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "*" ], "type": "string" } } } ], "responses": { "200": { "$ref": "#/components/responses/ChannelAdvisor.RestApi.V1.Models.SiteCollectionResponse" }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-pageable": { "nextLinkName": "@odata.nextLink", "operationName": "listMore" }, "x-ms-docs-operation-type": "operation" } }, "/v1/$batch": { "post": { "tags": [ "Batch" ], "summary": "Submit Batch Request", "description": "Submits a batch of individual API requests in a single HTTP call using the OData multipart/mixed batch format. Each request in the batch is processed independently and the response contains the individual results. Refer to the Batch Requests guide for full details on request formatting, required headers, and examples.", "operationId": "Batch.SubmitBatchRequest", "requestBody": { "description": "A multipart/mixed body containing individual requests separated by changeset boundaries. Each changeset includes the HTTP method, full URL, headers, and body for a single operation. The Content-Type header must be set to `multipart/mixed; boundary=changeset`.", "content": { "multipart/mixed": { "schema": { "type": "string", "description": "The raw multipart/mixed batch request body. Use `--batch` and `--changeset` delimiters to separate individual requests. The boundary value must match the one specified in the Content-Type header." }, "example": "--batch\nContent-Type: multipart/mixed; boundary=changeset\n\n--changeset\nContent-Type: application/http\nContent-Transfer-Encoding: binary\nContent-ID: 1\n\nGET https://api.channeladvisor.com/v1/Products(12345) HTTP/1.1\n\n--changeset\nContent-Type: application/http\nContent-Transfer-Encoding: binary\nContent-ID: 2\n\nPATCH https://api.channeladvisor.com/v1/Orders(11111) HTTP/1.1\nContent-Type: application/json\n\n{\"SellerOrderID\": \"SO-100045\"}\n\n--changeset--\n--batch--" } }, "required": true }, "responses": { "200": { "description": "A multipart/mixed response containing individual results for each request in the batch. Each part includes the HTTP status line and response body for the corresponding request.", "content": { "multipart/mixed": { "schema": { "type": "string", "description": "The raw multipart/mixed batch response body. Each part contains the HTTP status and optional response body for an individual request." } } } } } } }, "/v1/DistributionCenters({distributionCenterID})/OperatingHours({dayId})": { "delete": { "tags": [ "DistributionCenters" ], "summary": "Delete Operating Hours", "description": "Deletes operating hours for a distribution center and day.", "operationId": "DeleteOperatingHours", "parameters": [ { "name": "distributionCenterID", "in": "path", "description": "The distribution center ID.", "required": true, "schema": { "type": "integer" } }, { "name": "dayId", "in": "path", "description": "The day identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { } } }, "/v1/Webhooks": { "description": "Provides operations to manage the collection of Webhook entities.", "get": { "tags": [ "Webhooks" ], "summary": "Get Webhooks", "operationId": "Webhooks.Webhook.ListWebhook", "parameters": [ { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/count" }, { "name": "$orderby", "in": "query", "description": "Order items by property values", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ID", "ID desc", "Name", "Name desc", "Status", "Status desc", "AuthenticationType", "AuthenticationType desc", "WebhookUri", "WebhookUri desc", "SigningSecret", "SigningSecret desc", "EventTypes", "EventTypes desc" ], "type": "string" } } }, { "name": "$select", "in": "query", "description": "Select properties to be returned", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ID", "Name", "Status", "AuthenticationType", "WebhookUri", "SigningSecret", "EventTypes" ], "type": "string" } } }, { "name": "$expand", "in": "query", "description": "Expand related entities", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "*" ], "type": "string" } } } ], "responses": { "200": { "$ref": "#/components/responses/ChannelAdvisor.PostSale.RestApi.V1.Models.WebhookCollectionResponse" }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-pageable": { "nextLinkName": "@odata.nextLink", "operationName": "listMore" }, "x-ms-docs-operation-type": "operation" }, "post": { "tags": [ "Webhooks" ], "summary": "Create Webhooks", "operationId": "Webhooks.Webhook.CreateWebhook", "requestBody": { "description": "New entity", "content": { "application/json": { "schema": { "title": "Webhook", "type": "object", "properties": { "Name": { "type": [ "null", "string" ] }, "Status": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.WebhookEndpointStatus" }, "AuthenticationType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.WebhookAuthenticationType" }, "WebhookUri": { "type": [ "null", "string" ] }, "EventTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.WebhookEventType" } } }, "example": { "Name": "string", "Status": "Deleted", "AuthenticationType": "Unknown", "WebhookUri": "string", "EventTypes": [ "Unknown" ] } } } }, "required": true }, "responses": { "201": { "description": "Created entity", "content": { "application/json": { "schema": { "title": "Webhook", "type": "object", "properties": { "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "Name": { "type": [ "null", "string" ] }, "Status": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.WebhookEndpointStatus" }, "AuthenticationType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.WebhookAuthenticationType" }, "WebhookUri": { "type": [ "null", "string" ] }, "SigningSecret": { "type": [ "null", "string" ] }, "EventTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.WebhookEventType" } } }, "example": { "ID": 0, "Name": "string", "Status": "Deleted", "AuthenticationType": "Unknown", "WebhookUri": "string", "SigningSecret": "string", "EventTypes": [ "Unknown" ] } } } } }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "operation" } }, "/v1/Webhooks({ID})": { "description": "Provides operations to manage the collection of Webhook entities.", "get": { "tags": [ "Webhooks" ], "summary": "Get Webhooks by key", "operationId": "Webhooks.Webhook.GetWebhook", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Webhook", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Webhook" }, { "name": "$select", "in": "query", "description": "Select properties to be returned", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "ID", "Name", "Status", "AuthenticationType", "WebhookUri", "SigningSecret", "EventTypes" ], "type": "string" } } }, { "name": "$expand", "in": "query", "description": "Expand related entities", "explode": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "*" ], "type": "string" } } } ], "responses": { "200": { "description": "Retrieved entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.PostSale.RestApi.V1.Models.Webhook" } } }, "links": { "NewSigningSecret": { "operationId": "Webhooks.Webhook.NewSigningSecret" }, "RetrieveFailedEvents": { "operationId": "Webhooks.Webhook.RetrieveFailedEvents" }, "RetryFailedEvents": { "operationId": "Webhooks.Webhook.RetryFailedEvents" }, "UpdateAuthentication": { "operationId": "Webhooks.Webhook.UpdateAuthentication" } } }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "operation" }, "patch": { "tags": [ "Webhooks" ], "summary": "Update Webhooks", "operationId": "Webhooks.Webhook.UpdateWebhook", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Webhook", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Webhook" } ], "requestBody": { "description": "New property values", "content": { "application/json": { "schema": { "title": "Webhook", "type": "object", "properties": { "Name": { "type": [ "null", "string" ] }, "Status": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.WebhookEndpointStatus" }, "WebhookUri": { "type": [ "null", "string" ] }, "EventTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.WebhookEventType" } } }, "example": { "Name": "string", "Status": "Deleted", "WebhookUri": "string", "EventTypes": [ "Unknown" ] } }, "example": { "Name": "string", "Status": "Disabled", "WebhookUri": "https://www.example.com", "EventTypes": [ "PaymentCleared" ] } } }, "required": true }, "responses": { "204": { "description": "Success" }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "operation" }, "delete": { "tags": [ "Webhooks" ], "summary": "Delete Webhooks", "operationId": "Webhooks.Webhook.DeleteWebhook", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Webhook", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Webhook" }, { "name": "If-Match", "in": "header", "description": "ETag", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "operation" } }, "/v1/Webhooks({ID})/NewSigningSecret": { "description": "Provides operations to call the NewSigningSecret method.", "post": { "tags": [ "Webhooks" ], "summary": "New Signing Secret", "operationId": "Webhooks.Webhook.NewSigningSecret", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Webhook", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Webhook" } ], "responses": { "204": { "description": "Success" }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "action" } }, "/v1/Webhooks({ID})/RetrieveFailedEvents": { "description": "Provides operations to call the RetrieveFailedEvents method.", "get": { "tags": [ "Webhooks" ], "summary": "Get Retrieve Failed Events", "operationId": "Webhooks.Webhook.RetrieveFailedEvents", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Webhook", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Webhook" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.WebhookFailedEventsJob" }, { "type": "null" } ] } } } }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "function" } }, "/v1/Webhooks({ID})/RetryFailedEvents": { "description": "Provides operations to call the RetryFailedEvents method.", "post": { "tags": [ "Webhooks" ], "summary": "Retry Failed Events", "operationId": "Webhooks.Webhook.RetryFailedEvents", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Webhook", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Webhook" } ], "requestBody": { "description": "Action parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "Token": { "type": [ "null", "string" ] } } } } } }, "responses": { "204": { "description": "Success" }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "action" } }, "/v1/Webhooks({ID})/UpdateAuthentication": { "description": "Provides operations to call the UpdateAuthentication method.", "post": { "tags": [ "Webhooks" ], "summary": "Update Authentication", "operationId": "Webhooks.Webhook.UpdateAuthentication", "parameters": [ { "name": "ID", "in": "path", "description": "The unique identifier of Webhook", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "x-ms-docs-key-type": "Webhook" } ], "requestBody": { "description": "Action parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "Value": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.WebhookAuthenticationUpdateRequest" }, { "type": "null" } ] } } }, "example": { "Value": { "AuthenticationType": "SigningSecret" } } } } }, "responses": { "204": { "description": "Success" }, "4XX": { "$ref": "#/components/responses/error" }, "5XX": { "$ref": "#/components/responses/error" } }, "x-ms-docs-operation-type": "action" } }, "/v1/OperatingHours({distributionCenterID}, {dayId})": { "delete": { "tags": [ "OperatingHours" ], "summary": "Delete Operating Hours", "description": "Deletes operating hours for a distribution center and day.", "operationId": "DeleteOperatingHours", "parameters": [ { "name": "distributionCenterID", "in": "path", "description": "The distribution center ID.", "required": true, "schema": { "type": "integer" } }, { "name": "dayId", "in": "path", "description": "The day identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { } } }, "/v1/adjustments/unacknowledged": { "get": { "tags": [ "Adjustments" ], "summary": "Retrieves a list of adjustments that have not been acknowledged.", "operationId": "Adjustments_GetUnacknowledged", "parameters": [ { "name": "profileID", "in": "query", "description": "ProfileID is required when you have an integration with access to more than one profile.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "List of unacknowledged adjustments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdjustmentReponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdjustmentReponse" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/adjustments({id})/acknowledge": { "post": { "tags": [ "Adjustments" ], "summary": "Acknowledges an adjustment so it no longer shows up in the v1/adjustments/unacknowledged endpoint", "operationId": "Adjustments_PostAcknowledge", "parameters": [ { "name": "id", "in": "path", "description": "Adjustment ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "ShouldEvictOnAdjustmentChange signals that when the adjustment status changes it will automatically be unacknowledged. Extremely useful for RMAs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcknowledgeOption" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcknowledgeOption" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AcknowledgeOption" } } }, "required": true, "x-bodyName": "payloadBody" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "NotFound", "content": { "application/json": { }, "text/json": { } } } } }, "delete": { "tags": [ "Adjustments" ], "summary": "Unacknowledges an adjustment so it shows up in the v1/adjustments/unacknowledged endpoint", "operationId": "Adjustments_DeleteAcknowledge", "parameters": [ { "name": "id", "in": "path", "description": "Adjustment ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "NoContent", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "NotFound", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/Products({productID})/Attributes('{name}')": { "get": { "tags": [ "Alias" ], "summary": "Get Attribute", "operationId": "InventoryAlias_GetAttribute", "parameters": [ { "name": "productID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } }, "delete": { "tags": [ "Alias" ], "summary": "Delete Attribute", "operationId": "InventoryAlias_DeleteAttribute", "parameters": [ { "name": "productID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } }, "patch": { "tags": [ "Alias" ], "summary": "Update Attribute", "operationId": "InventoryAlias_UpdateAttribute", "parameters": [ { "name": "productID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } } }, "/v1/Products({productID})/Images('{placementName}')": { "get": { "tags": [ "Alias" ], "summary": "Get Image", "operationId": "InventoryAlias_GetImage", "parameters": [ { "name": "productID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "placementName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } }, "delete": { "tags": [ "Alias" ], "summary": "Delete Image", "operationId": "InventoryAlias_DeleteImage", "parameters": [ { "name": "productID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "placementName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } }, "patch": { "tags": [ "Alias" ], "summary": "Update Image", "operationId": "InventoryAlias_UpdateImage", "parameters": [ { "name": "productID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "placementName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } } }, "/v1/Products({productID})/Labels('{name}')": { "get": { "tags": [ "Alias" ], "summary": "Get Product Label", "operationId": "InventoryAlias_GetProductLabel", "parameters": [ { "name": "productID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } }, "delete": { "tags": [ "Alias" ], "summary": "Delete Product Label", "operationId": "InventoryAlias_DeleteProductLabel", "parameters": [ { "name": "productID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } }, "patch": { "tags": [ "Alias" ], "summary": "Update Product Label", "operationId": "InventoryAlias_UpdateProductLabel", "parameters": [ { "name": "productID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } } }, "/v1/Products({productID})/BundleComponents({componentID})": { "get": { "tags": [ "Alias" ], "summary": "Get Product Bundle Component", "operationId": "InventoryAlias_GetProductBundleComponent", "parameters": [ { "name": "productID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "componentID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } }, "delete": { "tags": [ "Alias" ], "summary": "Delete Product Bundle Component", "operationId": "InventoryAlias_DeleteProductBundleComponent", "parameters": [ { "name": "productID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "componentID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } }, "patch": { "tags": [ "Alias" ], "summary": "Update Product Bundle Component", "operationId": "InventoryAlias_UpdateProductBundleComponent", "parameters": [ { "name": "productID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "componentID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } } }, "/v1/Products({productID})/DCQuantities({distributionCenterID})": { "get": { "tags": [ "Alias" ], "summary": "Get DC Quantity", "operationId": "InventoryAlias_GetDCQuantity", "parameters": [ { "name": "productID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "distributionCenterID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } }, "delete": { "tags": [ "Alias" ], "summary": "Delete DC Quantity", "operationId": "InventoryAlias_DeleteDCQuantity", "parameters": [ { "name": "productID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "distributionCenterID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } }, "patch": { "tags": [ "Alias" ], "summary": "Update DC Quantity", "operationId": "InventoryAlias_UpdateDCQuantity", "parameters": [ { "name": "productID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "distributionCenterID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } } }, "/v1/Orders({orderID})/CustomFields({fieldID})": { "get": { "tags": [ "Alias" ], "summary": "Get Custom Field", "operationId": "PostSaleActionAlias_GetCustomField", "parameters": [ { "name": "orderID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fieldID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } }, "delete": { "tags": [ "Alias" ], "summary": "Delete Custom Field", "operationId": "PostSaleActionAlias_DeleteCustomField", "parameters": [ { "name": "orderID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fieldID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } }, "patch": { "tags": [ "Alias" ], "summary": "Update Custom Field", "operationId": "PostSaleActionAlias_UpdateCustomField", "parameters": [ { "name": "orderID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fieldID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } } }, "/v1/DistributionCentersUpload": { "get": { "tags": [ "DistributionCentersUpload" ], "summary": "Check Status", "operationId": "DistributionCentersUpload_CheckStatus", "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Upload Status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadStatus" } } } }, "400": { "description": "Usually caused by an invalid token", "content": { "application/json": { }, "text/json": { } } } } }, "post": { "tags": [ "DistributionCentersUpload" ], "summary": "Upload File", "operationId": "DistributionCentersUpload_UploadFile", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "uploadFile" ], "type": "object", "properties": { "uploadFile": { "type": "string", "description": "upload file", "format": "binary" } } } } } }, "responses": { "200": { "description": "Upload File Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadStatus" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { }, "text/json": { } } }, "429": { "description": "429", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/feeds/siteaccount/{siteAccountId}": { "get": { "tags": [ "Feeds" ], "summary": "Get Feeds By Customer Channel ID", "operationId": "Feeds_GetFeedsByCustomerChannelID", "parameters": [ { "name": "siteAccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pagesize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Collection of marketplace feeds for the provided Site Account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiFeedItem]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiFeedItem]" } } } }, "400": { "description": "ProfileID is required when the integration has access to multiple profiles.", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/groups": { "get": { "tags": [ "Groups" ], "summary": "Retrieves a paged list of user groups.", "description": "Example request:\n```http\n GET /v1/groups?profileid=12000000&page=1&pagesize=25&search=GroupName:\"Admin\"\n```\n\nSearchable fields:\n- GroupID (number)\n- GroupName (string)\n- ModuleID (number)\n- ModuleName (string)\n- AccountID (number)\n- AccountName (string)\n- ParentGroupID (number)\n- IsAdmin (boolean)\n\nSupported operators:\n- Strings: \":\" (exact). Values must be in quotes, e.g. GroupName:\"Admin\". Negate with leading '-'\n- Numbers/Dates: =, >, >=, <, <= (e.g. GroupID>100)\n- Booleans: \":\" with \"true\"/\"false\" in quotes (e.g. IsAdmin:\"true\"), negate with '-'\n- Null checks: field:null or -field:null (is null / is not null)\n- Combine with AND / OR (case-insensitive)\n\nNOTE: Only the first 10 Modules may be returned per group in the bulk list endpoint.\n\nValidation errors:\n- 400 InvalidPage: Page must be a positive integer.\n- 400 InvalidPageSize: Pagesize must be between 1 and 100.\n- 400 ProfileRequired: ProfileID is required when the integration has access to multiple profiles.\n- 401 Unauthorized: Access to the profile is not allowed.", "operationId": "UserGroupManagement_GetGroups", "parameters": [ { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "description": "1-based page number. Must be a positive integer.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pagesize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "search", "in": "query", "description": "Optional advanced search query.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Paged list of user groups", "content": { "application/json": { "schema": { "type": "object", "properties": { "Items": { "type": "array", "items": { "type": "object", "properties": { "GroupID": { "type": "integer", "format": "int32" }, "GroupName": { "type": "string" }, "IsAdmin": { "type": "boolean" }, "Modules": { "type": "array", "items": { "type": "object", "properties": { "ModuleID": { "type": "integer", "format": "int32" }, "Name": { "type": "string" }, "Description": { "type": "string" } } } }, "Users": { "type": "array", "items": { "type": "object", "properties": { "UserID": { "type": "integer", "format": "int32" }, "Status": { "type": "string" }, "DisabledOnDate": { "type": "string", "format": "date-time" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "LoginName": { "type": "string" }, "CorrespondenceEmailAddress": { "type": "string" }, "PhoneNumber": { "type": "string" }, "EnableSAMLDirectLogin": { "type": "boolean" }, "BillingAccess": { "type": "boolean" } } } }, "ProfileIDs": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "Metadata": { "type": "object", "properties": { "Page": { "type": "integer", "format": "int32" }, "PageSize": { "type": "integer", "format": "int32" }, "TotalItems": { "type": "integer", "format": "int32" } } } } } }, "text/json": { "schema": { "type": "object", "properties": { "Items": { "type": "array", "items": { "type": "object", "properties": { "GroupID": { "type": "integer", "format": "int32" }, "GroupName": { "type": "string" }, "IsAdmin": { "type": "boolean" }, "Modules": { "type": "array", "items": { "type": "object", "properties": { "ModuleID": { "type": "integer", "format": "int32" }, "Name": { "type": "string" }, "Description": { "type": "string" } } } }, "Users": { "type": "array", "items": { "type": "object", "properties": { "UserID": { "type": "integer", "format": "int32" }, "Status": { "type": "string" }, "DisabledOnDate": { "type": "string", "format": "date-time" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "LoginName": { "type": "string" }, "CorrespondenceEmailAddress": { "type": "string" }, "PhoneNumber": { "type": "string" }, "EnableSAMLDirectLogin": { "type": "boolean" }, "BillingAccess": { "type": "boolean" } } } }, "ProfileIDs": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "Metadata": { "type": "object", "properties": { "Page": { "type": "integer", "format": "int32" }, "PageSize": { "type": "integer", "format": "int32" }, "TotalItems": { "type": "integer", "format": "int32" } } } } } } } }, "400": { "description": "Invalid paging or profile requirement not met", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized to access the specified profile", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/groups/{id}": { "get": { "tags": [ "Groups" ], "summary": "Retrieves details for a specific user group by ID.", "description": "Example request:\n```http\n GET /v1/groups/10?profileid=12000000\n```", "operationId": "UserGroupManagement_GetGroupById", "parameters": [ { "name": "id", "in": "path", "description": "Group ID.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "User group details", "content": { "application/json": { "schema": { "type": "object", "properties": { "GroupID": { "type": "integer", "format": "int32" }, "GroupName": { "type": "string" }, "IsAdmin": { "type": "boolean" }, "Modules": { "type": "array", "items": { "type": "object", "properties": { "ModuleID": { "type": "integer", "format": "int32" }, "Name": { "type": "string" }, "Description": { "type": "string" } } } }, "Users": { "type": "array", "items": { "type": "object", "properties": { "UserID": { "type": "integer", "format": "int32" }, "Status": { "type": "string" }, "DisabledOnDate": { "type": "string", "format": "date-time" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "LoginName": { "type": "string" }, "CorrespondenceEmailAddress": { "type": "string" }, "PhoneNumber": { "type": "string" }, "EnableSAMLDirectLogin": { "type": "boolean" }, "BillingAccess": { "type": "boolean" } } } }, "ProfileIDs": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "text/json": { "schema": { "type": "object", "properties": { "GroupID": { "type": "integer", "format": "int32" }, "GroupName": { "type": "string" }, "IsAdmin": { "type": "boolean" }, "Modules": { "type": "array", "items": { "type": "object", "properties": { "ModuleID": { "type": "integer", "format": "int32" }, "Name": { "type": "string" }, "Description": { "type": "string" } } } }, "Users": { "type": "array", "items": { "type": "object", "properties": { "UserID": { "type": "integer", "format": "int32" }, "Status": { "type": "string" }, "DisabledOnDate": { "type": "string", "format": "date-time" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "LoginName": { "type": "string" }, "CorrespondenceEmailAddress": { "type": "string" }, "PhoneNumber": { "type": "string" }, "EnableSAMLDirectLogin": { "type": "boolean" }, "BillingAccess": { "type": "boolean" } } } }, "ProfileIDs": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized to access the specified profile", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "Group not found", "content": { "application/json": { }, "text/json": { } } } } } }, "/oauth2/identity": { "get": { "tags": [ "Identity" ], "summary": "Get", "operationId": "Identity_Get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ViewClaimModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ViewClaimModel" } } } } } } } }, "/ip-ranges": { "get": { "tags": [ "IpRanges" ], "summary": "Get", "operationId": "IpRanges_Get", "parameters": [ { "name": "bypassCache", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } } }, "/v1/listings/siteaccount/{siteAccountId}": { "get": { "tags": [ "Listings" ], "summary": "Get Listings By Customer Channel ID", "operationId": "Listings_GetListingsByCustomerChannelID", "parameters": [ { "name": "siteAccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pagesize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Collection of marketplace listings for the provided Site Account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingProduct]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingProduct]" } } } }, "400": { "description": "ProfileID is required when the integration has access to multiple profiles.", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/listings/productid/{productId}": { "get": { "tags": [ "Listings" ], "summary": "Get Listings By Product ID", "operationId": "Listings_GetListingsByProductID", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pagesize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Collection of marketplace listings for the provided item id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingProduct]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingProduct]" } } } }, "400": { "description": "ProfileID is required when the integration has access to multiple profiles.", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/listings/siteaccount/{siteAccountId}/productid/{productId}": { "get": { "tags": [ "Listings" ], "summary": "Get Listings By Customer Channel ID And Product ID", "operationId": "Listings_GetListingsByCustomerChannelIDAndProductID", "parameters": [ { "name": "siteAccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pagesize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Collection of marketplace listings for the provided site account id and item id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingProduct]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingProduct]" } } } }, "400": { "description": "ProfileID is required when the integration has access to multiple profiles.", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/listings/siteaccount/{siteAccountId}/errors": { "get": { "tags": [ "Listings" ], "summary": "Get Listings Errors By Customer Channel ID", "operationId": "Listings_GetListingsErrorsByCustomerChannelID", "parameters": [ { "name": "siteAccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pagesize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Collection of marketplace listings with errors for the provided site account id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingProduct]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingProduct]" } } } }, "400": { "description": "ProfileID is required when the integration has access to multiple profiles.", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/listings/productid/{productId}/errors": { "get": { "tags": [ "Listings" ], "summary": "Get Listings Errors By Product ID", "operationId": "Listings_GetListingsErrorsByProductID", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pagesize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Collection of marketplace listings with errors for the provided item id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingProduct]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingProduct]" } } } }, "400": { "description": "ProfileID is required when the integration has access to multiple profiles.", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/listings/siteaccount/{siteAccountId}/productid/{productId}/errors": { "get": { "tags": [ "Listings" ], "summary": "Get Listings Errors By Customer Channel ID And Product ID", "operationId": "Listings_GetListingsErrorsByCustomerChannelIDAndProductID", "parameters": [ { "name": "siteAccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pagesize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Collection of marketplace listings with errors for the provided site account id and item id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingProduct]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingProduct]" } } } }, "400": { "description": "ProfileID is required when the integration has access to multiple profiles.", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/listingserrorsrollup/siteaccount/{siteAccountId}": { "get": { "tags": [ "Listings" ], "summary": "Get Listings Errors Rollup By Customer Channel ID", "operationId": "Listings_GetListingsErrorsRollupByCustomerChannelID", "parameters": [ { "name": "siteAccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pagesize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Collection of marketplace listings error rollups for the provided site account id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingErrorRollupProduct]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingErrorRollupProduct]" } } } }, "400": { "description": "ProfileID is required when the integration has access to multiple profiles.", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/listingserrorsrollup/siteaccount/{siteAccountId}/{errorRollupId}/errors": { "get": { "tags": [ "Listings" ], "summary": "Get Listings Errors By Customer Channel ID And Rollup ID And Severity", "operationId": "Listings_GetListingsErrorsByCustomerChannelIDAndRollupIDAndSeverity", "parameters": [ { "name": "siteAccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "errorRollupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pagesize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Collection of marketplace listings with errors for the provided site account id and error rollup id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingProduct]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingProduct]" } } } }, "400": { "description": "ProfileID is required when the integration has access to multiple profiles.", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/listingserrorsrollup/siteaccount/{siteAccountId}/{errorRollupId}/listed": { "get": { "tags": [ "Listings" ], "summary": "Get Listings Errors By Customer Channel ID And Rollup ID Listed", "operationId": "Listings_GetListingsErrorsByCustomerChannelIDAndRollupIDListed", "parameters": [ { "name": "siteAccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "errorRollupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pagesize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Collection of marketplace listings with errors that are listed for the provided site account id and error rollup id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingProduct]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingProduct]" } } } }, "400": { "description": "ProfileID is required when the integration has access to multiple profiles.", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/listingserrorsrollup/siteaccount/{siteAccountId}/{errorRollupId}/notlisted": { "get": { "tags": [ "Listings" ], "summary": "Get Listings Errors By Customer Channel ID And Rollup ID Not Listed", "operationId": "Listings_GetListingsErrorsByCustomerChannelIDAndRollupIDNotListed", "parameters": [ { "name": "siteAccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "errorRollupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pagesize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Collection of marketplace listings with errors that are not listed for the provided site account id and error rollup id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingProduct]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ApiListingProduct]" } } } }, "400": { "description": "ProfileID is required when the integration has access to multiple profiles.", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/ProductExport": { "get": { "tags": [ "ProductExport" ], "summary": "Check Status", "operationId": "ProductExport_CheckStatus", "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Export Status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExportStatus" } } } }, "400": { "description": "Usually caused by an invalid token", "content": { "application/json": { }, "text/json": { } } }, "410": { "description": "File has been archived", "content": { "application/json": { }, "text/json": { } } } } }, "post": { "tags": [ "ProductExport" ], "summary": "Start Product Export", "description": "Queues a new product export job. Exports are processed asynchronously — the response body contains a token you use to poll for status and retrieve the download URL.\n\n**Request body (optional):** Send a `text/plain` body containing a comma-separated list of field names to include in the export. If the body is omitted or empty, all available fields are exported.\n\nField name examples: `id`, `sku`, `title`, `totalquantity`, `attr:size`, `attr:color`\n\n**Output format:** The exported file is tab-delimited.\n\n**Note:** Do not send a JSON body to this endpoint — the Content-Type must be `text/plain` if a body is provided. Sending `application/json` will cause unexpected failures.", "operationId": "ProductExport.ExportFile", "parameters": [ { "name": "$filter", "in": "query", "description": "OData-style filter expression to select which products to export (e.g. `$filter=ProfileID eq 12345`).", "schema": { "type": "string" } }, { "name": "profileId", "in": "query", "description": "Optional profile ID. If omitted, uses the profile associated with the access token.", "schema": { "type": "integer" } } ], "requestBody": { "description": "Comma-separated list of field names to include in the exported file. Omit the body to export all fields.", "content": { "text/plain": { "schema": { "type": "string", "description": "Comma-separated field names. Example: `id,sku,title,totalquantity,attr:size`" }, "example": "id,sku,title,totalquantity,attr:size,attr:color" } } }, "responses": { "200": { "description": "Export job accepted. Response body contains the export token. Use `GET /v1/ProductExport?token={token}` to poll for status.", "content": { "application/json": { "schema": { "type": "string", "description": "Export token string." } } } } } } }, "/v1/ProductUpload": { "get": { "tags": [ "ProductUpload" ], "summary": "Check Status", "operationId": "ProductUpload_CheckStatus", "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Upload Status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadStatus" } } } }, "400": { "description": "Usually caused by an invalid token", "content": { "application/json": { }, "text/json": { } } } } }, "post": { "tags": [ "ProductUpload" ], "summary": "Upload File", "operationId": "ProductUpload_UploadFile", "parameters": [ { "name": "profileId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "templateCode", "in": "query", "schema": { "type": "string" } }, { "name": "importType", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "uploadFile" ], "type": "object", "properties": { "uploadFile": { "type": "string", "description": "upload file", "format": "binary" } } } } } }, "responses": { "200": { "description": "Upload File Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadStatus" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { }, "text/json": { } } }, "429": { "description": "429", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/seller/details": { "get": { "tags": [ "SellerDetail" ], "summary": "Get", "operationId": "SellerDetail_Get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } } } } }, "/v1/shipping/mappings/inbound": { "get": { "tags": [ "Shipping" ], "summary": "Get Inbound", "operationId": "Shipping_GetInbound", "parameters": [ { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pagesize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "A page of inbound shipping mappings for the authorized profile(s).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResult[InboundShippingMappingModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResult[InboundShippingMappingModel]" } } } }, "400": { "description": "page or pagesize is out of range.", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "The token is not authorized for the requested profile.", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/shipping/mappings/outbound": { "get": { "tags": [ "Shipping" ], "summary": "Get Outbound", "operationId": "Shipping_GetOutbound", "parameters": [ { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "siteid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "carrierid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "classid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pagesize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "A page of outbound (channel) shipping mappings for the authorized profile(s).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResult[OutboundShippingMappingModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResult[OutboundShippingMappingModel]" } } } }, "400": { "description": "carrierid or classid was supplied without siteid, or page/pagesize is out of range.", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "The token is not authorized for the requested profile.", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/shipping/methods": { "get": { "tags": [ "Shipping" ], "summary": "Get Methods", "operationId": "Shipping_GetMethods", "parameters": [ { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pagesize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "A page of shipping methods for the authorized profile(s).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ShippingMethodModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResult[ShippingMethodModel]" } } } }, "400": { "description": "page or pagesize is out of range.", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "The token is not authorized for the requested profile.", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/Streams": { "get": { "tags": [ "Streams" ], "summary": "Returns all streams associated with the API integration", "operationId": "Streams_GetStreams", "responses": { "200": { "description": "Returns all streams for the integration", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StreamModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StreamModel" } } } } }, "204": { "description": "NoContent", "content": { "application/json": { }, "text/json": { } } } } }, "post": { "tags": [ "Streams" ], "summary": "Create a new stream for the API integration", "operationId": "Streams_Post", "requestBody": { "description": "Stream to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StreamModel" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/StreamModel" } } }, "required": true, "x-bodyName": "stream" }, "responses": { "201": { "description": "Returns created stream", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StreamModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/Streams({streamID})": { "get": { "tags": [ "Streams" ], "summary": "Returns a single stream object by ID", "operationId": "Streams_GetStream", "parameters": [ { "name": "streamID", "in": "path", "description": "Stream ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Returns stream by ID", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StreamModel" } } } }, "404": { "description": "NotFound", "content": { "application/json": { }, "text/json": { } } } } }, "delete": { "tags": [ "Streams" ], "summary": "Delete a stream", "operationId": "Streams_DeleteStream", "parameters": [ { "name": "streamID", "in": "path", "description": "Stream ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "NoContent", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "NotFound", "content": { "application/json": { }, "text/json": { } } } } }, "patch": { "tags": [ "Streams" ], "summary": "Update an existing stream", "operationId": "Streams_Patch", "parameters": [ { "name": "streamID", "in": "path", "description": "Stream ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Updated stream", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StreamModel" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/StreamModel" } } }, "required": true, "x-bodyName": "stream" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { }, "text/json": { } } }, "400": { "description": "BadRequest", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/Streams({streamID})/{startingPostion}": { "get": { "tags": [ "Streams" ], "summary": "Return a list of stream events starting from the supplied starting position.", "operationId": "Streams_GetEventsByStartingPosition", "parameters": [ { "name": "streamID", "in": "path", "description": "Stream ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "startingPostion", "in": "path", "description": "Starting positiong. This value is inclusive", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Returns stream events starting at startingPosition", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventModel" } } } } }, "204": { "description": "No more events left to process", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/Streams({streamID})/Event/{positionID}": { "get": { "tags": [ "Streams" ], "summary": "Returns a stream event from the supplied position", "operationId": "Streams_GetSpecificStreamEvent", "parameters": [ { "name": "streamID", "in": "path", "description": "Stream ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "positionID", "in": "path", "description": "Event positon", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Returns specific stream event at positionID", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventModel" } } } }, "204": { "description": "No event found", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/TrackingUpload": { "get": { "tags": [ "TrackingUpload" ], "summary": "Check Status", "operationId": "TrackingUpload_CheckStatus", "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Upload Status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackingUploadFileStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackingUploadFileStatus" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { }, "text/json": { } } } } }, "post": { "tags": [ "TrackingUpload" ], "summary": "Upload File", "operationId": "TrackingUpload_UploadFile", "parameters": [ { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "templatecode", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "uploadFile" ], "type": "object", "properties": { "uploadFile": { "type": "string", "description": "upload file", "format": "binary" } } } } } }, "responses": { "200": { "description": "Upload Status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackingUploadFileStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackingUploadFileStatus" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { }, "text/json": { } } }, "429": { "description": "429", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/users": { "get": { "tags": [ "Users" ], "summary": "Retrieves a paged list of users.", "description": "Example request:\n```http\n GET /v1/users?profileid=12000000&page=1&pagesize=25&search=FirstName:\"Alice\"\n```\n\nSearchable fields:\n- UserID (number)\n- Status (string)\n- LoginName (string)\n- DisabledOnDate (date)\n- FirstName (string)\n- LastName (string)\n- CorrespondenceEmailAddress (string)\n- PhoneNumber (string)\n- EnableSAMLDirectLogin (boolean)\n- BillingAccess (boolean)\n- Groups.GroupID (number)\n- Groups.GroupName (string)\n- Groups.IsAdmin (boolean)\n\nSupported operators:\n- Strings: \":\" (exact). Values must be in quotes, e.g. FirstName:\"Alice\" or LoginName:\"asmith\". Negate with leading '-', e.g. -FirstName:\"Alice\".\n- Numbers/Dates: =, >, >=, <, <= (e.g. UserID>100, DisabledOnDate>=2025-01-01)\n- Booleans: \":\" with \"true\"/\"false\" in quotes (e.g. BillingAccess:\"true\"), negate with '-'\n- Null checks: field:null or -field:null (is null / is not null)\n- Combine with AND / OR (case-insensitive)\n\nValidation errors:\n- 400 InvalidPage: Page must be a positive integer.\n- 400 InvalidPageSize: Pagesize must be between 1 and 100.\n- 400 ProfileRequired: ProfileID is required when the integration has access to multiple profiles.\n- 401 Unauthorized: Access to the profile is not allowed.", "operationId": "UserManagement_GetUsers", "parameters": [ { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "description": "1-based page number. Must be a positive integer.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pagesize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "search", "in": "query", "description": "Optional advanced search query.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Paged list of users", "content": { "application/json": { "schema": { "type": "object", "properties": { "Items": { "type": "array", "items": { "type": "object", "properties": { "UserID": { "type": "integer", "format": "int32" }, "Status": { "type": "string" }, "DisabledOnDate": { "type": "string", "format": "date-time" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "LoginName": { "type": "string" }, "CorrespondenceEmailAddress": { "type": "string" }, "PhoneNumber": { "type": "string" }, "EnableSAMLDirectLogin": { "type": "boolean" }, "BillingAccess": { "type": "boolean" }, "Groups": { "type": "array", "items": { "type": "object", "properties": { "GroupID": { "type": "integer", "format": "int32" }, "GroupName": { "type": "string" }, "IsAdmin": { "type": "boolean" } } } } } } }, "Metadata": { "type": "object", "properties": { "Page": { "type": "integer", "format": "int32" }, "PageSize": { "type": "integer", "format": "int32" }, "TotalItems": { "type": "integer", "format": "int32" } } } } } }, "text/json": { "schema": { "type": "object", "properties": { "Items": { "type": "array", "items": { "type": "object", "properties": { "UserID": { "type": "integer", "format": "int32" }, "Status": { "type": "string" }, "DisabledOnDate": { "type": "string", "format": "date-time" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "LoginName": { "type": "string" }, "CorrespondenceEmailAddress": { "type": "string" }, "PhoneNumber": { "type": "string" }, "EnableSAMLDirectLogin": { "type": "boolean" }, "BillingAccess": { "type": "boolean" }, "Groups": { "type": "array", "items": { "type": "object", "properties": { "GroupID": { "type": "integer", "format": "int32" }, "GroupName": { "type": "string" }, "IsAdmin": { "type": "boolean" } } } } } } }, "Metadata": { "type": "object", "properties": { "Page": { "type": "integer", "format": "int32" }, "PageSize": { "type": "integer", "format": "int32" }, "TotalItems": { "type": "integer", "format": "int32" } } } } } } } }, "400": { "description": "Invalid paging or profile requirement not met", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized to access the specified profile", "content": { "application/json": { }, "text/json": { } } } } }, "post": { "tags": [ "Users" ], "summary": "Creates a new user.", "description": "Required fields: FirstName, LastName, LoginName, GroupIDs (must contain at least one ID).\nOptional fields: PhoneNumber, CorrespondenceEmailAddress, BillingAccess, EnableSAMLDirectLogin, Enabled, DisableOnDate.\n\nNotes:\n- If CorrespondenceEmailAddress is not provided, LoginName is used for correspondence.\n- If Enabled is not provided, the user is created as Active. Set Enabled=false to create the user in a Disabled state.\n\nExample request body:\n```json\n {\n \"FirstName\": \"Alice\",\n \"LastName\": \"Smith\",\n \"LoginName\": \"asmith@example.com\",\n \"CorrespondenceEmailAddress\": \"asmithnotifications@example.com\",\n \"GroupIDs\": [ 100, 101 ]\n }\n```\n\nOn success, returns 201 Created with the full user object in the response body.\nThe Groups field in the response is populated with the groups assigned during creation,\nincluding GroupID, GroupName, and IsAdmin for each group.\nThe Location response header contains the URI of the newly created user (e.g., /v1/users/12345).", "operationId": "UserManagement_CreateUser", "parameters": [ { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "User creation payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } } }, "required": true, "x-bodyName": "request" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "201": { "description": "User was created", "content": { "application/json": { "schema": { "type": "object", "properties": { "UserID": { "type": "integer", "format": "int32" }, "Status": { "type": "string" }, "DisabledOnDate": { "type": "string", "format": "date-time" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "LoginName": { "type": "string" }, "CorrespondenceEmailAddress": { "type": "string" }, "PhoneNumber": { "type": "string" }, "EnableSAMLDirectLogin": { "type": "boolean" }, "BillingAccess": { "type": "boolean" }, "Groups": { "type": "array", "items": { "type": "object", "properties": { "GroupID": { "type": "integer", "format": "int32" }, "GroupName": { "type": "string" }, "IsAdmin": { "type": "boolean" } } } } } } }, "text/json": { "schema": { "type": "object", "properties": { "UserID": { "type": "integer", "format": "int32" }, "Status": { "type": "string" }, "DisabledOnDate": { "type": "string", "format": "date-time" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "LoginName": { "type": "string" }, "CorrespondenceEmailAddress": { "type": "string" }, "PhoneNumber": { "type": "string" }, "EnableSAMLDirectLogin": { "type": "boolean" }, "BillingAccess": { "type": "boolean" }, "Groups": { "type": "array", "items": { "type": "object", "properties": { "GroupID": { "type": "integer", "format": "int32" }, "GroupName": { "type": "string" }, "IsAdmin": { "type": "boolean" } } } } } } } } }, "400": { "description": "Missing or invalid fields", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized to access the specified profile", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/users/{id}": { "get": { "tags": [ "Users" ], "summary": "Retrieves a user by ID.", "description": "Example request:\n```http\n GET /v1/users/42?profileid=12000000\n```", "operationId": "UserManagement_GetUserById", "parameters": [ { "name": "id", "in": "path", "description": "User ID.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "User found", "content": { "application/json": { "schema": { "type": "object", "properties": { "UserID": { "type": "integer", "format": "int32" }, "Status": { "type": "string" }, "DisabledOnDate": { "type": "string", "format": "date-time" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "LoginName": { "type": "string" }, "CorrespondenceEmailAddress": { "type": "string" }, "PhoneNumber": { "type": "string" }, "EnableSAMLDirectLogin": { "type": "boolean" }, "BillingAccess": { "type": "boolean" }, "Groups": { "type": "array", "items": { "type": "object", "properties": { "GroupID": { "type": "integer", "format": "int32" }, "GroupName": { "type": "string" }, "IsAdmin": { "type": "boolean" } } } } } } }, "text/json": { "schema": { "type": "object", "properties": { "UserID": { "type": "integer", "format": "int32" }, "Status": { "type": "string" }, "DisabledOnDate": { "type": "string", "format": "date-time" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "LoginName": { "type": "string" }, "CorrespondenceEmailAddress": { "type": "string" }, "PhoneNumber": { "type": "string" }, "EnableSAMLDirectLogin": { "type": "boolean" }, "BillingAccess": { "type": "boolean" }, "Groups": { "type": "array", "items": { "type": "object", "properties": { "GroupID": { "type": "integer", "format": "int32" }, "GroupName": { "type": "string" }, "IsAdmin": { "type": "boolean" } } } } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized to access the specified profile", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "User not found", "content": { "application/json": { }, "text/json": { } } } } }, "patch": { "tags": [ "Users" ], "summary": "Partially updates an existing user.", "description": "Validation notes:\n- LoginName, FirstName, LastName cannot be empty strings if provided.\n- PhoneNumber may be cleared by providing an empty string.\n\nExample request body (PATCH):\n```json\n {\n \"FirstName\": \"Updated\",\n \"EnableSAMLDirectLogin\": true\n }\n```", "operationId": "UserManagement_PatchUser", "parameters": [ { "name": "id", "in": "path", "description": "User ID.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Fields to update. Omitted properties are unchanged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUserRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UpdateUserRequest" } } }, "required": true, "x-bodyName": "request" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "204": { "description": "User updated successfully", "content": { "application/json": { }, "text/json": { } } }, "400": { "description": "Invalid patch payload", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized to access the specified profile", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "User not found", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/users/{id}/groups": { "put": { "tags": [ "Users" ], "summary": "Replaces the user's group memberships with the specified Group IDs.", "description": "Validation:\n- GroupIDs are required and cannot be empty.\n- All existing groups will be removed and replaced by the provided list.\n\nExample request body:\n```json\n { \"GroupIDs\": [ 100, 200, 300 ] }\n```\n\nResponses:\n- 204 No Content: Groups replaced successfully.\n- 400 Bad Request: Missing/empty GroupIDs.\n- 401 Unauthorized: Access to the profile is not allowed.\n- 404 Not Found: User not found.", "operationId": "UserManagement_ReplaceUserGroups", "parameters": [ { "name": "id", "in": "path", "description": "User ID.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Payload containing GroupIDs to set. Required; must contain at least one ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupsRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/GroupsRequest" } } }, "required": true, "x-bodyName": "request" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "204": { "description": "Groups replaced successfully", "content": { "application/json": { }, "text/json": { } } }, "400": { "description": "Missing or invalid GroupIDs", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized to access the specified profile", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "User not found", "content": { "application/json": { }, "text/json": { } } } } }, "delete": { "tags": [ "Users" ], "summary": "Removes the specified groups from the user's membership.", "description": "Validation: You cannot remove all groups. At least one group must remain.\n\nExample request body:\n```json\n { \"GroupIDs\": [ 200, 300 ] }\n```", "operationId": "UserManagement_RemoveUserGroups", "parameters": [ { "name": "id", "in": "path", "description": "User ID.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "List of GroupIDs to remove.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupsRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/GroupsRequest" } } }, "required": true, "x-bodyName": "request" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "204": { "description": "Groups removed successfully", "content": { "application/json": { }, "text/json": { } } }, "400": { "description": "Invalid group list or attempt to remove all groups", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized to access the specified profile", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "User not found", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/users/{id}/disable": { "post": { "tags": [ "Users" ], "summary": "Disables a user (or sets a future disable date).", "description": "If no date is provided, the user's status is set to Disabled immediately.\n\nExample request body:\n```json\n { \"DisableOnDate\": \"2025-01-31T00:00:00Z\" }\n```", "operationId": "UserManagement_DisableUser", "parameters": [ { "name": "id", "in": "path", "description": "User ID.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Optional disable date. If provided, only DisabledOnDate is set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisableUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DisableUserRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DisableUserRequest" } } }, "required": true, "x-bodyName": "request" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "204": { "description": "User disabled or disable date set", "content": { "application/json": { }, "text/json": { } } }, "400": { "description": "Invalid request", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized to access the specified profile", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "User not found", "content": { "application/json": { }, "text/json": { } } } } } }, "/v1/users/{userId}/groups/{groupId}/modules": { "get": { "tags": [ "Users" ], "summary": "Retrieves a paged list of modules for a user in a specific group.", "description": "Example request:\n```http\n GET /v1/users/42/groups/100/modules\n```\n\nResponses:\n- 200 OK: PagedResult of modules.\n- 401 Unauthorized: Profile access denied or user not a member of the group.\n- 400 Bad Request: Invalid paging parameters or missing profileid when multiple profiles are available.", "operationId": "UserManagement_GetModulesForUserGroup", "parameters": [ { "name": "userId", "in": "path", "description": "User ID.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "groupId", "in": "path", "description": "Group ID.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "profileid", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "description": "1-based page number. Must be a positive integer.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pagesize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Paged list of security modules for the user & group", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResult[SecurityModule]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PagedResult[SecurityModule]" } } } }, "400": { "description": "Invalid paging or profile requirement not met", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized to access the specified profile or user not in group", "content": { "application/json": { }, "text/json": { } } } } } } }, "components": { "schemas": { "Core.ODataErrors.ODataError": { "required": [ "error" ], "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Core.ODataErrors.MainError" } } }, "Core.ODataErrors.MainError": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string", "x-ms-primary-error-message": true }, "target": { "type": [ "null", "string" ] }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/Core.ODataErrors.ErrorDetails" } }, "innerError": { "$ref": "#/components/schemas/Core.ODataErrors.InnerError" } } }, "Core.ODataErrors.ErrorDetails": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "target": { "type": [ "null", "string" ] } } }, "Core.ODataErrors.InnerError": { "type": "object", "description": "The structure of this object is service-specific" }, "ODataCountResponse": { "type": "number", "format": "int64" }, "StringCollectionResponse": { "title": "Collection of string", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "type": "string" } } } } ] }, "ReferenceUpdate": { "type": "object", "properties": { "@odata.id": { "type": "string" }, "@odata.type": { "type": [ "null", "string" ] } } }, "ReferenceCreate": { "type": "object", "properties": { "@odata.id": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "ReferenceNumeric": { "enum": [ "-INF", "INF", "NaN" ], "type": [ "null", "string" ] }, "BaseCollectionPaginationCountResponse": { "title": "Base collection pagination and count responses", "type": "object", "properties": { "@odata.count": { "type": [ "null", "number" ], "format": "int64" }, "@odata.nextLink": { "type": [ "null", "string" ] } } }, "ChannelAdvisor.RestApi.V1.Models.ShippingBusinessHour": { "title": "ShippingBusinessHour", "type": "object", "properties": { "DayOfWeek": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.DayOfWeek" }, "BusinessHours": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OpenInterval" } } }, "example": { "DayOfWeek": "Sunday", "BusinessHours": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OpenInterval" } ] } }, "ChannelAdvisor.RestApi.V1.Models.OpenInterval": { "title": "OpenInterval", "type": "object", "properties": { "StartTime": { "type": [ "null", "string" ] }, "EndTime": { "type": [ "null", "string" ] } }, "example": { "StartTime": "string", "EndTime": "string" } }, "ChannelAdvisor.RestApi.V1.Models.ShippingOverride": { "title": "ShippingOverride", "type": "object", "properties": { "Sku": { "type": [ "null", "string" ] }, "Quantity": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "DistributionCenterID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ShippingCarrier": { "type": [ "null", "string" ] }, "ShippingClass": { "type": [ "null", "string" ] }, "TrackingNumber": { "type": [ "null", "string" ] }, "TrackingUrl": { "type": [ "null", "string" ] }, "SellerFulfillmentID": { "type": [ "null", "string" ] }, "ShippedDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "ApplyShippingRules": { "type": "boolean" }, "EstimatedShipDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" } }, "example": { "Sku": "string", "Quantity": 0, "DistributionCenterID": 0, "ShippingCarrier": "string", "ShippingClass": "string", "TrackingNumber": "string", "TrackingUrl": "string", "SellerFulfillmentID": "string", "ShippedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "ApplyShippingRules": true, "EstimatedShipDateUtc": "0001-01-01T00:00:00.0000000+00:00" } }, "ChannelAdvisor.RestApi.V1.Models.OrderItemSubstitution": { "title": "OrderItemSubstitution", "type": "object", "properties": { "OriginalItem": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OriginalItem" }, "ReplacementItems": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ReplacementItem" } }, "Reason": { "maxLength": 500, "type": [ "null", "string" ] } }, "example": { "OriginalItem": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OriginalItem" }, "ReplacementItems": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ReplacementItem" } ], "Reason": "string" } }, "ChannelAdvisor.RestApi.V1.Models.OriginalItem": { "title": "OriginalItem", "type": "object", "properties": { "OrderItemID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "Sku": { "type": [ "null", "string" ] }, "Quantity": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" } }, "example": { "OrderItemID": 0, "Sku": "string", "Quantity": 0 } }, "ChannelAdvisor.RestApi.V1.Models.ReplacementItem": { "title": "ReplacementItem", "type": "object", "properties": { "Sku": { "type": [ "null", "string" ] }, "ProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "Quantity": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "Title": { "type": [ "null", "string" ] }, "UnitPrice": { "type": "number", "format": "decimal" }, "TaxPrice": { "type": "number", "format": "decimal" }, "ShippingPrice": { "type": "number", "format": "decimal" }, "ShippingTaxPrice": { "type": "number", "format": "decimal" }, "RecyclingFee": { "type": "number", "format": "decimal" }, "ShippingOverride": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ShippingOverride" }, { "type": "null" } ] }, "Promotions": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Promotion" }, "x-ms-navigationProperty": true } }, "example": { "Sku": "string", "ProductID": 0, "Quantity": 0, "Title": "string", "UnitPrice": 0, "TaxPrice": 0, "ShippingPrice": 0, "ShippingTaxPrice": 0, "RecyclingFee": 0, "ShippingOverride": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ShippingOverride" }, "Promotions": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Promotion" } ] } }, "ChannelAdvisor.RestApi.V1.Models.Order": { "title": "Order", "type": "object", "properties": { "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "SiteID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "SiteName": { "type": [ "null", "string" ] }, "UserDataPresent": { "type": "number", "format": "uint8" }, "UserDataRemovalDateUTC": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "SiteAccountID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "SiteOrderID": { "type": [ "null", "string" ] }, "SecondarySiteOrderID": { "type": [ "null", "string" ] }, "SellerOrderID": { "type": [ "null", "string" ] }, "CheckoutSourceID": { "type": [ "null", "number" ], "format": "uint8" }, "Currency": { "type": [ "null", "string" ] }, "CreatedDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": "string", "format": "date-time" }, "ImportDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": "string", "format": "date-time" }, "UpdatedDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "PublicNotes": { "type": [ "null", "string" ] }, "PrivateNotes": { "type": [ "null", "string" ] }, "SpecialInstructions": { "type": [ "null", "string" ] }, "TotalPrice": { "type": "number", "format": "decimal" }, "TotalTaxPrice": { "type": "number", "format": "decimal" }, "TotalShippingPrice": { "type": "number", "format": "decimal" }, "TotalShippingTaxPrice": { "type": [ "null", "number" ], "format": "decimal" }, "TotalInsurancePrice": { "type": "number", "format": "decimal" }, "TotalGiftOptionPrice": { "type": [ "null", "number" ], "format": "decimal" }, "TotalGiftOptionTaxPrice": { "type": [ "null", "number" ], "format": "decimal" }, "AdditionalCostOrDiscount": { "type": "number", "format": "decimal" }, "EstimatedShipDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "DeliverByDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "RequestedShippingCarrier": { "type": [ "null", "string" ] }, "RequestedShippingClass": { "type": [ "null", "string" ] }, "ResellerID": { "type": [ "null", "string" ] }, "FlagID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "FlagDescription": { "type": [ "null", "string" ] }, "OrderTags": { "type": [ "null", "string" ] }, "DistributionCenterTypeRollup": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.DistributionCenterRollupType" }, "CheckoutStatus": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.CheckoutStatus" }, "PaymentStatus": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.PaymentStatus" }, "ShippingStatus": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ShippingStatus" }, "CheckoutDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "PaymentDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "ShippingDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "BuyerUserId": { "type": [ "null", "string" ] }, "BuyerEmailAddress": { "type": [ "null", "string" ] }, "BuyerEmailOptIn": { "type": [ "null", "boolean" ] }, "OrderTaxType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.TaxType" }, "ShippingTaxType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.TaxType" }, "GiftOptionsTaxType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.TaxType" }, "PaymentMethod": { "type": [ "null", "string" ] }, "PaymentTransactionID": { "type": [ "null", "string" ] }, "PaymentPaypalAccountID": { "type": [ "null", "string" ] }, "PaymentCreditCardLast4": { "type": [ "null", "string" ] }, "PaymentMerchantReferenceNumber": { "type": [ "null", "string" ] }, "ShippingTitle": { "type": [ "null", "string" ] }, "ShippingFirstName": { "type": [ "null", "string" ] }, "ShippingLastName": { "type": [ "null", "string" ] }, "ShippingSuffix": { "type": [ "null", "string" ] }, "ShippingCompanyName": { "type": [ "null", "string" ] }, "ShippingCompanyJobTitle": { "type": [ "null", "string" ] }, "ShippingDaytimePhone": { "type": [ "null", "string" ] }, "ShippingEveningPhone": { "type": [ "null", "string" ] }, "ShippingAddressLine1": { "type": [ "null", "string" ] }, "ShippingAddressLine2": { "type": [ "null", "string" ] }, "ShippingCity": { "type": [ "null", "string" ] }, "ShippingStateOrProvince": { "type": [ "null", "string" ] }, "ShippingStateOrProvinceName": { "type": [ "null", "string" ] }, "ShippingPostalCode": { "type": [ "null", "string" ] }, "ShippingCountry": { "type": [ "null", "string" ] }, "BillingTitle": { "type": [ "null", "string" ] }, "BillingFirstName": { "type": [ "null", "string" ] }, "BillingLastName": { "type": [ "null", "string" ] }, "BillingSuffix": { "type": [ "null", "string" ] }, "BillingCompanyName": { "type": [ "null", "string" ] }, "BillingCompanyJobTitle": { "type": [ "null", "string" ] }, "BillingDaytimePhone": { "type": [ "null", "string" ] }, "BillingEveningPhone": { "type": [ "null", "string" ] }, "BillingAddressLine1": { "type": [ "null", "string" ] }, "BillingAddressLine2": { "type": [ "null", "string" ] }, "BillingCity": { "type": [ "null", "string" ] }, "BillingStateOrProvince": { "type": [ "null", "string" ] }, "BillingStateOrProvinceName": { "type": [ "null", "string" ] }, "BillingPostalCode": { "type": [ "null", "string" ] }, "BillingCountry": { "type": [ "null", "string" ] }, "PromotionCode": { "type": [ "null", "string" ] }, "PromotionAmount": { "type": "number", "format": "decimal" }, "ShippingAddressType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ShippingAddressType" }, "ShippingBusinessHours": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ShippingBusinessHour" } }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItem" }, "x-ms-navigationProperty": true }, "Fulfillments": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Fulfillment" }, "x-ms-navigationProperty": true }, "Adjustments": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderAdjustment" }, "x-ms-navigationProperty": true }, "CustomFields": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.CustomField" }, "x-ms-navigationProperty": true }, "OrderAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderAttributeValue" }, "x-ms-navigationProperty": true }, "Tags": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Tag" }, "x-ms-navigationProperty": true }, "Exports": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ExportStatus" }, "x-ms-navigationProperty": true }, "ChannelDocuments": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ChannelDocument" }, "x-ms-navigationProperty": true } }, "example": { "ID": 0, "ProfileID": 0, "SiteID": 0, "SiteName": "string", "UserDataPresent": 0, "UserDataRemovalDateUTC": "0001-01-01T00:00:00.0000000+00:00", "SiteAccountID": 0, "SiteOrderID": "string", "SecondarySiteOrderID": "string", "SellerOrderID": "string", "CheckoutSourceID": 0, "Currency": "string", "CreatedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "ImportDateUtc": "0001-01-01T00:00:00.0000000+00:00", "UpdatedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "PublicNotes": "string", "PrivateNotes": "string", "SpecialInstructions": "string", "TotalPrice": 0, "TotalTaxPrice": 0, "TotalShippingPrice": 0, "TotalShippingTaxPrice": 0, "TotalInsurancePrice": 0, "TotalGiftOptionPrice": 0, "TotalGiftOptionTaxPrice": 0, "AdditionalCostOrDiscount": 0, "EstimatedShipDateUtc": "0001-01-01T00:00:00.0000000+00:00", "DeliverByDateUtc": "0001-01-01T00:00:00.0000000+00:00", "RequestedShippingCarrier": "string", "RequestedShippingClass": "string", "ResellerID": "string", "FlagID": 0, "FlagDescription": "string", "OrderTags": "string", "DistributionCenterTypeRollup": "SellerManaged", "CheckoutStatus": "NotVisited", "PaymentStatus": "NotYetSubmitted", "ShippingStatus": "Unshipped", "CheckoutDateUtc": "0001-01-01T00:00:00.0000000+00:00", "PaymentDateUtc": "0001-01-01T00:00:00.0000000+00:00", "ShippingDateUtc": "0001-01-01T00:00:00.0000000+00:00", "BuyerUserId": "string", "BuyerEmailAddress": "string", "BuyerEmailOptIn": true, "OrderTaxType": "NoTax", "ShippingTaxType": "NoTax", "GiftOptionsTaxType": "NoTax", "PaymentMethod": "string", "PaymentTransactionID": "string", "PaymentPaypalAccountID": "string", "PaymentCreditCardLast4": "string", "PaymentMerchantReferenceNumber": "string", "ShippingTitle": "string", "ShippingFirstName": "string", "ShippingLastName": "string", "ShippingSuffix": "string", "ShippingCompanyName": "string", "ShippingCompanyJobTitle": "string", "ShippingDaytimePhone": "string", "ShippingEveningPhone": "string", "ShippingAddressLine1": "string", "ShippingAddressLine2": "string", "ShippingCity": "string", "ShippingStateOrProvince": "string", "ShippingStateOrProvinceName": "string", "ShippingPostalCode": "string", "ShippingCountry": "string", "BillingTitle": "string", "BillingFirstName": "string", "BillingLastName": "string", "BillingSuffix": "string", "BillingCompanyName": "string", "BillingCompanyJobTitle": "string", "BillingDaytimePhone": "string", "BillingEveningPhone": "string", "BillingAddressLine1": "string", "BillingAddressLine2": "string", "BillingCity": "string", "BillingStateOrProvince": "string", "BillingStateOrProvinceName": "string", "BillingPostalCode": "string", "BillingCountry": "string", "PromotionCode": "string", "PromotionAmount": 0, "ShippingAddressType": "Undefined", "ShippingBusinessHours": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ShippingBusinessHour" } ], "Items": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItem" } ], "Fulfillments": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Fulfillment" } ], "Adjustments": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderAdjustment" } ], "CustomFields": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.CustomField" } ], "OrderAttributes": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderAttributeValue" } ], "Tags": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Tag" } ], "Exports": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ExportStatus" } ], "ChannelDocuments": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ChannelDocument" } ] } }, "ChannelAdvisor.RestApi.V1.Models.OrderItem": { "title": "OrderItem", "type": "object", "properties": { "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "OrderID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "SiteOrderItemID": { "type": [ "null", "string" ] }, "SellerOrderItemID": { "type": [ "null", "string" ] }, "SiteListingID": { "type": [ "null", "string" ] }, "Sku": { "type": [ "null", "string" ] }, "Title": { "type": [ "null", "string" ] }, "Quantity": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "UnitPrice": { "type": [ "null", "number" ], "format": "decimal" }, "TaxPrice": { "type": "number", "format": "decimal" }, "ShippingPrice": { "type": "number", "format": "decimal" }, "ShippingTaxPrice": { "type": "number", "format": "decimal" }, "RecyclingFee": { "type": "number", "format": "decimal" }, "UnitEstimatedShippingCost": { "type": [ "null", "number" ], "format": "decimal" }, "GiftMessage": { "type": [ "null", "string" ] }, "GiftNotes": { "type": [ "null", "string" ] }, "GiftPrice": { "type": "number", "format": "decimal" }, "GiftTaxPrice": { "type": "number", "format": "decimal" }, "IsBundle": { "type": "boolean" }, "ItemURL": { "type": [ "null", "string" ] }, "HarmonizedCode": { "type": [ "null", "string" ] }, "ReferenceSku": { "type": [ "null", "string" ] }, "ReferenceProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "Order": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Order" }, { "type": "null" } ], "x-ms-navigationProperty": true }, "BundleComponents": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItemBundleComponent" }, "x-ms-navigationProperty": true }, "FulfillmentItems": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.FulfillmentItem" }, "x-ms-navigationProperty": true }, "Promotions": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Promotion" }, "x-ms-navigationProperty": true }, "Adjustments": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItemAdjustment" }, "x-ms-navigationProperty": true }, "OrderItemAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItemAttributeValue" }, "x-ms-navigationProperty": true } }, "example": { "ID": 0, "ProfileID": 0, "OrderID": 0, "ProductID": 0, "SiteOrderItemID": "string", "SellerOrderItemID": "string", "SiteListingID": "string", "Sku": "string", "Title": "string", "Quantity": 0, "UnitPrice": 0, "TaxPrice": 0, "ShippingPrice": 0, "ShippingTaxPrice": 0, "RecyclingFee": 0, "UnitEstimatedShippingCost": 0, "GiftMessage": "string", "GiftNotes": "string", "GiftPrice": 0, "GiftTaxPrice": 0, "IsBundle": true, "ItemURL": "string", "HarmonizedCode": "string", "ReferenceSku": "string", "ReferenceProductID": 0, "Order": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Order" }, "BundleComponents": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItemBundleComponent" } ], "FulfillmentItems": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.FulfillmentItem" } ], "Promotions": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Promotion" } ], "Adjustments": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItemAdjustment" } ], "OrderItemAttributes": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItemAttributeValue" } ] } }, "ChannelAdvisor.RestApi.V1.Models.Fulfillment": { "title": "Fulfillment", "type": "object", "properties": { "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "OrderID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "CreatedDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "UpdatedDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "Type": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.FulfillmentType" }, "DeliveryStatus": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.DeliveryStatus" }, "TrackingNumber": { "type": [ "null", "string" ] }, "TrackingUrl": { "type": [ "null", "string" ] }, "ReturnTrackingNumber": { "type": [ "null", "string" ] }, "ShippingCarrier": { "type": [ "null", "string" ] }, "ShippingClass": { "type": [ "null", "string" ] }, "DistributionCenterID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ExternalFulfillmentCenterCode": { "type": [ "null", "string" ] }, "ExternalFulfillmentStatus": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.FulfillmentRequestStatus" }, { "type": "null" } ] }, "ShippingCost": { "type": [ "null", "number" ], "format": "decimal" }, "InsuranceCost": { "type": [ "null", "number" ], "format": "decimal" }, "TaxCost": { "type": [ "null", "number" ], "format": "decimal" }, "ShippedDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "SellerFulfillmentID": { "type": [ "null", "string" ] }, "HasShippingLabel": { "type": "boolean" }, "HasChannelPackingSlip": { "type": "boolean" }, "HasReturnLabel": { "type": "boolean" }, "HasChannelReturnLabel": { "type": "boolean" }, "ExternalFulfillmentNumber": { "type": [ "null", "string" ] }, "ExternalFulfillmentReferenceNumber": { "type": [ "null", "string" ] }, "ShippingLabelRequestID": { "type": [ "null", "string" ] }, "StagingLocation": { "type": [ "null", "string" ] }, "SerialShippingContainerCode": { "type": [ "null", "string" ] }, "EarliestDeliveryDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "EarliestShipDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "EstimatedDeliveryDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "EstimatedShipDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "LabelFormat": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.PostSale.RestApi.V1.Models.LabelFormatType" }, { "type": "null" } ] }, "ReturnLabelFormat": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.PostSale.RestApi.V1.Models.LabelFormatType" }, { "type": "null" } ] }, "ChannelReturnLabelFormat": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.PostSale.RestApi.V1.Models.LabelFormatType" }, { "type": "null" } ] }, "Weight": { "type": [ "null", "number" ], "format": "decimal" }, "WeightUnit": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.WeightUnit" }, { "type": "null" } ] }, "Height": { "type": [ "null", "number" ], "format": "decimal" }, "Width": { "type": [ "null", "number" ], "format": "decimal" }, "Length": { "type": [ "null", "number" ], "format": "decimal" }, "MeasurementUnit": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.MeasurementUnit" }, { "type": "null" } ] }, "Order": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Order" }, { "type": "null" } ], "x-ms-navigationProperty": true }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.FulfillmentItem" }, "x-ms-navigationProperty": true } }, "example": { "ID": 0, "ProfileID": 0, "OrderID": 0, "CreatedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "UpdatedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "Type": "Ship", "DeliveryStatus": "NoChange", "TrackingNumber": "string", "TrackingUrl": "string", "ReturnTrackingNumber": "string", "ShippingCarrier": "string", "ShippingClass": "string", "DistributionCenterID": 0, "ExternalFulfillmentCenterCode": "string", "ExternalFulfillmentStatus": "New", "ShippingCost": 0, "InsuranceCost": 0, "TaxCost": 0, "ShippedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "SellerFulfillmentID": "string", "HasShippingLabel": true, "HasChannelPackingSlip": true, "HasReturnLabel": true, "HasChannelReturnLabel": true, "ExternalFulfillmentNumber": "string", "ExternalFulfillmentReferenceNumber": "string", "ShippingLabelRequestID": "string", "StagingLocation": "string", "SerialShippingContainerCode": "string", "EarliestDeliveryDateUtc": "0001-01-01T00:00:00.0000000+00:00", "EarliestShipDateUtc": "0001-01-01T00:00:00.0000000+00:00", "EstimatedDeliveryDateUtc": "0001-01-01T00:00:00.0000000+00:00", "EstimatedShipDateUtc": "0001-01-01T00:00:00.0000000+00:00", "LabelFormat": "JPEG", "ReturnLabelFormat": "JPEG", "ChannelReturnLabelFormat": "JPEG", "Weight": 0, "WeightUnit": "Gram", "Height": 0, "Width": 0, "Length": 0, "MeasurementUnit": "Centimeter", "Order": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Order" }, "Items": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.FulfillmentItem" } ] } }, "ChannelAdvisor.RestApi.V1.Models.FulfillmentItem": { "title": "FulfillmentItem", "type": "object", "properties": { "DistributionCenterItemUnitCost": { "type": [ "null", "number" ], "format": "decimal" }, "DistributionCenterShippingCost": { "type": [ "null", "number" ], "format": "decimal" }, "DistributionCenterCalculatedItemUnitCost": { "type": [ "null", "number" ], "format": "decimal" }, "DistributionCenterCalculatedShippingCost": { "type": [ "null", "number" ], "format": "decimal" }, "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "Sku": { "type": [ "null", "string" ] }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "FulfillmentID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "OrderID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "OrderItemID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "Quantity": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "SellerFulfillmentItemID": { "type": [ "null", "string" ] }, "MarketplaceShippingStatus": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.FulfillmentItemSiteCommunicationStatus" }, "ReferenceSku": { "type": [ "null", "string" ] }, "ReferenceProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "WarehouseLocation": { "type": [ "null", "string" ] }, "Fulfillment": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Fulfillment" }, { "type": "null" } ], "x-ms-navigationProperty": true }, "OrderItem": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItem" }, { "type": "null" } ], "x-ms-navigationProperty": true }, "BundleComponent": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItemBundleComponent" }, { "type": "null" } ], "x-ms-navigationProperty": true } }, "example": { "DistributionCenterItemUnitCost": 0, "DistributionCenterShippingCost": 0, "DistributionCenterCalculatedItemUnitCost": 0, "DistributionCenterCalculatedShippingCost": 0, "ID": 0, "Sku": "string", "ProfileID": 0, "FulfillmentID": 0, "OrderID": 0, "OrderItemID": 0, "Quantity": 0, "ProductID": 0, "SellerFulfillmentItemID": "string", "MarketplaceShippingStatus": "Pending", "ReferenceSku": "string", "ReferenceProductID": 0, "WarehouseLocation": "string", "Fulfillment": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Fulfillment" }, "OrderItem": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItem" }, "BundleComponent": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItemBundleComponent" } } }, "ChannelAdvisor.RestApi.V1.Models.DistributionCenter": { "title": "DistributionCenter", "type": "object", "properties": { "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "Name": { "type": [ "null", "string" ] }, "Code": { "type": [ "null", "string" ] }, "FulfillmentPartnerName": { "type": [ "null", "string" ] }, "ContactName": { "type": [ "null", "string" ] }, "ContactEmail": { "type": [ "null", "string" ] }, "ContactPhone": { "type": [ "null", "string" ] }, "Address1": { "type": [ "null", "string" ] }, "Address2": { "type": [ "null", "string" ] }, "City": { "type": [ "null", "string" ] }, "StateOrProvince": { "type": [ "null", "string" ] }, "Country": { "type": [ "null", "string" ] }, "PostalCode": { "type": [ "null", "string" ] }, "PickupLocation": { "type": "boolean" }, "ShipLocation": { "type": "boolean" }, "Type": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.DistributionCenterType" }, { "type": "null" } ] }, "IsExternallyManaged": { "type": "boolean" }, "IsDeleted": { "type": "boolean" }, "DeletedDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "County": { "type": [ "null", "string" ] }, "District": { "type": [ "null", "string" ] }, "TimeZone": { "type": [ "null", "string" ] }, "HandlingTimeMinutes": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "DeliveryAvailable": { "type": [ "null", "boolean" ] }, "PickupOrderHoldMinutes": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ThroughputLimitNumber": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ThroughputLimitUnits": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ThroughputLimitUnits" }, { "type": "null" } ] }, "MainPhone": { "type": [ "null", "string" ] }, "AltPhone": { "type": [ "null", "string" ] }, "Fax": { "type": [ "null", "string" ] }, "HomePage": { "type": [ "null", "string" ] }, "Email": { "type": [ "null", "string" ] }, "BusinessDescription": { "type": [ "null", "string" ] }, "Latitude": { "type": [ "null", "number" ], "format": "decimal" }, "Longitude": { "type": [ "null", "number" ], "format": "decimal" }, "StoreCategories": { "type": [ "null", "string" ] }, "CourierPickupInstructions": { "type": [ "null", "string" ] }, "CustomerPickupInstructions": { "type": [ "null", "string" ] }, "PickupInstructions": { "type": [ "null", "string" ] }, "OperatingHours": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OperatingHours" }, "x-ms-navigationProperty": true } }, "example": { "ID": 0, "Name": "string", "Code": "string", "FulfillmentPartnerName": "string", "ContactName": "string", "ContactEmail": "string", "ContactPhone": "string", "Address1": "string", "Address2": "string", "City": "string", "StateOrProvince": "string", "Country": "string", "PostalCode": "string", "PickupLocation": true, "ShipLocation": true, "Type": "Warehouse", "IsExternallyManaged": true, "IsDeleted": true, "DeletedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "County": "string", "District": "string", "TimeZone": "string", "HandlingTimeMinutes": 0, "DeliveryAvailable": true, "PickupOrderHoldMinutes": 0, "ThroughputLimitNumber": 0, "ThroughputLimitUnits": "Minutes", "MainPhone": "string", "AltPhone": "string", "Fax": "string", "HomePage": "string", "Email": "string", "BusinessDescription": "string", "Latitude": 0, "Longitude": 0, "StoreCategories": "string", "CourierPickupInstructions": "string", "CustomerPickupInstructions": "string", "PickupInstructions": "string", "OperatingHours": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OperatingHours" } ] } }, "ChannelAdvisor.RestApi.V1.Models.OperatingHours": { "title": "OperatingHours", "type": "object", "properties": { "DistributionCenterID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "DayID": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.DayIdentifier" }, "OpenTime": { "type": [ "null", "string" ] }, "CloseTime": { "type": [ "null", "string" ] } }, "example": { "DistributionCenterID": 0, "DayID": "Sunday", "OpenTime": "string", "CloseTime": "string" } }, "ChannelAdvisor.RestApi.V1.Models.OrderAdjustment": { "title": "OrderAdjustment", "type": "object", "properties": { "CreatedSource": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AdjustmentSource" }, { "type": "null" } ] }, "LastUpdatedSource": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AdjustmentSource" }, { "type": "null" } ] }, "ReturnSellerComment": { "type": [ "null", "string" ] }, "ReturnDistributionCenterID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ReturnDistributionCenterCode": { "type": [ "null", "string" ] }, "BuyerReturnComment": { "type": [ "null", "string" ] }, "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "OrderID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "IsRestock": { "type": "boolean" }, "Reason": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AdjustmentReason" }, "ItemAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "TaxAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "ShippingAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "ShippingTaxAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "GiftWrapAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "GiftWrapTaxAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "RecyclingFeeAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "Type": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AdjustmentType" }, "SellerAdjustmentID": { "type": [ "null", "string" ] }, "SiteAdjustmentID": { "type": [ "null", "string" ] }, "SiteRefundDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "AdjustmentTransactionID": { "type": [ "null", "string" ] }, "PublicNotes": { "type": [ "null", "string" ] }, "Comment": { "type": [ "null", "string" ] }, "CreatedDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "RequestStatus": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AsyncStatus" }, "RestockStatus": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AsyncStatus" }, { "type": "null" } ] }, "RmaNumber": { "type": [ "null", "string" ] }, "ReturnShippingFee": { "type": [ "null", "number" ], "format": "decimal" }, "RestockingFee": { "type": [ "null", "number" ], "format": "decimal" }, "ReturnTrackingNumberOrUrl": { "type": [ "null", "string" ] }, "ReturnShippingMethod": { "type": [ "null", "string" ] }, "ReturnShippingCost": { "type": [ "null", "number" ], "format": "decimal" }, "ReturnRejectionReason": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ReturnRejectionReason" }, { "type": "null" } ] }, "LastUpdatedDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "IsRma": { "type": "boolean" }, "Order": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Order" }, { "type": "null" } ], "x-ms-navigationProperty": true } }, "example": { "CreatedSource": "Channel", "LastUpdatedSource": "Channel", "ReturnSellerComment": "string", "ReturnDistributionCenterID": 0, "ReturnDistributionCenterCode": "string", "BuyerReturnComment": "string", "ID": 0, "ProfileID": 0, "OrderID": 0, "IsRestock": true, "Reason": "GeneralAdjustment", "ItemAdjustment": 0, "TaxAdjustment": 0, "ShippingAdjustment": 0, "ShippingTaxAdjustment": 0, "GiftWrapAdjustment": 0, "GiftWrapTaxAdjustment": 0, "RecyclingFeeAdjustment": 0, "Type": "Refund", "SellerAdjustmentID": "string", "SiteAdjustmentID": "string", "SiteRefundDateUtc": "0001-01-01T00:00:00.0000000+00:00", "AdjustmentTransactionID": "string", "PublicNotes": "string", "Comment": "string", "CreatedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "RequestStatus": "SubmittedNotProcessed", "RestockStatus": "SubmittedNotProcessed", "RmaNumber": "string", "ReturnShippingFee": 0, "RestockingFee": 0, "ReturnTrackingNumberOrUrl": "string", "ReturnShippingMethod": "string", "ReturnShippingCost": 0, "ReturnRejectionReason": "IneligibleForReturn", "LastUpdatedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "IsRma": true, "Order": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Order" } } }, "ChannelAdvisor.RestApi.V1.Models.OrderItemAdjustment": { "title": "OrderItemAdjustment", "type": "object", "properties": { "CreatedSource": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AdjustmentSource" }, { "type": "null" } ] }, "LastUpdatedSource": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AdjustmentSource" }, { "type": "null" } ] }, "ReturnSellerComment": { "type": [ "null", "string" ] }, "ReturnDistributionCenterID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ReturnDistributionCenterCode": { "type": [ "null", "string" ] }, "BuyerReturnComment": { "type": [ "null", "string" ] }, "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "OrderID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "OrderItemID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "Quantity": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "IsRestock": { "type": "boolean" }, "Reason": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AdjustmentReason" }, "ItemAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "TaxAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "ShippingAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "ShippingTaxAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "GiftWrapAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "GiftWrapTaxAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "RecyclingFeeAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "Type": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AdjustmentType" }, "SellerAdjustmentID": { "type": [ "null", "string" ] }, "SiteAdjustmentID": { "type": [ "null", "string" ] }, "SiteRefundDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "AdjustmentTransactionID": { "type": [ "null", "string" ] }, "PublicNotes": { "type": [ "null", "string" ] }, "Comment": { "type": [ "null", "string" ] }, "CreatedDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "RequestStatus": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AsyncStatus" }, "RestockStatus": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AsyncStatus" }, { "type": "null" } ] }, "RmaNumber": { "type": [ "null", "string" ] }, "ReturnShippingFee": { "type": [ "null", "number" ], "format": "decimal" }, "RestockingFee": { "type": [ "null", "number" ], "format": "decimal" }, "ReturnTrackingNumberOrUrl": { "type": [ "null", "string" ] }, "ReturnShippingMethod": { "type": [ "null", "string" ] }, "ReturnShippingCost": { "type": [ "null", "number" ], "format": "decimal" }, "ReferenceSku": { "type": [ "null", "string" ] }, "ReferenceProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ReturnRejectionReason": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ReturnRejectionReason" }, { "type": "null" } ] }, "LastUpdatedDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "IsRma": { "type": "boolean" }, "OrderItem": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItem" }, { "type": "null" } ], "x-ms-navigationProperty": true } }, "example": { "CreatedSource": "Channel", "LastUpdatedSource": "Channel", "ReturnSellerComment": "string", "ReturnDistributionCenterID": 0, "ReturnDistributionCenterCode": "string", "BuyerReturnComment": "string", "ID": 0, "ProfileID": 0, "OrderID": 0, "OrderItemID": 0, "Quantity": 0, "IsRestock": true, "Reason": "GeneralAdjustment", "ItemAdjustment": 0, "TaxAdjustment": 0, "ShippingAdjustment": 0, "ShippingTaxAdjustment": 0, "GiftWrapAdjustment": 0, "GiftWrapTaxAdjustment": 0, "RecyclingFeeAdjustment": 0, "Type": "Refund", "SellerAdjustmentID": "string", "SiteAdjustmentID": "string", "SiteRefundDateUtc": "0001-01-01T00:00:00.0000000+00:00", "AdjustmentTransactionID": "string", "PublicNotes": "string", "Comment": "string", "CreatedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "RequestStatus": "SubmittedNotProcessed", "RestockStatus": "SubmittedNotProcessed", "RmaNumber": "string", "ReturnShippingFee": 0, "RestockingFee": 0, "ReturnTrackingNumberOrUrl": "string", "ReturnShippingMethod": "string", "ReturnShippingCost": 0, "ReferenceSku": "string", "ReferenceProductID": 0, "ReturnRejectionReason": "IneligibleForReturn", "LastUpdatedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "IsRma": true, "OrderItem": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItem" } } }, "ChannelAdvisor.RestApi.V1.Models.OrderItemBundleComponent": { "title": "OrderItemBundleComponent", "type": "object", "properties": { "OrderID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "OrderItemID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "BundleProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "Sku": { "type": [ "null", "string" ] }, "BundleSku": { "type": [ "null", "string" ] }, "Title": { "type": [ "null", "string" ] }, "Quantity": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ReferenceProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ReferenceSku": { "type": [ "null", "string" ] }, "OrderItem": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItem" }, { "type": "null" } ], "x-ms-navigationProperty": true }, "FulfillmentItems": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.FulfillmentItem" }, "x-ms-navigationProperty": true } }, "example": { "OrderID": 0, "OrderItemID": 0, "ProductID": 0, "ProfileID": 0, "BundleProductID": 0, "Sku": "string", "BundleSku": "string", "Title": "string", "Quantity": 0, "ReferenceProductID": 0, "ReferenceSku": "string", "OrderItem": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItem" }, "FulfillmentItems": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.FulfillmentItem" } ] } }, "ChannelAdvisor.RestApi.V1.Models.Promotion": { "title": "Promotion", "type": "object", "properties": { "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "Code": { "type": [ "null", "string" ] }, "Amount": { "type": "number", "format": "decimal" }, "ShippingAmount": { "type": "number", "format": "decimal" }, "OrderItem": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItem" }, { "type": "null" } ], "x-ms-navigationProperty": true } }, "example": { "ID": 0, "Code": "string", "Amount": 0, "ShippingAmount": 0, "OrderItem": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItem" } } }, "ChannelAdvisor.RestApi.V1.Models.CustomField": { "title": "CustomField", "type": "object", "properties": { "FieldID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "OrderID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "Value": { "type": [ "null", "string" ] }, "Order": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Order" }, { "type": "null" } ], "x-ms-navigationProperty": true } }, "example": { "FieldID": 0, "OrderID": 0, "ProfileID": 0, "Value": "string", "Order": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Order" } } }, "ChannelAdvisor.RestApi.V1.Models.Profile": { "title": "Profile", "type": "object", "properties": { "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "AccountName": { "type": [ "null", "string" ] }, "CompanyName": { "type": [ "null", "string" ] }, "CurrencyCode": { "type": [ "null", "string" ] }, "TimeZoneRegion": { "type": [ "null", "string" ] }, "TimeZoneDescription": { "type": [ "null", "string" ] }, "DefaultDistributionCenterID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "SiteAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.SiteAccount" }, "x-ms-navigationProperty": true }, "ShippingLabelPartnerAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ShippingLabelPartnerAccount" }, "x-ms-navigationProperty": true } }, "example": { "ID": 0, "AccountName": "string", "CompanyName": "string", "CurrencyCode": "string", "TimeZoneRegion": "string", "TimeZoneDescription": "string", "DefaultDistributionCenterID": 0, "SiteAccounts": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.SiteAccount" } ], "ShippingLabelPartnerAccounts": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ShippingLabelPartnerAccount" } ] } }, "ChannelAdvisor.RestApi.V1.Models.Product": { "title": "Product", "type": "object", "properties": { "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "CreateDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "UpdateDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "QuantityUpdateDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "IsAvailableInStore": { "type": [ "null", "boolean" ] }, "IsBlocked": { "type": [ "null", "boolean" ] }, "IsBlockedFromAdvertising": { "type": [ "null", "boolean" ] }, "IsExternalQuantityBlocked": { "type": [ "null", "boolean" ] }, "InfiniteQuantity": { "type": [ "null", "boolean" ] }, "BlockComment": { "type": [ "null", "string" ] }, "BlockedDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "BlockedFromAdvertisingDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "ReceivedDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "LastSaleDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "ASIN": { "type": [ "null", "string" ] }, "Brand": { "type": [ "null", "string" ] }, "Condition": { "type": [ "null", "string" ] }, "Description": { "type": [ "null", "string" ] }, "EAN": { "type": [ "null", "string" ] }, "FlagDescription": { "type": [ "null", "string" ] }, "Flag": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.FlagType" }, "HarmonizedCode": { "type": [ "null", "string" ] }, "ISBN": { "type": [ "null", "string" ] }, "Manufacturer": { "type": [ "null", "string" ] }, "MPN": { "type": [ "null", "string" ] }, "ShortDescription": { "type": [ "null", "string" ] }, "Sku": { "type": [ "null", "string" ] }, "Subtitle": { "type": [ "null", "string" ] }, "TaxProductCode": { "type": [ "null", "string" ] }, "Title": { "type": [ "null", "string" ] }, "UPC": { "type": [ "null", "string" ] }, "WarehouseLocation": { "type": [ "null", "string" ] }, "Warranty": { "type": [ "null", "string" ] }, "MultipackQuantity": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "Height": { "type": [ "null", "number" ], "format": "decimal" }, "Length": { "type": [ "null", "number" ], "format": "decimal" }, "Width": { "type": [ "null", "number" ], "format": "decimal" }, "Weight": { "oneOf": [ { "type": [ "null", "number" ], "format": "double" }, { "type": [ "null", "string" ] }, { "$ref": "#/components/schemas/ReferenceNumeric" } ] }, "Cost": { "type": [ "null", "number" ], "format": "decimal" }, "Margin": { "type": [ "null", "number" ], "format": "decimal" }, "RetailPrice": { "type": [ "null", "number" ], "format": "decimal" }, "StartingPrice": { "type": [ "null", "number" ], "format": "decimal" }, "ReservePrice": { "type": [ "null", "number" ], "format": "decimal" }, "BuyItNowPrice": { "type": [ "null", "number" ], "format": "decimal" }, "StorePrice": { "type": [ "null", "number" ], "format": "decimal" }, "SecondChancePrice": { "type": [ "null", "number" ], "format": "decimal" }, "MinPrice": { "type": [ "null", "number" ], "format": "decimal" }, "MaxPrice": { "type": [ "null", "number" ], "format": "decimal" }, "EstimatedShippingCost": { "type": [ "null", "number" ], "format": "decimal" }, "SupplierName": { "type": [ "null", "string" ] }, "SupplierCode": { "type": [ "null", "string" ] }, "SupplierPO": { "type": [ "null", "string" ] }, "Classification": { "type": [ "null", "string" ] }, "IsDisplayInStore": { "type": [ "null", "boolean" ] }, "StoreTitle": { "type": [ "null", "string" ] }, "StoreDescription": { "type": [ "null", "string" ] }, "BundleType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.BundleType" }, "ProductType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.InventoryItemType" }, "TotalAvailableQuantity": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "OpenAllocatedQuantity": { "type": "number", "format": "int64" }, "OpenAllocatedQuantityPooled": { "type": "number", "format": "int64" }, "PendingCheckoutQuantity": { "type": "number", "format": "int64" }, "PendingCheckoutQuantityPooled": { "type": "number", "format": "int64" }, "PendingPaymentQuantity": { "type": "number", "format": "int64" }, "PendingPaymentQuantityPooled": { "type": "number", "format": "int64" }, "PendingShipmentQuantity": { "type": "number", "format": "int64" }, "PendingShipmentQuantityPooled": { "type": "number", "format": "int64" }, "TotalQuantity": { "type": [ "null", "number" ], "format": "int64" }, "TotalQuantityPooled": { "type": [ "null", "number" ], "format": "int64" }, "QuantitySoldLast7Days": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "QuantitySoldLast14Days": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "QuantitySoldLast30Days": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "QuantitySoldLast60Days": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "QuantitySoldLast90Days": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "IsParent": { "type": [ "null", "boolean" ] }, "IsInRelationship": { "type": [ "null", "boolean" ] }, "CopyToChildren": { "type": [ "null", "boolean" ] }, "CopyToAliases": { "type": [ "null", "string" ] }, "ParentProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ParentSku": { "type": [ "null", "string" ] }, "RelationshipName": { "type": [ "null", "string" ] }, "VaryBy": { "type": [ "null", "string" ] }, "AliasType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AliasType" }, "ReferenceSku": { "type": [ "null", "string" ] }, "ReferenceProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "AssemblyBundleDistributionCenters": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AssemblyBundleDistributionCenter" }, "x-ms-navigationProperty": true }, "Attributes": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AttributeValue" }, "x-ms-navigationProperty": true }, "DCQuantities": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.DCQuantity" }, "x-ms-navigationProperty": true }, "Images": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Image" }, "x-ms-navigationProperty": true }, "Labels": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ProductLabel" }, "x-ms-navigationProperty": true }, "BundleComponents": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ProductBundleComponent" }, "x-ms-navigationProperty": true }, "Children": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ChildRelationship" }, "x-ms-navigationProperty": true }, "AliasRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AliasRelationship" }, "x-ms-navigationProperty": true } }, "example": { "ID": 0, "ProfileID": 0, "CreateDateUtc": "0001-01-01T00:00:00.0000000+00:00", "UpdateDateUtc": "0001-01-01T00:00:00.0000000+00:00", "QuantityUpdateDateUtc": "0001-01-01T00:00:00.0000000+00:00", "IsAvailableInStore": true, "IsBlocked": true, "IsBlockedFromAdvertising": true, "IsExternalQuantityBlocked": true, "InfiniteQuantity": true, "BlockComment": "string", "BlockedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "BlockedFromAdvertisingDateUtc": "0001-01-01T00:00:00.0000000+00:00", "ReceivedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "LastSaleDateUtc": "0001-01-01T00:00:00.0000000+00:00", "ASIN": "string", "Brand": "string", "Condition": "string", "Description": "string", "EAN": "string", "FlagDescription": "string", "Flag": "NoFlag", "HarmonizedCode": "string", "ISBN": "string", "Manufacturer": "string", "MPN": "string", "ShortDescription": "string", "Sku": "string", "Subtitle": "string", "TaxProductCode": "string", "Title": "string", "UPC": "string", "WarehouseLocation": "string", "Warranty": "string", "MultipackQuantity": 0, "Height": 0, "Length": 0, "Width": 0, "Weight": 0, "Cost": 0, "Margin": 0, "RetailPrice": 0, "StartingPrice": 0, "ReservePrice": 0, "BuyItNowPrice": 0, "StorePrice": 0, "SecondChancePrice": 0, "MinPrice": 0, "MaxPrice": 0, "EstimatedShippingCost": 0, "SupplierName": "string", "SupplierCode": "string", "SupplierPO": "string", "Classification": "string", "IsDisplayInStore": true, "StoreTitle": "string", "StoreDescription": "string", "BundleType": "None", "ProductType": "Item", "TotalAvailableQuantity": 0, "OpenAllocatedQuantity": 0, "OpenAllocatedQuantityPooled": 0, "PendingCheckoutQuantity": 0, "PendingCheckoutQuantityPooled": 0, "PendingPaymentQuantity": 0, "PendingPaymentQuantityPooled": 0, "PendingShipmentQuantity": 0, "PendingShipmentQuantityPooled": 0, "TotalQuantity": 0, "TotalQuantityPooled": 0, "QuantitySoldLast7Days": 0, "QuantitySoldLast14Days": 0, "QuantitySoldLast30Days": 0, "QuantitySoldLast60Days": 0, "QuantitySoldLast90Days": 0, "IsParent": true, "IsInRelationship": true, "CopyToChildren": true, "CopyToAliases": "string", "ParentProductID": 0, "ParentSku": "string", "RelationshipName": "string", "VaryBy": "string", "AliasType": "None", "ReferenceSku": "string", "ReferenceProductID": 0, "AssemblyBundleDistributionCenters": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.AssemblyBundleDistributionCenter" } ], "Attributes": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.AttributeValue" } ], "DCQuantities": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.DCQuantity" } ], "Images": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Image" } ], "Labels": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ProductLabel" } ], "BundleComponents": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ProductBundleComponent" } ], "Children": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ChildRelationship" } ], "AliasRelationships": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.AliasRelationship" } ] } }, "ChannelAdvisor.RestApi.V1.Models.AssemblyBundleDistributionCenter": { "title": "AssemblyBundleDistributionCenter", "type": "object", "properties": { "DistributionCenterID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "DCCode": { "type": [ "null", "string" ] } }, "example": { "DistributionCenterID": 0, "ProfileID": 0, "DCCode": "string" } }, "ChannelAdvisor.RestApi.V1.Models.AliasRelationship": { "title": "AliasRelationship", "type": "object", "properties": { "AliasProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ReferenceProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "AliasProductSku": { "type": [ "null", "string" ] }, "Product": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Product" }, { "type": "null" } ], "x-ms-navigationProperty": true } }, "example": { "AliasProductID": 0, "ReferenceProductID": 0, "ProfileID": 0, "AliasProductSku": "string", "Product": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Product" } } }, "ChannelAdvisor.RestApi.V1.Models.Image": { "title": "Image", "type": "object", "properties": { "ProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "PlacementName": { "type": "string" }, "Abbreviation": { "type": [ "null", "string" ] }, "Url": { "type": [ "null", "string" ] }, "Product": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Product" }, { "type": "null" } ], "x-ms-navigationProperty": true } }, "example": { "ProductID": 0, "ProfileID": 0, "PlacementName": "string (identifier)", "Abbreviation": "string", "Url": "string", "Product": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Product" } } }, "ChannelAdvisor.RestApi.V1.Models.AttributeValue": { "title": "AttributeValue", "type": "object", "properties": { "ProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "Name": { "type": "string" }, "Value": { "type": [ "null", "string" ] }, "Product": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Product" }, { "type": "null" } ], "x-ms-navigationProperty": true } }, "example": { "ProductID": 0, "ProfileID": 0, "Name": "string (identifier)", "Value": "string", "Product": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Product" } } }, "ChannelAdvisor.RestApi.V1.Models.DCQuantity": { "title": "DCQuantity", "type": "object", "properties": { "ProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "DistributionCenterID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "AvailableQuantity": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "Product": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Product" }, { "type": "null" } ], "x-ms-navigationProperty": true } }, "example": { "ProductID": 0, "ProfileID": 0, "DistributionCenterID": 0, "AvailableQuantity": 0, "Product": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Product" } } }, "ChannelAdvisor.RestApi.V1.Models.ProductLabel": { "title": "ProductLabel", "type": "object", "properties": { "ProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "Name": { "type": "string" }, "Product": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Product" }, { "type": "null" } ], "x-ms-navigationProperty": true } }, "example": { "ProductID": 0, "ProfileID": 0, "Name": "string (identifier)", "Product": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Product" } } }, "ChannelAdvisor.RestApi.V1.Models.ProductBundleComponent": { "title": "ProductBundleComponent", "type": "object", "properties": { "ProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ComponentID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ComponentSku": { "type": [ "null", "string" ] }, "Quantity": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "Product": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Product" }, { "type": "null" } ], "x-ms-navigationProperty": true } }, "example": { "ProductID": 0, "ComponentID": 0, "ProfileID": 0, "ComponentSku": "string", "Quantity": 0, "Product": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Product" } } }, "ChannelAdvisor.RestApi.V1.Models.ChildRelationship": { "title": "ChildRelationship", "type": "object", "properties": { "ParentProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ChildProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ChildProduct": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Product" }, { "type": "null" } ], "x-ms-navigationProperty": true } }, "example": { "ParentProductID": 0, "ProfileID": 0, "ChildProductID": 0, "ChildProduct": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Product" } } }, "ChannelAdvisor.RestApi.V1.Models.Package": { "title": "Package", "type": "object", "properties": { "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "Name": { "type": [ "null", "string" ] }, "Description": { "type": [ "null", "string" ] }, "ShippingCarrier": { "type": [ "null", "string" ] }, "Length": { "type": "number", "format": "decimal" }, "Width": { "type": "number", "format": "decimal" }, "Height": { "type": "number", "format": "decimal" }, "EmptyWeight": { "type": [ "null", "number" ], "format": "decimal" } }, "example": { "ID": 0, "ProfileID": 0, "Name": "string", "Description": "string", "ShippingCarrier": "string", "Length": 0, "Width": 0, "Height": 0, "EmptyWeight": 0 } }, "ChannelAdvisor.RestApi.V1.Models.ChannelDocument": { "title": "ChannelDocument", "type": "object", "properties": { "DocumentKey": { "type": "string" }, "Contents": { "type": [ "null", "string" ] }, "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "DocumentType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ChannelDocumentType" } }, "example": { "DocumentKey": "string (identifier)", "Contents": "string", "ID": 0, "ProfileID": 0, "DocumentType": "AmazonVATInvoice" } }, "ChannelAdvisor.RestApi.V1.Models.NotSuppliedChannelDocument": { "title": "NotSuppliedChannelDocument", "type": "object", "properties": { "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "DocumentType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ChannelDocumentType" } }, "example": { "ID": 0, "ProfileID": 0, "DocumentType": "AmazonVATInvoice" } }, "ChannelAdvisor.RestApi.V1.Models.Site": { "title": "Site", "type": "object", "properties": { "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "SiteName": { "type": [ "null", "string" ] }, "SiteCategoryID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "SiteCategoryName": { "type": [ "null", "string" ] }, "CancellationConfiguration": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.CancellationConfiguration" }, { "type": "null" } ] }, "RefundConfiguration": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.RefundConfiguration" }, { "type": "null" } ] }, "AdjustmentReasons": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.CodeDescription" } } }, "example": { "ID": 0, "SiteName": "string", "SiteCategoryID": 0, "SiteCategoryName": "string", "CancellationConfiguration": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.CancellationConfiguration" }, "RefundConfiguration": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.RefundConfiguration" }, "AdjustmentReasons": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.CodeDescription" } ] } }, "ChannelAdvisor.RestApi.V1.Models.OrderDocumentFlyweight": { "title": "OrderDocumentFlyweight", "type": "object", "properties": { "DocumentKey": { "type": "string" }, "OrderID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "CreateDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": "string", "format": "date-time" }, "DocumentType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.DocumentType" }, "MimeType": { "type": [ "null", "string" ] }, "DocumentSource": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.DocumentSourceType" } }, "example": { "DocumentKey": "string (identifier)", "OrderID": 0, "ProfileID": 0, "CreateDateUtc": "0001-01-01T00:00:00.0000000+00:00", "DocumentType": "Unknown", "MimeType": "string", "DocumentSource": "Unknown" } }, "ChannelAdvisor.RestApi.V1.Models.OrderDocument": { "allOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderDocumentFlyweight" }, { "title": "OrderDocument", "type": "object", "properties": { "Content": { "type": [ "null", "string" ] }, "Metadata": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderDocumentMetadata" }, "x-ms-navigationProperty": true } } } ], "example": { "DocumentKey": "string (identifier)", "OrderID": 0, "ProfileID": 0, "CreateDateUtc": "0001-01-01T00:00:00.0000000+00:00", "DocumentType": "Unknown", "MimeType": "string", "DocumentSource": "Unknown", "Content": "string", "Metadata": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderDocumentMetadata" } ] } }, "ChannelAdvisor.RestApi.V1.Models.OrderDocumentMetadata": { "title": "OrderDocumentMetadata", "type": "object", "properties": { "Key": { "type": "string" }, "Value": { "type": [ "null", "string" ] } }, "example": { "Key": "string (identifier)", "Value": "string" } }, "ChannelAdvisor.RestApi.V1.Models.OrderAttributeValue": { "title": "OrderAttributeValue", "type": "object", "properties": { "Value": { "type": [ "null", "string" ] }, "Name": { "type": "string" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "OrderID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "Order": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Order" }, { "type": "null" } ], "x-ms-navigationProperty": true } }, "example": { "Value": "string", "Name": "string (identifier)", "ProfileID": 0, "OrderID": 0, "Order": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Order" } } }, "ChannelAdvisor.RestApi.V1.Models.OrderItemAttributeValue": { "title": "OrderItemAttributeValue", "type": "object", "properties": { "Value": { "type": [ "null", "string" ] }, "Name": { "type": "string" }, "OrderID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "OrderItemID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "OrderItem": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItem" }, { "type": "null" } ], "x-ms-navigationProperty": true } }, "example": { "Value": "string", "Name": "string (identifier)", "OrderID": 0, "OrderItemID": 0, "ProfileID": 0, "OrderItem": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItem" } } }, "ChannelAdvisor.RestApi.V1.Models.UploadChannelDocument": { "title": "UploadChannelDocument", "type": "object", "properties": { "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "OrderID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "DocumentType": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ChannelDocumentType" }, { "type": "null" } ] }, "Content": { "anyOf": [ { "$ref": "#/components/schemas/System.Net.Http.HttpContent" }, { "type": "null" } ] }, "AdjustmentID": { "type": [ "null", "string" ] }, "InvoiceNumber": { "type": [ "null", "string" ] }, "TotalAmount": { "type": [ "null", "number" ], "format": "decimal" }, "TotalVATAmount": { "type": [ "null", "number" ], "format": "decimal" } }, "example": { "ProfileID": 0, "OrderID": 0, "DocumentType": "AmazonVATInvoice", "Content": { "@odata.type": "System.Net.Http.HttpContent" }, "AdjustmentID": "string", "InvoiceNumber": "string", "TotalAmount": 0, "TotalVATAmount": 0 } }, "ChannelAdvisor.RestApi.V1.Models.WebhookAuthenticationUpdateRequest": { "title": "WebhookAuthenticationUpdateRequest", "type": "object", "properties": { "AuthenticationType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.WebhookAuthenticationType" }, "CustomHeader": { "type": [ "null", "string" ] }, "CustomHeaderValue": { "type": [ "null", "string" ] }, "BasicAuthUsername": { "type": [ "null", "string" ] }, "BasicAuthPassword": { "type": [ "null", "string" ] } }, "example": { "AuthenticationType": "Unknown", "CustomHeader": "string", "CustomHeaderValue": "string", "BasicAuthUsername": "string", "BasicAuthPassword": "string" } }, "ChannelAdvisor.RestApi.V1.Models.ShipOrderRequest": { "title": "ShipOrderRequest", "type": "object", "properties": { "ShippedDateUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "TrackingNumber": { "type": [ "null", "string" ] }, "ReturnTrackingNumber": { "type": [ "null", "string" ] }, "ShippingCarrier": { "type": [ "null", "string" ] }, "ShippingClass": { "type": [ "null", "string" ] }, "DistributionCenterID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "SellerFulfillmentID": { "type": [ "null", "string" ] }, "DeliveryStatus": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.DeliveryStatus" }, { "type": "null" } ] }, "FulfillmentType": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.FulfillmentType" }, { "type": "null" } ] }, "PreventMarketplaceCommunication": { "type": "boolean" }, "TrackingUrl": { "type": [ "null", "string" ] }, "SerialShippingContainerCode": { "type": [ "null", "string" ] }, "RejectOpenCancelRequests": { "type": [ "null", "boolean" ] }, "RejectCancelReqReason": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ReturnRejectionReason" }, { "type": "null" } ] }, "RejectCancelReqSellerComment": { "type": [ "null", "string" ] }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ShipOrderRequestItem" } } }, "example": { "ShippedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "TrackingNumber": "string", "ReturnTrackingNumber": "string", "ShippingCarrier": "string", "ShippingClass": "string", "DistributionCenterID": 0, "SellerFulfillmentID": "string", "DeliveryStatus": "NoChange", "FulfillmentType": "Ship", "PreventMarketplaceCommunication": true, "TrackingUrl": "string", "SerialShippingContainerCode": "string", "RejectOpenCancelRequests": true, "RejectCancelReqReason": "IneligibleForReturn", "RejectCancelReqSellerComment": "string", "Items": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ShipOrderRequestItem" } ] } }, "ChannelAdvisor.RestApi.V1.Models.ShippingItems": { "title": "ShippingItems", "type": "object", "properties": { "FulfillmentItemID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "OrderItemID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "Sku": { "type": [ "null", "string" ] }, "Quantity": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "Description": { "type": [ "null", "string" ] }, "UnitWeight": { "type": [ "null", "number" ], "format": "decimal" } }, "example": { "FulfillmentItemID": 0, "OrderItemID": 0, "Sku": "string", "Quantity": 0, "Description": "string", "UnitWeight": 0 } }, "ChannelAdvisor.RestApi.V1.Models.PickupLabelLineItem": { "title": "PickupLabelLineItem", "type": "object", "properties": { "OrderItemID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "Quantity": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "SerialNumbers": { "type": "array", "items": { "type": [ "null", "string" ] } }, "SiteOrderItemID": { "type": [ "null", "string" ] }, "Sku": { "type": [ "null", "string" ] } }, "example": { "OrderItemID": 0, "Quantity": 0, "SerialNumbers": [ "string" ], "SiteOrderItemID": "string", "Sku": "string" } }, "ChannelAdvisor.RestApi.V1.Models.PickupLabelResponse": { "title": "PickupLabelResponse", "type": "object", "properties": { "LabelContent": { "type": [ "null", "string" ] }, "LabelContentType": { "type": [ "null", "string" ] }, "FulfillmentID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "InvoiceID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "PackageID": { "type": [ "null", "string" ] }, "ErrorDetail": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.PickupLabelErrorDetail" }, { "type": "null" } ] } }, "example": { "LabelContent": "string", "LabelContentType": "string", "FulfillmentID": 0, "InvoiceID": 0, "PackageID": "string", "ErrorDetail": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.PickupLabelErrorDetail" } } }, "ChannelAdvisor.RestApi.V1.Models.OrderItemSubstitutionRequest": { "title": "OrderItemSubstitutionRequest", "type": "object", "properties": { "Substitutions": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItemSubstitution" } } }, "example": { "Substitutions": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItemSubstitution" } ] } }, "ChannelAdvisor.RestApi.V1.Models.RmaConditionQuantity": { "title": "RmaConditionQuantity", "type": "object", "properties": { "Condition": { "type": [ "null", "string" ] }, "Quantity": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" } }, "example": { "Condition": "string", "Quantity": 0 } }, "ChannelAdvisor.RestApi.V1.Models.QuantityUpdateRequest": { "title": "QuantityUpdateRequest", "type": "object", "properties": { "CompleteDCList": { "type": [ "null", "boolean" ] }, "UpdateType": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.QuantityUpdateType" }, { "type": "null" } ] }, "Updates": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.DCxQtyUpdate" } } }, "example": { "CompleteDCList": true, "UpdateType": "Absolute", "Updates": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.DCxQtyUpdate" } ] } }, "ChannelAdvisor.RestApi.V1.Models.ChildrenRemoveRequest": { "title": "ChildrenRemoveRequest", "type": "object", "properties": { "ChildProductIDList": { "type": "array", "items": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" } } }, "example": { "ChildProductIDList": [ 0 ] } }, "ChannelAdvisor.RestApi.V1.Models.AttributesUpdateRequest": { "title": "AttributesUpdateRequest", "type": "object", "properties": { "Attributes": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AttributeUpdate" } } }, "example": { "Attributes": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.AttributeUpdate" } ] } }, "ChannelAdvisor.RestApi.V1.Models.WebhookFailedEventsJob": { "title": "WebhookFailedEventsJob", "type": "object", "properties": { "Token": { "type": [ "null", "string" ] }, "Status": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.WebhookFailedEventsJobStatus" }, "StartedOnUtc": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": [ "null", "string" ], "format": "date-time" }, "ResponseFileUrl": { "type": [ "null", "string" ] } }, "example": { "Token": "string", "Status": "New", "StartedOnUtc": "0001-01-01T00:00:00.0000000+00:00", "ResponseFileUrl": "string" } }, "ChannelAdvisor.RestApi.V1.Models.Tag": { "title": "Tag", "type": "object", "properties": { "Name": { "type": "string" } }, "example": { "Name": "string (identifier)" } }, "ChannelAdvisor.RestApi.V1.Models.ExportStatus": { "title": "ExportStatus", "type": "object", "properties": { "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "OrderID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ApplicationID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "DeveloperKey": { "type": [ "null", "string" ] }, "Override": { "type": "boolean" }, "Order": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Order" }, { "type": "null" } ], "x-ms-navigationProperty": true } }, "example": { "ID": 0, "ProfileID": 0, "OrderID": 0, "ApplicationID": 0, "DeveloperKey": "string", "Override": true, "Order": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Order" } } }, "ChannelAdvisor.RestApi.V1.Models.AmazonVATInvoiceDocument": { "allOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ChannelDocument" }, { "title": "AmazonVATInvoiceDocument", "type": "object", "properties": { "OrderID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "AdjustmentID": { "type": [ "null", "string" ] }, "Status": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AmazonVATInvoiceRequestStatus" }, "InvoiceNumber": { "type": [ "null", "string" ] }, "TotalAmount": { "type": [ "null", "number" ], "format": "decimal" }, "TotalVATAmount": { "type": [ "null", "number" ], "format": "decimal" }, "CreateDateUTC": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": "string", "format": "date-time" }, "UpdateDateUTC": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": "string", "format": "date-time" } } } ], "example": { "DocumentKey": "string (identifier)", "Contents": "string", "ID": 0, "ProfileID": 0, "DocumentType": "AmazonVATInvoice", "OrderID": 0, "AdjustmentID": "string", "Status": "New", "InvoiceNumber": "string", "TotalAmount": 0, "TotalVATAmount": 0, "CreateDateUTC": "0001-01-01T00:00:00.0000000+00:00", "UpdateDateUTC": "0001-01-01T00:00:00.0000000+00:00" } }, "ChannelAdvisor.RestApi.V1.Models.SiteAccount": { "title": "SiteAccount", "type": "object", "properties": { "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "SiteAccountName": { "type": [ "null", "string" ] }, "SiteID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "SiteName": { "type": [ "null", "string" ] }, "Enabled": { "type": "boolean" }, "Profile": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Profile" }, { "type": "null" } ], "x-ms-navigationProperty": true } }, "example": { "ID": 0, "SiteAccountName": "string", "SiteID": 0, "SiteName": "string", "Enabled": true, "Profile": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Profile" } } }, "ChannelAdvisor.RestApi.V1.Models.ShippingLabelPartnerAccount": { "title": "ShippingLabelPartnerAccount", "type": "object", "properties": { "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "AccountName": { "type": [ "null", "string" ] }, "PartnerName": { "type": [ "null", "string" ] }, "Profile": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Profile" }, { "type": "null" } ], "x-ms-navigationProperty": true } }, "example": { "ID": 0, "AccountName": "string", "PartnerName": "string", "Profile": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Profile" } } }, "ChannelAdvisor.RestApi.V1.Models.NotSuppliedAmazonVATInvoiceDocument": { "allOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.NotSuppliedChannelDocument" }, { "title": "NotSuppliedAmazonVATInvoiceDocument", "type": "object", "properties": { "OrderID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "AdjustmentID": { "type": [ "null", "string" ] }, "CreateDateUTC": { "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$", "type": "string", "format": "date-time" } } } ], "example": { "ID": 0, "ProfileID": 0, "DocumentType": "AmazonVATInvoice", "OrderID": 0, "AdjustmentID": "string", "CreateDateUTC": "0001-01-01T00:00:00.0000000+00:00" } }, "ChannelAdvisor.RestApi.V1.Models.CancellationConfiguration": { "title": "CancellationConfiguration", "type": "object", "properties": { "SupportsOrderCancellations": { "type": "boolean" }, "SupportsOrderItemCancellations": { "type": "boolean" }, "SupportsOrderItemRMACancellations": { "type": "boolean" } }, "example": { "SupportsOrderCancellations": true, "SupportsOrderItemCancellations": true, "SupportsOrderItemRMACancellations": true } }, "ChannelAdvisor.RestApi.V1.Models.RefundConfiguration": { "title": "RefundConfiguration", "type": "object", "properties": { "SupportsOrderRefunds": { "type": "boolean" }, "SupportsOrderItemRefunds": { "type": "boolean" }, "SupportsOrderItemRMARefunds": { "type": "boolean" } }, "example": { "SupportsOrderRefunds": true, "SupportsOrderItemRefunds": true, "SupportsOrderItemRMARefunds": true } }, "ChannelAdvisor.RestApi.V1.Models.CodeDescription": { "title": "CodeDescription", "type": "object", "properties": { "Code": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "Description": { "type": [ "null", "string" ] } }, "example": { "Code": 0, "Description": "string" } }, "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString": { "title": "KeyValuePair_2OfString_IEnumerable_1OfString", "type": "object", "properties": { "Value": { "type": "array", "items": { "type": [ "null", "string" ] } } }, "example": { "Value": [ "string" ] } }, "ChannelAdvisor.RestApi.V1.Models.ODataBatchContent": { "allOf": [ { "$ref": "#/components/schemas/System.Net.Http.HttpContent" }, { "title": "ODataBatchContent", "type": "object", "properties": { "Responses": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ODataBatchResponseItem" } } } } ], "example": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ], "Responses": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ODataBatchResponseItem" } ] } }, "ChannelAdvisor.RestApi.V1.Models.ODataBatchResponseItem": { "title": "ODataBatchResponseItem", "type": "object" }, "ChannelAdvisor.RestApi.V1.Models.ChangeSetResponseItem": { "allOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ODataBatchResponseItem" }, { "title": "ChangeSetResponseItem", "type": "object", "properties": { "Responses": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.HttpResponseMessage" } } } } ], "example": { "Responses": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.HttpResponseMessage" } ] } }, "ChannelAdvisor.RestApi.V1.Models.OperationResponseItem": { "allOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ODataBatchResponseItem" }, { "title": "OperationResponseItem", "type": "object" } ] }, "ChannelAdvisor.RestApi.V1.Models.HttpResponseMessage": { "title": "HttpResponseMessage", "type": "object", "properties": { "Version": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Version" }, { "type": "null" } ] }, "Content": { "anyOf": [ { "$ref": "#/components/schemas/System.Net.Http.HttpContent" }, { "type": "null" } ] }, "StatusCode": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.HttpStatusCode" }, "ReasonPhrase": { "type": [ "null", "string" ] }, "Headers": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } }, "RequestMessage": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.HttpRequestMessage" }, { "type": "null" } ] } }, "example": { "Version": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Version" }, "Content": { "@odata.type": "System.Net.Http.HttpContent" }, "StatusCode": "Continue", "ReasonPhrase": "string", "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ], "RequestMessage": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.HttpRequestMessage" } } }, "ChannelAdvisor.RestApi.V1.Models.Version": { "title": "Version", "type": "object" }, "ChannelAdvisor.RestApi.V1.Models.HttpRequestMessage": { "title": "HttpRequestMessage", "type": "object", "properties": { "Version": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Version" }, { "type": "null" } ] }, "Content": { "anyOf": [ { "$ref": "#/components/schemas/System.Net.Http.HttpContent" }, { "type": "null" } ] }, "Method": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.HttpMethod" }, { "type": "null" } ] }, "RequestUri": { "anyOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Uri" }, { "type": "null" } ] }, "Headers": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } } }, "example": { "Version": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Version" }, "Content": { "@odata.type": "System.Net.Http.HttpContent" }, "Method": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.HttpMethod" }, "RequestUri": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Uri" }, "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.HttpMethod": { "title": "HttpMethod", "type": "object" }, "ChannelAdvisor.RestApi.V1.Models.Uri": { "title": "Uri", "type": "object", "properties": { "Segments": { "type": "array", "items": { "type": [ "null", "string" ] } } }, "example": { "Segments": [ "string" ] } }, "ChannelAdvisor.RestApi.V1.Models.ByteRangeStreamContent": { "allOf": [ { "$ref": "#/components/schemas/System.Net.Http.HttpContent" }, { "title": "ByteRangeStreamContent", "type": "object" } ], "example": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.PushStreamContent": { "allOf": [ { "$ref": "#/components/schemas/System.Net.Http.HttpContent" }, { "title": "PushStreamContent", "type": "object" } ], "example": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.HttpMessageContent": { "allOf": [ { "$ref": "#/components/schemas/System.Net.Http.HttpContent" }, { "title": "HttpMessageContent", "type": "object" } ], "example": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.ObjectContent": { "allOf": [ { "$ref": "#/components/schemas/System.Net.Http.HttpContent" }, { "title": "ObjectContent", "type": "object" } ], "example": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.ObjectContent_1OfT": { "allOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ObjectContent" }, { "title": "ObjectContent_1OfT", "type": "object" } ], "example": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.MultipartContent": { "allOf": [ { "$ref": "#/components/schemas/System.Net.Http.HttpContent" }, { "title": "MultipartContent", "type": "object" } ], "example": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.MultipartFormDataContent": { "allOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.MultipartContent" }, { "title": "MultipartFormDataContent", "type": "object" } ], "example": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.ByteArrayContent": { "allOf": [ { "$ref": "#/components/schemas/System.Net.Http.HttpContent" }, { "title": "ByteArrayContent", "type": "object" } ], "example": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.FormUrlEncodedContent": { "allOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ByteArrayContent" }, { "title": "FormUrlEncodedContent", "type": "object" } ], "example": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.StringContent": { "allOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ByteArrayContent" }, { "title": "StringContent", "type": "object" } ], "example": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.StreamContent": { "allOf": [ { "$ref": "#/components/schemas/System.Net.Http.HttpContent" }, { "title": "StreamContent", "type": "object" } ], "example": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.ShipOrderRequestItem": { "title": "ShipOrderRequestItem", "type": "object", "properties": { "OrderItemID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "ProductID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "Sku": { "type": [ "null", "string" ] }, "Quantity": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "SellerFulfillmentItemID": { "type": [ "null", "string" ] }, "ReferenceSku": { "type": [ "null", "string" ] } }, "example": { "OrderItemID": 0, "ProductID": 0, "Sku": "string", "Quantity": 0, "SellerFulfillmentItemID": "string", "ReferenceSku": "string" } }, "ChannelAdvisor.RestApi.V1.Models.PickupLabelErrorDetail": { "title": "PickupLabelErrorDetail", "type": "object", "properties": { "Code": { "type": [ "null", "string" ] }, "Message": { "type": [ "null", "string" ] } }, "example": { "Code": "string", "Message": "string" } }, "ChannelAdvisor.RestApi.V1.Models.DCxQtyUpdate": { "title": "DCxQtyUpdate", "type": "object", "properties": { "DistributionCenterID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "Quantity": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" } }, "example": { "DistributionCenterID": 0, "Quantity": 0 } }, "ChannelAdvisor.RestApi.V1.Models.AttributeUpdate": { "title": "AttributeUpdate", "type": "object", "properties": { "Name": { "type": [ "null", "string" ] }, "Value": { "type": [ "null", "string" ] } }, "example": { "Name": "string", "Value": "string" } }, "ChannelAdvisor.RestApi.V1.Models.DeliveryConfirmationType": { "title": "DeliveryConfirmationType", "enum": [ "Default", "SignatureRequired", "AdultSignatureRequired", "NoDeliveryConfirmation" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.MeasurementUnit": { "title": "MeasurementUnit", "enum": [ "Centimeter", "Inch" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.WeightUnit": { "title": "WeightUnit", "enum": [ "Gram", "Pound" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.ExportReason": { "title": "ExportReason", "enum": [ "MERCHANDISE", "DOCUMENTS" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.AdjustmentReason": { "title": "AdjustmentReason", "enum": [ "GeneralAdjustment", "ItemNotAvailable", "CustomerReturnedItem", "CouldNotShip", "AlternateItemProvided", "BuyerCancelled", "CustomerExchange", "MerchandiseNotReceived", "ShippingAddressUndeliverable" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.AdjustmentAction": { "title": "AdjustmentAction", "enum": [ "Approve", "Reject" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.ReturnRejectionReason": { "title": "ReturnRejectionReason", "enum": [ "IneligibleForReturn", "ReturnNotNeeded", "ReturnWindowClosed", "DamagedProduct", "MissingItem", "ProductReturnedAfterTheReturnWindow", "WrongProduct", "Other" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.DayOfWeek": { "title": "DayOfWeek", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.DistributionCenterRollupType": { "title": "DistributionCenterRollupType", "enum": [ "SellerManaged", "ExternallyManaged", "Mixed" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.CheckoutStatus": { "title": "CheckoutStatus", "enum": [ "NotVisited", "Completed", "Visited", "CompletedAndVisited", "Disabled", "CompletedOffline", "OnHold" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.PaymentStatus": { "title": "PaymentStatus", "enum": [ "NotYetSubmitted", "Cleared", "Submitted", "Failed", "Deposited" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.ShippingStatus": { "title": "ShippingStatus", "enum": [ "Unshipped", "Shipped", "PartiallyShipped", "PendingShipment", "Canceled", "ThirdPartyManaged" ], "type": "string", "description": "Indicates the shipping state of an order.\n\n| Value | Description |\n|---|---|\n| `Unshipped` | Fulfillment is incomplete. This is the default value. |\n| `Shipped` | Fulfillment is complete. |\n| `PartiallyShipped` | Fulfillment is incomplete. |\n| `PendingShipment` | Fulfillment is incomplete. |\n| `Canceled` | Fulfillment is complete. |\n| `ThirdPartyManaged` | Fulfillment is complete. |" }, "ChannelAdvisor.RestApi.V1.Models.TaxType": { "title": "TaxType", "enum": [ "NoTax", "Standard", "ExclusiveVat", "InclusiveVat" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.ShippingAddressType": { "title": "ShippingAddressType", "enum": [ "Undefined", "Residential", "Commercial" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.FulfillmentType": { "title": "FulfillmentType", "enum": [ "Ship", "Pickup", "ShipToStore", "Courier" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.DeliveryStatus": { "title": "DeliveryStatus", "enum": [ "NoChange", "InTransit", "ReadyForPickup", "Complete", "Canceled", "ThirdPartyManaged", "Confirmed", "PickAndPack", "LabelCreated", "Held", "Delivered", "FailedDelivery" ], "type": "string", "description": "Indicates the delivery state of a fulfillment.\n\n| Value | Description |\n|---|---|\n| `NoChange` | The fulfillment is unshipped. Making a request with this value will set a fulfillment or order to unshipped. |\n| `InTransit` | The fulfillment is in transit to a location where the recipient may pick it up. Used for eBay In-Store-Pickup orders. |\n| `ReadyForPickup` | The fulfillment has arrived at the pickup location and is ready for the recipient to pick up. Used for eBay In-Store-Pickup orders. |\n| `Complete` | The fulfillment is complete and/or fully shipped. |\n| `Canceled` | The items on this fulfillment have been canceled and will not be fulfilled. |\n| `ThirdPartyManaged` | The fulfillment is handled outside Rithum. |\n| `Confirmed` | The fulfillment location confirms receipt of the order. |\n| `PickAndPack` | The items in the fulfillment are in the process of being retrieved and packed. |\n| `LabelCreated` | The items in the fulfillment are packed and a label has been generated for pickup or retrieval. |\n| `Held` | The fulfillment is in Held status when decisions are needed for change in the fulfillment. |\n| `Delivered` | The shipment was delivered to the final destination. |\n| `FailedDelivery` | The shipment failed delivery to the final destination. |" }, "ChannelAdvisor.RestApi.V1.Models.FulfillmentRequestStatus": { "title": "FulfillmentRequestStatus", "enum": [ "New", "Pending", "Sent", "Processing", "Complete", "Held", "Failed" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.FulfillmentItemSiteCommunicationStatus": { "title": "FulfillmentItemSiteCommunicationStatus", "enum": [ "Pending", "InProgress", "Complete", "CompletedWithoutNotification", "Failed" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.AdjustmentType": { "title": "AdjustmentType", "enum": [ "Refund", "Cancellation" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.AsyncStatus": { "title": "AsyncStatus", "enum": [ "SubmittedNotProcessed", "NewRma", "PendingApproval", "ProcessingApproval", "ReadyForReturn", "PendingReturn", "ProcessingReturn", "PendingRejection", "ProcessingRejection", "ProcessedNotAcknowledged", "PendingReturnRejection", "ProcessingReturnRejection", "AcknowledgedPostProcessingNotComplete", "Queued", "PostProcessingComplete", "RejectionCompleted", "InformationOnly", "NoChange", "Error" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.AdjustmentSource": { "title": "AdjustmentSource", "enum": [ "Channel", "UserInterface", "Api", "System" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.ChannelDocumentType": { "title": "ChannelDocumentType", "enum": [ "AmazonVATInvoice", "AmazonVATCreditNote" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.AmazonVATInvoiceRequestStatus": { "title": "AmazonVATInvoiceRequestStatus", "enum": [ "New", "DocumentGenerated", "SentToAmazon", "Complete", "Failed", "SellerUploaded", "FailedNeedsRetry", "SkippedBeforeStartDate" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.DistributionCenterType": { "title": "DistributionCenterType", "enum": [ "Warehouse", "ExternallyManaged", "DropShip", "RetailStore" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.ThroughputLimitUnits": { "title": "ThroughputLimitUnits", "enum": [ "Minutes", "Hours", "Days" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.DayIdentifier": { "title": "DayIdentifier", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.FlagType": { "title": "FlagType", "enum": [ "NoFlag", "RedFlag", "QuestionMark", "NotAvailable", "Price", "YellowFlag", "GreenFlag", "BlueFlag", "NotSpecified", "ItemCopied", "ExclamationPoint" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.BundleType": { "title": "BundleType", "enum": [ "None", "BundleComponent", "BundleItem", "AssemblyBundleItem" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.InventoryItemType": { "title": "InventoryItemType", "enum": [ "Item", "Child", "Bundle", "Parent" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.AliasType": { "title": "AliasType", "enum": [ "None", "Reference", "Alias" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.WebhookEndpointStatus": { "title": "WebhookEndpointStatus", "enum": [ "Deleted", "Enabled", "Disabled", "Suspended" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.WebhookAuthenticationType": { "title": "WebhookAuthenticationType", "enum": [ "Unknown", "SigningSecret", "CustomHeader", "BasicAuth" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.WebhookEventType": { "title": "WebhookEventType", "enum": [ "Unknown", "PaymentCleared", "SellerFulfillmentStatusChanged", "ExternalFulfillmentStatusChanged", "CancellationStarted", "CancellationFinalized", "RefundStarted", "RefundFinalized", "SellerManagedOrderPaymentCleared", "ExternallyManagedFulfillmentCompleted", "OrderModified" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.DocumentType": { "title": "DocumentType", "enum": [ "Unknown", "VATInvoice", "VATCreditNote", "ReturnShippingLabel" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.DocumentSourceType": { "title": "DocumentSourceType", "enum": [ "Unknown", "Site", "Seller" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.HttpStatusCode": { "title": "HttpStatusCode", "enum": [ "Continue", "SwitchingProtocols", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultipleChoices", "MovedPermanently", "Redirect", "SeeOther", "NotModified", "UseProxy", "Unused", "TemporaryRedirect", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "RequestEntityTooLarge", "RequestUriTooLong", "UnsupportedMediaType", "RequestedRangeNotSatisfiable", "ExpectationFailed", "UpgradeRequired", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HttpVersionNotSupported" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.QuantityUpdateType": { "title": "QuantityUpdateType", "enum": [ "Absolute", "Relative", "Available", "InStock", "UnShipped", "Unconfirmed" ], "type": "string" }, "ChannelAdvisor.RestApi.V1.Models.WebhookFailedEventsJobStatus": { "title": "WebhookFailedEventsJobStatus", "enum": [ "New", "Processing", "Ready", "Completed", "Failed" ], "type": "string" }, "ChannelAdvisor.PostSale.RestApi.V1.Models.Webhook": { "title": "Webhook", "type": "object", "properties": { "ID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "Name": { "type": [ "null", "string" ] }, "Status": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.WebhookEndpointStatus" }, "AuthenticationType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.WebhookAuthenticationType" }, "WebhookUri": { "type": [ "null", "string" ] }, "SigningSecret": { "type": [ "null", "string" ] }, "EventTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.WebhookEventType" } } }, "example": { "ID": 0, "Name": "string", "Status": "Deleted", "AuthenticationType": "Unknown", "WebhookUri": "string", "SigningSecret": "string", "EventTypes": [ "Unknown" ] } }, "ChannelAdvisor.PostSale.RestApi.V1.Models.LabelFormatType": { "title": "LabelFormatType", "enum": [ "JPEG", "PDF", "PNG", "GzipPDF", "GIFLandscape", "GzipPNG", "GIFPortrait", "ZPL", "GzipZPL" ], "type": "string" }, "ChannelAdvisor.PostSale.RestApi.V1.OrderDocuments.OrderDocumentUpload": { "title": "OrderDocumentUpload", "type": "object", "properties": { "ProfileID": { "maximum": 2147483647, "minimum": -2147483648, "type": [ "null", "number" ], "format": "int32" }, "OrderID": { "maximum": 2147483647, "minimum": -2147483648, "type": "number", "format": "int32" }, "DocumentKey": { "type": [ "null", "string" ] }, "DocumentType": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.DocumentType" }, "Metadata": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderDocumentMetadata" }, "x-ms-navigationProperty": true } }, "example": { "ProfileID": 0, "OrderID": 0, "DocumentKey": "string", "DocumentType": "Unknown", "Metadata": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderDocumentMetadata" } ] } }, "System.Net.Http.HttpContent": { "title": "HttpContent", "type": "object", "properties": { "Headers": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } } }, "example": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "Core.OpenApiExample": { "title": "OpenApiExample", "type": "object", "properties": { "Description": { "type": [ "null", "string" ] }, "Summary": { "type": [ "null", "string" ] }, "ParameterName": { "type": [ "null", "string" ] }, "Payload": { "type": [ "null", "string" ] } }, "example": { "Description": "string", "Summary": "string", "ParameterName": "string", "Payload": "string" } }, "Core.OpenApiDocumentation": { "title": "OpenApiDocumentation", "type": "object", "properties": { "OpenApiOperationID": { "type": [ "null", "string" ] }, "OpenApiTag": { "type": [ "null", "string" ] }, "Description": { "type": [ "null", "string" ] }, "Summary": { "type": [ "null", "string" ] }, "Examples": { "type": "array", "items": { "$ref": "#/components/schemas/Core.OpenApiExample" } } }, "example": { "OpenApiOperationID": "string", "OpenApiTag": "string", "Description": "string", "Summary": "string", "Examples": [ { "@odata.type": "Core.OpenApiExample" } ] } }, "ChannelAdvisor.RestApi.V1.Models.OrderCollectionResponse": { "title": "Collection of Order", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Order" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.OrderItemCollectionResponse": { "title": "Collection of OrderItem", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItem" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.FulfillmentCollectionResponse": { "title": "Collection of Fulfillment", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Fulfillment" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.FulfillmentItemCollectionResponse": { "title": "Collection of FulfillmentItem", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.FulfillmentItem" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.DistributionCenterCollectionResponse": { "title": "Collection of DistributionCenter", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.DistributionCenter" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.OperatingHoursCollectionResponse": { "title": "Collection of OperatingHours", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OperatingHours" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.OrderAdjustmentCollectionResponse": { "title": "Collection of OrderAdjustment", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderAdjustment" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.OrderItemAdjustmentCollectionResponse": { "title": "Collection of OrderItemAdjustment", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItemAdjustment" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.OrderItemBundleComponentCollectionResponse": { "title": "Collection of OrderItemBundleComponent", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItemBundleComponent" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.PromotionCollectionResponse": { "title": "Collection of Promotion", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Promotion" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.CustomFieldCollectionResponse": { "title": "Collection of CustomField", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.CustomField" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.ProfileCollectionResponse": { "title": "Collection of Profile", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Profile" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.ProductCollectionResponse": { "title": "Collection of Product", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Product" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.AliasRelationshipCollectionResponse": { "title": "Collection of AliasRelationship", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AliasRelationship" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.ImageCollectionResponse": { "title": "Collection of Image", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Image" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.AttributeValueCollectionResponse": { "title": "Collection of AttributeValue", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AttributeValue" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.DCQuantityCollectionResponse": { "title": "Collection of DCQuantity", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.DCQuantity" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.ProductLabelCollectionResponse": { "title": "Collection of ProductLabel", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ProductLabel" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.ProductBundleComponentCollectionResponse": { "title": "Collection of ProductBundleComponent", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ProductBundleComponent" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.ChildRelationshipCollectionResponse": { "title": "Collection of ChildRelationship", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ChildRelationship" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.PackageCollectionResponse": { "title": "Collection of Package", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Package" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.ChannelDocumentCollectionResponse": { "title": "Collection of ChannelDocument", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ChannelDocument" }, { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AmazonVATInvoiceDocument" } ] } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.NotSuppliedChannelDocumentCollectionResponse": { "title": "Collection of NotSuppliedChannelDocument", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.NotSuppliedChannelDocument" }, { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.NotSuppliedAmazonVATInvoiceDocument" } ] } } } } ] }, "ChannelAdvisor.PostSale.RestApi.V1.Models.WebhookCollectionResponse": { "title": "Collection of Webhook", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.PostSale.RestApi.V1.Models.Webhook" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.SiteCollectionResponse": { "title": "Collection of Site", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Site" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.OrderDocumentCollectionResponse": { "title": "Collection of OrderDocument", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderDocument" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.OrderDocumentFlyweightCollectionResponse": { "title": "Collection of OrderDocumentFlyweight", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderDocumentFlyweight" }, { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderDocument" } ] } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.OrderDocumentMetadataCollectionResponse": { "title": "Collection of OrderDocumentMetadata", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderDocumentMetadata" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.OrderAttributeValueCollectionResponse": { "title": "Collection of OrderAttributeValue", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderAttributeValue" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.OrderItemAttributeValueCollectionResponse": { "title": "Collection of OrderItemAttributeValue", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItemAttributeValue" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.TagCollectionResponse": { "title": "Collection of Tag", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.Tag" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.ExportStatusCollectionResponse": { "title": "Collection of ExportStatus", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ExportStatus" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.SiteAccountCollectionResponse": { "title": "Collection of SiteAccount", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.SiteAccount" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.ShippingLabelPartnerAccountCollectionResponse": { "title": "Collection of ShippingLabelPartnerAccount", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ShippingLabelPartnerAccount" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.AssemblyBundleDistributionCenterCollectionResponse": { "title": "Collection of AssemblyBundleDistributionCenter", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AssemblyBundleDistributionCenter" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.AmazonVATInvoiceDocumentCollectionResponse": { "title": "Collection of AmazonVATInvoiceDocument", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AmazonVATInvoiceDocument" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.NotSuppliedAmazonVATInvoiceDocumentCollectionResponse": { "title": "Collection of NotSuppliedAmazonVATInvoiceDocument", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.NotSuppliedAmazonVATInvoiceDocument" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.OpenIntervalCollectionResponse": { "title": "Collection of ChannelAdvisor.RestApi.V1.Models.OpenInterval", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OpenInterval" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.ReplacementItemCollectionResponse": { "title": "Collection of ChannelAdvisor.RestApi.V1.Models.ReplacementItem", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ReplacementItem" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.ShippingBusinessHourCollectionResponse": { "title": "Collection of ChannelAdvisor.RestApi.V1.Models.ShippingBusinessHour", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ShippingBusinessHour" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.CodeDescriptionCollectionResponse": { "title": "Collection of ChannelAdvisor.RestApi.V1.Models.CodeDescription", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.CodeDescription" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.ShipOrderRequestItemCollectionResponse": { "title": "Collection of ChannelAdvisor.RestApi.V1.Models.ShipOrderRequestItem", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ShipOrderRequestItem" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.OrderItemSubstitutionCollectionResponse": { "title": "Collection of ChannelAdvisor.RestApi.V1.Models.OrderItemSubstitution", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItemSubstitution" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.DCxQtyUpdateCollectionResponse": { "title": "Collection of ChannelAdvisor.RestApi.V1.Models.DCxQtyUpdate", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.DCxQtyUpdate" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.AttributeUpdateCollectionResponse": { "title": "Collection of ChannelAdvisor.RestApi.V1.Models.AttributeUpdate", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AttributeUpdate" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfStringCollectionResponse": { "title": "Collection of ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.ODataBatchResponseItemCollectionResponse": { "title": "Collection of ChannelAdvisor.RestApi.V1.Models.ODataBatchResponseItem", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ODataBatchResponseItem" } } } } ] }, "ChannelAdvisor.RestApi.V1.Models.HttpResponseMessageCollectionResponse": { "title": "Collection of ChannelAdvisor.RestApi.V1.Models.HttpResponseMessage", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.HttpResponseMessage" } } } } ] }, "Core.OpenApiExampleCollectionResponse": { "title": "Collection of Core.OpenApiExample", "type": "object", "allOf": [ { "$ref": "#/components/schemas/BaseCollectionPaginationCountResponse" }, { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/Core.OpenApiExample" } } } } ] }, "Object": { "type": "object" }, "AdjustmentReponse": { "type": "object", "properties": { "Adjustments": { "type": "array", "items": { "$ref": "#/components/schemas/Adjustment" } } } }, "Adjustment": { "type": "object", "properties": { "ID": { "type": "integer", "format": "int32" }, "ProfileID": { "type": "integer", "format": "int32" }, "OrderID": { "type": "integer", "format": "int32" }, "OrderItemID": { "type": "integer", "format": "int32" }, "Quantity": { "type": "integer", "format": "int32" }, "IsRestock": { "type": "boolean" }, "Reason": { "enum": [ "GeneralAdjustment", "ItemNotAvailable", "CustomerReturnedItem", "CouldNotShip", "AlternateItemProvided", "BuyerCancelled", "CustomerExchange", "MerchandiseNotReceived", "ShippingAddressUndeliverable" ], "type": "string" }, "ItemAdjustment": { "type": "number", "format": "double" }, "TaxAdjustment": { "type": "number", "format": "double" }, "ShippingAdjustment": { "type": "number", "format": "double" }, "ShippingTaxAdjustment": { "type": "number", "format": "double" }, "GiftWrapAdjustment": { "type": "number", "format": "double" }, "GiftWrapTaxAdjustment": { "type": "number", "format": "double" }, "RecyclingFeeAdjustment": { "type": "number", "format": "double" }, "Type": { "enum": [ "Refund", "Cancellation" ], "type": "string" }, "SellerAdjustmentID": { "type": "string" }, "SiteAdjustmentID": { "type": "string" }, "SiteRefundDateUtc": { "type": "string", "format": "date-time" }, "AdjustmentTransactionID": { "type": "string" }, "PublicNotes": { "type": "string" }, "Comment": { "type": "string" }, "CreatedDateUtc": { "type": "string", "format": "date-time" }, "RequestStatus": { "enum": [ "Error", "SubmittedNotProcessed", "NewRma", "PendingApproval", "ProcessingApproval", "ReadyForReturn", "PendingReturn", "ProcessingReturn", "PendingRejection", "ProcessingRejection", "ProcessedNotAcknowledged", "PendingReturnRejection", "ProcessingReturnRejection", "AcknowledgedPostProcessingNotComplete", "Queued", "PostProcessingComplete", "RejectionCompleted", "InformationOnly", "NoChange" ], "type": "string" }, "RestockStatus": { "enum": [ "Error", "SubmittedNotProcessed", "NewRma", "PendingApproval", "ProcessingApproval", "ReadyForReturn", "PendingReturn", "ProcessingReturn", "PendingRejection", "ProcessingRejection", "ProcessedNotAcknowledged", "PendingReturnRejection", "ProcessingReturnRejection", "AcknowledgedPostProcessingNotComplete", "Queued", "PostProcessingComplete", "RejectionCompleted", "InformationOnly", "NoChange" ], "type": "string" }, "RmaNumber": { "type": "string" }, "ReturnShippingFee": { "type": "number", "format": "double" }, "RestockingFee": { "type": "number", "format": "double" }, "ReturnTrackingNumberOrUrl": { "type": "string" }, "ReturnShippingMethod": { "type": "string" }, "ReturnShippingCost": { "type": "number", "format": "double" }, "ReferenceSku": { "type": "string" }, "ReferenceProductID": { "type": "integer", "format": "int32" }, "CreatedSource": { "enum": [ "Channel", "UserInterface", "Api", "System" ], "type": "string" }, "LastUpdatedSource": { "enum": [ "Channel", "UserInterface", "Api", "System" ], "type": "string" }, "ReturnRejectionReason": { "enum": [ "IneligibleForReturn", "ReturnNotNeeded", "ReturnWindowClosed", "DamagedProduct", "MissingItem", "ProductReturnedAfterTheReturnWindow", "WrongProduct", "Other" ], "type": "string" }, "ReturnSellerComment": { "type": "string" }, "LastUpdatedDateUtc": { "type": "string", "format": "date-time" }, "IsRma": { "type": "boolean" }, "ReturnDistributionCenterID": { "type": "integer", "format": "int32" }, "ReturnDistributionCenterCode": { "type": "string" }, "BuyerReturnComment": { "type": "string" } } }, "AcknowledgeOption": { "type": "object", "properties": { "ShouldEvictOnAdjustmentChange": { "type": "boolean" } } }, "UploadStatus": { "type": "object", "properties": { "Token": { "type": "string" }, "Status": { "type": "string" }, "StartedOnUtc": { "type": "string", "format": "date-time" }, "ResponseFileUrl": { "type": "string" } } }, "PagedResult[ApiFeedItem]": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/ApiFeedItem" } }, "Metadata": { "$ref": "#/components/schemas/PagingMetadata" } } }, "ApiFeedItem": { "type": "object", "properties": { "SiteAccountID": { "type": "integer", "format": "int32" }, "LabelID": { "type": "integer", "format": "int32" }, "LabelName": { "type": "string" }, "SiteID": { "type": "integer", "format": "int32" }, "SiteName": { "type": "string" } } }, "PagingMetadata": { "type": "object", "properties": { "Page": { "type": "integer", "format": "int32" }, "PageSize": { "type": "integer", "format": "int32" }, "TotalItems": { "type": "integer", "format": "int32" }, "NextPageUrl": { "type": "string" } } }, "PagedResult[UserGroup]": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "Metadata": { "$ref": "#/components/schemas/PagingMetadata" } } }, "UserGroup": { "type": "object", "properties": { "GroupID": { "type": "integer", "description": "The unique identifier for the group.", "format": "int32" }, "GroupName": { "type": "string", "description": "The name of the group." }, "IsAdmin": { "type": "boolean", "description": "Indicating whether the group has administrative privileges." }, "Modules": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityModule" }, "description": "The modules assigned to this group.\r\n Not populated when returned from GET v1/Users." }, "Users": { "type": "array", "items": { "$ref": "#/components/schemas/User" }, "description": "The users that belong to this group.\r\n Not populated when returned from GET v1/Users." }, "ProfileIDs": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The profile IDs associated with this group.\r\n Not populated when returned from GET v1/Users." } }, "description": "Represents a security group" }, "SecurityModule": { "type": "object", "properties": { "ModuleID": { "type": "integer", "description": "The unique identifier for the security module.", "format": "int32" }, "Name": { "type": "string", "description": "The name of the security module." }, "Description": { "type": "string", "description": "The description of the security module." } }, "description": "Security Module that controls access to various features in the user management system." }, "User": { "type": "object", "properties": { "UserID": { "type": "integer", "description": "The unique identifier for the user.", "format": "int32" }, "Status": { "enum": [ "Active", "Disabled", "DeactivatedByPolicy" ], "type": "string", "description": "Status of the user." }, "DisabledOnDate": { "type": "string", "description": "The date and time when the user was disabled.", "format": "date-time" }, "FirstName": { "type": "string", "description": "The first name of the user." }, "LastName": { "type": "string", "description": "The last name of the user." }, "LoginName": { "type": "string", "description": "The login name for the user." }, "CorrespondenceEmailAddress": { "type": "string", "description": "The correspondence email address for the user." }, "PhoneNumber": { "type": "string", "description": "The phone number for the user." }, "EnableSAMLDirectLogin": { "type": "boolean", "description": "Indicates whether the user can login directly if they have SAML access." }, "BillingAccess": { "type": "boolean", "description": "Indicating whether the user can access Rithum for Brands billing features." }, "Groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, "description": "Gets or sets the groups this user belongs to.\r\n Note: When returned from GET v1/Users, the Groups collection will NOT have Modules, Users, or ProfileIDs populated in the Group object." } }, "description": "Represents a user in the Rithum for Brands system." }, "ViewClaimModel": { "type": "object", "properties": { "Type": { "type": "string" }, "Value": { "type": "string" } } }, "PagedResult[ProductUploadArchiveItem]": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/ProductUploadArchiveItem" } }, "Metadata": { "$ref": "#/components/schemas/PagingMetadata" } } }, "ProductUploadArchiveItem": { "type": "object", "properties": { "FileId": { "type": "integer", "description": "Inventory file identifier, unique within the profile. This is the value the single-file\r\n endpoint takes.", "format": "int32" }, "FileType": { "type": "string", "description": "Upload type by name rather than by number: InventoryUpload, not 10. The\r\n numeric vocabulary is internal and is published nowhere a caller could look it up, so a\r\n bare id would be unreadable. Today this endpoint only ever reports one value; it is stated\r\n on every row anyway so the payload stays self-describing if that widens." }, "ImportType": { "type": "string", "description": "What the import was to do to existing data, by name: InventoryAddUpdate,\r\n InventoryUpdate, InventoryAdd or InventoryWipeAndReplace.\r\n \r\n Reported rather than filtered on. Paging already reads the whole date window, so a\r\n server-side filter would trim the payload and not the work, and callers disagree about\r\n which cut they want. Null where the file carries no import type.\r\n \r\n Note this says what the import was to do, not where the file came from. It\r\n will not separate a seller's own upload from one a runner produced, because a behaviour\r\n is stamped on generated rows too. The field that would is SourceTypeID, which the\r\n catalog procedure does not return; surfacing it needs a change in the DATABASE repo." }, "FileName": { "type": "string", "description": "The name the customer submitted the file under. Not the name of the archive object in S3,\r\n that is always uploadsource_{fileId}_original.{ext}.zip and is reported by the\r\n single-file endpoint, which has resolved it." }, "ProductCount": { "type": "integer", "description": "Rows the upload was recorded as carrying, or zero where no count was written.", "format": "int32" }, "SubmittedDate": { "type": "string", "description": "When the upload was submitted, UTC. The modifiedsince lower bound filters on this.", "format": "date-time" }, "CompletedDate": { "type": "string", "description": "When processing finished, UTC. Null while the upload is still in flight.", "format": "date-time" } }, "description": "One customer product upload, as the internal uploads endpoint reports it.\r\n \r\n Deliberately carries no download URL. Signing one costs an S3 directory listing per file,\r\n because the archive object's name ends in the submitted file's extension and so cannot be\r\n derived from the file id, so a hundred-row page would be a hundred S3 calls. Consumers fetch a\r\n URL for the files they actually want, one at a time." }, "ProductUploadArchiveDownload": { "type": "object", "properties": { "FileId": { "type": "integer", "description": "Inventory file identifier the archive belongs to.", "format": "int32" }, "ArchiveFileName": { "type": "string", "description": "Name of the archive object itself, uploadsource_{fileId}_original.{ext}.zip. The\r\n extension reflects what the customer submitted, which is why resolving it needs a lookup\r\n rather than string formatting." }, "SizeBytes": { "type": "integer", "description": "Size of the archive in bytes, as S3 reports it.", "format": "int64" }, "LastModified": { "type": "string", "description": "Last-modified timestamp of the archive object.", "format": "date-time" }, "Url": { "type": "string", "description": "The pre-signed URL. Treat it as a secret: anyone holding it can fetch the file until it\r\n expires." }, "ExpiresAt": { "type": "string", "description": "When {ChannelAdvisor.RestApi.Common.ProductUploads.Models.ProductUploadArchiveDownload.Url} stops working, UTC. Derived from the same lifetime the signature was\r\n produced with, so a consumer can decide whether to reuse a URL or ask for a fresh one\r\n instead of discovering the answer from a 403.", "format": "date-time" } }, "description": "A resolved product upload archive and a short-lived, pre-signed URL for its bytes.\r\n \r\n The URL is a plain AWS SigV4 link straight to S3: no Complete session, no cookie and no\r\n handler in the path, so an unattended service can fetch it with nothing but an HTTP client.\r\n The bytes never pass through this API; it answers only what exists and where." }, "PagedResult[LabelChannelTargetingItem]": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/LabelChannelTargetingItem" } }, "Metadata": { "$ref": "#/components/schemas/PagingMetadata" } } }, "LabelChannelTargetingItem": { "type": "object", "properties": { "LabelName": { "type": "string", "description": "Inventory label name. Joins to Product.Labels[] on the public REST surface." }, "LabelId": { "type": "integer", "description": "Identifier of the label. Retained alongside {ChannelAdvisor.RestApi.Common.LabelTargeting.Models.LabelChannelTargetingItem.LabelName} so a consumer can\r\n still correlate rows when a label has been renamed or its name could not be resolved.", "format": "int32" }, "SiteAccountId": { "type": "integer", "description": "Integer customer channel identifier of the targeted connection. This is the same\r\n identity the public REST surface calls SiteAccount / siteAccountId,\r\n and it is what distinguishes two connections to the same marketplace.", "format": "int32" }, "SiteId": { "type": "integer", "description": "Marketplace site identifier of the connection.", "format": "int32" }, "SiteName": { "type": "string", "description": "Marketplace name of the connection (for example Amazon, eBay)." }, "SiteAccountName": { "type": "string", "description": "Display name of the connection. The seller's custom name when one is set, otherwise\r\n the derived nickname, which appends the site instance for marketplaces that allow\r\n several accounts so same-marketplace connections remain distinguishable." } }, "description": "One edge in a profile's effective label-to-connection targeting: the label\r\n {ChannelAdvisor.RestApi.Common.LabelTargeting.Models.LabelChannelTargetingItem.LabelName} routes items to the channel connection identified by\r\n {ChannelAdvisor.RestApi.Common.LabelTargeting.Models.LabelChannelTargetingItem.SiteAccountId}.\r\n \r\n A connection may appear on several rows when more than one label routes to it\r\n (for example a Marketplaces connection with several active feeds, or a\r\n ChannelSync connection carrying both a primary and a Digital Marketing feed).\r\n A label may likewise appear on several rows when it routes to more than one\r\n connection. Consumers group by whichever key they need." }, "PagedResult[DcMappingItem]": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/DcMappingItem" } }, "Metadata": { "$ref": "#/components/schemas/PagingMetadata" } } }, "DcMappingItem": { "type": "object", "properties": { "SiteAccountId": { "type": "integer", "description": "Integer customer channel identifier of the connection the row belongs to. This is the same\r\n identity the public REST surface calls SiteAccount / siteAccountId, and it is\r\n what distinguishes two connections to the same marketplace.", "format": "int32" }, "SiteId": { "type": "integer", "description": "Marketplace site identifier of the connection. Also the site whose enabled distribution\r\n centres produced this row, so two connections on the same site report the same centres.", "format": "int32" }, "SiteName": { "type": "string", "description": "Marketplace name of the connection (for example Walmart, Target)." }, "SiteAccountName": { "type": "string", "description": "Display name of the connection. The seller's custom name when one is set, otherwise the\r\n derived nickname, which appends the site instance for marketplaces that allow several\r\n accounts so same-marketplace connections remain distinguishable." }, "DistributionCenterId": { "type": "integer", "description": "ChannelAdvisor distribution centre identifier — the client-level ClientDistCtrID.\r\n Joins to the DistributionCenters entity set and to the per-centre quantities a\r\n consumer reads from DCQuantity.", "format": "int32" }, "DistributionCenterCode": { "type": "string", "description": "Code of the ChannelAdvisor distribution centre, resolved from the centre itself rather than\r\n read from the stored mapping. Neither storage shape persists it: the shared shape keeps only\r\n the identifier, and the 1P shape keeps a name. Resolving it makes the field populated\r\n identically for every channel family instead of only for some.\r\n \r\n null when the identifier does not resolve to a distribution centre on the client.\r\n Soft-deleted centres do resolve, since one can still hold a site-priority record." }, "DistributionCenterPriority": { "type": "integer", "description": "Order the site publishes this distribution centre in, from the site's distribution centre\r\n priority configuration. Lower is higher priority.\r\n \r\n Always present: every row originates from a priority record, which is what makes this\r\n non-nullable while the site-side fields below are not.", "format": "int32" }, "SiteDistributionCenterCode": { "type": "string", "description": "The marketplace's own identifier for the warehouse this distribution centre publishes to —\r\n a Walmart ship node, a Target warehouse code, a 1P warehouse code.\r\n \r\n null when the connection has no stored mapping for this centre, which is a normal\r\n state and means quantity is not routed anywhere for it. Never an empty string, including\r\n when the channel stored a blank one." }, "SiteDistributionCenterName": { "type": "string", "description": "The marketplace's own name for that warehouse. null when there is no stored mapping,\r\n and also when the mapping supplies no name — the common case, since most channels store a\r\n code and no name. Distinguishing null from \"\" matters here: the first says the\r\n channel gave us no name, the second would be indistinguishable from a channel that gave us\r\n a blank one." } }, "description": "One distribution centre a connection publishes quantity from, and the marketplace warehouse\r\n that quantity is routed to when a mapping has been configured.\r\n \r\n A row exists because the distribution centre is enabled for the connection's site, not\r\n because a mapping was stored for it. The stored mapping is a left join onto that set:\r\n {ChannelAdvisor.RestApi.Common.DcMappings.Models.DcMappingItem.SiteDistributionCenterCode} and {ChannelAdvisor.RestApi.Common.DcMappings.Models.DcMappingItem.SiteDistributionCenterName} are\r\n populated when one matches and null when none does. That mirrors what ChannelSync does\r\n at publish time, which iterates the site's enabled centres and enriches from the stored\r\n mapping — so an enabled centre with no mapping is visible as the routing gap it is, rather\r\n than being invisible.\r\n \r\n The consequence in the other direction: a stored mapping for a centre the site has not enabled\r\n produces no row, because the sync would not publish it either.\r\n \r\n The relation is many-to-many, so the shape is a flat edge list rather than a connection holding\r\n an array. A connection appears once per enabled centre, and a centre appears once per\r\n connection whose site enables it. Consumers group by whichever key they need." }, "PagedResult[ApiListingProduct]": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/ApiListingProduct" } }, "Metadata": { "$ref": "#/components/schemas/PagingMetadata" } } }, "ApiListingProduct": { "type": "object", "properties": { "ListingID": { "type": "integer", "format": "int32" }, "SiteAccountID": { "type": "integer", "format": "int32" }, "ItemID": { "type": "integer", "format": "int32" }, "MarketplaceID": { "type": "string" }, "Price": { "type": "number", "format": "double" }, "PriceLeader": { "type": "string" }, "PriceSource": { "enum": [ "Template", "Repricer", "DealPlanner", "InvalidShippingPrice", "VelocityPricing", "Unknown" ], "type": "string" }, "Category": { "type": "string" }, "Quantity": { "type": "integer", "format": "int32" }, "ListingStatus": { "enum": [ "NotListed", "Listed" ], "type": "string" }, "SyncStatus": { "enum": [ "Pending", "Live", "Error", "Sent", "NotSent", "Warning", "Filtered" ], "type": "string" }, "LastSubmittedDateUTC": { "type": "string", "format": "date-time" }, "LastUpdateDateUTC": { "type": "string", "format": "date-time" }, "BuyBoxPercentage": { "type": "number", "format": "double" }, "Product": { "$ref": "#/components/schemas/ListingsProduct" } } }, "ListingsProduct": { "type": "object", "properties": { "Sku": { "type": "string" }, "ParentSku": { "type": "string" }, "ReferenceSku": { "type": "string" }, "Title": { "type": "string" }, "Brand": { "type": "string" }, "GTIN": { "type": "string" }, "FeaturedFields": { "type": "array", "items": { "$ref": "#/components/schemas/FeaturedField" } } } }, "FeaturedField": { "type": "object", "properties": { "Name": { "type": "string" }, "Value": { "type": "string" }, "Type": { "enum": [ "Numeric", "Text", "Boolean" ], "type": "string" } } }, "PagedResult[ApiListingErrorProduct]": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/ApiListingErrorProduct" } }, "Metadata": { "$ref": "#/components/schemas/PagingMetadata" } } }, "ApiListingErrorProduct": { "type": "object", "properties": { "EstimatedPotentialRevenue": { "type": "number", "format": "double" }, "Severity": { "enum": [ "Information", "Warning", "Error" ], "type": "string" }, "ErrorMessage": { "type": "string" }, "ErrorCode": { "type": "string" }, "ErrorTitle": { "type": "string" }, "ErrorDetails": { "type": "string" }, "ListingID": { "type": "integer", "format": "int32" }, "SiteAccountID": { "type": "integer", "format": "int32" }, "ItemID": { "type": "integer", "format": "int32" }, "MarketplaceID": { "type": "string" }, "Price": { "type": "number", "format": "double" }, "PriceLeader": { "type": "string" }, "PriceSource": { "enum": [ "Template", "Repricer", "DealPlanner", "InvalidShippingPrice", "VelocityPricing", "Unknown" ], "type": "string" }, "Category": { "type": "string" }, "Quantity": { "type": "integer", "format": "int32" }, "ListingStatus": { "enum": [ "NotListed", "Listed" ], "type": "string" }, "SyncStatus": { "enum": [ "Pending", "Live", "Error", "Sent", "NotSent", "Warning", "Filtered" ], "type": "string" }, "LastSubmittedDateUTC": { "type": "string", "format": "date-time" }, "LastUpdateDateUTC": { "type": "string", "format": "date-time" }, "BuyBoxPercentage": { "type": "number", "format": "double" }, "Product": { "$ref": "#/components/schemas/ListingsProduct" } } }, "PagedResult[ApiListingErrorRollupProduct]": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/ApiListingErrorRollupProduct" } }, "Metadata": { "$ref": "#/components/schemas/PagingMetadata" } } }, "ApiListingErrorRollupProduct": { "type": "object", "properties": { "ID": { "type": "string" }, "SiteAccountID": { "type": "integer", "format": "int32" }, "Severity": { "enum": [ "Information", "Warning", "Error" ], "type": "string" }, "Message": { "type": "string" }, "TotalListed": { "type": "integer", "format": "int32" }, "TotalNotListed": { "type": "integer", "format": "int32" }, "TotalErrorCount": { "type": "integer", "format": "int32" }, "Quantity": { "type": "integer", "format": "int32" }, "TotalEstimatedPotentialRevenue": { "type": "number", "format": "double" }, "Metadata": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ExportFile": { "type": "object", "properties": { "ProfileId": { "type": "integer", "format": "int32" } } }, "ExportStatus": { "type": "object", "properties": { "Token": { "type": "string" }, "Status": { "type": "string" }, "StartedOnUtc": { "type": "string", "format": "date-time" }, "ResponseFileUrl": { "type": "string" } } }, "UploadFile": { "type": "object", "properties": { "ProfileId": { "type": "integer", "format": "int32" }, "Extension": { "type": "string" }, "Filename": { "type": "string" }, "Delimiter": { "type": "string" }, "TemplateCode": { "type": "string" }, "TdfTemplateId": { "type": "integer", "format": "int32" }, "ImportType": { "type": "integer", "format": "int32" }, "InventoryFileType": { "type": "integer", "format": "int32", "readOnly": true }, "Source": { "type": "integer", "format": "int32" }, "Content": { "$ref": "#/components/schemas/HttpContent" } } }, "HttpContent": { "type": "object", "properties": { "Headers": { "type": "array", "items": { "$ref": "#/components/schemas/KeyValuePair[String,IEnumerable[String]]" }, "readOnly": true } } }, "KeyValuePair[String,IEnumerable[String]]": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "array", "items": { "type": "string" } } } }, "PagedResult[InboundShippingMappingModel]": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/InboundShippingMappingModel" } }, "Metadata": { "$ref": "#/components/schemas/PagingMetadata" } } }, "InboundShippingMappingModel": { "type": "object", "properties": { "ProfileID": { "type": "integer", "description": "The profile (seller account) this mapping belongs to.", "format": "int32" }, "SiteCarrierName": { "type": "string", "description": "The channel/marketplace carrier name being mapped from." }, "SiteCarrierClassName": { "type": "string", "description": "The channel/marketplace carrier class (shipping method) being mapped from." }, "SiteClassDescription": { "type": "string", "description": "The channel/marketplace class description." }, "ShippingCarrierID": { "type": "integer", "description": "The ChannelAdvisor-internal carrier the channel carrier maps to.", "format": "int32" }, "ShippingCarrier": { "type": "string", "description": "The name of the ChannelAdvisor-internal carrier ({ChannelAdvisor.RestApi.Authorization.Server.Models.Shipping.InboundShippingMappingModel.ShippingCarrierID})." }, "ShippingClassID": { "type": "integer", "description": "The ChannelAdvisor-internal class the channel class maps to.", "format": "int32" }, "ShippingClass": { "type": "string", "description": "The name of the ChannelAdvisor-internal class ({ChannelAdvisor.RestApi.Authorization.Server.Models.Shipping.InboundShippingMappingModel.ShippingClassID})." }, "InboundShippingMappingType": { "enum": [ "OrderImport", "TrackingUpdate" ], "type": "string", "description": "Where the mapping applies: order import or tracking update." } }, "description": "A single inbound shipping mapping row: a channel/marketplace carrier + class that maps to a\r\n ChannelAdvisor-internal carrier/class, applied on order import and tracking updates. Flat\r\n projection of {ChannelAdvisor.PostSale.Client.ShippingMappingSettings}, stamped with the owning profile." }, "PagedResult[OutboundShippingMappingModel]": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/OutboundShippingMappingModel" } }, "Metadata": { "$ref": "#/components/schemas/PagingMetadata" } } }, "OutboundShippingMappingModel": { "type": "object", "properties": { "ProfileID": { "type": "integer", "description": "The profile (seller account) this mapping belongs to.", "format": "int32" }, "SiteID": { "type": "integer", "description": "The site (marketplace channel) the mapping applies to.", "format": "int32" }, "ShippingCarrierID": { "type": "integer", "description": "The ChannelAdvisor-internal carrier being mapped from.", "format": "int32" }, "ShippingCarrier": { "type": "string", "description": "The name of the ChannelAdvisor-internal carrier ({ChannelAdvisor.RestApi.Authorization.Server.Models.Shipping.OutboundShippingMappingModel.ShippingCarrierID})." }, "ShippingClassID": { "type": "integer", "description": "The ChannelAdvisor-internal class being mapped from.", "format": "int32" }, "ShippingClass": { "type": "string", "description": "The name of the ChannelAdvisor-internal class ({ChannelAdvisor.RestApi.Authorization.Server.Models.Shipping.OutboundShippingMappingModel.ShippingClassID})." }, "ChannelCarrierCode": { "type": "string", "description": "The channel's carrier code the internal carrier maps to." }, "ChannelCarrierClassCode": { "type": "string", "description": "The channel's carrier class code the internal class maps to." } }, "description": "A single outbound (\"channel\") shipping mapping row: a ChannelAdvisor-internal carrier/class that\r\n maps to a channel's carrier + class codes for a given site. Flat projection of\r\n {ChannelAdvisor.PostSale.Client.ChannelShippingMapping}, stamped with the owning profile." }, "PagedResult[ShippingMethodModel]": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodModel" } }, "Metadata": { "$ref": "#/components/schemas/PagingMetadata" } } }, "ShippingMethodModel": { "type": "object", "properties": { "ProfileID": { "type": "integer", "description": "The profile (seller account) this method belongs to.", "format": "int32" }, "ShippingCarrierID": { "type": "integer", "description": "The ChannelAdvisor-internal carrier ID.", "format": "int32" }, "ShippingCarrier": { "type": "string", "description": "The carrier name." }, "ShippingCarrierCode": { "type": "string", "description": "The carrier code." }, "ShippingClassID": { "type": "integer", "description": "The ChannelAdvisor-internal class ID.", "format": "int32" }, "ShippingClass": { "type": "string", "description": "The class name." }, "ShippingClassCode": { "type": "string", "description": "The class code." }, "TrackingUrlFormat": { "type": "string", "description": "The tracking URL format template for this carrier/class." } }, "description": "A single ChannelAdvisor shipping method (carrier + class) available to a profile. Flat projection of\r\n {ChannelAdvisor.PostSale.Client.ShippingCarrierClass}, stamped with the owning profile. Methods that are neither\r\n seller-enabled nor seller-visible are excluded." }, "StreamModel": { "type": "object", "properties": { "StreamID": { "type": "integer", "format": "int32" }, "EventTypes": { "type": "array", "items": { "enum": [ "Unknown", "NewRma", "ReadyForReturn" ], "type": "string" } }, "Status": { "enum": [ "Disabled", "Enabled" ], "type": "string" }, "CreatedDateUtc": { "type": "string", "format": "date-time" } } }, "EventModel": { "type": "object", "properties": { "StreamEventID": { "type": "integer", "format": "int32" }, "ProfileID": { "type": "integer", "format": "int32" }, "StreamID": { "type": "integer", "format": "int32" }, "OrderID": { "type": "integer", "format": "int32" }, "EntityID": { "type": "integer", "format": "int32" }, "EventType": { "enum": [ "Unknown", "NewRma", "ReadyForReturn" ], "type": "string" }, "EventDateUtc": { "type": "string", "format": "date-time" }, "EventPayload": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Object" } } }, "description": "Stream event. The EventPayload is a dynamic object that will be based on the EventType" }, "TrackingUploadFile": { "type": "object", "properties": { "Extension": { "type": "string" }, "FileName": { "type": "string" }, "Delimiter": { "type": "string" }, "IsZip": { "type": "boolean" }, "Content": { "$ref": "#/components/schemas/HttpContent" } } }, "TrackingUploadFileStatus": { "type": "object", "properties": { "Token": { "type": "string" }, "Status": { "type": "string" }, "StartedOnUtc": { "type": "string", "format": "date-time" }, "ResponseFileUrl": { "type": "string" } } }, "PagedResult[User]": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "Metadata": { "$ref": "#/components/schemas/PagingMetadata" } } }, "CreateUserRequest": { "required": [ "FirstName", "LastName", "LoginName", "GroupIDs" ], "type": "object", "properties": { "FirstName": { "type": "string", "description": "First name. Required." }, "LastName": { "type": "string", "description": "Last name. Required." }, "LoginName": { "type": "string", "description": "Login name. Required." }, "PhoneNumber": { "type": "string", "description": "Phone number." }, "BillingAccess": { "type": "boolean", "description": "Billing access flag." }, "DisableOnDate": { "type": "string", "description": "Date to disable the user.", "format": "date-time" }, "EnableSAMLDirectLogin": { "type": "boolean", "description": "Enable SAML direct login flag." }, "Enabled": { "type": "boolean", "description": "Enable or disable the user." }, "CorrespondenceEmailAddress": { "type": "string", "description": "Correspondence email address. If not provided, LoginName will be used." }, "GroupIDs": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "List of group IDs. Required. Must contain at least one ID." } } }, "UpdateUserRequest": { "type": "object", "properties": { "LoginName": { "type": "string", "description": "New login name. Cannot be empty string." }, "FirstName": { "type": "string", "description": "New first name. Cannot be empty string." }, "LastName": { "type": "string", "description": "New last name. Cannot be empty string." }, "PhoneNumber": { "type": "string", "description": "New phone number. Empty string clears the value." }, "BillingAccess": { "type": "boolean", "description": "Billing access flag." }, "DisableOnDate": { "type": "string", "description": "Date to disable the user.", "format": "date-time" }, "EnableSAMLDirectLogin": { "type": "boolean", "description": "Enable SAML direct login flag." }, "Enabled": { "type": "boolean", "description": "Enable or disable the user." }, "CorrespondenceEmailAddress": { "type": "string", "description": "Correspondence email address. If not provided, LoginName will be used." } } }, "GroupsRequest": { "required": [ "GroupIDs" ], "type": "object", "properties": { "GroupIDs": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "List of group IDs. Must contain at least one ID." } } }, "DisableUserRequest": { "type": "object", "properties": { "DisableOnDate": { "type": "string", "description": "Date to disable the user.", "format": "date-time" } } }, "PagedResult[SecurityModule]": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityModule" } }, "Metadata": { "$ref": "#/components/schemas/PagingMetadata" } } }, "Webhook.WebhookEventEnvelope": { "type": "object", "properties": { "schema": { "type": "string" }, "eventDateUtc": { "type": "string", "format": "date-time" }, "webhookId": { "type": "integer" }, "payload": { "oneOf": [ { "$ref": "#/components/schemas/Webhook.OrderEventPayload" }, { "$ref": "#/components/schemas/Webhook.FulfillmentEventPayload" }, { "$ref": "#/components/schemas/Webhook.AdjustmentEventPayload" } ], "description": "Event-specific payload" } }, "description": "Webhook event envelope containing metadata and payload" }, "Webhook.OrderEventPayload": { "type": "object", "properties": { "schema": { "type": "string" }, "eventDateUtc": { "type": "string", "format": "date-time" }, "webhookId": { "type": "integer" }, "payload": { "$ref": "#/components/schemas/Webhook.Order" } } }, "Webhook.FulfillmentEventPayload": { "type": "object", "properties": { "schema": { "type": "string" }, "eventDateUtc": { "type": "string", "format": "date-time" }, "webhookId": { "type": "integer" }, "payload": { "$ref": "#/components/schemas/Webhook.Fulfillment" } } }, "Webhook.AdjustmentEventPayload": { "type": "object", "properties": { "schema": { "type": "string" }, "eventDateUtc": { "type": "string", "format": "date-time" }, "webhookId": { "type": "integer" }, "payload": { "$ref": "#/components/schemas/Webhook.AdjustmentPayload" } } }, "Webhook.Order": { "type": "object", "properties": { "ID": { "type": "integer" }, "ProfileID": { "type": "integer" }, "SiteID": { "type": "integer" }, "SiteName": { "type": "string" }, "UserDataPresent": { "type": "string" }, "UserDataRemovalDateUTC": { "type": [ "null", "string" ], "format": "date-time" }, "SiteAccountID": { "type": [ "null", "integer" ] }, "SiteOrderID": { "type": "string" }, "SecondarySiteOrderID": { "type": "string" }, "SellerOrderID": { "type": "string" }, "CheckoutSourceID": { "type": [ "null", "string" ] }, "Currency": { "type": "string" }, "CreatedDateUtc": { "type": "string", "format": "date-time" }, "ImportDateUtc": { "type": "string", "format": "date-time" }, "UpdatedDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "PublicNotes": { "type": "string" }, "PrivateNotes": { "type": "string" }, "SpecialInstructions": { "type": "string" }, "TotalPrice": { "type": "number", "format": "decimal" }, "TotalTaxPrice": { "type": "number", "format": "decimal" }, "TotalShippingPrice": { "type": "number", "format": "decimal" }, "TotalShippingTaxPrice": { "type": [ "null", "number" ], "format": "decimal" }, "TotalInsurancePrice": { "type": "number", "format": "decimal" }, "TotalGiftOptionPrice": { "type": [ "null", "number" ], "format": "decimal" }, "TotalGiftOptionTaxPrice": { "type": [ "null", "number" ], "format": "decimal" }, "AdditionalCostOrDiscount": { "type": "number", "format": "decimal" }, "EstimatedShipDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "DeliverByDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "RequestedShippingCarrier": { "type": "string" }, "RequestedShippingClass": { "type": "string" }, "ResellerID": { "type": "string" }, "FlagID": { "type": [ "null", "integer" ] }, "FlagDescription": { "type": "string" }, "OrderTags": { "type": "string" }, "DistributionCenterTypeRollup": { "$ref": "#/components/schemas/Webhook.DistributionCenterRollupType" }, "CheckoutStatus": { "$ref": "#/components/schemas/Webhook.CheckoutStatus" }, "PaymentStatus": { "$ref": "#/components/schemas/Webhook.PaymentStatus" }, "ShippingStatus": { "$ref": "#/components/schemas/Webhook.ShippingStatus" }, "CheckoutDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "PaymentDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "ShippingDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "BuyerUserId": { "type": "string" }, "BuyerEmailAddress": { "type": "string" }, "BuyerEmailOptIn": { "type": [ "null", "boolean" ] }, "OrderTaxType": { "$ref": "#/components/schemas/Webhook.TaxType" }, "ShippingTaxType": { "$ref": "#/components/schemas/Webhook.TaxType" }, "GiftOptionsTaxType": { "$ref": "#/components/schemas/Webhook.TaxType" }, "PaymentMethod": { "type": "string" }, "PaymentTransactionID": { "type": "string" }, "PaymentPaypalAccountID": { "type": "string" }, "PaymentCreditCardLast4": { "type": "string" }, "PaymentMerchantReferenceNumber": { "type": "string" }, "ShippingTitle": { "type": "string" }, "ShippingFirstName": { "type": "string" }, "ShippingLastName": { "type": "string" }, "ShippingSuffix": { "type": "string" }, "ShippingCompanyName": { "type": "string" }, "ShippingCompanyJobTitle": { "type": "string" }, "ShippingDaytimePhone": { "type": "string" }, "ShippingEveningPhone": { "type": "string" }, "ShippingAddressLine1": { "type": "string" }, "ShippingAddressLine2": { "type": "string" }, "ShippingCity": { "type": "string" }, "ShippingStateOrProvince": { "type": "string" }, "ShippingStateOrProvinceName": { "type": "string" }, "ShippingPostalCode": { "type": "string" }, "ShippingCountry": { "type": "string" }, "BillingTitle": { "type": "string" }, "BillingFirstName": { "type": "string" }, "BillingLastName": { "type": "string" }, "BillingSuffix": { "type": "string" }, "BillingCompanyName": { "type": "string" }, "BillingCompanyJobTitle": { "type": "string" }, "BillingDaytimePhone": { "type": "string" }, "BillingEveningPhone": { "type": "string" }, "BillingAddressLine1": { "type": "string" }, "BillingAddressLine2": { "type": "string" }, "BillingCity": { "type": "string" }, "BillingStateOrProvince": { "type": "string" }, "BillingStateOrProvinceName": { "type": "string" }, "BillingPostalCode": { "type": "string" }, "BillingCountry": { "type": "string" }, "PromotionCode": { "type": "string" }, "PromotionAmount": { "type": "number", "format": "decimal" }, "ShippingAddressType": { "$ref": "#/components/schemas/Webhook.ShippingAddressType" }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.OrderItem" } }, "Fulfillments": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.Fulfillment" } }, "Adjustments": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.OrderAdjustment" } }, "CustomFields": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.CustomField" } }, "OrderAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.OrderAttributeValue" } }, "Tags": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.Tag" } }, "ShippingBusinessHours": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.ShippingBusinessHour" } } }, "description": "Order entity representing a ChannelAdvisor order.\n\nNote: The properties included vary by event type:\n- Order events: All properties are included.\n- Fulfillment events: Items, Fulfillments, and Adjustments are excluded. CustomFields and OrderAttributes are included.\n- Adjustment events: CustomFields are excluded. Items, Fulfillments, Adjustments, and OrderAttributes are included." }, "Webhook.Fulfillment": { "type": "object", "properties": { "ID": { "type": "integer" }, "ProfileID": { "type": "integer" }, "OrderID": { "type": "integer" }, "CreatedDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "UpdatedDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "Type": { "$ref": "#/components/schemas/Webhook.FulfillmentType" }, "DeliveryStatus": { "$ref": "#/components/schemas/Webhook.DeliveryStatus" }, "TrackingNumber": { "type": "string" }, "TrackingUrl": { "type": "string" }, "ReturnTrackingNumber": { "type": "string" }, "ShippingCarrier": { "type": "string" }, "ShippingClass": { "type": "string" }, "DistributionCenterID": { "type": "integer" }, "ExternalFulfillmentCenterCode": { "type": "string" }, "ExternalFulfillmentStatus": { "$ref": "#/components/schemas/Webhook.FulfillmentRequestStatus" }, "ShippingCost": { "type": [ "null", "number" ], "format": "decimal" }, "InsuranceCost": { "type": [ "null", "number" ], "format": "decimal" }, "TaxCost": { "type": [ "null", "number" ], "format": "decimal" }, "ShippedDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "SellerFulfillmentID": { "type": "string" }, "HasShippingLabel": { "type": "boolean" }, "HasChannelPackingSlip": { "type": "boolean" }, "HasReturnLabel": { "type": "boolean" }, "HasChannelReturnLabel": { "type": "boolean" }, "ExternalFulfillmentNumber": { "type": "string" }, "ExternalFulfillmentReferenceNumber": { "type": "string" }, "ShippingLabelRequestID": { "type": "string" }, "StagingLocation": { "type": "string" }, "EstimatedShipDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "SerialShippingContainerCode": { "type": "string" }, "EarliestDeliveryDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "EarliestShipDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "EstimatedDeliveryDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "LabelFormat": { "$ref": "#/components/schemas/Webhook.LabelFormatType" }, "ReturnLabelFormat": { "$ref": "#/components/schemas/Webhook.LabelFormatType" }, "ChannelReturnLabelFormat": { "$ref": "#/components/schemas/Webhook.LabelFormatType" }, "Order": { "$ref": "#/components/schemas/Webhook.Order" }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.FulfillmentItem" } } } }, "Webhook.AdjustmentPayload": { "type": "object", "properties": { "OrderAdjustment": { "$ref": "#/components/schemas/Webhook.OrderAdjustment" }, "OrderItemAdjustment": { "$ref": "#/components/schemas/Webhook.OrderItemAdjustment" }, "Order": { "$ref": "#/components/schemas/Webhook.Order" } } }, "Webhook.DistributionCenterRollupType": { "enum": [ "SellerManaged", "ExternallyManaged", "Mixed" ], "type": "string", "description": "DistributionCenterRollupType enumeration" }, "Webhook.CheckoutStatus": { "enum": [ "NotVisited", "Completed", "Visited", "CompletedAndVisited", "Disabled", "CompletedOffline", "OnHold" ], "type": "string", "description": "CheckoutStatus enumeration" }, "Webhook.PaymentStatus": { "enum": [ "NotYetSubmitted", "Cleared", "Submitted", "Failed", "Deposited" ], "type": "string", "description": "PaymentStatus enumeration" }, "Webhook.ShippingStatus": { "enum": [ "Unshipped", "Shipped", "PartiallyShipped", "PendingShipment", "Canceled", "ThirdPartyManaged" ], "type": "string", "description": "Indicates the shipping state of an order.\n\n| Value | Description |\n|---|---|\n| `Unshipped` | Fulfillment is incomplete. This is the default value. |\n| `Shipped` | Fulfillment is complete. |\n| `PartiallyShipped` | Fulfillment is incomplete. |\n| `PendingShipment` | Fulfillment is incomplete. |\n| `Canceled` | Fulfillment is complete. |\n| `ThirdPartyManaged` | Fulfillment is complete. |" }, "Webhook.TaxType": { "enum": [ "NoTax", "Standard", "ExclusiveVat", "InclusiveVat" ], "type": "string", "description": "TaxType enumeration" }, "Webhook.ShippingAddressType": { "enum": [ "Undefined", "Residential", "Commercial" ], "type": "string", "description": "ShippingAddressType enumeration" }, "Webhook.OrderItem": { "type": "object", "properties": { "ID": { "type": "integer" }, "ProfileID": { "type": "integer" }, "OrderID": { "type": "integer" }, "ProductID": { "type": "integer" }, "SiteOrderItemID": { "type": "string" }, "SellerOrderItemID": { "type": "string" }, "SiteListingID": { "type": "string" }, "Sku": { "type": "string" }, "Title": { "type": "string" }, "Quantity": { "type": "integer" }, "UnitPrice": { "type": [ "null", "number" ], "format": "decimal" }, "TaxPrice": { "type": "number", "format": "decimal" }, "ShippingPrice": { "type": "number", "format": "decimal" }, "ShippingTaxPrice": { "type": "number", "format": "decimal" }, "RecyclingFee": { "type": "number", "format": "decimal" }, "UnitEstimatedShippingCost": { "type": [ "null", "number" ], "format": "decimal" }, "GiftMessage": { "type": "string" }, "GiftNotes": { "type": "string" }, "GiftPrice": { "type": "number", "format": "decimal" }, "GiftTaxPrice": { "type": "number", "format": "decimal" }, "IsBundle": { "type": "boolean" }, "ItemURL": { "type": "string" }, "HarmonizedCode": { "type": "string" }, "ReferenceSku": { "type": "string" }, "ReferenceProductID": { "type": [ "null", "integer" ] }, "BundleComponents": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.OrderItemBundleComponent" } }, "Promotions": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.Promotion" } }, "Adjustments": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.OrderItemAdjustment" } }, "OrderItemAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.OrderItemAttributeValue" } } } }, "Webhook.OrderAdjustment": { "type": "object", "properties": { "ID": { "type": "integer" }, "ProfileID": { "type": "integer" }, "OrderID": { "type": "integer" }, "IsRestock": { "type": "boolean" }, "Reason": { "$ref": "#/components/schemas/Webhook.AdjustmentReason" }, "ItemAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "TaxAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "ShippingAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "ShippingTaxAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "GiftWrapAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "GiftWrapTaxAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "RecyclingFeeAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "Type": { "$ref": "#/components/schemas/Webhook.AdjustmentType" }, "SellerAdjustmentID": { "type": "string" }, "SiteAdjustmentID": { "type": "string" }, "SiteRefundDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "AdjustmentTransactionID": { "type": "string" }, "PublicNotes": { "type": "string" }, "Comment": { "type": "string" }, "CreatedDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "RequestStatus": { "$ref": "#/components/schemas/Webhook.AsyncStatus" }, "RestockStatus": { "$ref": "#/components/schemas/Webhook.AsyncStatus" }, "RmaNumber": { "type": "string" }, "ReturnShippingFee": { "type": [ "null", "number" ], "format": "decimal" }, "RestockingFee": { "type": [ "null", "number" ], "format": "decimal" }, "ReturnTrackingNumberOrUrl": { "type": "string" }, "ReturnShippingMethod": { "type": "string" }, "CreatedSource": { "$ref": "#/components/schemas/Webhook.AdjustmentSource" }, "LastUpdatedSource": { "$ref": "#/components/schemas/Webhook.AdjustmentSource" }, "ReturnRejectionReason": { "$ref": "#/components/schemas/Webhook.ReturnRejectionReason" }, "ReturnSellerComment": { "type": "string" }, "ReturnShippingCost": { "type": [ "null", "number" ], "format": "decimal" }, "LastUpdatedDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "IsRma": { "type": "boolean" }, "ReturnDistributionCenterID": { "type": [ "null", "integer" ] }, "ReturnDistributionCenterCode": { "type": "string" }, "BuyerReturnComment": { "type": "string" } } }, "Webhook.CustomField": { "type": "object", "properties": { "FieldID": { "type": "integer" }, "OrderID": { "type": "integer" }, "ProfileID": { "type": "integer" }, "Value": { "type": "string" } } }, "Webhook.OrderAttributeValue": { "type": "object", "properties": { "OrderID": { "type": "integer" }, "ProfileID": { "type": "integer" }, "Name": { "type": "string" }, "Value": { "type": "string" } } }, "Webhook.Tag": { "type": "object", "properties": { "Name": { "type": "string" } } }, "Webhook.ShippingBusinessHour": { "type": "object", "properties": { "DayOfWeek": { "$ref": "#/components/schemas/Webhook.DayOfWeek" }, "BusinessHours": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook.OpenInterval" } } } }, "Webhook.FulfillmentType": { "enum": [ "Ship", "Pickup", "ShipToStore", "Courier" ], "type": "string", "description": "FulfillmentType enumeration" }, "Webhook.DeliveryStatus": { "enum": [ "NoChange", "InTransit", "ReadyForPickup", "Complete", "Canceled", "ThirdPartyManaged", "Confirmed", "PickAndPack", "LabelCreated", "Held", "Delivered", "FailedDelivery" ], "type": "string", "description": "Indicates the delivery state of a fulfillment.\n\n| Value | Description |\n|---|---|\n| `NoChange` | The fulfillment is unshipped. Making a request with this value will set a fulfillment or order to unshipped. |\n| `InTransit` | The fulfillment is in transit to a location where the recipient may pick it up. Used for eBay In-Store-Pickup orders. |\n| `ReadyForPickup` | The fulfillment has arrived at the pickup location and is ready for the recipient to pick up. Used for eBay In-Store-Pickup orders. |\n| `Complete` | The fulfillment is complete and/or fully shipped. |\n| `Canceled` | The items on this fulfillment have been canceled and will not be fulfilled. |\n| `ThirdPartyManaged` | The fulfillment is handled outside Rithum. |\n| `Confirmed` | The fulfillment location confirms receipt of the order. |\n| `PickAndPack` | The items in the fulfillment are in the process of being retrieved and packed. |\n| `LabelCreated` | The items in the fulfillment are packed and a label has been generated for pickup or retrieval. |\n| `Held` | The fulfillment is in Held status when decisions are needed for change in the fulfillment. |\n| `Delivered` | The shipment was delivered to the final destination. |\n| `FailedDelivery` | The shipment failed delivery to the final destination. |" }, "Webhook.FulfillmentRequestStatus": { "enum": [ "New", "Pending", "Sent", "Processing", "Complete", "Held", "Failed" ], "type": "string", "description": "FulfillmentRequestStatus enumeration" }, "Webhook.LabelFormatType": { "enum": [ "JPEG", "PDF", "PNG", "GzipPDF", "GIFLandscape", "GzipPNG", "GIFPortrait", "ZPL", "GzipZPL" ], "type": "string", "description": "LabelFormatType enumeration" }, "Webhook.FulfillmentItem": { "type": "object", "properties": { "ID": { "type": "integer" }, "Sku": { "type": "string" }, "ProfileID": { "type": "integer" }, "FulfillmentID": { "type": "integer" }, "OrderID": { "type": "integer" }, "OrderItemID": { "type": "integer" }, "Quantity": { "type": "integer" }, "ProductID": { "type": "integer" }, "SellerFulfillmentItemID": { "type": "string" }, "MarketplaceShippingStatus": { "$ref": "#/components/schemas/Webhook.FulfillmentItemSiteCommunicationStatus" }, "DistributionCenterItemUnitCost": { "type": [ "null", "number" ], "format": "decimal" }, "DistributionCenterShippingCost": { "type": [ "null", "number" ], "format": "decimal" }, "DistributionCenterCalculatedItemUnitCost": { "type": [ "null", "number" ], "format": "decimal" }, "DistributionCenterCalculatedShippingCost": { "type": [ "null", "number" ], "format": "decimal" }, "ReferenceSku": { "type": "string" }, "ReferenceProductID": { "type": [ "null", "integer" ] }, "WarehouseLocation": { "type": "string" } } }, "Webhook.OrderItemAdjustment": { "type": "object", "properties": { "ID": { "type": "integer" }, "ProfileID": { "type": "integer" }, "OrderID": { "type": "integer" }, "OrderItemID": { "type": "integer" }, "Quantity": { "type": [ "null", "integer" ] }, "IsRestock": { "type": "boolean" }, "Reason": { "$ref": "#/components/schemas/Webhook.AdjustmentReason" }, "ItemAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "TaxAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "ShippingAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "ShippingTaxAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "GiftWrapAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "GiftWrapTaxAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "RecyclingFeeAdjustment": { "type": [ "null", "number" ], "format": "decimal" }, "Type": { "$ref": "#/components/schemas/Webhook.AdjustmentType" }, "SellerAdjustmentID": { "type": "string" }, "SiteAdjustmentID": { "type": "string" }, "SiteRefundDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "AdjustmentTransactionID": { "type": "string" }, "PublicNotes": { "type": "string" }, "Comment": { "type": "string" }, "CreatedDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "RequestStatus": { "$ref": "#/components/schemas/Webhook.AsyncStatus" }, "RestockStatus": { "$ref": "#/components/schemas/Webhook.AsyncStatus" }, "RmaNumber": { "type": "string" }, "ReturnShippingFee": { "type": [ "null", "number" ], "format": "decimal" }, "RestockingFee": { "type": [ "null", "number" ], "format": "decimal" }, "ReturnTrackingNumberOrUrl": { "type": "string" }, "ReturnShippingMethod": { "type": "string" }, "CreatedSource": { "$ref": "#/components/schemas/Webhook.AdjustmentSource" }, "LastUpdatedSource": { "$ref": "#/components/schemas/Webhook.AdjustmentSource" }, "ReferenceSku": { "type": "string" }, "ReferenceProductID": { "type": [ "null", "integer" ] }, "ReturnRejectionReason": { "$ref": "#/components/schemas/Webhook.ReturnRejectionReason" }, "ReturnSellerComment": { "type": "string" }, "ReturnShippingCost": { "type": [ "null", "number" ], "format": "decimal" }, "LastUpdatedDateUtc": { "type": [ "null", "string" ], "format": "date-time" }, "IsRma": { "type": "boolean" }, "ReturnDistributionCenterID": { "type": [ "null", "integer" ] }, "ReturnDistributionCenterCode": { "type": "string" }, "BuyerReturnComment": { "type": "string" } } }, "Webhook.OrderItemBundleComponent": { "type": "object", "properties": { "OrderID": { "type": "integer" }, "OrderItemID": { "type": "integer" }, "ProductID": { "type": "integer" }, "ProfileID": { "type": "integer" }, "BundleProductID": { "type": "integer" }, "Sku": { "type": "string" }, "BundleSku": { "type": "string" }, "Title": { "type": "string" }, "Quantity": { "type": "integer" }, "ReferenceProductID": { "type": [ "null", "integer" ] }, "ReferenceSku": { "type": "string" } } }, "Webhook.Promotion": { "type": "object", "properties": { "ID": { "type": "integer" }, "Code": { "type": "string" }, "Amount": { "type": "number", "format": "decimal" }, "ShippingAmount": { "type": "number", "format": "decimal" } } }, "Webhook.OrderItemAttributeValue": { "type": "object", "properties": { "OrderItemID": { "type": "integer" }, "OrderID": { "type": "integer" }, "ProfileID": { "type": "integer" }, "Name": { "type": "string" }, "Value": { "type": "string" } } }, "Webhook.AdjustmentReason": { "enum": [ "GeneralAdjustment", "ItemNotAvailable", "CustomerReturnedItem", "CouldNotShip", "AlternateItemProvided", "BuyerCancelled", "CustomerExchange", "MerchandiseNotReceived", "ShippingAddressUndeliverable" ], "type": "string", "description": "AdjustmentReason enumeration" }, "Webhook.AdjustmentType": { "enum": [ "Refund", "Cancellation" ], "type": "string", "description": "AdjustmentType enumeration" }, "Webhook.AsyncStatus": { "enum": [ "SubmittedNotProcessed", "NewRma", "PendingApproval", "ProcessingApproval", "ReadyForReturn", "PendingReturn", "ProcessingReturn", "PendingRejection", "ProcessingRejection", "ProcessedNotAcknowledged", "PendingReturnRejection", "ProcessingReturnRejection", "AcknowledgedPostProcessingNotComplete", "Queued", "PostProcessingComplete", "RejectionCompleted", "InformationOnly", "NoChange", "Error" ], "type": "string", "description": "AsyncStatus enumeration" }, "Webhook.AdjustmentSource": { "enum": [ "Channel", "UserInterface", "Api", "System" ], "type": "string", "description": "AdjustmentSource enumeration" }, "Webhook.ReturnRejectionReason": { "enum": [ "IneligibleForReturn", "ReturnNotNeeded", "ReturnWindowClosed", "DamagedProduct", "MissingItem", "ProductReturnedAfterTheReturnWindow", "WrongProduct", "Other" ], "type": "string", "description": "ReturnRejectionReason enumeration" }, "Webhook.DayOfWeek": { "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string", "description": "DayOfWeek enumeration" }, "Webhook.OpenInterval": { "type": "object", "properties": { "StartTime": { "type": "string" }, "EndTime": { "type": "string" } } }, "Webhook.FulfillmentItemSiteCommunicationStatus": { "enum": [ "Pending", "InProgress", "Complete", "CompletedWithoutNotification", "Failed" ], "type": "string", "description": "FulfillmentItemSiteCommunicationStatus enumeration" } }, "responses": { "error": { "description": "error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.ODataErrors.ODataError" } } } }, "ODataCountResponse": { "description": "The count of the resource", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ODataCountResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.OrderCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.OrderItemCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItemCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.FulfillmentCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.FulfillmentCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.FulfillmentItemCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.FulfillmentItemCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.DistributionCenterCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.DistributionCenterCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.OperatingHoursCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OperatingHoursCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.OrderAdjustmentCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderAdjustmentCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.OrderItemAdjustmentCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItemAdjustmentCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.OrderItemBundleComponentCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItemBundleComponentCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.PromotionCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.PromotionCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.CustomFieldCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.CustomFieldCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.ProfileCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ProfileCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.ProductCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ProductCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.AliasRelationshipCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AliasRelationshipCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.ImageCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ImageCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.AttributeValueCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AttributeValueCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.DCQuantityCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.DCQuantityCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.ProductLabelCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ProductLabelCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.ProductBundleComponentCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ProductBundleComponentCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.ChildRelationshipCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ChildRelationshipCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.PackageCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.PackageCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.ChannelDocumentCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ChannelDocumentCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.NotSuppliedChannelDocumentCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.NotSuppliedChannelDocumentCollectionResponse" } } } }, "ChannelAdvisor.PostSale.RestApi.V1.Models.WebhookCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.PostSale.RestApi.V1.Models.WebhookCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.SiteCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.SiteCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.OrderDocumentCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderDocumentCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.OrderDocumentFlyweightCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderDocumentFlyweightCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.OrderDocumentMetadataCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderDocumentMetadataCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.OrderAttributeValueCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderAttributeValueCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.OrderItemAttributeValueCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItemAttributeValueCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.TagCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.TagCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.ExportStatusCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ExportStatusCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.SiteAccountCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.SiteAccountCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.ShippingLabelPartnerAccountCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ShippingLabelPartnerAccountCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.AssemblyBundleDistributionCenterCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AssemblyBundleDistributionCenterCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.AmazonVATInvoiceDocumentCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AmazonVATInvoiceDocumentCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.NotSuppliedAmazonVATInvoiceDocumentCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.NotSuppliedAmazonVATInvoiceDocumentCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.OpenIntervalCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OpenIntervalCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.ReplacementItemCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ReplacementItemCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.ShippingBusinessHourCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ShippingBusinessHourCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.CodeDescriptionCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.CodeDescriptionCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.ShipOrderRequestItemCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ShipOrderRequestItemCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.OrderItemSubstitutionCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.OrderItemSubstitutionCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.DCxQtyUpdateCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.DCxQtyUpdateCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.AttributeUpdateCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.AttributeUpdateCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfStringCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfStringCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.ODataBatchResponseItemCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.ODataBatchResponseItemCollectionResponse" } } } }, "ChannelAdvisor.RestApi.V1.Models.HttpResponseMessageCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAdvisor.RestApi.V1.Models.HttpResponseMessageCollectionResponse" } } } }, "Core.OpenApiExampleCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.OpenApiExampleCollectionResponse" } } } }, "StringCollectionResponse": { "description": "Retrieved collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringCollectionResponse" } } } } }, "parameters": { "top": { "name": "$top", "in": "query", "description": "Show only the first n items", "explode": false, "schema": { "minimum": 0, "type": "number", "format": "int64" }, "example": 50 }, "skip": { "name": "$skip", "in": "query", "description": "Skip the first n items", "explode": false, "schema": { "minimum": 0, "type": "number", "format": "int64" } }, "count": { "name": "$count", "in": "query", "description": "Include count of items", "explode": false, "schema": { "type": "boolean" } }, "filter": { "name": "$filter", "in": "query", "description": "Filter items by property values", "explode": false, "schema": { "type": "string" } }, "search": { "name": "$search", "in": "query", "description": "Search items by search phrases", "explode": false, "schema": { "type": "string" } } }, "examples": { "ChannelAdvisor.RestApi.V1.Models.ShippingBusinessHour": { "value": { "DayOfWeek": "Sunday", "BusinessHours": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OpenInterval" } ] } }, "ChannelAdvisor.RestApi.V1.Models.OpenInterval": { "value": { "StartTime": "string", "EndTime": "string" } }, "ChannelAdvisor.RestApi.V1.Models.ShippingOverride": { "value": { "Sku": "string", "Quantity": 0, "DistributionCenterID": 0, "ShippingCarrier": "string", "ShippingClass": "string", "TrackingNumber": "string", "TrackingUrl": "string", "SellerFulfillmentID": "string", "ShippedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "ApplyShippingRules": true, "EstimatedShipDateUtc": "0001-01-01T00:00:00.0000000+00:00" } }, "ChannelAdvisor.RestApi.V1.Models.OrderItemSubstitution": { "value": { "OriginalItem": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OriginalItem" }, "ReplacementItems": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ReplacementItem" } ], "Reason": "string" } }, "ChannelAdvisor.RestApi.V1.Models.OriginalItem": { "value": { "OrderItemID": 0, "Sku": "string", "Quantity": 0 } }, "ChannelAdvisor.RestApi.V1.Models.ReplacementItem": { "value": { "Sku": "string", "ProductID": 0, "Quantity": 0, "Title": "string", "UnitPrice": 0, "TaxPrice": 0, "ShippingPrice": 0, "ShippingTaxPrice": 0, "RecyclingFee": 0, "ShippingOverride": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ShippingOverride" }, "Promotions": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Promotion" } ] } }, "ChannelAdvisor.RestApi.V1.Models.Order": { "value": { "ID": 0, "ProfileID": 0, "SiteID": 0, "SiteName": "string", "UserDataPresent": 0, "UserDataRemovalDateUTC": "0001-01-01T00:00:00.0000000+00:00", "SiteAccountID": 0, "SiteOrderID": "string", "SecondarySiteOrderID": "string", "SellerOrderID": "string", "CheckoutSourceID": 0, "Currency": "string", "CreatedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "ImportDateUtc": "0001-01-01T00:00:00.0000000+00:00", "UpdatedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "PublicNotes": "string", "PrivateNotes": "string", "SpecialInstructions": "string", "TotalPrice": 0, "TotalTaxPrice": 0, "TotalShippingPrice": 0, "TotalShippingTaxPrice": 0, "TotalInsurancePrice": 0, "TotalGiftOptionPrice": 0, "TotalGiftOptionTaxPrice": 0, "AdditionalCostOrDiscount": 0, "EstimatedShipDateUtc": "0001-01-01T00:00:00.0000000+00:00", "DeliverByDateUtc": "0001-01-01T00:00:00.0000000+00:00", "RequestedShippingCarrier": "string", "RequestedShippingClass": "string", "ResellerID": "string", "FlagID": 0, "FlagDescription": "string", "OrderTags": "string", "DistributionCenterTypeRollup": "SellerManaged", "CheckoutStatus": "NotVisited", "PaymentStatus": "NotYetSubmitted", "ShippingStatus": "Unshipped", "CheckoutDateUtc": "0001-01-01T00:00:00.0000000+00:00", "PaymentDateUtc": "0001-01-01T00:00:00.0000000+00:00", "ShippingDateUtc": "0001-01-01T00:00:00.0000000+00:00", "BuyerUserId": "string", "BuyerEmailAddress": "string", "BuyerEmailOptIn": true, "OrderTaxType": "NoTax", "ShippingTaxType": "NoTax", "GiftOptionsTaxType": "NoTax", "PaymentMethod": "string", "PaymentTransactionID": "string", "PaymentPaypalAccountID": "string", "PaymentCreditCardLast4": "string", "PaymentMerchantReferenceNumber": "string", "ShippingTitle": "string", "ShippingFirstName": "string", "ShippingLastName": "string", "ShippingSuffix": "string", "ShippingCompanyName": "string", "ShippingCompanyJobTitle": "string", "ShippingDaytimePhone": "string", "ShippingEveningPhone": "string", "ShippingAddressLine1": "string", "ShippingAddressLine2": "string", "ShippingCity": "string", "ShippingStateOrProvince": "string", "ShippingStateOrProvinceName": "string", "ShippingPostalCode": "string", "ShippingCountry": "string", "BillingTitle": "string", "BillingFirstName": "string", "BillingLastName": "string", "BillingSuffix": "string", "BillingCompanyName": "string", "BillingCompanyJobTitle": "string", "BillingDaytimePhone": "string", "BillingEveningPhone": "string", "BillingAddressLine1": "string", "BillingAddressLine2": "string", "BillingCity": "string", "BillingStateOrProvince": "string", "BillingStateOrProvinceName": "string", "BillingPostalCode": "string", "BillingCountry": "string", "PromotionCode": "string", "PromotionAmount": 0, "ShippingAddressType": "Undefined", "ShippingBusinessHours": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ShippingBusinessHour" } ], "Items": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItem" } ], "Fulfillments": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Fulfillment" } ], "Adjustments": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderAdjustment" } ], "CustomFields": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.CustomField" } ], "OrderAttributes": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderAttributeValue" } ], "Tags": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Tag" } ], "Exports": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ExportStatus" } ], "ChannelDocuments": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ChannelDocument" } ] } }, "ChannelAdvisor.RestApi.V1.Models.OrderItem": { "value": { "ID": 0, "ProfileID": 0, "OrderID": 0, "ProductID": 0, "SiteOrderItemID": "string", "SellerOrderItemID": "string", "SiteListingID": "string", "Sku": "string", "Title": "string", "Quantity": 0, "UnitPrice": 0, "TaxPrice": 0, "ShippingPrice": 0, "ShippingTaxPrice": 0, "RecyclingFee": 0, "UnitEstimatedShippingCost": 0, "GiftMessage": "string", "GiftNotes": "string", "GiftPrice": 0, "GiftTaxPrice": 0, "IsBundle": true, "ItemURL": "string", "HarmonizedCode": "string", "ReferenceSku": "string", "ReferenceProductID": 0, "Order": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Order" }, "BundleComponents": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItemBundleComponent" } ], "FulfillmentItems": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.FulfillmentItem" } ], "Promotions": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Promotion" } ], "Adjustments": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItemAdjustment" } ], "OrderItemAttributes": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItemAttributeValue" } ] } }, "ChannelAdvisor.RestApi.V1.Models.Fulfillment": { "value": { "ID": 0, "ProfileID": 0, "OrderID": 0, "CreatedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "UpdatedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "Type": "Ship", "DeliveryStatus": "NoChange", "TrackingNumber": "string", "TrackingUrl": "string", "ReturnTrackingNumber": "string", "ShippingCarrier": "string", "ShippingClass": "string", "DistributionCenterID": 0, "ExternalFulfillmentCenterCode": "string", "ExternalFulfillmentStatus": "New", "ShippingCost": 0, "InsuranceCost": 0, "TaxCost": 0, "ShippedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "SellerFulfillmentID": "string", "HasShippingLabel": true, "HasChannelPackingSlip": true, "HasReturnLabel": true, "HasChannelReturnLabel": true, "ExternalFulfillmentNumber": "string", "ExternalFulfillmentReferenceNumber": "string", "ShippingLabelRequestID": "string", "StagingLocation": "string", "SerialShippingContainerCode": "string", "EarliestDeliveryDateUtc": "0001-01-01T00:00:00.0000000+00:00", "EarliestShipDateUtc": "0001-01-01T00:00:00.0000000+00:00", "EstimatedDeliveryDateUtc": "0001-01-01T00:00:00.0000000+00:00", "EstimatedShipDateUtc": "0001-01-01T00:00:00.0000000+00:00", "LabelFormat": "JPEG", "ReturnLabelFormat": "JPEG", "ChannelReturnLabelFormat": "JPEG", "Weight": 0, "WeightUnit": "Gram", "Height": 0, "Width": 0, "Length": 0, "MeasurementUnit": "Centimeter", "Order": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Order" }, "Items": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.FulfillmentItem" } ] } }, "ChannelAdvisor.RestApi.V1.Models.FulfillmentItem": { "value": { "DistributionCenterItemUnitCost": 0, "DistributionCenterShippingCost": 0, "DistributionCenterCalculatedItemUnitCost": 0, "DistributionCenterCalculatedShippingCost": 0, "ID": 0, "Sku": "string", "ProfileID": 0, "FulfillmentID": 0, "OrderID": 0, "OrderItemID": 0, "Quantity": 0, "ProductID": 0, "SellerFulfillmentItemID": "string", "MarketplaceShippingStatus": "Pending", "ReferenceSku": "string", "ReferenceProductID": 0, "WarehouseLocation": "string", "Fulfillment": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Fulfillment" }, "OrderItem": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItem" }, "BundleComponent": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItemBundleComponent" } } }, "ChannelAdvisor.RestApi.V1.Models.DistributionCenter": { "value": { "ID": 0, "Name": "string", "Code": "string", "FulfillmentPartnerName": "string", "ContactName": "string", "ContactEmail": "string", "ContactPhone": "string", "Address1": "string", "Address2": "string", "City": "string", "StateOrProvince": "string", "Country": "string", "PostalCode": "string", "PickupLocation": true, "ShipLocation": true, "Type": "Warehouse", "IsExternallyManaged": true, "IsDeleted": true, "DeletedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "County": "string", "District": "string", "TimeZone": "string", "HandlingTimeMinutes": 0, "DeliveryAvailable": true, "PickupOrderHoldMinutes": 0, "ThroughputLimitNumber": 0, "ThroughputLimitUnits": "Minutes", "MainPhone": "string", "AltPhone": "string", "Fax": "string", "HomePage": "string", "Email": "string", "BusinessDescription": "string", "Latitude": 0, "Longitude": 0, "StoreCategories": "string", "CourierPickupInstructions": "string", "CustomerPickupInstructions": "string", "PickupInstructions": "string", "OperatingHours": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OperatingHours" } ] } }, "ChannelAdvisor.RestApi.V1.Models.OperatingHours": { "value": { "DistributionCenterID": 0, "DayID": "Sunday", "OpenTime": "string", "CloseTime": "string" } }, "ChannelAdvisor.RestApi.V1.Models.OrderAdjustment": { "value": { "CreatedSource": "Channel", "LastUpdatedSource": "Channel", "ReturnSellerComment": "string", "ReturnDistributionCenterID": 0, "ReturnDistributionCenterCode": "string", "BuyerReturnComment": "string", "ID": 0, "ProfileID": 0, "OrderID": 0, "IsRestock": true, "Reason": "GeneralAdjustment", "ItemAdjustment": 0, "TaxAdjustment": 0, "ShippingAdjustment": 0, "ShippingTaxAdjustment": 0, "GiftWrapAdjustment": 0, "GiftWrapTaxAdjustment": 0, "RecyclingFeeAdjustment": 0, "Type": "Refund", "SellerAdjustmentID": "string", "SiteAdjustmentID": "string", "SiteRefundDateUtc": "0001-01-01T00:00:00.0000000+00:00", "AdjustmentTransactionID": "string", "PublicNotes": "string", "Comment": "string", "CreatedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "RequestStatus": "SubmittedNotProcessed", "RestockStatus": "SubmittedNotProcessed", "RmaNumber": "string", "ReturnShippingFee": 0, "RestockingFee": 0, "ReturnTrackingNumberOrUrl": "string", "ReturnShippingMethod": "string", "ReturnShippingCost": 0, "ReturnRejectionReason": "IneligibleForReturn", "LastUpdatedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "IsRma": true, "Order": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Order" } } }, "ChannelAdvisor.RestApi.V1.Models.OrderItemAdjustment": { "value": { "CreatedSource": "Channel", "LastUpdatedSource": "Channel", "ReturnSellerComment": "string", "ReturnDistributionCenterID": 0, "ReturnDistributionCenterCode": "string", "BuyerReturnComment": "string", "ID": 0, "ProfileID": 0, "OrderID": 0, "OrderItemID": 0, "Quantity": 0, "IsRestock": true, "Reason": "GeneralAdjustment", "ItemAdjustment": 0, "TaxAdjustment": 0, "ShippingAdjustment": 0, "ShippingTaxAdjustment": 0, "GiftWrapAdjustment": 0, "GiftWrapTaxAdjustment": 0, "RecyclingFeeAdjustment": 0, "Type": "Refund", "SellerAdjustmentID": "string", "SiteAdjustmentID": "string", "SiteRefundDateUtc": "0001-01-01T00:00:00.0000000+00:00", "AdjustmentTransactionID": "string", "PublicNotes": "string", "Comment": "string", "CreatedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "RequestStatus": "SubmittedNotProcessed", "RestockStatus": "SubmittedNotProcessed", "RmaNumber": "string", "ReturnShippingFee": 0, "RestockingFee": 0, "ReturnTrackingNumberOrUrl": "string", "ReturnShippingMethod": "string", "ReturnShippingCost": 0, "ReferenceSku": "string", "ReferenceProductID": 0, "ReturnRejectionReason": "IneligibleForReturn", "LastUpdatedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "IsRma": true, "OrderItem": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItem" } } }, "ChannelAdvisor.RestApi.V1.Models.OrderItemBundleComponent": { "value": { "OrderID": 0, "OrderItemID": 0, "ProductID": 0, "ProfileID": 0, "BundleProductID": 0, "Sku": "string", "BundleSku": "string", "Title": "string", "Quantity": 0, "ReferenceProductID": 0, "ReferenceSku": "string", "OrderItem": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItem" }, "FulfillmentItems": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.FulfillmentItem" } ] } }, "ChannelAdvisor.RestApi.V1.Models.Promotion": { "value": { "ID": 0, "Code": "string", "Amount": 0, "ShippingAmount": 0, "OrderItem": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItem" } } }, "ChannelAdvisor.RestApi.V1.Models.CustomField": { "value": { "FieldID": 0, "OrderID": 0, "ProfileID": 0, "Value": "string", "Order": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Order" } } }, "ChannelAdvisor.RestApi.V1.Models.Profile": { "value": { "ID": 0, "AccountName": "string", "CompanyName": "string", "CurrencyCode": "string", "TimeZoneRegion": "string", "TimeZoneDescription": "string", "DefaultDistributionCenterID": 0, "SiteAccounts": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.SiteAccount" } ], "ShippingLabelPartnerAccounts": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ShippingLabelPartnerAccount" } ] } }, "ChannelAdvisor.RestApi.V1.Models.Product": { "value": { "ID": 0, "ProfileID": 0, "CreateDateUtc": "0001-01-01T00:00:00.0000000+00:00", "UpdateDateUtc": "0001-01-01T00:00:00.0000000+00:00", "QuantityUpdateDateUtc": "0001-01-01T00:00:00.0000000+00:00", "IsAvailableInStore": true, "IsBlocked": true, "IsBlockedFromAdvertising": true, "IsExternalQuantityBlocked": true, "InfiniteQuantity": true, "BlockComment": "string", "BlockedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "BlockedFromAdvertisingDateUtc": "0001-01-01T00:00:00.0000000+00:00", "ReceivedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "LastSaleDateUtc": "0001-01-01T00:00:00.0000000+00:00", "ASIN": "string", "Brand": "string", "Condition": "string", "Description": "string", "EAN": "string", "FlagDescription": "string", "Flag": "NoFlag", "HarmonizedCode": "string", "ISBN": "string", "Manufacturer": "string", "MPN": "string", "ShortDescription": "string", "Sku": "string", "Subtitle": "string", "TaxProductCode": "string", "Title": "string", "UPC": "string", "WarehouseLocation": "string", "Warranty": "string", "MultipackQuantity": 0, "Height": 0, "Length": 0, "Width": 0, "Weight": 0, "Cost": 0, "Margin": 0, "RetailPrice": 0, "StartingPrice": 0, "ReservePrice": 0, "BuyItNowPrice": 0, "StorePrice": 0, "SecondChancePrice": 0, "MinPrice": 0, "MaxPrice": 0, "EstimatedShippingCost": 0, "SupplierName": "string", "SupplierCode": "string", "SupplierPO": "string", "Classification": "string", "IsDisplayInStore": true, "StoreTitle": "string", "StoreDescription": "string", "BundleType": "None", "ProductType": "Item", "TotalAvailableQuantity": 0, "OpenAllocatedQuantity": 0, "OpenAllocatedQuantityPooled": 0, "PendingCheckoutQuantity": 0, "PendingCheckoutQuantityPooled": 0, "PendingPaymentQuantity": 0, "PendingPaymentQuantityPooled": 0, "PendingShipmentQuantity": 0, "PendingShipmentQuantityPooled": 0, "TotalQuantity": 0, "TotalQuantityPooled": 0, "QuantitySoldLast7Days": 0, "QuantitySoldLast14Days": 0, "QuantitySoldLast30Days": 0, "QuantitySoldLast60Days": 0, "QuantitySoldLast90Days": 0, "IsParent": true, "IsInRelationship": true, "CopyToChildren": true, "CopyToAliases": "string", "ParentProductID": 0, "ParentSku": "string", "RelationshipName": "string", "VaryBy": "string", "AliasType": "None", "ReferenceSku": "string", "ReferenceProductID": 0, "AssemblyBundleDistributionCenters": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.AssemblyBundleDistributionCenter" } ], "Attributes": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.AttributeValue" } ], "DCQuantities": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.DCQuantity" } ], "Images": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Image" } ], "Labels": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ProductLabel" } ], "BundleComponents": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ProductBundleComponent" } ], "Children": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ChildRelationship" } ], "AliasRelationships": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.AliasRelationship" } ] } }, "ChannelAdvisor.RestApi.V1.Models.AssemblyBundleDistributionCenter": { "value": { "DistributionCenterID": 0, "ProfileID": 0, "DCCode": "string" } }, "ChannelAdvisor.RestApi.V1.Models.AliasRelationship": { "value": { "AliasProductID": 0, "ReferenceProductID": 0, "ProfileID": 0, "AliasProductSku": "string", "Product": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Product" } } }, "ChannelAdvisor.RestApi.V1.Models.Image": { "value": { "ProductID": 0, "ProfileID": 0, "PlacementName": "string (identifier)", "Abbreviation": "string", "Url": "string", "Product": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Product" } } }, "ChannelAdvisor.RestApi.V1.Models.AttributeValue": { "value": { "ProductID": 0, "ProfileID": 0, "Name": "string (identifier)", "Value": "string", "Product": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Product" } } }, "ChannelAdvisor.RestApi.V1.Models.DCQuantity": { "value": { "ProductID": 0, "ProfileID": 0, "DistributionCenterID": 0, "AvailableQuantity": 0, "Product": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Product" } } }, "ChannelAdvisor.RestApi.V1.Models.ProductLabel": { "value": { "ProductID": 0, "ProfileID": 0, "Name": "string (identifier)", "Product": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Product" } } }, "ChannelAdvisor.RestApi.V1.Models.ProductBundleComponent": { "value": { "ProductID": 0, "ComponentID": 0, "ProfileID": 0, "ComponentSku": "string", "Quantity": 0, "Product": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Product" } } }, "ChannelAdvisor.RestApi.V1.Models.ChildRelationship": { "value": { "ParentProductID": 0, "ProfileID": 0, "ChildProductID": 0, "ChildProduct": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Product" } } }, "ChannelAdvisor.RestApi.V1.Models.Package": { "value": { "ID": 0, "ProfileID": 0, "Name": "string", "Description": "string", "ShippingCarrier": "string", "Length": 0, "Width": 0, "Height": 0, "EmptyWeight": 0 } }, "ChannelAdvisor.RestApi.V1.Models.ChannelDocument": { "value": { "DocumentKey": "string (identifier)", "Contents": "string", "ID": 0, "ProfileID": 0, "DocumentType": "AmazonVATInvoice" } }, "ChannelAdvisor.RestApi.V1.Models.NotSuppliedChannelDocument": { "value": { "ID": 0, "ProfileID": 0, "DocumentType": "AmazonVATInvoice" } }, "ChannelAdvisor.RestApi.V1.Models.Site": { "value": { "ID": 0, "SiteName": "string", "SiteCategoryID": 0, "SiteCategoryName": "string", "CancellationConfiguration": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.CancellationConfiguration" }, "RefundConfiguration": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.RefundConfiguration" }, "AdjustmentReasons": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.CodeDescription" } ] } }, "ChannelAdvisor.RestApi.V1.Models.OrderDocumentFlyweight": { "value": { "DocumentKey": "string (identifier)", "OrderID": 0, "ProfileID": 0, "CreateDateUtc": "0001-01-01T00:00:00.0000000+00:00", "DocumentType": "Unknown", "MimeType": "string", "DocumentSource": "Unknown" } }, "ChannelAdvisor.RestApi.V1.Models.OrderDocument": { "value": { "DocumentKey": "string (identifier)", "OrderID": 0, "ProfileID": 0, "CreateDateUtc": "0001-01-01T00:00:00.0000000+00:00", "DocumentType": "Unknown", "MimeType": "string", "DocumentSource": "Unknown", "Content": "string", "Metadata": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderDocumentMetadata" } ] } }, "ChannelAdvisor.RestApi.V1.Models.OrderDocumentMetadata": { "value": { "Key": "string (identifier)", "Value": "string" } }, "ChannelAdvisor.RestApi.V1.Models.OrderAttributeValue": { "value": { "Value": "string", "Name": "string (identifier)", "ProfileID": 0, "OrderID": 0, "Order": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Order" } } }, "ChannelAdvisor.RestApi.V1.Models.OrderItemAttributeValue": { "value": { "Value": "string", "Name": "string (identifier)", "OrderID": 0, "OrderItemID": 0, "ProfileID": 0, "OrderItem": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItem" } } }, "ChannelAdvisor.RestApi.V1.Models.UploadChannelDocument": { "value": { "ProfileID": 0, "OrderID": 0, "DocumentType": "AmazonVATInvoice", "Content": { "@odata.type": "System.Net.Http.HttpContent" }, "AdjustmentID": "string", "InvoiceNumber": "string", "TotalAmount": 0, "TotalVATAmount": 0 } }, "ChannelAdvisor.RestApi.V1.Models.WebhookAuthenticationUpdateRequest": { "value": { "AuthenticationType": "Unknown", "CustomHeader": "string", "CustomHeaderValue": "string", "BasicAuthUsername": "string", "BasicAuthPassword": "string" } }, "ChannelAdvisor.RestApi.V1.Models.ShipOrderRequest": { "value": { "ShippedDateUtc": "0001-01-01T00:00:00.0000000+00:00", "TrackingNumber": "string", "ReturnTrackingNumber": "string", "ShippingCarrier": "string", "ShippingClass": "string", "DistributionCenterID": 0, "SellerFulfillmentID": "string", "DeliveryStatus": "NoChange", "FulfillmentType": "Ship", "PreventMarketplaceCommunication": true, "TrackingUrl": "string", "SerialShippingContainerCode": "string", "RejectOpenCancelRequests": true, "RejectCancelReqReason": "IneligibleForReturn", "RejectCancelReqSellerComment": "string", "Items": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ShipOrderRequestItem" } ] } }, "ChannelAdvisor.RestApi.V1.Models.ShippingItems": { "value": { "FulfillmentItemID": 0, "OrderItemID": 0, "Sku": "string", "Quantity": 0, "Description": "string", "UnitWeight": 0 } }, "ChannelAdvisor.RestApi.V1.Models.PickupLabelLineItem": { "value": { "OrderItemID": 0, "Quantity": 0, "SerialNumbers": [ "string" ], "SiteOrderItemID": "string", "Sku": "string" } }, "ChannelAdvisor.RestApi.V1.Models.PickupLabelResponse": { "value": { "LabelContent": "string", "LabelContentType": "string", "FulfillmentID": 0, "InvoiceID": 0, "PackageID": "string", "ErrorDetail": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.PickupLabelErrorDetail" } } }, "ChannelAdvisor.RestApi.V1.Models.OrderItemSubstitutionRequest": { "value": { "Substitutions": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderItemSubstitution" } ] } }, "ChannelAdvisor.RestApi.V1.Models.RmaConditionQuantity": { "value": { "Condition": "string", "Quantity": 0 } }, "ChannelAdvisor.RestApi.V1.Models.QuantityUpdateRequest": { "value": { "CompleteDCList": true, "UpdateType": "Absolute", "Updates": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.DCxQtyUpdate" } ] } }, "ChannelAdvisor.RestApi.V1.Models.ChildrenRemoveRequest": { "value": { "ChildProductIDList": [ 0 ] } }, "ChannelAdvisor.RestApi.V1.Models.AttributesUpdateRequest": { "value": { "Attributes": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.AttributeUpdate" } ] } }, "ChannelAdvisor.RestApi.V1.Models.WebhookFailedEventsJob": { "value": { "Token": "string", "Status": "New", "StartedOnUtc": "0001-01-01T00:00:00.0000000+00:00", "ResponseFileUrl": "string" } }, "ChannelAdvisor.RestApi.V1.Models.Tag": { "value": { "Name": "string (identifier)" } }, "ChannelAdvisor.RestApi.V1.Models.ExportStatus": { "value": { "ID": 0, "ProfileID": 0, "OrderID": 0, "ApplicationID": 0, "DeveloperKey": "string", "Override": true, "Order": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Order" } } }, "ChannelAdvisor.RestApi.V1.Models.AmazonVATInvoiceDocument": { "value": { "DocumentKey": "string (identifier)", "Contents": "string", "ID": 0, "ProfileID": 0, "DocumentType": "AmazonVATInvoice", "OrderID": 0, "AdjustmentID": "string", "Status": "New", "InvoiceNumber": "string", "TotalAmount": 0, "TotalVATAmount": 0, "CreateDateUTC": "0001-01-01T00:00:00.0000000+00:00", "UpdateDateUTC": "0001-01-01T00:00:00.0000000+00:00" } }, "ChannelAdvisor.RestApi.V1.Models.SiteAccount": { "value": { "ID": 0, "SiteAccountName": "string", "SiteID": 0, "SiteName": "string", "Enabled": true, "Profile": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Profile" } } }, "ChannelAdvisor.RestApi.V1.Models.ShippingLabelPartnerAccount": { "value": { "ID": 0, "AccountName": "string", "PartnerName": "string", "Profile": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Profile" } } }, "ChannelAdvisor.RestApi.V1.Models.NotSuppliedAmazonVATInvoiceDocument": { "value": { "ID": 0, "ProfileID": 0, "DocumentType": "AmazonVATInvoice", "OrderID": 0, "AdjustmentID": "string", "CreateDateUTC": "0001-01-01T00:00:00.0000000+00:00" } }, "ChannelAdvisor.RestApi.V1.Models.CancellationConfiguration": { "value": { "SupportsOrderCancellations": true, "SupportsOrderItemCancellations": true, "SupportsOrderItemRMACancellations": true } }, "ChannelAdvisor.RestApi.V1.Models.RefundConfiguration": { "value": { "SupportsOrderRefunds": true, "SupportsOrderItemRefunds": true, "SupportsOrderItemRMARefunds": true } }, "ChannelAdvisor.RestApi.V1.Models.CodeDescription": { "value": { "Code": 0, "Description": "string" } }, "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString": { "value": { "Value": [ "string" ] } }, "ChannelAdvisor.RestApi.V1.Models.ODataBatchContent": { "value": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ], "Responses": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.ODataBatchResponseItem" } ] } }, "ChannelAdvisor.RestApi.V1.Models.ODataBatchResponseItem": { "value": { } }, "ChannelAdvisor.RestApi.V1.Models.ChangeSetResponseItem": { "value": { "Responses": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.HttpResponseMessage" } ] } }, "ChannelAdvisor.RestApi.V1.Models.OperationResponseItem": { "value": { } }, "ChannelAdvisor.RestApi.V1.Models.HttpResponseMessage": { "value": { "Version": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Version" }, "Content": { "@odata.type": "System.Net.Http.HttpContent" }, "StatusCode": "Continue", "ReasonPhrase": "string", "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ], "RequestMessage": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.HttpRequestMessage" } } }, "ChannelAdvisor.RestApi.V1.Models.Version": { "value": { } }, "ChannelAdvisor.RestApi.V1.Models.HttpRequestMessage": { "value": { "Version": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Version" }, "Content": { "@odata.type": "System.Net.Http.HttpContent" }, "Method": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.HttpMethod" }, "RequestUri": { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Uri" }, "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.HttpMethod": { "value": { } }, "ChannelAdvisor.RestApi.V1.Models.Uri": { "value": { "Segments": [ "string" ] } }, "ChannelAdvisor.RestApi.V1.Models.ByteRangeStreamContent": { "value": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.PushStreamContent": { "value": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.HttpMessageContent": { "value": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.ObjectContent": { "value": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.ObjectContent_1OfT": { "value": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.MultipartContent": { "value": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.MultipartFormDataContent": { "value": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.ByteArrayContent": { "value": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.FormUrlEncodedContent": { "value": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.StringContent": { "value": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.StreamContent": { "value": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "ChannelAdvisor.RestApi.V1.Models.ShipOrderRequestItem": { "value": { "OrderItemID": 0, "ProductID": 0, "Sku": "string", "Quantity": 0, "SellerFulfillmentItemID": "string", "ReferenceSku": "string" } }, "ChannelAdvisor.RestApi.V1.Models.PickupLabelErrorDetail": { "value": { "Code": "string", "Message": "string" } }, "ChannelAdvisor.RestApi.V1.Models.DCxQtyUpdate": { "value": { "DistributionCenterID": 0, "Quantity": 0 } }, "ChannelAdvisor.RestApi.V1.Models.AttributeUpdate": { "value": { "Name": "string", "Value": "string" } }, "ChannelAdvisor.PostSale.RestApi.V1.Models.Webhook": { "value": { "ID": 0, "Name": "string", "Status": "Deleted", "AuthenticationType": "Unknown", "WebhookUri": "string", "SigningSecret": "string", "EventTypes": [ "Unknown" ] } }, "ChannelAdvisor.PostSale.RestApi.V1.OrderDocuments.OrderDocumentUpload": { "value": { "ProfileID": 0, "OrderID": 0, "DocumentKey": "string", "DocumentType": "Unknown", "Metadata": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderDocumentMetadata" } ] } }, "System.Net.Http.HttpContent": { "value": { "Headers": [ { "@odata.type": "ChannelAdvisor.RestApi.V1.Models.KeyValuePair_2OfString_IEnumerable_1OfString" } ] } }, "Core.OpenApiExample": { "value": { "Description": "string", "Summary": "string", "ParameterName": "string", "Payload": "string" } }, "Core.OpenApiDocumentation": { "value": { "OpenApiOperationID": "string", "OpenApiTag": "string", "Description": "string", "Summary": "string", "Examples": [ { "@odata.type": "Core.OpenApiExample" } ] } } }, "requestBodies": { "refPostBody": { "description": "New navigation property ref value", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceCreate" } } }, "required": true }, "refPutBody": { "description": "New navigation property ref values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceUpdate" } } }, "required": true } }, "securitySchemes": { "oauth2": { "type": "oauth2", "description": "OAuth2 Authorization using Authorization Code and Implicit flows", "flows": { "implicit": { "authorizationUrl": "https://api.channeladvisor.com/oauth2/authorize", "scopes": { "orders": "Access orders", "inventory": "Access inventory" } }, "authorizationCode": { "authorizationUrl": "https://api.channeladvisor.com/oauth2/authorize", "tokenUrl": "https://api.channeladvisor.com/oauth2/token", "scopes": { "orders": "Access orders", "inventory": "Access inventory" } } } }, "bearer": { "type": "http", "description": "Bearer token authentication. Access token must be obtained using the OAuth2 flow.", "scheme": "bearer" } } }, "security": [ { "oauth2": [ "orders", "inventory" ], "bearer": [ ] } ], "tags": [ { "name": "Overview", "description": "This document provides a high-level introduction to integrating with the Rithum For Brands API. It covers typical integration patterns, core components, environment setup, and frequently asked questions to help developers and partners get started quickly.\r\n\r\n---\r\n\r\n## Typical Integration Workflow\r\nA standard integration between a client system (your application) and Rithum For Brands involves:\r\n1. **Sending product data** to Rithum For Brands (inventory creation and updates)\r\n2. **Retrieving 'Ready To Ship' orders** from Rithum For Brands\r\n3. **Sending shipping confirmations** back to Rithum For Brands\r\n4. **Handling cancellations and refunds** as needed\r\n\r\n---\r\n\r\n## Core Integration Components\r\n\r\n### Products\r\n- **Creating Products:** Add new products to Rithum For Brands, either individually or in batches.\r\n- **Updating Products:** Update product price, quantity, and attributes as needed. Prefer incremental updates for efficiency.\r\n- **Performance Note:** For catalogs over 20,000 products, consider using FTP for updates instead of the API. Contact Support for FTP setup.\r\n\r\n### Orders\r\n- **Getting New Orders:** Retrieve only valid orders for fulfillment (not previously acknowledged, payment status Cleared).\r\n- **Acknowledging Orders:** Mark orders as exported after saving to your system to avoid duplicate retrievals.\r\n- **Shipping Orders:** Notify Rithum For Brands when orders are shipped; details are sent to the marketplace.\r\n- **Canceling/Refunding Orders:** Submit cancellation or refund requests; Rithum For Brands processes these with the marketplace.\r\n\r\n---\r\n\r\n## API Environment & Behavior\r\n- All client interactions use the same API endpoints for both live and test (sandbox) operations.\r\n- There is **no separate sandbox base URL**; production and sandbox accounts use the same endpoints.\r\n- Authorization and access procedures are identical across environments.\r\n\r\n### Best Practice: Separate Authorizations\r\n- Use distinct API authorizations for production and sandbox posting accounts to keep environments separate.\r\n\r\n### Posting Accounts\r\n- **Production Posting Account:** Used for live operations.\r\n- **Sandbox (Test) Posting Account:** Used for testing; recommended to include \"Sandbox\" or \"Test\" in the account name. Test accounts are not connected to marketplaces and are billable.\r\n- To request a test account, see the Knowledge Center article \"Add a new posting account\" (login required).\r\n\r\n---\r\n\r\n## Getting Started & FAQ\r\n\r\n### Developer Access\r\n- Read and understand the [Terms of Use](#tag/Terms), then click on the requesting a developer account link below. After the account is granted, the email used to for the request is delivered an email with credentials.\r\n- Register for the Developer Network by [requesting a developer account](https://complete.channeladvisor.com/DeveloperNetwork/RequestApiDevKey.aspx) (external link).\r\n- API credentials require a Rithum For Brands customer to grant access to their account.\r\n\r\n### Test Accounts\r\n- Test accounts are available for clients only and are billable.\r\n- Developers working for a client should have the client request a test account.\r\n\r\n### REST API vs. SOAP API\r\n- The SOAP API is in maintenance mode; new integrations should use the REST API.\r\n- See the Knowledge Center for a comparison table and API request limits.\r\n\r\n### Common Questions (FAQ)\r\n\r\n
orders inventory).\r\n ? are case-sensitive; after ? are not.PreventSiteProcessing property in Orders or Order Items requests.\r\n PreventMarketplaceCommunication property on the /v1/Orders/Ship endpoint or as a query string parameter on the /v1/Fulfillments endpoint.\r\n LastUpdatedDateUtc with exported=true as a parameter.\r\n