API Documentation. Public API Documentation Last Updated: 05/14/2012

Transcription

1 API Documentation Summary... 3 Protocols... 3 Requirements... 3 First Time Authorization Sign Up Login Authenticate User Execute the API... 6 API Calls... 7 Operations... 7 Call Arguments and Filters... 8 Page Size... 8 Versioning... 8 Filters... 9 API Call Example Request Response Category Management ReadCategoryRequest Arguments ReadCategory Response ReadCategory Filters Customer Management ReadCustomer Arguments ReadCustomer ReadCustomer Filters Manufacturer Management Manufacturer Arguments ReadManufacturer ReadManufacturer Filters Order Management ReadOrder Arguments ReadOrder ReadOrder Filters UpdateOrder Arguments Order Status Management ReadOrderStatus Arguments ReadOrderStatus Read OrderStatus Filters Product Management ReadProduct Arguments ReadProduct ReadProduct Filters UpdateInventory Site Information Management of 29

2 ReadSiteSetting Arguments Warehouse Management ReadWarehouse ReadWarehouse ReadWarehouse Filters of 29

3 Summary This API document is a guide for developers who wish to use the Network Solutions Public API function to create applications that utilize their customer s online store, inventory, order, and customer data. Protocols The Network Solutions Public API can send and receive data utilizing either a soap or xml request. Requirements Listed below are the required items you must have to access and utilize the Public API A user created in the control panel for specific store that will use the API. This user must have full superadmin rights. A Network Solutions issued certificate which is a user key that is given out when the participating application has been approved by Network Solutions. First Time Authorization There are specific steps that must occur the first time you attempt to connect with the Public API. These steps are listed below. 1. Sign Up Register to our Public API by filling in the form with the appropriate information. It s important to enter a valid address since this is what we will use to provide you with a Certificate key. 3 of 29

4 2. Login Login to the API using; Your specific Application Name (entered in the form of the previous step) Public API Documentation Your Network Solutions Certificate (provided in the you received after submitting the form) Using the GetUserKey API function Call will return a Login URL and Userkey. The LoginURL is specific to the site that is accessing the API and the Userkey is specific to the session.the following examples show a sample of a GetUserKey request and response: Request: <soapenv:envelope xmlns:soapenv=" xmlns:urn="urn:networksolutions:apis"> <soapenv:header> <urn:securitycredential> <urn:application>myapplication</urn:application> <urn:certificate>e5fd d9b326012e483</urn:certificate> </urn:securitycredential> </soapenv:header> <soapenv:body> <urn:getuserkeyrequest/> </soapenv:body> </soapenv:envelope> Response: <soap:envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" <soap:body> <GetUserKeyResponse xmlns="urn:networksolutions:apis"> <Status>Success</Status> <TimeStamp> T18:47: Z</TimeStamp> <UserKey> <LoginUrl> y=p27shwku39910t2v </LoginUrl> <UserKey> p27shwku39910t2v</userkey> </UserKey> </GetUserKeyResponse> </soap:body> </soap:envelope> 4 of 29

5 3. Authenticate User Once you have obtained the LoginURL and UserKey, the specific user must be identified. This is done by browsing to the URL provided in the previous step and filling in the form with the appropriate information: Store URL (entered in the form during Step 1) User Name (user with SuperAdmin or NS API Access roles) Password These three items will uniquely identify the user, the store and the current session. Once the user s permissions, the storefront and other data have been verified, the user will be redirected to a Success URL indicating that connection has been made with the API. NOTE: We recommend that you create a specific user with NS API Access role only. This role allows the user to perform any API interactions but all other control panel permissions are denied. 5 of 29

6 4. Execute the API Executing API calls require three pieces of information to identify, authenticate, and authorize the API call; Application; This string identifies the specific application that is making the API call. Certificate This string is a Network Solutions generated password associated with the specific application making the API call. User Token This string is a unique generated number that identifies the particular storefront and the specific user making the API call. Argument Type Required Meaning Application String Yes Specifies the application or developer making the Api call. Certificate String Yes A generated password associated with the application. UserToken String Conditional Identifies the storefront and user making the call. The UserToken identifies the storefront and user making the API call. The user must grant the application access to their data using the authorization page. The user must be a physical user within the storefront ecommerce application and have Super admin or NS API Access permissions. Once the user token has been verified and received, you may begin to use the Public API. 6 of 29

