Skip to main content

The shipment object

Invoice

ParameterData typeDefaultDescription
shipment_numberstringThe shipment number for this shipment. This is generated as order number plus a suffix
statusstringopenStatus of the shipment
customer_idintThe customer of the shipment
order_idintThe order of the order
notesstringNULLAn optional note/comment
currencystringThe currency of the shipment
metaobject{}An object with {"key": "value"} with custom meta data of the order. This is used for storing custom fields
created_atdatetime
updated_atdatetime
lines.*An array of object shipment line

Invoice line

ParameterData typeDefaultDescription
product_idintThe product shipped
variant_idintThe variant shipped
quantityintThe quantity shipped
price_before_discountfloatThe unit price of the line before discount and ex VAT
discount_amountfloatThe unit discount given as an amount ex VAT
discount_percentagefloatThe discount given as a percentage
net_pricefloatThe unit price of the line ex VAT and after discount
vat_amountfloatThe unit VAT amount
total_pricefloatThe total price of the line ex VAT. This is calculated as quantity * net_price
total_price_after_vatfloatThe total price of the line incl VAT
created_atdatetime
updated_atdatetime