@plentymarkets/shop-api / getOrder

Function: getOrder()

getOrder(context, params): Promise<Data<Order | GetOrderError>>

Defined in: api/getOrder/index.ts:29

Method getOrder - Used to get the order data.

Parameters

context

PlentysystemsIntegrationContext

params

OrderSearchParams

orderId: string; accessKey: string; name: string; postcode: string;

Returns

Promise<Data<Order | GetOrderError>>

Remarks

• Calls /rest/storefront/orders/$
• Method should be used to get the order data.

Example

const { data } = await useSdk().plentysystems.getOrder({
  orderId: '1383',
  name: 'Backpack Gaia',
  accessKey: '1231234',
  postcode: '012799'
});