7 API Calls Public API Documentation The API offers the ubiquitous CRUD operations (Create, Read, Update, Delete) over most of the entities supported. You can always go to for an updated definition of operations, messages and types supported. Operations Currently, the types of API calls are limited to: CreateAttribute ReadProduct CreateCategory ReadSiteSetting CreateCustomer ReadWarehouse CreateGiftCertificate UpdateAttribute CreateManufacturer UpdateCategory CreateOrderStatus UpdateCustomer CreatePriceLevel UpdateGiftCertificate CreateProduct UpdateInventory CreateWarehouse UpdateManufacturer DeleteAttribute UpdateOrder DeleteCategory UpdateOrderStatus DeleteCustomer UpdatePriceLevel DeleteGiftCertificate UpdateProduct DeleteManufacturer UpdateWarehouse DeleteOrderStatus DeletePriceLevel DeleteProduct DeleteWarehouse GetUserKey GetUserToken PerformMultiple ReadAttribute ReadCategory ReadCustomer ReadGiftCertificate ReadManufacturer ReadOrder ReadOrderStatus 7 of 29

8 ReadPriceLevel Call Arguments and Filters Each API call contains its own supported parameters that can be used to organize the data being requested. Page Size Your API calls can be currently filtered using the following parameters; Example: DetailSize This argument will filter the information coming from the API and is restriced to Small, Medium, Large, and Custom. Check the specific API call below to see which data filters to which detail size. Page This argument identifies which page of data will be reported. This is modified by the Size argument. Size This argument modifies the page argument by expressing how many items will be called per page. If you wanted to retrieve the data from products 251 to 300, you might have an argument such as: <PageRequest> <Page>2</Page> <Size>250</Size> </PageRequest> Would return the second page of products, putting 250 products per page. Versioning The Public API supports versioning since version 7.7. This means that any breaking changes added will only be available for the new version being released. The following set of rules was applied to this new feature: If no version is provided, we will consider the request as targeted to the latest version. If a version is provided and: o Is lower than the minimum version we currently support (7.7), then we will default it to this minimum version. o Is higher than the current version, we will default to the latest version. Echoing: We echo the exact same version that was sent in the request as long as it is higher than the minimum we support (7.7), otherwise we don't echo any version in the response. We only support 2 digits versioning: x.y The following example shows how to make a call against the 7.8 API version: <ReadCategoryRequest xmlns="urn:networksolutions:apis"> <RequestId>ReadCategoryDetail</RequestId> <DetailSize>Large</DetailSize> <FilterList> <Field>CategoryId</Field> <ValueList>87</ValueList> <Operator>Equal</Operator> </FilterList> <Version>7.8</Version> </ReadCategoryRequest> 8 of 29

9 Filters We support executing query-style read requests by using specific operators and available fields. This is an extremely powerful feature that provides you with great flexibility to obtain the exact data you are looking for. To achieve this, you will only need to add FilterList elements to your read request, each of which should contain the corresponding criteria (Field + Operator + ValueList) to be used for the search. Specifying multiple FilterList elements will result in a logical AND concatenation of criterias; there is currently no support for nested logical operations. List of supported operators: Between Equal GreaterEqual GreaterThan In IsNull LessEqual LessThan Like NotEqual A list of available filter fields for each ReadRequest can be found under the specific api call documentation below in this document. The following example shows how to retrieve all products that have a quantity in stock between 5 and 10, are enabled and belong to the Regular product class: <?xml version="1.0" encoding="utf-8"?> <ReadProductRequest xmlns:xsi=" xmlns="urn:networksolutions:apis"> <DetailSize>Small</DetailSize> <FilterList> <Field>QtyInStock</Field> <Operator>Between</Operator> <ValueList>5</ValueList> <ValueList>10</ValueList> </FilterList> <FilterList> <Field>Enabled</Field> <Operator>Equal</Operator> <ValueList>True</ValueList> </FilterList> <FilterList> <Field>ProductClass</Field> <Operator>Equal</Operator> <ValueList>Regular</ValueList> </FilterList> </ReadProductRequest> 9 of 29

