Retrieve order / reservation by id (V4)

GET

/v4/orders/{id}

const url = 'https://api-crm-staging.divinea.com/api/v4/orders/example';
const options = {method: 'GET', headers: {APIKey: '<APIKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api-crm-staging.divinea.com/api/v4/orders/example \
  --header 'APIKey: <APIKey>'

CRM order: header from orders + winery_channels + order_totals, lines from order_products + order_product_details, product metadata. Same payload as /{id}; /order-details is the explicit path for the order detail page. WS-2594: optional split-payer rows may appear in userMetadata.secondaryContacts as an array of { contactId (string), amountCents (integer >= 0) }; primary cart contact remains contactId on the order.

Authorizations

ApiKey

Parameters

Path Parameters

required

string

Header Parameters

APIKey

string

APIKey

Responses

200

*/*

OrdersAndReservationsDTOV4

object

channelId

integer format: int32

channelName

string

contactId

string

couponCode

string

couponDiscountTotalCents

number format: double

creationDate

string format: date-time

deliveryDate

string format: date-time

discountCents

integer format: int32

externalId

string

extraMetadata

object

giftCents

number format: double

grossTotalPrice

number format: double

string

manualDiscountTotalCents

number format: double

marketingManual

boolean

netTotalPrice

number format: double

notes

string

orderType

string

paid

boolean

paymentMethod

string

pointOfSaleWineSuiteId

string format: uuid

products

Array<object>

OrdersAndReservationsProductDTOV4

object

attributesSnapshot

object

commercialDiscounts

object

discounts

object

extraMetadata

object

metadata

Array<object>

MetadataField

object

label

string

value

string

netPrice

number format: double

pricingBreakdown

object

productId

string format: uuid

productName

string

quantity

integer format: int32

sku

string

type

string

unitPriceCents

integer format: int32

vatPercentage

integer format: int32

shipmentCents

integer format: int32

sourceExternalId

string

sourceExternalType

string

sourceSyncedAt

string format: date-time

status

string

subtotalCents

integer format: int32

taxCents

integer format: int32

totalCents

integer format: int32

totalsDiscounts

object

totalsExtraMetadata

object

updatedDate

string format: date-time

userMetadata

object

vatRate

string

wineryId

string