POST /admin/api/{api_version}/orders/{order_id}/transactions.json
Caution
For multi-currency orders, the currency
property is required when creating refund and capture transactions. The value should be the presentment currency from the order. For more information, see Migrating to support multiple currencies.
Creates a transaction for an order.
Servers
- https://{store_name}.myshopify.com
- {store_name}.myshopify.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
order_id |
String | Yes | |
api_version |
String | Yes |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
x-shopify-access-token |
String | No |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
transaction |
Object | No | |
transaction.parent_id |
Number | No | |
transaction.amount |
String | No | |
transaction.kind |
String | No | |
transaction.currency |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.