10 API Call Example Shown below is an example of the syntax used to issue a call and the type of data retrieved. Example for Individual Detail Request <ReadCategoryRequest xmlns="urn:networksolutions:apis"> <RequestId>ReadCategoryDetail</RequestId> <DetailSize>Large</DetailSize> <FilterList> <Field>CategoryId</Field> <ValueList>87</ValueList> <Operator>Equal</Operator> </FilterList> </ReadCategoryRequest> Response <ReadCategoryResponse xmlns="urn:networksolutions:apis"> <RequestId>ReadCategoryDetail</RequestId> <Status>Success</Status> <TimeStamp> T15:04: Z</TimeStamp> <PageResponse> <Page>1</Page> <Size>100</Size> <TotalSize>1</TotalSize> <HasMore>false</HasMore> </PageResponse> <CategoryList CategoryId="87"> <Name>Tees Short Sleeve</Name> <Description>Special short sleeve t- shirt.</description> <FullDescription><strong><span style="color: #1e90ff">Full Description</span></strong></FullDescription> <Enabled>true</Enabled> <SortOrder>0</SortOrder> <PageUrl>~/teesshortsleeve.aspx</PageUrl> <Depth>2</Depth> <Parent CategoryId="85"> <Name>Apparel </Name> <Enabled>false</Enabled> </Parent> <Image> <Path>/themes/default/images/Sunset.jpg</Path> <AlternateText>Sunset</AlternateText> </Image> <SearchInformation> <Title>Short Sleeve T-Shirt</Title> <Keyword>Tee, Shirt, Blue</Keyword> <Description>This is the metadescriptions</description> </SearchInformation> </CategoryList> </ReadCategoryResponse> 10 of 29

11 Category Management ReadCategoryRequest Arguments Argument Type Required Meaning CategoryId Long Conditional Auto assigned value that uniquely identifies the category. Name String Conditional Specifies the name of the category. Must be unique within a particular branch in the category tree. Max length: 100 (characters). Description String Optional Describes the Category. Max length: 100 (characters). FullDescription String Optional Full description rendered in the category details page. Enabled String Optional Determines if the Category is visible on the site. Default value: True Depth Integer Optional Readonly value indicating at which level the category is at. Top level categories will have a depth of 1. Valid Range: 1 to 5 SortOrder String Optional Determines the order in which Categories are displayed. Valid Range: PageUrl String Optional The page to the storefront to which you can redirect to display the category details page. (REQUIRES MUCH MORE EPLANATION) You can supply this value in CreateCategory or UpdateCategory and invalid characters are removed. The corrected value is echoed in the response. Max length: 75 (characters) Parent CategoryType Optional container Parent.CategoryId Long Optional Specifies the parent category. Parent.Name String Optional Read only name of the parent category. SearchInformation SearchInformat Optional iontype container SearchInformation.Title String Optional Specifies the Meta Title html for the category detail page. Max length: 250 (characters). 11 of 29

12 Argument Type Required Meaning SearchInformation.Keyword String Optional Specifies the Meta Keyword html for the category detail page. Max length: 3000 (characters). SearchInformation.Description String Optional Specifies the Meta description html for the category detail page. Image ImageType container Optional Max length: 500 (characters). The Category image logo to display. Image.Path String Optional Path to the image. Max length: 255 (characters). Image.AlternativeText String Optional Alternative Text to display. Max length: 255 (characters). ReadCategory Response The default sort for categories is Depth followed by SortOrder and Name. The following table shows returned values at each detail level. Argument Small Medium Large Filter Name Enabled Depth SortOrder PageUrl Description If specified If specified FullDescription If specified If specified If specified Parent.Name Parent.Enabled Image.Path Image.AlternateText SearchInformation.Title If specified If specified If specified If specified SearchInformation.Keyword If specified SearchInformation.Description If specified 12 of 29

13 ReadCategory Filters Filter Description Values Name Category name String Enabled Whether it is enabled or not Boolean SortOrder The sort order number specified Integer Depth Hierarchy depth number Integer - Between 1 and 5 CategoryId Category Id Long Parent.CategoryId Category Id of parent category Long 13 of 29

