GuidesAPI ReferenceChangelog
API Reference

Create a product

post
https://api.getbyrd.com/v2/warehouse/products

Creates a product, or a bundle when productType is bundle. The
SKU must match the one your sales channel sends on its order lines,
otherwise orders for it cannot be released.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
boolean | null

Whether the product can be shipped. Defaults to true.

string | null

Value of the primary barcode printed on the product, at most 48 characters; mirrors the primary entry of barcodes. null when the product has no barcode.

string | null
enum

Symbology of barcode; required when barcode is set.

  • ean_13: EAN-13
  • code_128: Code 128
  • gs1_128: GS1-128
  • qr_code: QR code
Allowed:
barcodes
array of objects | null

All barcodes printed on the product, at most one of them primary. When you send both barcode and barcodes, barcode must match the primary entry.

barcodes
string | null
^([0-9]{6}|[0-9]{8}|[0-9]{10})$

Harmonised System (HS) tariff code of the product: 6, 8 or 10 digits. Required for shipments leaving the EU or the UK.

customsValue
object | null

Value declared to customs for the product when the shipment item has no price, for example for a free gift; null for none. Not the purchase price.

string | null

Free-text description of the product.

string | null

European Article Number (EAN) of the product, passed on as its GTIN in customs data.

string | null

International Standard Book Number (ISBN) of the product, passed on as its GTIN in customs data when it has no EAN or UPC.

boolean

Whether lots (batches) of the product are tracked when it is inbounded and shipped. Bundles cannot be lot tracked. Defaults to false.

boolean

Whether the product also comes in packaging units holding several units, which the warehouse can pick as a whole. Defaults to false.

boolean

Whether serial numbers of the product are recorded when it is shipped. Defaults to false.

string | null

Regular expression the serial numbers recorded when shipping the product must match; null for no check.

boolean

Whether serial numbers are also tracked in inventory, from inbounding onwards. Requires serialNumberEnabled. Defaults to false.

string
required
length ≥ 1

Name of the product; at least one character.

string | null
^[A-Z]{2}$

Country the product was made in (ISO 3166-1 alpha-2); UK is stored as GB. Required for shipments leaving the EU or the UK.

boolean | null

Whether the product is organic and needs special storage and shipping conditions. Bundles cannot be organic. Defaults to false.

boolean | null

Whether the product complies with the Global Recycled Standard (GRS) and needs specific storage conditions. Defaults to false.

boolean | null

Whether the product is fragile and needs special packaging. For a bundle it is derived from the ingredients and cannot be set. Defaults to false.

string | null

Deprecated. ID of the article in your shop system; required when shopID is set.

string | null

Type of the product. Defaults to product; bundle, supplementary and packaging_material cannot be changed afterwards.

  • product: a regular physical product
  • bundle: a group of other products sold under one SKU, see bundleIngredients
  • prepacked_product: a product shipped in its own packaging
  • packaging_material: packaging material, such as boxes or fillers
  • branding: branded material packed into shipments, not counted as a product item
  • supplementary: a product only shipped together with another product
  • alias: another SKU for an existing product, sharing its stock
  • marketing: marketing material
purchasePrice
object | null

Purchase price of one unit, used to insure shipments. Use the purchase price, not the retail price; bundles cannot have one.

string | null

HTTPS link to a document proving the purchase price, such as an invoice.

integer | null
≥ 0

Available stock level at or below which the product is reported as low on stock, for example in the daily notification email if you enabled it. Defaults to 0.

number | null
≥ 0

Retail price of one unit, for your reference; at least 0.

string | null

Your stock keeping unit (SKU) for the product, unique among your products. It must match the SKU your sales channel sends on order lines.

string | null

Universal Product Code (UPC) of the product, passed on as its GTIN in customs data when it has no EAN.

string | null

Deprecated. ID of the article variant in your shop system.

bundleIngredients
array of objects | null

Products a bundle is made of and how many units of each, as ingredientID and quantity; only for productType bundle. Replaces the current ingredients. Write-only: read them with the bundle endpoints.

bundleIngredients
uuid | null

ID of the byrd user who owns the product (UUID). Products you create are always yours.

uuid | null

ID of the shop the product is linked to (UUID); null when it is not linked to a shop.

packagingUnits
array of objects
length ≤ 1

Packaging unit of the product: a pack of several units with its own barcode. At most one; its barcode is required when you create the product and must differ from the product barcodes.

packagingUnits
dangerousGoods
array of objects | null

Dangerous goods the product contains, one entry per UN number. Bundles cannot have any: add them to the ingredients instead.

dangerousGoods
string | null

HTTPS link to the material safety data sheet (MSDS) of the dangerous goods in the product.

dimensions
object | null

Size and weight of one unit of the product. The weight is needed for shipments leaving the EU or the UK; a prepacked_product needs all dimensions and a sizeGroup.

changeRequests
array of objects | null

Changes the warehouse asks you to make to the product settings, one per info; null when there are none. Answer them by sending this list back with a status of accepted or declined.

changeRequests
Headers
string
enum
Defaults to application/vnd.byrd.customer+json

Generated from available response content types

Allowed:
Responses

Updated 10 days ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.byrd.customer+json
application/json

Updated 10 days ago