API Documentation
Webhook Documentation
API Documentation
Note 1: Please note that the Parent_UPC and Group_UPC fields have been phased out for product groupings and variants. Going forward, you must use the Variant_Group_ID field for matching product groupings and variants.
Note 2: Effective immediately new API call requirements: All SKUs have recently been discontinued. Going forward the TDID field will be the new product identifier used.
Reseller
Reseller API allows you to Retrieve Reseller data.
Subscription
Throttle: 600 calls every 60 seconds ( Leaky Bucket )
Query subscription type and status
Request Parameters
Response Parameters
Array of Products
curl --location --request POST 'https://topdawg.com/api/TDApi/Reseller/subscription' \ --header 'Authorization: Bearer INSERT_TOKEN_INSTEAD_IF_THIS_TAG \ --header 'Content-Type: application/json' \ --data-raw '[]'
[]
{
"subscription_list": [
{
"subscription": "Scale",
"active": "1",
"integration_id": 3334,
"platform": "shopify",
"store": "create-development-store.myshopify.com"
}
]
}
Reseller Orders
Reseller Orders API allows you to List, Retrieve and Create Orders, Update order Contents, Process and Cancel orders, Manage and Track order fulfilment.
Reseller Order View
Throttle: 600 calls every 60 seconds ( Leaky Bucket )
View reseller order by Order ID
Request Parameters
View order by ID.
Response Parameters
Order ID.
Order creation date
Order delivery date (null before delivery)
Gross cost of products
Shipping cost of products
Total cost of products
General status { 1 : Saved Order, 2 : Pending Order, 3 : Pending Action, 4 : In Transit, 5 : Delivered, 6 : Returned, 7 : Failed , 8 : Canceled, 9 : Declined }
A string of up to 256 characters that can be filled with any additional information you want to attach to the order. Recommended to use JSON format. JSON formatted field names: `id`, `order`, `source` : One both or all three fields will be depicted on orders UI for ease of cross identification.
JSON formatted checkout messages.
Array of Customer Properties
Array of Address Properties
Array of Transactions - In case this field is not populated, order will have no transactions (results in empty order). Empty orders are used in case of full api integration for interactive order population and processing.
Array of Parcels
curl --location --request POST 'https://topdawg.com/api/TDApi/ResellerOrder/view' \
--header 'Authorization: Bearer INSERT_TOKEN_INSTEAD_IF_THIS_TAG \
--header 'Content-Type: application/json' \
--data-raw '{
"order_id": "18453"
}'
{
"order_id": "18453"
}
{
"order_id": "18453",
"created_at": "2021-06-10",
"delivered_at": "2021-06-10",
"gross": "15.05",
"shipping": "3.02",
"total": "18.07",
"status": "1",
"metadata": "{\"id\":4456, \"order\":13334562,\"source\":\"shopify\"}",
"checkout_messages": "[{\"success\": true, \"msg\": \"Order was processed successfully.\", \"receipt_url\": \"https:\\\/\\\/pay.stripe.com\\\/receipts\\\/acct_1AAnM0BCuWWwhDtF\\\/ch_3KsNA2BCuWWwhDtF0VTa4LWQ\\\/rcpt_LZWClnxfFiTQPXrqqz3VW3iVW2wJKv6\", \"pm_data\": \"\", \"created_at\": \"2022-04-25 04:20:48\"}]",
"customer": {
"customer_id": "2884",
"first_name": "Leroy",
"last_name": "Jenkins",
"phone": "1 234 567 89 01"
},
"address_to": {
"address_id": "2442",
"address_1": "123 Main Street",
"address_2": "APT 111",
"city": "Edison",
"state_code": "NJ",
"country_code": "US",
"zip_code": "08818"
},
"transactions": [
{
"transaction_id": "24662",
"tdid": "S000487B001525P000444V002",
"product_code": "Macaron-no-window-1",
"price": "pet-supplies",
"quantity": "pet-supplies",
"gross": "15.05",
"packing_fee": "1.02",
"shipping": "3.02",
"total": "3.02",
"status": "1"
}
],
"parcels": [
{
"parcel": {
"id": "262",
"status": "PRE_TRANSIT",
"carrier": "USPS",
"tracking_number": "92612901755477000000000010"
},
"content": [
{
"tdid": "S000487B001525P000444V002",
"product_code": "Macaron-no-window-1",
"quantity": 3,
"status": "1"
}
]
}
]
}
Create
Throttle: 600 calls every 60 seconds ( Leaky Bucket )
Create Order. And optionally flag it not to be processed automatically.
Request Parameters
Automatically process order (Generate Shipping Costs and Pay order), Field is optional and by default is enabled (set to true even if omitted). {auto_process : false} to Place un-processed orders for further manual processing.
Automatically validate customer address (Proof customer address to avoid returned shipments), Field is optional and by default is disabled (set to false even if omitted). {bypass_address_validation : true} to process un-validated addresses. All costs and responsibility from failed deliveries fall upon reseller
A string of up to 25 characters that identifies order/api aggregator company.
A string of up to 256 characters that can be filled with any additional information you want to attach to the order. Recommended to use JSON format. JSON formatted field names: `id`, `order`, `source` : One both or all three fields will be depicted on orders UI for ease of cross identification.
Integration ID for particular store
Array of Customer Properties
Array of Delivery Address Properties
Array of Transactions
Response Parameters
Order ID
Processing status of the Order, Status 1 is default status on order creation.
curl --location --request POST 'https://topdawg.com/api/TDApi/ResellerOrder/create' \
--header 'Authorization: Bearer INSERT_TOKEN_INSTEAD_IF_THIS_TAG \
--header 'Content-Type: application/json' \
--data-raw '{
"api_aggregator": "inventory_source",
"metadata": "{\"id\":4456, \"order\":13334562,\"source\":\"shopify\"}",
"integration_id": 3334,
"customer": {
"customer_id": "2884",
"first_name": "Leroy",
"last_name": "Jenkins",
"phone": "1 234 567 89 01"
},
"address_to": {
"address_id": "2442",
"address_1": "123 Main Street",
"address_2": "APT 111",
"city": "Edison",
"state_code": "NJ",
"country_code": "US",
"zip_code": "08818"
},
"transactions": [
{
"tdid": "S000487B001525P000444V002",
"sku": "S000487B001525P000444V002",
"quantity": 3
}
]
}'
{
"api_aggregator": "inventory_source",
"metadata": "{\"id\":4456, \"order\":13334562,\"source\":\"shopify\"}",
"integration_id": 3334,
"customer": {
"customer_id": "2884",
"first_name": "Leroy",
"last_name": "Jenkins",
"phone": "1 234 567 89 01"
},
"address_to": {
"address_id": "2442",
"address_1": "123 Main Street",
"address_2": "APT 111",
"city": "Edison",
"state_code": "NJ",
"country_code": "US",
"zip_code": "08818"
},
"transactions": [
{
"tdid": "S000487B001525P000444V002",
"sku": "S000487B001525P000444V002",
"quantity": 3
}
]
}
{
"order_id": "15533",
"status": "1"
}
Reseller Products
Reseller Products API allows you to List, Retrieve and Create Products, Update inventory Levels and Manage overall accessibility of your product on TopDawg portal.
List Products
Throttle: 10 calls every 10 seconds ( Leaky Bucket )
Retrieve list of the products. Optionally can be filtered by Brands, Sections, Categories and Departments.
Request Parameters
Paged retrieval of the data is enabled by providing index of the page to be retrieved.
Products to be displayed per each paged response.
Integration ID for particular store
Array of the Product TDID-s
Array of the Departments to list products from
Array of the Sections to list products from
Array of the Categories to list products from
Array of the Brands to list products from
Array of the Country Codes to list products from
Array of Channels - if provided, products without given channel restrictions will be listed
Array of Variant Group ID - if provided, products without given Variant Group ID restrictions will be listed
Minimal count of products per pack. For Bulk Packaging Filtering
Minimal count of products in stock. For secure stock management
Filter products by international shipping availability.
Filter products by updated date
Response Parameters
Array of Products
Array of Pagination variables, used to navigate through product list
curl --location --request POST 'https://topdawg.com/api/TDApi/ResellerProduct/list' \
--header 'Authorization: Bearer INSERT_TOKEN_INSTEAD_IF_THIS_TAG \
--header 'Content-Type: application/json' \
--data-raw '{
"page": "1",
"per_page": "100",
"integration_id": 3334,
"tdid_array": [
"S000487B001525P000444V002"
],
"departments": [
"pet-supplies"
],
"sections": [
"apparel"
],
"categories": [
"hand-tools"
],
"brands": [
"ali-industries"
],
"countries": [
"US"
],
"no_channel_restrictions": [
"amazon"
],
"variant_group_id": [
"6-851-1"
],
"min_pack_of": "2",
"min_quantity": "100",
"international_shipping": "Yes",
"product_updated_at": "2022-11-27 05:01:01"
}'
{
"page": "1",
"per_page": "100",
"integration_id": 3334,
"tdid_array": [
"S000487B001525P000444V002"
],
"departments": [
"pet-supplies"
],
"sections": [
"apparel"
],
"categories": [
"hand-tools"
],
"brands": [
"ali-industries"
],
"countries": [
"US"
],
"no_channel_restrictions": [
"amazon"
],
"variant_group_id": [
"6-851-1"
],
"min_pack_of": "2",
"min_quantity": "100",
"international_shipping": "Yes",
"product_updated_at": "2022-11-27 05:01:01"
}
{
"products": [
{
"tdid": "S000487B001525P000444V002",
"product_name": "Stainless Steel Spike",
"upc": "9369998008780",
"description": "AQUA LEASH is no ordinary leash and has revolutionized the dog walking industry.",
"product_country": "US",
"ship_country": "US",
"ship_state": "FL",
"shipping_estimate": "{\"ne\": {\"cost\": \"9.10\", \"city\": \"Portland\"}, \"se\": {\"cost\": \"8.75\", \"city\": \"Miami\"}, \"nw\": {\"cost\": \"9.54\", \"city\": \"Seattle\"}, \"sw\": {\"cost\": \"9.54\", \"city\": \"San Diego\"}, \"average\": \"9.23\", \"max\": \"9.54\", \"min\": \"8.75\", \"date\": \"05-15-2022\"}",
"color": "Red",
"ingredients": "Purified water, lauryl glucoside (coconut & sugar derived), glycerin.",
"size": "Small\/medium .78",
"width": "0.78",
"length": "8.26",
"height": "5.90",
"product_weight": "1.64",
"ship_length": "8.26",
"ship_height": "5.90",
"ship_width": "1.64",
"msrp": "34.95",
"price_map": "34.95",
"pack_of": "1",
"qty_initial": "4500",
"qty_available": "500",
"cost": "17.96",
"channel_restriction": "No",
"product_code": "No",
"packing_fee": "No",
"return": "30, 'Yes', 'No' ",
"brand_name": "pets",
"department": "pets",
"section": "Collars and Harnesses",
"age_group": "Adults",
"gender": "Unisex",
"variant_group_id": "9369998008780",
"category": "Dog Collars",
"image_url": "https:\/\/topdawg-production-images.s3.amazonaws.com\/9369998008780.0.jpg",
"thumbnail_url": "https:\/\/topdawg-production-images.s3.amazonaws.com\/9369998008780.0.jpg",
"product_updated_at": "2022-11-27 05:01:01"
}
],
"pagination": {
"total": 2729,
"count": 10,
"per_page": 10,
"current_page": 3,
"total_pages": 273
}
}