FulfillmentOrderMerchantRequest - admin-graphql - OBJECT

Version: 2024-10

Description:

A request made by the merchant or an order management app to a fulfillment service for a fulfillment order.

Access Scopes

`read_assigned_fulfillment_orders` access scope, `read_merchant_managed_fulfillment_orders` access scope or `read_third_party_fulfillment_orders` access scope.

Fields

  • fulfillmentOrder: FulfillmentOrder! - The fulfillment order associated with the merchant request.
  • id: ID! - A globally-unique ID.
  • kind: FulfillmentOrderMerchantRequestKind! - The kind of request made.
  • message: String - The optional message that the merchant included in the request.
  • requestOptions: JSON - Additional options requested by the merchant. These depend on the `kind` of the request. For example, for a `FULFILLMENT_REQUEST`, one option is `notify_customer`, which indicates whether the merchant intends to notify the customer upon fulfillment. The fulfillment service can then set `notifyCustomer` when making calls to `FulfillmentCreate`.
  • responseData: JSON - The response from the fulfillment service.
  • sentAt: DateTime! - The timestamp when the request was made.

Connections

Related queries

Related mutations

Related Unions

Examples