@plentymarkets/shop-api / setOrderPaymentMethod

Function: setOrderPaymentMethod()

setOrderPaymentMethod(context, params): Promise<Data<Order>>

Defined in: api/setOrderPaymentMethod/index.ts:32

Method setOrderPaymentMethod - Used to set a new payment method for an order.

Parameters

context

PlentysystemsIntegrationContext

params

OrderSetPaymentMethodParams

orderId: string; accessKey: string; name: string; postcode: string; paymentId: number;

Returns

Promise<Data<Order>>

Order

Remarks

• Calls /rest/storefront/orders/${params.orderId}/switch-payment-method
• Method should be used to set a new payment method for an order. It will return the updated order with the new payment method.

Example

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