14 Customer Management Customers are shoppers who register on the storefront and have login credentials to track their orders. ReadCustomer Arguments Argument Type Required String (Guid format) Conditional Auto assigned value that uniquely identifies the customer. Address String Conditional Specifies the address of the Customer. Must be unique. Max length: 255 (characters) and must be valid address format. Password String Optional Password for the customer to log into the storefront. This is not returned by ReadCustomer. Min length: 6 (characters). Max length: 50 (characters). NonTaxable Boolean Optional Specifies that the customer is not taxed for any purchases they make. Default value: false TaxIdentification String Optional Tax number or tax code for the customer. BillingAddress AddressType Container Conditional Max length: 100 (characters). Container for the billing information for the customer. Required in CreateCustomer BillingAddress.FirstName String Conditional First name of the customer. Max length: 50 (characters) BillingAddress.LastName String Conditional Last name of the customer. Max length: 50 (characters) BillingAddress.Company String Optional Company associated with the customer. Max length: 250 (characters) BillingAddress.Address1 String Conditional Street address for the customer. Max length: 100 (characters). BillingAddress.Address2 String Optional Street address line 2 for the customer. Max length: 100 (characters). BillingAddress.City String Conditional City for the customer. Max length: 100 (characters). BillingAddress.StateProvince String Conditional State or province for the customer. If country is US (United States) or CA (Canada) then StateProvince is required and must be specified as two digit abbrievation of State or province. For all other countries StateProvince field is optional and free form text field. Max length: 50 (characters). BillingAddress.PostalCode String Conditional Postal code for the customer. Max length: 40 (characters). 14 of 29

15 Argument Type Required Meaning BillingAddress.Country CountryCodeType Conditional Country for the customer. BillingAddress.Phone String Optional Phone number for the customer. Max length: 3000 (characters). ShippingAddress AddressType Container Optional All rules of BillingAddress nodes above apply. If not specified in CreateCustomer the BillingAddress specified is assumed to be the ShippingAddress. All ShippingAddress.Fields See BillingAddress Field above for usage. ReadCustomer The following table shows returned values at each detail level. Argument Small Medium Large Filter Address Password NonTaxable TaxIdentification If specified If specified BillingAddress.FirstName BillingAddress.LastName BillingAddress.Company BillingAddress.Address1 BillingAddress.Address2 If specified If specified BillingAddress.City BillingAddress.StateProvince If specified If specified BillingAddress.PostalCode BillingAddress.Country BillingAddress.Phone If specified If specified ShippingAddress.FirstName ShippingAddress.LastName ShippingAddress.Company ShippingAddress.Address1 ShippingAddress.Address2 ShippingAddress.City ShippingAddress.StateProvince ShippingAddress.PostalCode If specified If specified 15 of 29

16 ShippingAddress.Country ShippingAddress.Phone If specified ReadCustomer Filters Filter Description Values Address Customer address String CustomerId Customer Id Long CreateDate Customer creation date Date CustomerNumber Existing customer's number String BillingAddress.FirstName Customer BillingAddress.FirstName String BillingAddress.LastName Customer BillingAddress.LastName String BillingAddress.City Customer BillingAddress.City String BillingAddress.StateProvince Customer BillingAddress.StateProvince String BillingAddress.PostalCode Customer BillingAddress.PostalCode String BillingAddress.Country Customer BillingAddress.Country Two characters country code (eg: US, CA, JP) ShippingAddress.FirstName Customer ShippingAddress.FirstName String ShippingAddress.LastName Customer ShippingAddress.LastName String ShippingAddress.City Customer ShippingAddress.City String ShippingAddress.StateProvince Customer ShippingAddress.StateProvince String ShippingAddress.PostalCode Customer ShippingAddress.PostalCode String ShippingAddress.Country Customer ShippingAddress.Country Two characters country code (eg: US, CA, JP) Network Solutions, All Rights Reserved 16 of 29

