Gunweb's preferred API setup from supplier Restful API
Authentication
Basic Authentication:
Authorization: Basic BASE64_ENCODED(username:password)
Products - Individual
Returns a list of all products.
Parameters
| Parameter | Description | Parameter Type | Data Type | Required |
|---|---|---|---|---|
| productCode | The code of the product to retrieve | query | string | yes |
| format | Format of the response (json or xml) | path | string | yes |
Response Format
{
"status":0,
"country":"string",
"data":{
"code":0,
"name":"string",
"features":[
"string"
],
"description":"string",
"additional_specifications":[
{
"specification":"string",
"description":"string"
}
],
"additional_materials":[
{
"component":"string",
"material":"string"
}
],
"active":"string",
"status":"string",
"last_updated":"string",
"categories":[
{
"name":"string",
"num":"string"
}
],
"colours":"string",
"dimensions":[
"string"
],
"sizing":[
{
"sizing_line":"string"
}
],
"branding_options":[
{
"print_type":"string",
"print_description":"string"
}
],
"packaging":"string",
"carton":{
"length":0,
"width":0,
"height":0,
"weight":"string",
"quantity":0
},
"full_colour":0,
"mix_and_match":0,
"image_count":0,
"images":[
{
"link":"string",
"name":"string",
"stock_code":0,
"colour":"string",
"caption":"string"
}
],
"images_updated":"string",
"product_wire":"string",
"product_wire_last_updated":"string",
"stock":[
{
"stock_code":0,
"description":"string",
"quantity":0,
"next_shipment":0,
"due_date":"string"
}
],
"pricing":[
{
"type":"string",
"primary_price_description":"string",
"less_than_moq":"string",
"prices":[
{
"quantity":0,
"price":0
}
],
"additional_costs":[
{
"id":0,
"type":"string",
"description":"string",
"branding_option":"string",
"branding_area":"string",
"description":"string",
"unit_price":0,
"price_per_unit_charge_code":0,
"setup_price":0,
"price_per_order_charge_code":0
}
],
"pricing_comment":"string"
}
]
}
}
Field Descriptions
Code: 6 digit product code
Name: Product Name
Features: Key selling points about an item
Description: Product Description
Additional Specifications: Product specifications
Additional Materials: Product materials for all main components of the item
Categories: A list of category codes which apply to the product
Colours: Colours in which the product is available
Dimensions: A list of product and packaging dimensions
Active: Is this item currently active and available for sale
Status: New, Normal or Discontinued
Last Updated: When was an update to the product data/images for this item last updated
Sizing: For Apparel items: each sizing line represents a row in a table
Branding
Branding Options – Print Type: The name of the branding process
Branding Options – Print Description: Print area for the listed branding process
Packaging: Estimate carton measurements and quantities for finished product
Full Colour: Is full colour available 1: Yes 0: No
Mix and Match: Is the item a mix and match item 1: Yes 0: No
Image Count: Number of images available for this item
Images
Images - Link: a link to the image from hosted site
Images - Name: The file name of the image available in the download file on the toolbox menu of the Website
Images - Stock Code: internal 6 digit stock code
Images - Colour: Colour of the product
Images - Caption: Title of the image
Images Updated: Timestamp of the last time that the items' images were updated
Product Wire: A link to the artwork wire
Product Wire Last Updated: Timestamp of the last time that the product wire pdf was updated
Stock
Stock - Code: internal 6 digit stock code
Stock - Description: Description of the stocked component
Stock - Quantity: Quantity available
Stock - Next Shipment: The quantity of future shipment less any stock already allocated
Stock - Due Date: Approximate arrival date of the next shipment
Pricing
Pricing Type: A description of the delivery method that applies to listed pricing e.g. Stock, Indent - Sea, Indent – Air
Primary Price Description: A description of what is included in the primary
Less than MOQ: Is less than minimum order quantity available on this pricing option: Y: Yes N: No
Pricing – Quantity: Quantity Break
Pricing – Price: Price Break
Additional Costs
Additional Cost - ID: Unique identifier for the additional cost entity
Additional Cost - Type: Description of the cost type e.g. Decoration Option, Additional Extra, Branding Option on an Additional Extra
Additional Cost - Branding Option: Branding method
Additional Cost - Branding Area: Branding area measurement
Additional Cost - Description: A description of the additional cost
Additional Cost - Unit Price: The per unit price of the listed additional cost
Additional Cost - Price Per Unit Charge Code: List of internal 6 digit stock code
Additional Cost - Setup: The per order setup price of the listed additional cost
Additional Cost - Price Per Order Charge Code: internal 6 digit stock code
Pricing Comment: Additional information regarding the pricing
Products - List
Parameters
| Parameter | Description | Parameter Type | Data Type | Required |
|---|---|---|---|---|
| format | Format of the response (json or xml) | path | string | yes |
| category_no | Category number to get products for | query | string | |
| page_size | Number of products per page, default is 100 | query | string | |
| page_no | Page number to get, default is 1 | query | string | |
| inc_discontinued | Should items flagged to be discontinued be included in results | query | boolean | |
| inc_inactive | Should items, flagged as no longer available, be included in search results (a value of 0 = no, 1 = yes) | query | string | |
| last_updated | Only includes products updated since a particular date/time. Date must be in ISO 8601 format. | query | string |
Response Format
{
"status":0,
"country":"string",
"page_count":0,
"page_current":0,
"page_size":0,
"total_items":0,
"data":{
"code":0,
"name":"string",
"features":[
"string"
],
"description":"string",
"additional_specifications":[
{
"specification":"string",
"description":"string"
}
],
"additional_materials":[
{
"component":"string",
"material":"string"
}
],
"active":"string",
"status":"string",
"last_updated":"string",
"categories":[
{
"name":"string",
"num":"string"
}
],
"colours":"string",
"dimensions":[
"string"
],
"sizing":[
{
"sizing_line":"string"
}
],
"branding_options":[
{
"print_type":"string",
"print_description":"string"
}
],
"packaging":"string",
"carton":{
"length":0,
"width":0,
"height":0,
"weight":"string",
"quantity":0
},
"full_colour":0,
"mix_and_match":0,
"image_count":0,
"images":[
{
"link":"string",
"name":"string",
"stock_code":0,
"colour":"string",
"caption":"string"
}
],
"images_updated":"string",
"product_wire":"string",
"product_wire_last_updated":"string",
"pricing":[
{
"type":"string",
"primary_price_description":"string",
"less_than_moq":"string",
"prices":[
{
"quantity":0,
"price":0
}
],
"additional_costs":[
{
"id":0,
"type":"string",
"description":"string",
"branding_option":"string",
"branding_area":"string",
"description":"string",
"unit_price":0,
"price_per_unit_charge_code":0,
"setup_price":0,
"price_per_order_charge_code":0
}
],
"pricing_comment":"string"
}
]
}
}
Field Descriptions
Code: 6 digit product code
Name: Product Name
Features: Key selling points about an item
Description: Product Description
Additional Specifications: Product specifications
Additional Materials: Product materials for all main components of the item
Categories: A list of category codes which apply to the product
Colours: Colours in which the product is available
Dimensions: A list of product and packaging dimensions
Active: Is this item currently active and available for sale
Status: New, Normal or Discontinued
Last Updated: When was an update to the product data/images for this item last updated
Sizing: For Apparel items: each sizing line represents a row in a table
Branding Options
Branding Options – Print Type: The name of the branding process
Branding Options – Print Description: Print area for the listed branding process
Packaging: Estimate carton measurements and quantities for finished product
Full Colour: Is full colour available 1: Yes 0: No
Mix and Match: Is the item a mix and match item 1: Yes 0: No
Image Count: Number of images available for this item
Images
Images - Link: a link to the image
Images - Name: The file name of the image available in the download file on the toolbox menu of the Website
Images - Stock Code: internal 6 digit stock code
Images - Colour: Colour of the product
Images - Caption: Title of the image
Images Updated: Timestamp of the last time that the items' images were updated
Product Wire: A link to the product wire
Product Wire Last Updated: Timestamp of the last time that the product wire pdf was updated
Pricing
Pricing Type: A description of the delivery method that applies to listed pricing e.g. Stock, Indent – Sea, Indent – Air
Primary Price Description: A description of what is included in the primary
Less than MOQ: Is less than minimum order quantity available on this pricing option: Y: Yes N: No
Pricing – Quantity: Quantity Break
Pricing – Price: Price Break
Additional Costs
Additional Cost - ID: Unique identifier for the additional cost entity
Additional Cost - Type: Description of the cost type e.g. Decoration Option, Additional Extra, Branding Option on an Additional Extra
Additional Cost - Branding Option: Branding method
Additional Cost - Branding Area: Branding area measurement
Additional Cost - Description: A description of the additional cost
Additional Cost - Unit Price: The per unit price of the listed additional cost
Additional Cost - Price Per Unit Charge Code: List of internal 6 digit stock code
Additional Cost - Setup: The per order setup price of the listed additional cost
Additional Cost - Price Per Order Charge Code: internal 6 digit stock code
Pricing Comment: Additional information regarding the pricing
Sample Individual GET Request and Response
Sample GET Request and Response Using the Trends API in the GunWebSystems Data Processing Site
GET Request header:
Response:
Comments
0 comments
Please sign in to leave a comment.