GetOrders
Retrieves orders from Shopify
Task version: 1.0.0
Required Frends version: 5.7+
Required .NET version: 8.0
Compatible Agents: Crossplatform
Task Parameters
CreatedAtMin : String
Optional. Start date/time in ISO 8601 format.
Default: -
Example: "2025-01-01T00:00:00Z"
CreatedAtMax : String
Optional. End date/time in ISO 8601 format.
Default: -
Example: "2025-12-31T23:59:59Z"
Status : String
Optional. Filter orders by status. Default is open.
Default: open
Example: open, closed, cancelled
FulfillmentStatus : String
Optional. Filter by fulfillment status.
Default: -
Example: shipped, partial, unshipped
ShopDomain : String
Your Shopify store domain.
Default: -
Example: your-store.myshopify.com
🗝AccessToken : String
Shopify Admin API access token for authenticating requests (from private app or OAuth).
Default: -
Example: Private: shpat_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx OAuth: shpca_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
ApiVersion : String
The version of Shopify API to use
Default: -
Example: 2025-07
Fields : String
Optional. Comma-separated list of fields to return.
Default: -
Example: id,created_at,total_price
PageInfo : String
Optional. Pagination cursor, e.g. nextPage or previousPage.
Default: -
Example: eyJsYXN0X2lkIjo0MDkzNTg3ODQsImxhc3RfdmFsdWUiOiI0MDkzNTg3ODQifQ==
Limit : Int32
Optional. Max number of results per page (1-250). Default is 50.
Default: 50
Example: 50
ThrowErrorOnFailure : Boolean
Whether to throw an error on failure. True by default.
Default: True
Example: False
ErrorMessageOnFailure : String
Overrides the error message on failure.
Default: -
Example: Failed to retrieve orders from store
Task Result
Success : Boolean
Indicates whether the retrieval was successful.
Example: true
Orders : List<Object>
List of order objects returned from Shopify.
Example: [ { "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 } ] } ]
PageInfo : PageInfo
Pagination cursor.
Example: object { string NextPage, string PreviousPage }
Error : Error
Error that occurred during task execution.
Example: object { string Message, object { Exception Exception } AdditionalInfo }
Task Changelog
Changelog for Task Frends.Shopify.GetOrders.
[1.0.0] - 2025-07-11
Changed
Initial implementation
Last updated
Was this helpful?