17 Manufacturer Management You can get a list of your product s manufacturers to display on your sites product pages. You can associate these manufacturers with your products on the Advanced tab in the Products section. Manufacturer Arguments Argument Type Required Long Conditional Auto assigned value which uniquely identifies the manufacturer. Name String Conditional Specifies the name of the manufacturer. Must be unique across all manufacturers. Max length: 150 (characters). Description String Optional Describes the manufacturer. SortOrder Integer Optional Determines the order of sorting on the storefront. Dependent on Setting value MFGSORTTYPE. Image ImageType Container Optional Default Value: 0 The manufacturer image logo to display. Image.Path Boolean Optional Path to the image. Combine value with setting of url. Default Value: False Image.AlternativeText Boolean Optional Determines if the contains product information. Set this to false if you do not wish for you Manufacturer to know the product information. Default Value: False 17 of 29

18 ReadManufacturer Following table shows returned value at each detail level. Argument Small Medium Large Filter Name Description If specified If specified SortOrder ImagePath If specified If specified ImageAlternateText If specified If specified ReadManufacturer Filters Filter Description Values Name Manufacturer name String SortOrder SortOrder Integer ManufacturerId ManufacturerId Long 18 of 29

19 Order Management The Public API has the ability to receive and update order information. Currently, this is limited to ReadOrder Arguments Argument Type Required Meaning OrderList OrderID String Conditional Auto assigned value that uniquely identifies the order CreateDate String Conditional Date that the order was String (Guid format) Conditional Auto assigned value that uniquely identifies the customer. Address String Conditional Specifies the address of the Customer. Must be unique. Max length: 255 (characters) and must be valid address format. Password String Optional Password for the customer to log into the storefront. This is not returned by ReadCustomer. Min length: 6 (characters). Max length: 50 (characters). NonTaxable Boolean Optional Specifies that the customer is not taxed for any purchases they make. Default value: false TaxIdentification String Optional Tax number or tax code for the customer. BillingAddress AddressType Container Conditional Max length: 100 (characters). Container for the billing information for the customer. Required in CreateCustomer BillingAddress.FirstName String Conditional First name of the customer. Max length: 50 (characters) BillingAddress.LastName String Conditional Last name of the customer. Max length: 50 (characters) BillingAddress.Company String Optional Company associated with the customer. Max length: 250 (characters) BillingAddress.Address1 String Conditional Street address for the customer. Max length: 100 (characters). BillingAddress.Address2 String Optional Street address line 2 for the customer. Max length: 100 (characters). BillingAddress.City String Conditional City for the customer. Max length: 100 (characters). BillingAddress.StateProvince String Conditional State or province for the customer. If country is US (United States) or CA (Canada) then StateProvince is required and must be specified as two digit abbrievation of State or province. For all other countries StateProvince field is optional and free form text field. Max length: 50 (characters). 19 of 29

20 Argument Type Required Meaning BillingAddress.PostalCode String Conditional Postal code for the customer. Max length: 40 (characters). BillingAddress.Country CountryCodeType Conditional Country for the customer. BillingAddress.Phone String Optional Phone number for the customer. ShippingAddress AddressType Container Optional Max length: 3000 (characters). All rules of BillingAddress nodes above apply. If not specified in CreateCustomer the BillingAddress specified is assumed to be the ShippingAddress. All ShippingAddress.Fields See BillingAddress Field above for usage. Subtotal Currency String Conditional The type of currency and subtotal of the order. Total Currency String Conditional The type of currency and total of the order. CombineHandling Boolean Conditional Specifies whether the products will be handled together. Weight String Conditional Specifies the weight of the product. FreeShipping Boolean Conditional Determines whether this order has free shipping. Name String Conditional The Name of the product. NonTaxable Boolean Optional Specifies that the customer is not taxed for any purchases they make. Default value: false ProductID String Conditional Auto assigned value that uniquely identifies the product. ProductClass String Conditional Determines the class of the product. QtySold String Conditional Specifies the number of the product in the order. UnitPrice Currency String Conditional The type of currency and unit price of the product. PaymentMethod String Conditional Specifies the payment method for the order. Shipping String Conditional Specifies the name and carrier shipping the product. Status OrderStatusID String Conditional Auto assigned value that uniquely identifies the order status. Questionlist String Conditional Specifies the personalization questions used in the order. 20 of 29

