GET api/v1/store/{storeID}/product?verbose={verbose}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
storeID | string |
Required |
|
verbose | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of ProductResponseName | Description | Type | Additional information |
---|---|---|---|
APIKey | string |
None. |
|
StoreID | string |
None. |
|
Updated | date |
None. |
|
_meta | ResponseMeta |
None. |
|
ID | string |
None. |
|
DefaultQty | integer |
None. |
|
MinimumQty | integer |
None. |
|
MaximumQty | integer |
None. |
|
IncrementQty | integer |
None. |
|
Name | string |
None. |
|
Description | string |
None. |
|
ImageURL | string |
None. |
|
Files | Collection of ResponseProductFile |
None. |
|
HasTemplate | boolean |
None. |
|
DeliveryMethod | string |
None. |
|
TemplateFields | Collection of ResponseFPTemplate |
None. |
|
DeliveredPrices | Collection of DeliveredPrice |
None. |
|
ProductionSpeeds | Collection of ProductionSpeed |
None. |
|
ProductFormat | string |
None. |
|
Inventory | Inventory |
None. |
|
CustomValues | Collection of Pair of string [key] and string [value] |
None. |
|
_Internal | Collection of Pair of string [key] and string [value] |
None. |
Response Formats
application/json, text/json
Sample:
[ { "APIKey": "sample string 2", "StoreID": "sample string 2", "Updated": "2024-11-02T14:41:52.2903637+00:00", "_meta": { "Messages": [ "sample string 1", "sample string 2" ], "ChangeType": "Created" }, "ID": "sample string 4", "DefaultQty": 5, "MinimumQty": 6, "MaximumQty": 1, "IncrementQty": 7, "Name": "sample string 8", "Description": "sample string 9", "ImageURL": "sample string 10", "Files": [ { "Url": "sample string 1", "Format": "sample string 2", "Type": "sample string 3" }, { "Url": "sample string 1", "Format": "sample string 2", "Type": "sample string 3" } ], "HasTemplate": true, "DeliveryMethod": "sample string 12", "TemplateFields": [ { "Required": true, "Type": "sample string 2", "SubType": "sample string 3", "FieldName": "sample string 4", "Prompt": "sample string 5", "DefaultValue": "sample string 6", "OrgValue": "sample string 7" }, { "Required": true, "Type": "sample string 2", "SubType": "sample string 3", "FieldName": "sample string 4", "Prompt": "sample string 5", "DefaultValue": "sample string 6", "OrgValue": "sample string 7" } ], "DeliveredPrices": [ { "DeliveryMethodCode": "sample string 1", "Description": "sample string 2", "Price": 1.1, "Country": "sample string 3", "CountryCode": "sample string 4", "Created": "2024-11-02T14:41:52.2903637+00:00", "LocationType": "sample string 6", "IsDefault": true }, { "DeliveryMethodCode": "sample string 1", "Description": "sample string 2", "Price": 1.1, "Country": "sample string 3", "CountryCode": "sample string 4", "Created": "2024-11-02T14:41:52.2903637+00:00", "LocationType": "sample string 6", "IsDefault": true } ], "ProductionSpeeds": [ { "Days": 1, "IsDefault": true }, { "Days": 1, "IsDefault": true } ], "ProductFormat": "sample string 13", "Inventory": { "QuantityOnHand": 1, "QuantityTarget": 1, "QuantityRedLine": 1 }, "CustomValues": [ { "Key": "sample string 1", "Value": "sample string 2" }, { "Key": "sample string 1", "Value": "sample string 2" } ], "_Internal": [ { "Key": "sample string 1", "Value": "sample string 2" }, { "Key": "sample string 1", "Value": "sample string 2" } ] }, { "APIKey": "sample string 2", "StoreID": "sample string 2", "Updated": "2024-11-02T14:41:52.2903637+00:00", "_meta": { "Messages": [ "sample string 1", "sample string 2" ], "ChangeType": "Created" }, "ID": "sample string 4", "DefaultQty": 5, "MinimumQty": 6, "MaximumQty": 1, "IncrementQty": 7, "Name": "sample string 8", "Description": "sample string 9", "ImageURL": "sample string 10", "Files": [ { "Url": "sample string 1", "Format": "sample string 2", "Type": "sample string 3" }, { "Url": "sample string 1", "Format": "sample string 2", "Type": "sample string 3" } ], "HasTemplate": true, "DeliveryMethod": "sample string 12", "TemplateFields": [ { "Required": true, "Type": "sample string 2", "SubType": "sample string 3", "FieldName": "sample string 4", "Prompt": "sample string 5", "DefaultValue": "sample string 6", "OrgValue": "sample string 7" }, { "Required": true, "Type": "sample string 2", "SubType": "sample string 3", "FieldName": "sample string 4", "Prompt": "sample string 5", "DefaultValue": "sample string 6", "OrgValue": "sample string 7" } ], "DeliveredPrices": [ { "DeliveryMethodCode": "sample string 1", "Description": "sample string 2", "Price": 1.1, "Country": "sample string 3", "CountryCode": "sample string 4", "Created": "2024-11-02T14:41:52.2903637+00:00", "LocationType": "sample string 6", "IsDefault": true }, { "DeliveryMethodCode": "sample string 1", "Description": "sample string 2", "Price": 1.1, "Country": "sample string 3", "CountryCode": "sample string 4", "Created": "2024-11-02T14:41:52.2903637+00:00", "LocationType": "sample string 6", "IsDefault": true } ], "ProductionSpeeds": [ { "Days": 1, "IsDefault": true }, { "Days": 1, "IsDefault": true } ], "ProductFormat": "sample string 13", "Inventory": { "QuantityOnHand": 1, "QuantityTarget": 1, "QuantityRedLine": 1 }, "CustomValues": [ { "Key": "sample string 1", "Value": "sample string 2" }, { "Key": "sample string 1", "Value": "sample string 2" } ], "_Internal": [ { "Key": "sample string 1", "Value": "sample string 2" }, { "Key": "sample string 1", "Value": "sample string 2" } ] } ]
application/xml, text/xml
Sample:
<ArrayOfProductResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.GenericAPI.Response"> <ProductResponse> <APIKey xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">sample string 2</APIKey> <CustomValues xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI"> <d3p1:KeyValuePairOfstringstring> <d3p1:key>sample string 1</d3p1:key> <d3p1:value>sample string 2</d3p1:value> </d3p1:KeyValuePairOfstringstring> <d3p1:KeyValuePairOfstringstring> <d3p1:key>sample string 1</d3p1:key> <d3p1:value>sample string 2</d3p1:value> </d3p1:KeyValuePairOfstringstring> </CustomValues> <DefaultQty xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">5</DefaultQty> <DeliveredPrices xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI"> <DeliveredPrice> <Country>sample string 3</Country> <CountryCode>sample string 4</CountryCode> <Created>2024-11-02T14:41:52.2903637+00:00</Created> <DeliveryMethodCode>sample string 1</DeliveryMethodCode> <Description>sample string 2</Description> <IsDefault>true</IsDefault> <LocationType>sample string 6</LocationType> <Price>1.1</Price> </DeliveredPrice> <DeliveredPrice> <Country>sample string 3</Country> <CountryCode>sample string 4</CountryCode> <Created>2024-11-02T14:41:52.2903637+00:00</Created> <DeliveryMethodCode>sample string 1</DeliveryMethodCode> <Description>sample string 2</Description> <IsDefault>true</IsDefault> <LocationType>sample string 6</LocationType> <Price>1.1</Price> </DeliveredPrice> </DeliveredPrices> <Description xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">sample string 9</Description> <Files xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI"> <ResponseProductFile> <Format>sample string 2</Format> <Type>sample string 3</Type> <Url>sample string 1</Url> </ResponseProductFile> <ResponseProductFile> <Format>sample string 2</Format> <Type>sample string 3</Type> <Url>sample string 1</Url> </ResponseProductFile> </Files> <HasTemplate xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">true</HasTemplate> <ID xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">sample string 4</ID> <ImageURL xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">sample string 10</ImageURL> <IncrementQty xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">7</IncrementQty> <InternalID xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">sample string 3</InternalID> <Inventory xmlns:d3p1="http://schemas.datacontract.org/2004/07/_PFL.BO.IRIS" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI"> <d3p1:QuantityOnHand>1</d3p1:QuantityOnHand> <d3p1:QuantityRedLine>1</d3p1:QuantityRedLine> <d3p1:QuantityTarget>1</d3p1:QuantityTarget> </Inventory> <LastUpdated xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">2024-11-02T14:41:52.2903637+00:00</LastUpdated> <MaximumQty xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">1</MaximumQty> <MinimumQty xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">6</MinimumQty> <Name xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">sample string 8</Name> <ProductFormat xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">sample string 13</ProductFormat> <ProductionSpeeds xmlns:d3p1="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI.Response" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI"> <d3p1:ProductionSpeed> <d3p1:Days>1</d3p1:Days> <d3p1:IsDefault>true</d3p1:IsDefault> </d3p1:ProductionSpeed> <d3p1:ProductionSpeed> <d3p1:Days>1</d3p1:Days> <d3p1:IsDefault>true</d3p1:IsDefault> </d3p1:ProductionSpeed> </ProductionSpeeds> <ShippingMethod xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">sample string 12</ShippingMethod> <TemplateFields xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI"> <ResponseFPTemplate> <DefaultValue>sample string 6</DefaultValue> <FieldName>sample string 4</FieldName> <OrgValue>sample string 7</OrgValue> <Prompt>sample string 5</Prompt> <Required>true</Required> <SubType>sample string 3</SubType> <Type>sample string 2</Type> </ResponseFPTemplate> <ResponseFPTemplate> <DefaultValue>sample string 6</DefaultValue> <FieldName>sample string 4</FieldName> <OrgValue>sample string 7</OrgValue> <Prompt>sample string 5</Prompt> <Required>true</Required> <SubType>sample string 3</SubType> <Type>sample string 2</Type> </ResponseFPTemplate> </TemplateFields> <_Internal xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI"> <d3p1:KeyValuePairOfstringstring> <d3p1:key>sample string 1</d3p1:key> <d3p1:value>sample string 2</d3p1:value> </d3p1:KeyValuePairOfstringstring> <d3p1:KeyValuePairOfstringstring> <d3p1:key>sample string 1</d3p1:key> <d3p1:value>sample string 2</d3p1:value> </d3p1:KeyValuePairOfstringstring> </_Internal> <StoreID>sample string 2</StoreID> <_meta> <ChangeType>Created</ChangeType> <Messages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Messages> </_meta> </ProductResponse> <ProductResponse> <APIKey xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">sample string 2</APIKey> <CustomValues xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI"> <d3p1:KeyValuePairOfstringstring> <d3p1:key>sample string 1</d3p1:key> <d3p1:value>sample string 2</d3p1:value> </d3p1:KeyValuePairOfstringstring> <d3p1:KeyValuePairOfstringstring> <d3p1:key>sample string 1</d3p1:key> <d3p1:value>sample string 2</d3p1:value> </d3p1:KeyValuePairOfstringstring> </CustomValues> <DefaultQty xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">5</DefaultQty> <DeliveredPrices xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI"> <DeliveredPrice> <Country>sample string 3</Country> <CountryCode>sample string 4</CountryCode> <Created>2024-11-02T14:41:52.2903637+00:00</Created> <DeliveryMethodCode>sample string 1</DeliveryMethodCode> <Description>sample string 2</Description> <IsDefault>true</IsDefault> <LocationType>sample string 6</LocationType> <Price>1.1</Price> </DeliveredPrice> <DeliveredPrice> <Country>sample string 3</Country> <CountryCode>sample string 4</CountryCode> <Created>2024-11-02T14:41:52.2903637+00:00</Created> <DeliveryMethodCode>sample string 1</DeliveryMethodCode> <Description>sample string 2</Description> <IsDefault>true</IsDefault> <LocationType>sample string 6</LocationType> <Price>1.1</Price> </DeliveredPrice> </DeliveredPrices> <Description xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">sample string 9</Description> <Files xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI"> <ResponseProductFile> <Format>sample string 2</Format> <Type>sample string 3</Type> <Url>sample string 1</Url> </ResponseProductFile> <ResponseProductFile> <Format>sample string 2</Format> <Type>sample string 3</Type> <Url>sample string 1</Url> </ResponseProductFile> </Files> <HasTemplate xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">true</HasTemplate> <ID xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">sample string 4</ID> <ImageURL xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">sample string 10</ImageURL> <IncrementQty xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">7</IncrementQty> <InternalID xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">sample string 3</InternalID> <Inventory xmlns:d3p1="http://schemas.datacontract.org/2004/07/_PFL.BO.IRIS" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI"> <d3p1:QuantityOnHand>1</d3p1:QuantityOnHand> <d3p1:QuantityRedLine>1</d3p1:QuantityRedLine> <d3p1:QuantityTarget>1</d3p1:QuantityTarget> </Inventory> <LastUpdated xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">2024-11-02T14:41:52.2903637+00:00</LastUpdated> <MaximumQty xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">1</MaximumQty> <MinimumQty xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">6</MinimumQty> <Name xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">sample string 8</Name> <ProductFormat xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">sample string 13</ProductFormat> <ProductionSpeeds xmlns:d3p1="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI.Response" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI"> <d3p1:ProductionSpeed> <d3p1:Days>1</d3p1:Days> <d3p1:IsDefault>true</d3p1:IsDefault> </d3p1:ProductionSpeed> <d3p1:ProductionSpeed> <d3p1:Days>1</d3p1:Days> <d3p1:IsDefault>true</d3p1:IsDefault> </d3p1:ProductionSpeed> </ProductionSpeeds> <ShippingMethod xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI">sample string 12</ShippingMethod> <TemplateFields xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI"> <ResponseFPTemplate> <DefaultValue>sample string 6</DefaultValue> <FieldName>sample string 4</FieldName> <OrgValue>sample string 7</OrgValue> <Prompt>sample string 5</Prompt> <Required>true</Required> <SubType>sample string 3</SubType> <Type>sample string 2</Type> </ResponseFPTemplate> <ResponseFPTemplate> <DefaultValue>sample string 6</DefaultValue> <FieldName>sample string 4</FieldName> <OrgValue>sample string 7</OrgValue> <Prompt>sample string 5</Prompt> <Required>true</Required> <SubType>sample string 3</SubType> <Type>sample string 2</Type> </ResponseFPTemplate> </TemplateFields> <_Internal xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic" xmlns="http://schemas.datacontract.org/2004/07/PFL.PFLLink.BO.PFLAPI"> <d3p1:KeyValuePairOfstringstring> <d3p1:key>sample string 1</d3p1:key> <d3p1:value>sample string 2</d3p1:value> </d3p1:KeyValuePairOfstringstring> <d3p1:KeyValuePairOfstringstring> <d3p1:key>sample string 1</d3p1:key> <d3p1:value>sample string 2</d3p1:value> </d3p1:KeyValuePairOfstringstring> </_Internal> <StoreID>sample string 2</StoreID> <_meta> <ChangeType>Created</ChangeType> <Messages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Messages> </_meta> </ProductResponse> </ArrayOfProductResponse>
multipart/form-data
Sample:
image/png
Sample:
image/jpg
Sample:
image/jpeg
Sample:
image/bmp
Sample: