# GetOrders

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Unknown

Source code: <https://github.com/FrendsPlatform/Frends.Shopify/tree/main/Frends.Shopify.GetOrders>

{% tabs %}
{% tab title="Parameter: Input" %}

| Name                         | Description                                                                                                                                      |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| CreatedAtMin : `String`      | <p>Optional. Start date/time in ISO 8601 format.</p><p><br>Default: <code>-</code><br>Example: <code>"2025-01-01T00:00:00Z"</code></p>           |
| CreatedAtMax : `String`      | <p>Optional. End date/time in ISO 8601 format.</p><p><br>Default: <code>-</code><br>Example: <code>"2025-12-31T23:59:59Z"</code></p>             |
| Status : `String`            | <p>Optional. Filter orders by status. Default is open.</p><p><br>Default: <code>open</code><br>Example: <code>open, closed, cancelled</code></p> |
| FulfillmentStatus : `String` | <p>Optional. Filter by fulfillment status.</p><p><br>Default: <code>-</code><br>Example: <code>shipped, partial, unshipped</code></p>            |
| {% endtab %}                 |                                                                                                                                                  |

{% tab title="Parameter: Connection" %}

| Name                     | Description                                                                                                                                                                                                                                               |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ShopDomain : `String`    | <p>Your Shopify store domain.</p><p><br>Default: <code>-</code><br>Example: <code>your-store.myshopify.com</code></p>                                                                                                                                     |
| 🗝AccessToken : `String` | <p>Shopify Admin API access token for authenticating requests (from private app or OAuth).</p><p><br>Default: <code>-</code><br>Example: <code>Private: shpat\_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx OAuth: shpca\_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</code></p> |
| ApiVersion : `String`    | <p>The version of Shopify API to use</p><p><br>Default: <code>-</code><br>Example: <code>2025-07</code></p>                                                                                                                                               |
| {% endtab %}             |                                                                                                                                                                                                                                                           |

{% tab title="Parameter: Options" %}

| Name                             | Description                                                                                                                                                                                    |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Fields : `String`                | <p>Optional. Comma-separated list of fields to return.</p><p><br>Default: <code>-</code><br>Example: <code>id,created\_at,total\_price</code></p>                                              |
| PageInfo : `String`              | <p>Optional. Pagination cursor, e.g. nextPage or previousPage.</p><p><br>Default: <code>-</code><br>Example: <code>eyJsYXN0X2lkIjo0MDkzNTg3ODQsImxhc3RfdmFsdWUiOiI0MDkzNTg3ODQifQ==</code></p> |
| Limit : `Int32`                  | <p>Optional. Max number of results per page (1-250). Default is 50.</p><p><br>Default: <code>50</code><br>Example: <code>50</code></p>                                                         |
| ThrowErrorOnFailure : `Boolean`  | <p>Whether to throw an error on failure. True by default.</p><p><br>Default: <code>True</code><br>Example: <code>False</code></p>                                                              |
| ErrorMessageOnFailure : `String` | <p>Overrides the error message on failure.</p><p><br>Default: <code>-</code><br>Example: <code>Failed to retrieve orders from store</code></p>                                                 |
| {% endtab %}                     |                                                                                                                                                                                                |

{% tab title="Result: Result" %}

| Name                    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Success : `Boolean`     | <p>Indicates whether the retrieval was successful.<br>Example: <code>true</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Orders : `List<Object>` | <p>List of order objects returned from Shopify.<br>Example: <code>\[ { "id": 1234567890123, "email": "<customer@example.com>", "created\_at": "2025-01-01T12:00:00Z", "updated\_at": "2025-01-01T12:00:00Z", "number": 1001, "status": "open", "total\_price": "10.00", "currency": "EUR", "customer": { "id": 1234567890123, "first\_name": "Example", "last\_name": "Name" }, "line\_items": \[ { "id": 1234567890123, "product\_id": 1234567890123, "name": "Example Product", "price": "10.00", "quantity": 1 } ] } ]</code></p> |
| PageInfo : `PageInfo`   | <p>Pagination cursor.<br>Example: <code>object { string NextPage, string PreviousPage }</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Error : `Error`         | <p>Error that occurred during task execution.<br>Example: <code>object { string Message, object { Exception Exception } AdditionalInfo }</code></p>                                                                                                                                                                                                                                                                                                                                                                                  |
| {% endtab %}            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |

{% tab title="Changelog" %}

## Changelog

### \[1.0.0] - 2025-07-11

#### Changed

* Initial implementation
  {% endtab %}
  {% endtabs %}