21 ReadOrder Following table shows returned value at each detail level. Argument Small Medium Large Filter Field OrderList OrderID CreateDate Address Password NonTaxable TaxIdentification BillingAddress.FirstName BillingAddress.LastName BillingAddress.Company BillingAddress.Address1 BillingAddress.Address2 If Specified If Specified BillingAddress.City BillingAddress.StateProvince BillingAddress.PostalCode BillingAddress.Country BillingAddress.Phone ShippingAddress All ShippingAddress.Fields See BillingAddress Field above for usage. If Specified If Specified If Specified If Specified Subtotal Currency Total Currency CombineHandling Weight FreeShipping Name NonTaxable ProductID ProductClass 21 of 29

22 QtySold UnitPrice Currency PaymentMethod Shipping Status OrderStatusID Questionlist ReadOrder Filters Filter Description Values OrderId OrderId Long OrderNumber OrderNumber Long Customer. Address Order Customer. Address String Archived Archived Boolean Status.OrderStatusId Status.OrderStatusId Long CreateDate CreateDate Date BillingAddress.FirstName Order BillingAddress.FirstName String BillingAddress.LastName Order BillingAddress.LastName String BillingAddress.City Order BillingAddress.City String ShippingAddress.FirstName Order ShippingAddress.FirstName String ShippingAddress.LastName Order ShippingAddress.LastName String ShippingAddress.City Order ShippingAddress.City String LineItemList.ProductId Order LineItemList.ProductId Long LineItemList.Name Order LineItemList.Name String UpdateOrder Arguments Argument Type Required Meaning OrderList OrderID String Conditional Auto assigned value that uniquely identifies the order Status OrderStatusID String Conditional Auto assigned value that uniquely identifies the order status. Tracking # String Optional Specifies the tracking number used to update the order. AdminNotes String Optional Specifies new Admin Notes to be added to the order. Notes String Optional Specifies new Notes to be added to the order. SalesRep String Optional Species a Sales Rep to be added to the order. 22 of 29

23 Order Status Management The Public API can gather the status of orders from the database. ReadOrderStatus Arguments Argument Type Required Meaning OrderStatusID String Conditional Auto assigned value that uniquely identifies the order status Name String Conditional The status name. Customer Boolean Conditional Specifies whether this order status triggers an to the customer. Administrator Boolean Conditional Specifies whether this order status triggers an to the administrator. NextStatusList OrderStatusID String Conditional Auto assigned value that uniquely identifies the possible statuses the order can be assigned. ReadOrderStatus Argument Small Medium Large Filter Field OrderStatusID Name Customer Administrator NextStatusList OrderStatusID Read OrderStatus Filters Filter Description Values OrderStatusId OrderStatusId Long Parent.OrderStatusId OrderStatus Parent.OrderStatusId Long Name OrderStatus Name String 23 of 29

24 Product Management The Public API can receive information about a client s products and also update the inventory. ReadProduct Arguments Argument Type Required Meaning ProductList ProductID String Conditional Auto assigned value that uniquely identifies the product. CategorySpecial Boolean Conditional Specifies whether or not this product is a special product for it s category. Description String Conditional The short description for the product. Enabled Boolean Conditional Specifies whether this product is enabled on the storefront. FreeShipping Boolean Conditional Specifies whether this product has free shipping enabled. FullDescription String Optional The full description for the product. HomePageSpecial Boolean Optional Specifies whether the product a home page special. ManufacturerPartNumber String Optional Specifies the Manufacturer Part Number used for the product. Name String Conditional The name of the product. NonTaxable Boolean Optional Specifies that the customer is not taxed for any purchases they make. Default value: false PageUrl String Optional Specifies the page url for the product. PreventPurchase Boolean Optional Specifies whether the product is prevented from being purchased by customers. ProductClass String Optional Specifies the class of the product. SortOrder String Optional Specifies the particular sort order number for the product. Price String Conditional Specifies the currency type and price of the product. Weight String Conditional Specifies the weight of the product. CategoryList CategoryID String Conditional Specifies the Category ID for the product. VariationList VariationGroupID String Optional Auto assigned value that uniquely identifies the variation group for the product. OptionList VariationOptionID String Optional Specifies the Variation Option ID for the individual variation options for the specific variation group. Enabled String Optional Specifies whether the specific variation option is enabled. ThumbnailURL String Optional Specifies the Url for the thumbnail image of the product. DisplayURL String Optional Specifies the Url for the display image of the product. DetailURL String Optional Specifies the Url for the detail image of the product. 24 of 29

