Create Product

post

https://api.shipmonk.com/v1/integrations/product

ERP push to ShipMonk
ShipMonk will ensure that only single Product with matching SKU exists and will reject repeated requests.
Possible values for required_packaging
- poly_mailer, bubble_mailer, box, slap_a_label
- ShipMonk will use this field to resolve lowest level of packaging for orders.
Field country_of_origin will accept 2 letter ISO 3166-1-alpha2 country code
Updates to products will be made directly in ShipMonk UI

Fragile products

If you mark product as fragile, the selected packaging must be box.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

product_key

string

required

length between 3 and 255

Unique identifier for the product in your external system. Must be unique across all your products.

sku

string

required

length between 3 and 255

Stock Keeping Unit (SKU) identifying the product. Must be unique across all active products in your account.

name

string

required

length between 3 and 255

Human-readable product name displayed in the UI and on documents.

required_packaging

string

enum

required

Minimum packaging type required to ship this product: poly_mailer, bubble_mailer, box, slap_a_label (label applied directly), or custom.

Allowed:

fragile

boolean

required

Whether the product requires fragile handling during fulfillment. If true, required_packaging must be box.

replacement_cost

double

required

Cost to replace the product, used for insurance and claims. Must be positive, in the currency given by currency_code.

customs_declaration_value

double

required

Declared customs value per unit, used to calculate duties and taxes on international shipments. Must be positive, in the currency given by currency_code.

country_of_origin

string

required

length between 2 and 2

Country of origin as an ISO 3166-1 alpha-2 code (e.g. US, DE, CN), used on customs documentation for international shipments.

barcodes

array of strings

required

Barcodes associated with the product (e.g. UPC, EAN, ISBN). Each barcode must be 1-255 characters; pass an empty array if none.

barcodes*

dimensions_in

Dimensions In Input | null

Defaults to null

Physical product dimensions in inches. Omit if dimensions are unknown.

weight_lb

double | null

Defaults to null

Product weight in pounds (decimal). Must be positive. Omit or set null if weight is unknown.

currency_code

string

length between 3 and 3

Defaults to USD

ISO 4217 currency code (e.g. USD, EUR) for replacement_cost and customs_declaration_value. Defaults to USD.

hs_code

string | null

Defaults to null

Default Harmonized System (HS) code used on customs declarations when no region-specific code in hs_codes matches. Max 255 characters.

hs_codes

array of objects

Defaults to []

Region-specific Harmonized System (HS) codes used for customs classification per destination region. Takes precedence over hs_code when a matching region is found.

hs_codes

image_url

string | null

Defaults to null

Publicly accessible URL of the product image. Must be a valid URL and unique across all your products.

custom_data

array of objects

Defaults to []

Custom key/value metadata to attach to the product, typically used for integration-specific data.

custom_data

product_handling_units

array of objects

Defaults to []

List of handling units (inner carton, master carton, pallet) describing the product's packaging hierarchy used for receiving and storage. Omit if the product ships as individual units only.

product_handling_units

lot_control_settings

Integration Product Lot Control Setting Input | null

Defaults to null

Lot control settings specifying whether lot number and/or expiration date tracking is required for this product. Provide for products that must be tracked by batch or expiration.

Response

200Success