v4

latestOpenAPI 3.0.02026-07-31811,0021.1 MB
Order

get/v1/pvt/Order/{orderId}

Path parameters

orderIdstring required

Response

Idinteger
OriginalIdstring

This is the Id in the third party system.

OrderPlacementDatestring date-time

Date of the customer's purchase.

OrderCompletedDatestring date-time nullable

Date the order reached the completed state (usually it's invoiced or delivered).

OrderCancelledDatestring date-time nullable

if the order is cancelled, contains the date.

OrderStatusstring

Status at the client's order system.

IsCancelledOrReturnedboolean

if true the order was cancelled or returned.

IsCompletedboolean

If true it means the order has reached its final status and points can be awarded to the consumer.

OrderTotalnumber

Can be used at Loyalty Programs. Important: these values should not include Shipping costs.

UpdatedDatestring date-time

the date from the last update on this order.

Couponstring nullable

Coupon code used on this order.

State0 | 1 | 2 | 3 | 4

0 = Initial 1 = Pending 2 = Completed 3 = Cancelled 4 = Ignored

Origin0 | 1 | 2 | 3 | 4

0 = Integration 1 = API 2 = Import 3 = PDV 4 = OfflineIntegration

ExternalCouponstring nullable

This is the "official" field for coupons from the ecomm platform - normally used for affiliate Coupon