The shipment object
Invoice
Parameter | Data type | Default | Description |
---|---|---|---|
shipment_number | string | The shipment number for this shipment. This is generated as order number plus a suffix | |
status | string | open | Status of the shipment |
customer_id | int | The customer of the shipment | |
order_id | int | The order of the order | |
notes | string | NULL | An optional note/comment |
currency | string | The currency of the shipment | |
meta | object | {} | An object with {"key": "value"} with custom meta data of the order. This is used for storing custom fields |
created_at | datetime | ||
updated_at | datetime | ||
lines.* | An array of object shipment line |
Invoice line
Parameter | Data type | Default | Description |
---|---|---|---|
product_id | int | The product shipped | |
variant_id | int | The variant shipped | |
quantity | int | The quantity shipped | |
price_before_discount | float | The unit price of the line before discount and ex VAT | |
discount_amount | float | The unit discount given as an amount ex VAT | |
discount_percentage | float | The discount given as a percentage | |
net_price | float | The unit price of the line ex VAT and after discount | |
vat_amount | float | The unit VAT amount | |
total_price | float | The total price of the line ex VAT. This is calculated as quantity * net_price | |
total_price_after_vat | float | The total price of the line incl VAT | |
created_at | datetime | ||
updated_at | datetime |