25 ReadProduct Argument Small Medium Large Filter Field ProductList ProductID CategorySpecial Description Enabled FreeShipping FullDescription HomePageSpecial ManufacturerPartNumber Name NonTaxable PageUrl PreventPurchase ProductClass SortOrder Price Weight CategoryList CategoryID VariationList VariationGroupID OptionList VariationOptionID Enabled ThumbnailURL DisplayURL DetailURL 25 of 29

26 ReadProduct Filters Filter Description Values Parent.ProductId Product Parent.ProductId Long Parent.Category.CategoryId Product Parent.Category.CategoryId Long Parent.CategoryList.CategoryId Product Parent.CategoryList.CategoryId Long ParentList.Category.CategoryId Product ParentList.Category.CategoryId Long ParentList.CategoryList.CategoryId Product ParentList.CategoryList.CategoryId Long ProductId ProductId Long Enabled Whether it is enabled or not Boolean Name Product Name String SortOrder SortOrder Integer ParentProduct Product's parent entity ProductType ProductClass ProductClass Regular, GiftCertificate, Electronic, Custom QtyInStock QtyInStock Integer PartNumber PartNumber String Manufacturer.ManufacturerId Product Manufacturer.ManufacturerId Long Warehouse.WarehouseId Product Warehouse.WarehouseId Long Category.CategoryId Product Category.CategoryId Long CategoryList.CategoryId Product CategoryList.CategoryId Long UpdateInventory You have a choice of either Updating the inventory, or adding to the inventory. The update button will replace your current inventory in the storefront while the Add to inventory will add the amount you wish to your current inventory. The Public API accepts negative numbers. Argument Type Required Meaning ProductID String Conditional Auto assigned value that uniquely identifies the product. QtyInStock String Conditional Specifies the quantity of product in stock. Adjustment Boolean Conditional Determines whether you are adding the QtyInStock to the current number of product. 26 of 29

27 Site Information Management The Site Information API call will return the basic information used to describe how the client s site is setup. ReadSiteSetting Arguments Argument Type Required Meaning CompanyName String Conditional The name of the site. Enabled Boolean Conditional Whether the site is enabled. StoreUrl String Conditional Specifies the Url for the store. StoreSecureUrl String Conditional Specifies the Secure Url for the store. Software String Conditional Specifies whether the site uses the Standard or Professional E-Commerce package. SoftwareVersion String Conditional Specifies the version of the current E-Commerce package being used by the site. 27 of 29

28 Warehouse Management Warehouses are used to send s and notifications for products you are drop-shipping. A store is limited to 25 warehouses. ReadWarehouse Argument Type Required Long Conditional is an automatically assigned value and uniquely identifies the warehouse. Name String Conditional Specifies the name of the Warehouse. Must be unique across all warehouses. Max length: 100 (characters). Address String Optional Specifies the address of the warehouse to which an containing order information is sent when an order is placed. Max length: 255 (characters) and must be valid format. Header String Optional The custom header in the . Max length: 255 (characters) and must be valid format. Pricing Boolean Optional Determines if the contains pricing information about the products. Set this to false if you do not wish for you warehouse to know the price the product sold for. Default Value: False Products Boolean Optional Determines if the contains product information. Set this to false if you do not wish for you warehouse to know the product information. Default Value: False Shipping Boolean Optional Determines if the contains the customer s shipping address. Set this to false if you do not wish for you warehouse to know the customer s address. Default Value: False Enabled Boolean Optional Determines if an will be sent to the warehouse. Default Value: False Notes String Optional Administrator only notes about the warehouse. Max length: 2000 (characters) 28 of 29

29 ReadWarehouse Following table shows returned value at each detail level. Argument Small Medium Large Filter Name Address If specified If specified If specified Header If specified If specified Pricing Products Shipping Enabled Notes If specified ReadWarehouse Filters Filter Description Values Address Warehouse Address String Enabled Whether it is enabled or not Boolean Name Warehouse name String WarehouseId WarehouseId Long 29 of 29