{"swagger":"2.0","info":{"version":"v1","title":"Katana.API","description":"Katana Commerce API"},"host":"katana-api.homestudios.nl","schemes":["https"],"paths":{"/Order/Add":{"post":{"tags":["Order"],"summary":"End-point to add new orders, not fully implemented yet","operationId":"Order_Add","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/Katana.API.Models.Order.OrderAddModel"}}],"responses":{"200":{"description":"OK","schema":{"format":"int32","type":"integer"}}}}},"/Order/Find":{"get":{"tags":["Order"],"summary":"Find all orders by filter, the filter is optional","operationId":"Order_Find","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"filterModel.orderNumber","in":"query","required":true,"type":"string"},{"name":"filterModel.vendorId","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Order.OrderModel"}}}}}},"/Product/Find":{"get":{"tags":["Product"],"summary":"This endpoint has been made deprecated, in favour of the  endpoint, which also returns paging information.\r\nIf you absolutely HAVE to use this endpoint, but still want to use paging, that is possible. Just keep requesting the next page until you get an\r\nempty response.\r\n            \r\nFind all products by filter, the filter is optional.","operationId":"Product_Find","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"filterModel.paging.pageIndex","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.paging.pageSize","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.id","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.keywords","in":"query","required":false,"type":"string"},{"name":"filterModel.name","in":"query","required":false,"type":"string"},{"name":"filterModel.descriptionShort","in":"query","required":false,"type":"string"},{"name":"filterModel.descriptionFull","in":"query","required":false,"type":"string"},{"name":"filterModel.sku","in":"query","required":false,"type":"string"},{"name":"filterModel.vendorName","in":"query","required":false,"type":"string"},{"name":"filterModel.vendorId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.isPublished","in":"query","required":false,"type":"boolean"},{"name":"filterModel.storeId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.countryId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.tag","in":"query","required":false,"type":"string"},{"name":"filterModel.lanuageId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.priceMin","in":"query","required":false,"type":"number","format":"double"},{"name":"filterModel.priceMax","in":"query","required":false,"type":"number","format":"double"},{"name":"filterModel.currencyCode","in":"query","required":false,"type":"string"},{"name":"filterModel.grandParentExternalId","in":"query","required":false,"type":"string"},{"name":"filterModel.parentExternalId","in":"query","required":false,"type":"string"},{"name":"filterModel.parentId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.grandParentId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.updatedOnUtc","in":"query","required":false,"type":"string","format":"date-time"},{"name":"filterModel.specFilters","in":"query","required":false,"type":"array","items":{},"collectionFormat":"multi"},{"name":"filterModel.productType","in":"query","required":false,"type":"string","enum":["SimpleProduct","GroupedProduct","BundledProduct","ParentProduct","GrandParentProduct","Template"]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.ProductModel"}}}},"deprecated":true}},"/Product":{"get":{"tags":["Product"],"summary":"Find all products\r\n* by filter, the filter is optional, omitting it will return all products (with a maximum of 10000)\r\n* the filter includes options to page the results","operationId":"Product_Get","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"filterModel.paging.pageIndex","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.paging.pageSize","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.id","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.keywords","in":"query","required":false,"type":"string"},{"name":"filterModel.name","in":"query","required":false,"type":"string"},{"name":"filterModel.descriptionShort","in":"query","required":false,"type":"string"},{"name":"filterModel.descriptionFull","in":"query","required":false,"type":"string"},{"name":"filterModel.sku","in":"query","required":false,"type":"string"},{"name":"filterModel.vendorName","in":"query","required":false,"type":"string"},{"name":"filterModel.vendorId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.isPublished","in":"query","required":false,"type":"boolean"},{"name":"filterModel.storeId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.countryId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.tag","in":"query","required":false,"type":"string"},{"name":"filterModel.lanuageId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.priceMin","in":"query","required":false,"type":"number","format":"double"},{"name":"filterModel.priceMax","in":"query","required":false,"type":"number","format":"double"},{"name":"filterModel.currencyCode","in":"query","required":false,"type":"string"},{"name":"filterModel.grandParentExternalId","in":"query","required":false,"type":"string"},{"name":"filterModel.parentExternalId","in":"query","required":false,"type":"string"},{"name":"filterModel.parentId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.grandParentId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.updatedOnUtc","in":"query","required":false,"type":"string","format":"date-time"},{"name":"filterModel.specFilters","in":"query","required":false,"type":"array","items":{},"collectionFormat":"multi"},{"name":"filterModel.productType","in":"query","required":false,"type":"string","enum":["SimpleProduct","GroupedProduct","BundledProduct","ParentProduct","GrandParentProduct","Template"]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Katana.API.Models.PagedListModel[Katana.API.Models.Product.ProductModel]"}}}}},"/Spec/Find":{"get":{"tags":["Spec"],"summary":"Find all specifications by filter, the filter is optional","operationId":"Spec_Find","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"filterModel.specId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.specName","in":"query","required":false,"type":"string"},{"name":"filterModel.vendorId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.specCategoryId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"filterModel.allowFiltering","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.SpecModel"}}}}}},"/Spec/FindSpecLocations":{"get":{"tags":["Spec"],"summary":"Please note: previously, this endpoint was used to find all specification locations, but in Katana the specification locations have recently been to specification categories.\r\nWe advise you to use FindSpecCategories instead.","operationId":"Spec_FindSpecLocations","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.SpecLocationModel"}}}},"deprecated":true}},"/Spec/FindSpecCategories":{"get":{"tags":["Spec"],"summary":"Find all specification categories, the specifications are always coupled to a specification category","operationId":"Spec_FindSpecCategories","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.SpecCategoryModel"}}}}}},"/Spec/SpecificationGroup":{"get":{"tags":["Spec"],"summary":"Find all specification groups, specifications can be coupled to a specification group","operationId":"Spec_SpecificationGroup","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.SpecificationGroupModel"}}}}}},"/Store/GetAll":{"get":{"tags":["Store"],"summary":"Find all stores","operationId":"Store_GetAll","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.StoreModel"}}}}}},"/Vendor/FindAll":{"get":{"tags":["Vendor"],"summary":"Find all vendors","operationId":"Vendor_Find","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Vendor.VendorModel"}}}}}}},"definitions":{"Katana.API.Models.Order.OrderAddModel":{"required":["TotalVat","OrderItems","OrderTotal","OrderSubTotalInclTax","OrderSubTotalExclTax","OrderShippingInclTax","OrderShippingExclTax"],"type":"object","properties":{"TotalVat":{"format":"double","type":"number"},"OrderItems":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Order.OrderItemAddModel"}},"Id":{"format":"int32","type":"integer"},"CreatedOnUtc":{"format":"date-time","type":"string"},"UpdatedOnUtc":{"format":"date-time","type":"string"},"OrderReference":{"type":"string"},"StoreId":{"format":"int32","type":"integer"},"OrderStatus":{"enum":["Pending","Processing","Complete","Cancelled"],"type":"string"},"ShippingStatus":{"enum":["ShippingNotRequired","NotYetShipped","PartiallyShipped","Shipped","Delivered"],"type":"string"},"PaymentStatus":{"enum":["Pending","Authorized","Paid","PartiallyRefunded","Refunded","Voided"],"type":"string"},"OrderTotal":{"format":"double","type":"number"},"OrderSubTotalInclTax":{"format":"double","type":"number"},"OrderSubTotalExclTax":{"format":"double","type":"number"},"OrderSubTotalDiscountInclTax":{"format":"double","type":"number"},"OrderSubTotalDiscountExclTax":{"format":"double","type":"number"},"OrderShippingInclTax":{"format":"double","type":"number"},"OrderShippingExclTax":{"format":"double","type":"number"},"PaymentMethodAdditionalFeeInclTax":{"format":"double","type":"number"},"PaymentMethodAdditionalFeeExclTax":{"format":"double","type":"number"},"PaymentMethodName":{"type":"string"},"CurrencyCode":{"type":"string"},"AuthorizationTransactionId":{"type":"string"},"CheckoutAttributes":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Order.CheckoutAttributeModel"}},"Customer":{"$ref":"#/definitions/Katana.API.Models.Customer.CustomerModel"},"BillingAddress":{"$ref":"#/definitions/Katana.API.Models.Customer.AddressModel"},"ShippingAddress":{"$ref":"#/definitions/Katana.API.Models.Customer.AddressModel"}}},"Katana.API.Models.Order.OrderItemAddModel":{"type":"object","properties":{"UnitPriceInclVat":{"format":"double","type":"number"},"AssociatedOrderItems":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Order.OrderItemAddModel"}},"Id":{"format":"int32","type":"integer"},"OrderId":{"format":"int32","type":"integer"},"ProductId":{"format":"int32","type":"integer"},"Quantity":{"format":"int32","type":"integer"},"UnitPriceInclTax":{"type":"string"},"UnitPriceExclTax":{"type":"string"},"UnitPriceInclTaxValue":{"format":"double","type":"number"},"UnitPriceExclTaxValue":{"format":"double","type":"number"},"SubTotalInclTax":{"type":"string"},"SubTotalExclTax":{"type":"string"},"SubTotalInclTaxValue":{"format":"double","type":"number"},"SubTotalExclTaxValue":{"format":"double","type":"number"},"AttributeInfo":{"type":"string"},"GroupedOrderItemId":{"format":"int32","type":"integer"}}},"Katana.API.Models.Order.CheckoutAttributeModel":{"type":"object","properties":{"AttributeId":{"format":"int32","type":"integer"},"Value":{"type":"string"}}},"Katana.API.Models.Customer.CustomerModel":{"required":["Email"],"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Company":{"type":"string"},"Gender":{"type":"string"},"DateOfBirth":{"format":"date-time","type":"string"},"Email":{"type":"string"},"Active":{"type":"boolean"},"Deleted":{"type":"boolean"},"StreetAddress":{"type":"string"},"HouseNumber":{"type":"string"},"ZipPostalCode":{"type":"string"},"City":{"type":"string"},"CountryTwoLetterIsoCode":{"type":"string"},"Phone":{"type":"string"},"Fax":{"type":"string"},"BillingAddress_Id":{"format":"int32","type":"integer"},"ShippingAddress_Id":{"format":"int32","type":"integer"},"ShoppingCartItemList":{"type":"array","items":{"$ref":"#/definitions/Katana.Core.Domain.Orders.ShoppingCartItem"}},"VatNumberStatus":{"enum":["Unknown","Empty","Valid","Invalid"],"type":"string"}}},"Katana.API.Models.Customer.AddressModel":{"required":["FirstName","LastName","CountryTwoLetterIsoCode","City","Address1","HouseNumber","ZipPostalCode"],"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"Company":{"type":"string"},"CountryTwoLetterIsoCode":{"type":"string"},"City":{"type":"string"},"Address1":{"type":"string"},"HouseNumber":{"type":"string"},"ZipPostalCode":{"type":"string"},"PhoneNumber":{"type":"string"},"FaxNumber":{"type":"string"}}},"Katana.Core.Domain.Orders.ShoppingCartItem":{"type":"object","properties":{"StoreId":{"format":"int32","type":"integer"},"ShoppingCartTypeId":{"format":"int32","type":"integer"},"CustomerId":{"format":"int32","type":"integer"},"ProductId":{"format":"int32","type":"integer"},"GroupedProductId":{"format":"int32","type":"integer"},"GroupingGuid":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"AttributesXml":{"type":"string"},"CustomerEnteredPrice":{"format":"double","type":"number"},"Quantity":{"format":"int32","type":"integer"},"AppliedDiscountId":{"format":"int32","type":"integer"},"RentalStartDateUtc":{"format":"date-time","type":"string"},"RentalEndDateUtc":{"format":"date-time","type":"string"},"ShoppingCartType":{"enum":["ShoppingCart","Wishlist"],"type":"string"},"Customer":{"$ref":"#/definitions/Katana.Core.Domain.Customers.Customer"},"Id":{"format":"int32","type":"integer"},"CreatedOnUtc":{"format":"date-time","type":"string"},"UpdatedOnUtc":{"format":"date-time","type":"string"},"Guid":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"IsCached":{"type":"boolean"}}},"Katana.Core.Domain.Customers.Customer":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Company":{"type":"string"},"Gender":{"type":"string"},"DateOfBirth":{"format":"date-time","type":"string"},"Email":{"type":"string"},"Password":{"type":"string"},"PasswordSalt":{"type":"string"},"PasswordVersion":{"format":"int32","type":"integer"},"AdminComment":{"type":"string"},"IsTaxExempt":{"type":"boolean"},"VendorId":{"format":"int32","type":"integer"},"HasShoppingCartItems":{"type":"boolean"},"Active":{"type":"boolean"},"Deleted":{"type":"boolean"},"IsSystemAccount":{"type":"boolean"},"SystemName":{"type":"string"},"LastIpAddress":{"type":"string"},"LastLoginDateUtc":{"format":"date-time","type":"string"},"LastActivityDateUtc":{"format":"date-time","type":"string"},"StreetAddress":{"type":"string"},"HouseNumber":{"type":"string"},"ZipPostalCode":{"type":"string"},"City":{"type":"string"},"CountryId":{"format":"int32","type":"integer"},"StateProvinceId":{"format":"int32","type":"integer"},"Phone":{"type":"string"},"Fax":{"type":"string"},"StreetAndCityFromZipCodeService":{"type":"boolean"},"CreditLimit":{"format":"int32","type":"integer"},"DebtorNumber":{"type":"string"},"DisableEdit":{"type":"boolean"},"AbandonedCartMailSendOnUtc":{"format":"date-time","type":"string"},"AbandonedCartLinkUsedOnUtc":{"format":"date-time","type":"string"},"ExternalAuthenticationRecords":{"type":"array","items":{"$ref":"#/definitions/Katana.Core.Domain.Customers.ExternalAuthenticationRecord"},"readOnly":true},"CustomerRoles":{"type":"array","items":{"$ref":"#/definitions/Katana.Core.Domain.Customers.CustomerRole"}},"ShoppingCartItems":{"type":"array","items":{"$ref":"#/definitions/Katana.Core.Domain.Orders.ShoppingCartItem"},"readOnly":true},"ReturnRequests":{"type":"array","items":{"$ref":"#/definitions/Katana.Core.Domain.Orders.ReturnRequest"},"readOnly":true},"BillingAddress_Id":{"format":"int32","type":"integer"},"BillingAddress":{"$ref":"#/definitions/Katana.Core.Domain.Common.Address"},"ShippingAddress_Id":{"format":"int32","type":"integer"},"ShippingAddress":{"$ref":"#/definitions/Katana.Core.Domain.Common.Address"},"ShoppingCartItemList":{"type":"array","items":{"$ref":"#/definitions/Katana.Core.Domain.Orders.ShoppingCartItem"},"readOnly":true},"VatNumber":{"type":"string"},"VatNumberStatusId":{"format":"int32","type":"integer"},"VatNumberStatus":{"enum":["Unknown","Empty","Valid","Invalid"],"type":"string"},"Id":{"format":"int32","type":"integer"},"CreatedOnUtc":{"format":"date-time","type":"string"},"UpdatedOnUtc":{"format":"date-time","type":"string"},"Guid":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"IsCached":{"type":"boolean"}}},"Katana.Core.Domain.Customers.ExternalAuthenticationRecord":{"type":"object","properties":{"CustomerId":{"format":"int32","type":"integer"},"Email":{"type":"string"},"ExternalIdentifier":{"type":"string"},"ExternalDisplayIdentifier":{"type":"string"},"OAuthToken":{"type":"string"},"OAuthAccessToken":{"type":"string"},"ProviderSystemName":{"type":"string"},"Customer":{"$ref":"#/definitions/Katana.Core.Domain.Customers.Customer"},"Id":{"format":"int32","type":"integer"},"CreatedOnUtc":{"format":"date-time","type":"string"},"UpdatedOnUtc":{"format":"date-time","type":"string"},"Guid":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"IsCached":{"type":"boolean"}}},"Katana.Core.Domain.Customers.CustomerRole":{"type":"object","properties":{"Name":{"type":"string"},"FreeShipping":{"type":"boolean"},"TaxExempt":{"type":"boolean"},"Active":{"type":"boolean"},"IsSystemRole":{"type":"boolean"},"SystemName":{"type":"string"},"PurchasedWithProductId":{"format":"int32","type":"integer"},"PimStatusId":{"format":"int32","type":"integer"},"PermissionRecords":{"type":"array","items":{"$ref":"#/definitions/Katana.Core.Domain.Security.PermissionRecord"},"readOnly":true},"Id":{"format":"int32","type":"integer"},"CreatedOnUtc":{"format":"date-time","type":"string"},"UpdatedOnUtc":{"format":"date-time","type":"string"},"Guid":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"IsCached":{"type":"boolean"}}},"Katana.Core.Domain.Orders.ReturnRequest":{"type":"object","properties":{"StoreId":{"format":"int32","type":"integer"},"OrderItemId":{"format":"int32","type":"integer"},"CustomerId":{"format":"int32","type":"integer"},"Quantity":{"format":"int32","type":"integer"},"ReasonForReturn":{"type":"string"},"RequestedAction":{"type":"string"},"CustomerComments":{"type":"string"},"StaffNotes":{"type":"string"},"ReturnRequestStatusId":{"format":"int32","type":"integer"},"RefundCorrection":{"format":"double","type":"number"},"ReturnRequestStatus":{"enum":["Pending","PendingFulfillment","Received","ReturnAuthorized","ItemsRepaired","ItemsRefunded","RequestRejected","Cancelled"],"type":"string"},"Customer":{"$ref":"#/definitions/Katana.Core.Domain.Customers.Customer"},"Id":{"format":"int32","type":"integer"},"CreatedOnUtc":{"format":"date-time","type":"string"},"UpdatedOnUtc":{"format":"date-time","type":"string"},"Guid":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"IsCached":{"type":"boolean"}}},"Katana.Core.Domain.Common.Address":{"type":"object","properties":{"FirstName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"},"Company":{"type":"string"},"CountryId":{"format":"int32","type":"integer"},"StateProvinceId":{"format":"int32","type":"integer"},"City":{"type":"string"},"Address1":{"type":"string"},"HouseNumber":{"type":"string"},"ZipPostalCode":{"type":"string"},"PhoneNumber":{"type":"string"},"FaxNumber":{"type":"string"},"CustomAttributes":{"type":"string"},"Country":{"$ref":"#/definitions/Katana.Core.Domain.Directory.Country"},"StateProvince":{"$ref":"#/definitions/Katana.Core.Domain.Directory.StateProvince"},"StreetAndCityFromZipCodeService":{"type":"boolean"},"Code":{"type":"string"},"Id":{"format":"int32","type":"integer"},"CreatedOnUtc":{"format":"date-time","type":"string"},"UpdatedOnUtc":{"format":"date-time","type":"string"},"Guid":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"IsCached":{"type":"boolean"}}},"Katana.Core.Domain.Security.PermissionRecord":{"type":"object","properties":{"Name":{"type":"string"},"SystemName":{"type":"string"},"Category":{"type":"string"},"StoreId":{"format":"int32","type":"integer"},"CustomerRoles":{"type":"array","items":{"$ref":"#/definitions/Katana.Core.Domain.Customers.CustomerRole"},"readOnly":true},"Id":{"format":"int32","type":"integer"},"CreatedOnUtc":{"format":"date-time","type":"string"},"UpdatedOnUtc":{"format":"date-time","type":"string"},"Guid":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"IsCached":{"type":"boolean"}}},"Katana.Core.Domain.Directory.Country":{"type":"object","properties":{"Name":{"type":"string"},"AllowsBilling":{"type":"boolean"},"AllowsShipping":{"type":"boolean"},"TwoLetterIsoCode":{"type":"string"},"ThreeLetterIsoCode":{"type":"string"},"NumericIsoCode":{"format":"int32","type":"integer"},"SubjectToVat":{"type":"boolean"},"Published":{"type":"boolean"},"DisplayOrder":{"format":"int32","type":"integer"},"LimitedToStores":{"type":"boolean"},"StateProvinces":{"type":"array","items":{"$ref":"#/definitions/Katana.Core.Domain.Directory.StateProvince"},"readOnly":true},"RestrictedShippingMethods":{"type":"array","items":{"$ref":"#/definitions/Katana.Core.Domain.Shipping.ShippingMethod"},"readOnly":true},"Id":{"format":"int32","type":"integer"},"CreatedOnUtc":{"format":"date-time","type":"string"},"UpdatedOnUtc":{"format":"date-time","type":"string"},"Guid":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"IsCached":{"type":"boolean"}}},"Katana.Core.Domain.Directory.StateProvince":{"type":"object","properties":{"CountryId":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Abbreviation":{"type":"string"},"Published":{"type":"boolean"},"DisplayOrder":{"format":"int32","type":"integer"},"Country":{"$ref":"#/definitions/Katana.Core.Domain.Directory.Country"},"Id":{"format":"int32","type":"integer"},"CreatedOnUtc":{"format":"date-time","type":"string"},"UpdatedOnUtc":{"format":"date-time","type":"string"},"Guid":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"IsCached":{"type":"boolean"}}},"Katana.Core.Domain.Shipping.ShippingMethod":{"type":"object","properties":{"Name":{"type":"string"},"Description":{"type":"string"},"DisplayOrder":{"format":"int32","type":"integer"},"IsPickup":{"type":"boolean"},"IsPostNlPickup":{"type":"boolean"},"IsPostNlTimeframe":{"type":"boolean"},"PostNlApiUrl":{"type":"string"},"PostNlApiKey":{"type":"string"},"PostNlPickerLocationTypeId":{"format":"int32","type":"integer"},"PostNlPickerLocationType":{"enum":["Cart","Checkout"],"type":"string"},"RestrictedCountries":{"type":"array","items":{"$ref":"#/definitions/Katana.Core.Domain.Directory.Country"},"readOnly":true},"PostNlAllowedTimeframesIds":{"type":"string"},"PostNlAllowedTimeframes":{"enum":["Daytime","Morning","Noon","Afternoon","Evening","Sunday","Sameday","Pickup"],"type":"string"},"MinimumDelayInDays":{"format":"int32","type":"integer"},"LimitedToStores":{"type":"boolean"},"Id":{"format":"int32","type":"integer"},"CreatedOnUtc":{"format":"date-time","type":"string"},"UpdatedOnUtc":{"format":"date-time","type":"string"},"Guid":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"IsCached":{"type":"boolean"}}},"Katana.API.Models.Order.OrderFilterModel":{"description":"","required":["OrderNumber"],"type":"object","properties":{"OrderNumber":{"type":"string"},"VendorId":{"format":"int32","type":"integer"}}},"Katana.API.Models.Order.OrderModel":{"description":"","required":["OrderTotal","OrderSubTotalInclTax","OrderSubTotalExclTax","OrderShippingInclTax","OrderShippingExclTax"],"type":"object","properties":{"OrderItems":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Order.OrderItemModel"}},"Id":{"format":"int32","type":"integer"},"CreatedOnUtc":{"format":"date-time","type":"string"},"UpdatedOnUtc":{"format":"date-time","type":"string"},"OrderReference":{"type":"string"},"StoreId":{"format":"int32","type":"integer"},"OrderStatus":{"enum":["Pending","Processing","Complete","Cancelled"],"type":"string"},"ShippingStatus":{"enum":["ShippingNotRequired","NotYetShipped","PartiallyShipped","Shipped","Delivered"],"type":"string"},"PaymentStatus":{"enum":["Pending","Authorized","Paid","PartiallyRefunded","Refunded","Voided"],"type":"string"},"OrderTotal":{"format":"double","type":"number"},"OrderSubTotalInclTax":{"format":"double","type":"number"},"OrderSubTotalExclTax":{"format":"double","type":"number"},"OrderSubTotalDiscountInclTax":{"format":"double","type":"number"},"OrderSubTotalDiscountExclTax":{"format":"double","type":"number"},"OrderShippingInclTax":{"format":"double","type":"number"},"OrderShippingExclTax":{"format":"double","type":"number"},"PaymentMethodAdditionalFeeInclTax":{"format":"double","type":"number"},"PaymentMethodAdditionalFeeExclTax":{"format":"double","type":"number"},"PaymentMethodName":{"type":"string"},"CurrencyCode":{"type":"string"},"AuthorizationTransactionId":{"type":"string"},"CheckoutAttributes":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Order.CheckoutAttributeModel"}},"Customer":{"$ref":"#/definitions/Katana.API.Models.Customer.CustomerModel"},"BillingAddress":{"$ref":"#/definitions/Katana.API.Models.Customer.AddressModel"},"ShippingAddress":{"$ref":"#/definitions/Katana.API.Models.Customer.AddressModel"}}},"Katana.API.Models.Order.OrderItemModel":{"description":"","type":"object","properties":{"AssociatedOrderItems":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Order.OrderItemModel"}},"Id":{"format":"int32","type":"integer"},"OrderId":{"format":"int32","type":"integer"},"ProductId":{"format":"int32","type":"integer"},"Quantity":{"format":"int32","type":"integer"},"UnitPriceInclTax":{"type":"string"},"UnitPriceExclTax":{"type":"string"},"UnitPriceInclTaxValue":{"format":"double","type":"number"},"UnitPriceExclTaxValue":{"format":"double","type":"number"},"SubTotalInclTax":{"type":"string"},"SubTotalExclTax":{"type":"string"},"SubTotalInclTaxValue":{"format":"double","type":"number"},"SubTotalExclTaxValue":{"format":"double","type":"number"},"AttributeInfo":{"type":"string"},"GroupedOrderItemId":{"format":"int32","type":"integer"}}},"Katana.IServices.Models.ProductFilter.ProductFilterModel":{"type":"object","properties":{"Paging":{"$ref":"#/definitions/Katana.IServices.Models.Common.PagingModel"},"Id":{"format":"int32","type":"integer"},"Keywords":{"type":"string"},"Name":{"type":"string"},"DescriptionShort":{"type":"string"},"DescriptionFull":{"type":"string"},"Sku":{"type":"string"},"VendorName":{"type":"string"},"VendorId":{"format":"int32","type":"integer"},"IsPublished":{"type":"boolean"},"StoreId":{"format":"int32","type":"integer"},"CountryId":{"format":"int32","type":"integer"},"Tag":{"type":"string"},"LanuageId":{"format":"int32","type":"integer"},"PriceMin":{"format":"double","type":"number"},"PriceMax":{"format":"double","type":"number"},"CurrencyCode":{"type":"string"},"GrandParentExternalId":{"type":"string"},"ParentExternalId":{"type":"string"},"ParentId":{"format":"int32","type":"integer"},"GrandParentId":{"format":"int32","type":"integer"},"UpdatedOnUtc":{"format":"date-time","type":"string"},"SpecFilters":{"type":"array","items":{"$ref":"#/definitions/Katana.IServices.Models.ProductFilter.ProductSpecFilterModel"}},"ProductType":{"enum":["SimpleProduct","GroupedProduct","BundledProduct","ParentProduct","GrandParentProduct","Template"],"type":"string"}}},"Katana.IServices.Models.Common.PagingModel":{"type":"object","properties":{"PageIndex":{"format":"int32","type":"integer"},"PageSize":{"format":"int32","type":"integer"}}},"Katana.IServices.Models.ProductFilter.ProductSpecFilterModel":{"type":"object","properties":{"SpecValueId":{"format":"int32","type":"integer"},"SpecValue":{"type":"string"},"SpecSubtitle":{"type":"string"},"SpecId":{"format":"int32","type":"integer"},"SpecName":{"type":"string"},"VendorId":{"format":"int32","type":"integer"},"SpecCategoryId":{"format":"int32","type":"integer"},"AllowFiltering":{"type":"boolean"}}},"Katana.API.Models.Product.ProductModel":{"description":"","type":"object","properties":{"Id":{"format":"int32","type":"integer"},"CreatedOnUtc":{"format":"date-time","type":"string"},"UpdatedOnUtc":{"format":"date-time","type":"string"},"ProductType":{"enum":["SimpleProduct","GroupedProduct","BundledProduct","ParentProduct","GrandParentProduct","Template"],"type":"string"},"ProductTypeDescription":{"type":"string"},"PimSeverity":{"type":"string"},"PimStatus":{"type":"string"},"SortOrder":{"format":"int32","type":"integer"},"GrandParentExternalId":{"type":"string"},"ParentExternalId":{"type":"string"},"ParentId":{"format":"int32","type":"integer"},"GrandParentId":{"format":"int32","type":"integer"},"Collections":{"$ref":"#/definitions/Katana.API.Models.Product.CollectionsModel"},"Dimensions":{"$ref":"#/definitions/Katana.API.Models.Product.DimensionsModel"},"Package":{"$ref":"#/definitions/Katana.API.Models.Product.PackageModel"},"FirstOnStockDate":{"format":"date-time","type":"string"},"Settings":{"$ref":"#/definitions/Katana.API.Models.Product.SettingsModel"},"EcommerceSettings":{"$ref":"#/definitions/Katana.API.Models.Product.EcommerceSettingsModel"},"OrderSettings":{"$ref":"#/definitions/Katana.API.Models.Product.OrderSettingsModel"},"Prices":{"$ref":"#/definitions/Katana.API.Models.Product.PricesModel"},"Stock":{"$ref":"#/definitions/Katana.API.Models.Product.StockModel"},"TextFieldsModel":{"$ref":"#/definitions/Katana.API.Models.Product.TextFieldsModel"},"Vendor":{"$ref":"#/definitions/Katana.API.Models.Product.VendorModel"},"Reviews":{"$ref":"#/definitions/Katana.API.Models.Product.ReviewsModel"},"AdditionProducts":{"$ref":"#/definitions/Katana.API.Models.Product.AdditionProductsModel"},"Download":{"$ref":"#/definitions/Katana.API.Models.Product.DownloadModel"},"Recurring":{"$ref":"#/definitions/Katana.API.Models.Product.RecurringModel"},"Rental":{"$ref":"#/definitions/Katana.API.Models.Product.RentalModel"},"LocalizedProperties":{"type":"array","items":{"$ref":"#/definitions/Katana.Core.Domain.ElasticSearch.ElasticLocalizedProperty"}}}},"Katana.API.Models.Product.CollectionsModel":{"type":"object","properties":{"Categories":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Mapping.Category.CategoryModel"}},"Attributes":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.ProductAttributeModel"}},"Specs":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.ProductSpecModel"}},"SpecificationGroups":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.ProductSpecificationGroupModel"}},"ChildProducts":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.ProductModel"}},"Attachments":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.AttachmentModel"}},"Images":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.ImageModel"}},"Tags":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.TagModel"}},"Labels":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.LabelModel"}},"LimitedToStores":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.StoreModel"}},"Manufacturers":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.ManufacturerModel"}}}},"Katana.API.Models.Product.DimensionsModel":{"type":"object","properties":{"Weight":{"format":"double","type":"number"},"Length":{"format":"double","type":"number"},"Width":{"format":"double","type":"number"},"Height":{"format":"double","type":"number"}}},"Katana.API.Models.Product.PackageModel":{"type":"object","properties":{"Size":{"format":"int32","type":"integer"},"Unit":{"type":"string"},"UnitItem":{"type":"string"}}},"Katana.API.Models.Product.SettingsModel":{"type":"object","properties":{"LimitedToStores":{"type":"boolean"},"DeliveryDate":{"type":"string"},"IsTelecommunicationsOrBroadcastingOrElectronicServices":{"type":"boolean"},"ManageInventoryMethod":{"type":"string"},"UseMultipleWarehouses":{"type":"boolean"},"AllowBackInStockSubscriptions":{"type":"boolean"},"HasPriceBookItems":{"type":"boolean"},"HasDiscountsApplied":{"type":"boolean"},"AvailableStartDateTimeUtc":{"format":"date-time","type":"string"},"AvailableEndDateTimeUtc":{"format":"date-time","type":"string"},"Published":{"type":"boolean"},"ShowOnHomePage":{"type":"boolean"},"IsGiftcard":{"type":"boolean"}}},"Katana.API.Models.Product.EcommerceSettingsModel":{"type":"object","properties":{"DisableBuyButton":{"type":"boolean"},"DisableWishlistButton":{"type":"boolean"},"AvailableForPreOrder":{"type":"boolean"},"PreOrderAvailabilityStartDateTimeUtc":{"format":"date-time","type":"string"}}},"Katana.API.Models.Product.OrderSettingsModel":{"type":"object","properties":{"OrderMinimumQuantity":{"format":"int32","type":"integer"},"OrderMaximumQuantity":{"format":"int32","type":"integer"},"IsShipEnabled":{"type":"boolean"},"AllowCancelling":{"type":"boolean"},"AllowReturns":{"type":"boolean"},"IsFreeShipping":{"type":"boolean"},"ShipSeparately":{"type":"boolean"},"AllowedQuantities":{"type":"string"}}},"Katana.API.Models.Product.PricesModel":{"type":"object","properties":{"AdditionalShippingCharge":{"format":"double","type":"number"},"IsTaxExempt":{"type":"boolean"},"TaxCategoryId":{"format":"int32","type":"integer"},"TaxCategoryDescription":{"type":"string"},"OldPrice":{"format":"double","type":"number"},"CustomerEntersPrice":{"type":"boolean"},"MinimumCustomerEnteredPrice":{"format":"double","type":"number"},"MaximumCustomerEnteredPrice":{"format":"double","type":"number"},"CurrentPriceBookItem":{"$ref":"#/definitions/Katana.API.Models.Product.CurrentPriceBookItemModel"},"PriceBookItems":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.PriceBookItemModel"}},"Currency":{"type":"string"},"SpecialPrice":{"format":"double","type":"number"},"SpecialPriceStartDateTimeUtc":{"format":"date-time","type":"string"},"SpecialPriceEndDateTimeUtc":{"format":"date-time","type":"string"}}},"Katana.API.Models.Product.StockModel":{"type":"object","properties":{"TotalStock":{"format":"int32","type":"integer"},"MinStockQuantity":{"format":"int32","type":"integer"},"LowStockActivity":{"type":"string"},"NotifyAdminForQuantityBelow":{"format":"int32","type":"integer"},"BackorderMode":{"type":"string"},"BackorderDeliveryDate":{"type":"string"}}},"Katana.API.Models.Product.TextFieldsModel":{"type":"object","properties":{"Sku":{"type":"string"},"Gtin":{"type":"string"},"Name":{"type":"string"},"ShortDescription":{"type":"string"},"FullDescription":{"type":"string"},"ManufacturerPartNumber":{"type":"string"},"EmbeddedVideo":{"type":"string"},"MetaKeywords":{"type":"string"},"MetaDescription":{"type":"string"},"MetaTitle":{"type":"string"}}},"Katana.API.Models.Product.VendorModel":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"}}},"Katana.API.Models.Product.ReviewsModel":{"type":"object","properties":{"AllowCustomerReviews":{"type":"boolean"},"ApprovedRatingSum":{"format":"int32","type":"integer"},"ApprovedTotalReviews":{"format":"int32","type":"integer"}}},"Katana.API.Models.Product.AdditionProductsModel":{"type":"object","properties":{"RequireOtherProducts":{"type":"boolean"},"RequiredProductIds":{"type":"string"},"AutomaticallyAddRequiredProducts":{"type":"boolean"}}},"Katana.API.Models.Product.DownloadModel":{"type":"object","properties":{"IsDownload":{"type":"boolean"},"MaxNumberOfDownloads":{"format":"int32","type":"integer"},"UnlimitedDownloads":{"type":"boolean"},"DownloadExpirationDays":{"format":"int32","type":"integer"},"HasSampleDownload":{"type":"boolean"},"HasUserAgreement":{"type":"boolean"},"UserAgreementText":{"type":"string"}}},"Katana.API.Models.Product.RecurringModel":{"type":"object","properties":{"IsRecurring":{"type":"boolean"},"RecurringCycleLength":{"format":"int32","type":"integer"},"RecurringCyclePeriod":{"type":"string"},"RecurringTotalCycles":{"format":"int32","type":"integer"}}},"Katana.API.Models.Product.RentalModel":{"type":"object","properties":{"IsRental":{"type":"boolean"},"RentalPriceLength":{"format":"int32","type":"integer"},"RentalPricePeriod":{"type":"string"}}},"Katana.Core.Domain.ElasticSearch.ElasticLocalizedProperty":{"type":"object","properties":{"LanguageId":{"format":"int32","type":"integer"},"LanguageCulture":{"type":"string"},"LocaleKey":{"type":"string"},"LocaleValue":{"type":"string"},"LocaleValueSuggest":{"type":"string"}}},"Katana.API.Models.Mapping.Category.CategoryModel":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Code":{"type":"string"},"Description":{"type":"string"},"ParentCategory":{"$ref":"#/definitions/Katana.API.Models.Mapping.Category.CategoryModel"}}},"Katana.API.Models.Product.ProductAttributeModel":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Description":{"type":"string"},"Values":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.ProductAttributeValueModel"}}}},"Katana.API.Models.Product.ProductSpecModel":{"description":"","required":["Name","OptionName"],"type":"object","properties":{"Name":{"type":"string"},"OptionName":{"type":"string"},"OptionCode":{"type":"string"},"OptionSubtitle":{"type":"string"}}},"Katana.API.Models.Product.ProductSpecificationGroupModel":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"}}},"Katana.API.Models.Product.AttachmentModel":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Url":{"type":"string"}}},"Katana.API.Models.Product.ImageModel":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Url":{"type":"string"}}},"Katana.API.Models.Product.TagModel":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"}}},"Katana.API.Models.Product.LabelModel":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"SortOrder":{"format":"int32","type":"integer"}}},"Katana.API.Models.Product.StoreModel":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"SystemName":{"type":"string"},"Name":{"type":"string"}}},"Katana.API.Models.Product.ManufacturerModel":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Code":{"type":"string"}}},"Katana.API.Models.Product.CurrentPriceBookItemModel":{"type":"object","properties":{"CostPrice":{"format":"double","type":"number"},"Price":{"format":"double","type":"number"}}},"Katana.API.Models.Product.PriceBookItemModel":{"description":"","type":"object","properties":{"CostPrice":{"format":"double","type":"number"},"Price":{"format":"double","type":"number"},"OldPrice":{"format":"double","type":"number"},"NewPrice":{"format":"double","type":"number"},"StartDate":{"format":"date-time","type":"string"},"EndDate":{"format":"date-time","type":"string"}}},"Katana.API.Models.Product.ProductAttributeValueModel":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"PriceAdjustment":{"format":"double","type":"number"}}},"Katana.API.Models.PagedListModel[Katana.API.Models.Product.ProductModel]":{"type":"object","properties":{"PageIndex":{"format":"int32","type":"integer"},"PageSize":{"format":"int32","type":"integer"},"TotalCount":{"format":"int32","type":"integer"},"TotalPages":{"format":"int32","type":"integer"},"Items":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.ProductModel"}}}},"Katana.IServices.Models.ProductFilter.SpecFilterModel":{"type":"object","properties":{"SpecId":{"format":"int32","type":"integer"},"SpecName":{"type":"string"},"VendorId":{"format":"int32","type":"integer"},"SpecCategoryId":{"format":"int32","type":"integer"},"AllowFiltering":{"type":"boolean"}}},"Katana.API.Models.Product.SpecModel":{"description":"","type":"object","properties":{"Location":{"$ref":"#/definitions/Katana.API.Models.Product.SpecLocationModel"},"Category":{"$ref":"#/definitions/Katana.API.Models.Product.SpecCategoryModel"},"Options":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.SpecOptionModel"}},"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"}}},"Katana.API.Models.Product.SpecLocationModel":{"description":"","type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Code":{"type":"string"}}},"Katana.API.Models.Product.SpecCategoryModel":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Code":{"type":"string"}}},"Katana.API.Models.Product.SpecOptionModel":{"description":"","type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Subtitle":{"type":"string"},"Code":{"type":"string"}}},"Katana.API.Models.Product.SpecificationGroupModel":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Specifications":{"type":"array","items":{"$ref":"#/definitions/Katana.API.Models.Product.SpecBaseModel"}}}},"Katana.API.Models.Product.SpecBaseModel":{"description":"","type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"}}},"Katana.API.Models.Vendor.VendorModel":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Name":{"type":"string"}}}},"securityDefinitions":{"apiKey":{"type":"apiKey","description":"API Key Authentication","name":"apikey","in":"header"}},"security":[{"apikey":[]}]}