orderCapture mutation

Captures from an authorized transaction on an order.

Required access

write_orders access scope.

On this page

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

mutation orderCapture($input: OrderCaptureInput!) { orderCapture(input: $input) { 
  1. <font style="color:#1F61A0;">transaction</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">field</font>
  11.   <font style="color:#1F61A0;">message</font>
  13. <font style="color:#555555;">}</font>
} } { “input”: { 
  1. <font style="color:#8B2BB9;">"id"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="</font><font style="color:#555555;">,</font>
  3. <font style="color:#8B2BB9;">"parentTransactionId"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="</font><font style="color:#555555;">,</font>
  5. <font style="color:#8B2BB9;">"amount"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font>
} }

Arguments

Argument Description
input
(
[OrderCaptureInput!](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordercaptureinput)

) REQUIRED		 The input for the mutation.

OrderCaptureInput fields

  • amount ([Money!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#money-2021-01)) REQUIRED
    The amount to capture.
  • currency ([CurrencyCode](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/currencycode))
    The currency (in ISO format) that is used to capture the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)) REQUIRED
    The ID of the order to capture.
  • parentTransactionId ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)) REQUIRED
    The ID of the authorized transaction to capture.

Return fields

  • transaction ([OrderTransaction](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordertransaction))
    The transaction of the capture.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.