Add a single product to the store

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Request

The product to add

namestringRequired1-2000 characters

The name of the product

reference_idstringRequired1-400 characters

Unique reference identifier for the product. Any linked or generated inventory will also be uniquely identified by this value

barcodestring or nullOptional<=150 characters

Barcode for the product

gtinstring or nullOptional<=50 characters

Global Trade Item Number - unique and internationally recognized identifier assigned to item by company GS1.

skustring or nullOptional<=400 characters

Stock keeping unit for the product

unit_pricedouble or nullOptional

The price of one unit

upcstring or nullOptional<=50 characters

Universal Product Code - Unique external identifier

Response

Success

barcodestring or null

Barcode for the product

bundle_root_informationobject or null

channelobject or null

Information about a store channel

created_datedatetime or null

Date the product was created

fulfillable_inventory_itemslist of objects or null

The inventory that this product will resolve to when packing a shipment

fulfillable_quantity_by_fulfillment_centerlist of objects or null

Fulfillable quantity of this product broken down by fulfillment center location

gtinstring or null

Global Trade Item Number - unique and internationally recognized identifier assigned to item by company GS1.

idinteger or null

Unique identifier of the product

namestring or null

The name of the product

reference_idstring or null

Unique reference identifier of the product

skustring or null

Stock keeping unit for the product

total_committed_quantityinteger or null

Total committed quantity of this product

total_fulfillable_quantityinteger or null

Total fulfillable quantity of this product

total_onhand_quantityinteger or null

Total on hand quantity of this product

unit_pricedouble or null

The price of one unit

upcstring or null

Universal Product Code - Unique external identifier

1	import requests
2
3	url = "https://api.shipbob.com/1.0/product"
4
5	payload = {
6	"name": "Medium Blue T-Shirt",
7	"reference_id": "TShirtBlueM",
8	"barcode": "123456789012",
9	"gtin": "012345678905",
10	"sku": "TShirtBlueM",
11	"unit_price": 20.32,
12	"upc": "012345678912"
13	}
14	headers = {
15	"shipbob_channel_id": "shipbob_channel_id",
16	"Authorization": "Bearer <token>",
17	"Content-Type": "application/json"
18	}
19
20	response = requests.post(url, json=payload, headers=headers)
21
22	print(response.json())

1	{
2	"barcode": "123456789012",
3	"bundle_root_information": {
4	"id": 0,
5	"name": "string"
6	},
7	"channel": {
8	"id": 0,
9	"name": "House of Slippers"
10	},
11	"created_date": "2019-08-24T14:15:22Z",
12	"fulfillable_inventory_items": [
13	{
14	"id": 0,
15	"name": "Medium Blue T-Shirt",
16	"quantity": 0
17	}
18	],
19	"fulfillable_quantity_by_fulfillment_center": [
20	{
21	"committed_quantity": 0,
22	"fulfillable_quantity": 0,
23	"id": 0,
24	"name": "Cicero",
25	"onhand_quantity": 0
26	}
27	],
28	"gtin": "012345678905",
29	"id": 0,
30	"name": "Medium Blue T-Shirt",
31	"reference_id": "TShirtBlueM",
32	"sku": "TShirtBlueM",
33	"total_committed_quantity": 0,
34	"total_fulfillable_quantity": 0,
35	"total_onhand_quantity": 0,
36	"unit_price": 20.32,
37	"upc": "012345678912"
38	}

Authentication

Headers

Request

Response

Errors