Skip to main content

Order

The Order object represents a finalized purchase within webround.com. It contains the economic summary, payment status, logistics information, and a detailed list of purchased items.

Order Definition

PropertyTypeDescription
idstring (UUID)Unique identifier for the order.
storeIdstring (UUID)ID of the store where the purchase was made.
customerIdstring (UUID)ID of the user who placed the order.
amountstring (Decimal)Total order amount (gross).
currencyCodestringCurrency code (e.g., EUR).
paymentStatusstringPayment status (e.g., paid, pending, failed).
shippingStatusstringShipping status (e.g., unassigned, shipped, delivered).
stripeInvoiceUrlstring (URL)Direct link to the invoice generated on Stripe.
shippingTrackingUrlstringnull
itemsOrderItem[]Array containing the individual items included in the order.
createdAtstring (ISO 8601)Order creation date.
updatedAtstring (ISO 8601)Last record update date.

OrderItem

Represents a single line item (product/variant) within an order, including tax details and unit prices.

PropertyTypeDescription
productIdstring (UUID)ID of the main product.
variantIdstring (UUID)ID of the specific variant.
skuIdstring (UUID)Unique SKU ID for the item.
variantNamestringDescriptive name of the purchased variant (e.g., "Black Cap").
coverUrlstring (URL)URL of the product's cover image.
quantitynumberQuantity purchased for this line item.
deliveryMethodDeliveryMethodDelivery method chosen for the item.
appliedTaxRatenumberApplied VAT rate (e.g., 22).
unitNetstring (Decimal)Unit price excluding taxes.
unitGrossstring (Decimal)Gross unit price.
totalNetstring (Decimal)Total net line amount (unitNet * quantity).
totalGrossstring (Decimal)Total gross line amount (unitGross * quantity).

Note on Decimals

Economic values (amount, unitNet, etc.) are returned as string to preserve decimal precision during financial operations, avoiding the rounding errors typical of the float type in JavaScript.