Skip to main content
Log inSign up

Payment properties deprecation on the Admin API Order resource

The following properties on the REST and GraphQL Admin API's Order resource, including webhooks, are deprecated:

  • gateway
  • payment_details
  • processing_method

The gateway and payment_details properties are available on the corresponding Transaction resources.

The processing_method property is no longer available due to orders supporting multiple transactions with various processing methods, the field contained incorrect data. The values it provided can be inferred from various sources:

  • free. This is accessible through the order totals.
  • checkout can be determined by the presence of checkout_id on an order.
  • express, direct, offsite, and manual can be inferred through the OrderTransaction gateway and payment_details properties.

These deprecated properties will be removed from unstable in January 2023. The change will be made official in the 2023-04 Admin API version.

Was this section helpful?