Shop orders

These endpoints allow you to fetch the orders placed for a shop.

The order model

The order model contains info about the order placed, it contains the following properties:

Properties

Name
created_at
Type
string
Description
The creation date and time of the record.
Name
processing_status
Type
string
Description
The current processing status of the record.
Name
processed_at
Type
string
Description
The date and time when the record was processed.
Name
number
Type
string
Description
The unique number identifier for the record.
Name
currency
Type
string
Description
The currency code used in the transaction.
Name
total
Type
string
Description
The total amount of the transaction.
Name
updated_at
Type
string
Description
The date and time when the record was last updated.
Name
uuid
Type
string
Description
A unique identifier for the record.
Name
payment_id
Type
string
Description
The unique identifier for the payment.
Name
payment_status
Type
string
Description
The status of the payment.
Name
points_used
Type
integer
Description
The number of points used in the transaction.
Name
total_order_points_price
Type
integer
Description
The total price of the order in points.
Name
mail_delivered_in_inbox
Type
boolean
Description
Indicates whether the mail was delivered to the inbox.
Name
passes
Type
array
Description
An array of passes associated with the record.
Name
member
Type
object
Description
An object containing member information.
Name
member_partner_id
Type
string
Description
The partner identifier for the member.
Name
brand
Type
object
Description
An object containing brand information.

GET/shops/:brand_id/orders

List all orders for a brand

This endpoint allows you to fetch all orders for a brand. Paginated by 10.

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
shops.orders.get
Type
string
Description
The scope required to access this endpoint.

Route parameters

Name
brand_id
Type
string|Required
Description
The identifieer of the brand

Body parameters

Name
processing_status
Type
string
Description
The current processing state, enum: processed,archived,being_processed,open
Name
status
Type
string
Description
The current state of the order, enum: paid,open,canceled,expired,failed
Name
page
Type
string
Description
The current page that you want the results for.

Request

GET

/shops/:brand_id/orders

curl -X GET https://api.walletapp.co/shops/:brand_id/orders
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"

Response

{
    "current_page": "{current_page}",
    "data": [
        {
            "created_at": "{timestamp}",
            "processing_status": "{processing_status}",
            "processed_at": "{timestamp_or_null}",
            "number": "{number}",
            "currency": "{currency_code}",
            "total": "{amount}",
            "updated_at": "{timestamp}",
            "uuid": "{uuid}",
            "payment_id": "{payment_id_or_null}",
            "payment_status": "{payment_status_or_null}",
            "points_used": "{integer}",
            "total_order_points_price": "{integer}",
            "mail_delivered_in_inbox": "{boolean_integer}",
            "passes": [
                {
                    "qr_code": "{qr_code_or_empty_string}",
                    "expiration_date": "{timestamp_or_null}",
                    "status": "{status}",
                    "coupon": {
                        "external_reference": "{external_reference_or_null}",
                        "title": "{title}",
                        "identifier": "{identifier}"
                    }
                }
            ],
            "member": {
                "email": "{email}",
                "name": "{name_or_null}",
                "identifier": "{identifier}"
            },
            "member_partner_id": "{member_partner_id_or_null}",
            "brand": {
                "name": "{brand_name}",
                "identifier": "{brand_identifier}"
            }
        }
    ],
    "first_page_url": "{api_endpoint}?page={first_page}",
    "from": "{from_record_number}",
    "last_page": "{last_page_number}",
    "last_page_url": "{api_endpoint}?page={last_page}",
    "links": [
        {
            "url": "{previous_page_url_or_null}",
            "label": "{label}",
            "active": "{boolean}"
        },
        {
            "url": "{current_page_url}",
            "label": "{label}",
            "active": "{boolean}"
        }
        // ...
    ],
    "next_page_url": "{next_page_url_or_null}",
    "path": "{api_endpoint}",
    "per_page": "{records_per_page}",
    "prev_page_url": "{previous_page_url_or_null}",
    "to": "{to_record_number}",
    "total": "{total_records}"
}

GET/shops/:brand_id/orders/:order_id

Inspect a specific order

This endpoint allows you to fetch a specific order for a brand.

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
shops.orders.get
Type
string
Description
The scope required to access this endpoint.

Route parameters

Name
brand_id
Type
string|Required
Description
The identifier of the brand.

Name
order_id
Type
string|Required
Description
The identifier of the order.

Request

GET

/shops/:brand_id/orders/:order_id

curl -X GET https://api.walletapp.co/shops/:brand_id/orders/:order_id
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"

Response

{
    "success": "{boolean}",
    "data": {
        "created_at": "{timestamp}",
        "processing_status": "{processing_status}",
        "processed_at": "{timestamp_or_null}",
        "number": "{number}",
        "currency": "{currency_code}",
        "total": "{amount}",
        "updated_at": "{timestamp}",
        "uuid": "{uuid}",
        "payment_id": "{payment_id_or_null}",
        "payment_status": "{payment_status_or_null}",
        "points_used": "{integer}",
        "total_order_points_price": "{integer}",
        "mail_delivered_in_inbox": "{boolean_integer}",
        "passes": [
            {
                "qr_code": "{qr_code_or_empty_string}",
                "expiration_date": "{timestamp}",
                "status": "{status}",
                "coupon": {
                    "external_reference": "{external_reference_or_null}",
                    "title": "{title}",
                    "identifier": "{identifier}"
                }
            }
        ],
        "member": {
            "email": "{email}",
            "name": "{name_or_null}",
            "identifier": "{identifier}"
        },
        "member_partner_id": "{member_partner_id_or_null}",
        "brand": {
            "name": "{brand_name}",
            "identifier": "{brand_identifier}"
        }
    }
}

GET/shops/:brand_id/orders/by-email

Get orders by email adres

This endpoint allows you to fetch all orders for a brand by email adres. Paginated by 10.

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
shops.orders.get
Type
string
Description
The scope required to access this endpoint.

Route parameters

Name
brand_id
Type
string|Required
Description
The identifieer of the brand

Body parameters

Name
email
Type
string|Required
Description
The email adres of the member
Name
processing_status
Type
string
Description
The current processing state, enum: processed,archived,being_processed,open
Name
status
Type
string
Description
The current state of the order, enum: paid,open,canceled,expired,failed
Name
page
Type
string
Description
The current page that you want the results for.

Request

GET

/shops/:brand_id/orders/by-email

curl -X get https://api.walletapp.co/shops/:brand_id/orders/by-email
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"
-d '{"email": "john@example.com"}'

Response

{
    "success": "{boolean}",
    "data": [
        {
            "created_at": "{timestamp}",
            "processing_status": "{processing_status}",
            "processed_at": "{timestamp_or_null}",
            "number": "{number}",
            "currency": "{currency_code}",
            "total": "{amount}",
            "updated_at": "{timestamp}",
            "uuid": "{uuid}",
            "payment_id": "{payment_id_or_null}",
            "payment_status": "{payment_status_or_null}",
            "points_used": "{integer}",
            "total_order_points_price": "{integer}",
            "mail_delivered_in_inbox": "{boolean_integer}",
            "passes": [
                {
                    "qr_code": "{qr_code_or_empty_string}",
                    "expiration_date": "{timestamp}",
                    "status": "{status}",
                    "coupon": {
                        "external_reference": "{external_reference_or_null}",
                        "title": "{title}",
                        "identifier": "{identifier}"
                    }
                }
                // ...
            ],
            "member": {
                "email": "{email}",
                "name": "{name_or_null}",
                "identifier": "{identifier}"
            },
            "member_partner_id": "{member_partner_id_or_null}",
            "brand": {
                "name": "{brand_name}",
                "identifier": "{brand_identifier}"
            }
        }
        // ...
    ]
}

GET/shops/:brand_id/orders/by-member-id

Get orders by member id

This endpoint allows you to fetch all orders for a brand by member id. Paginated by 10.

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
shops.orders.get
Type
string
Description
The scope required to access this endpoint.

Route parameters

Name
brand_id
Type
string|Required
Description
The identifieer of the brand

Body parameters

Name
member_id
Type
string|Required
Description
The identifier of the member
Name
processing_status
Type
string
Description
The current processing state, enum: processed,archived,being_processed,open
Name
status
Type
string
Description
The current state of the order, enum: paid,open,canceled,expired,failed
Name
page
Type
string
Description
The current page that you want the results for.

Request

GET

/shops/:brand_id/orders/by-member-id

curl -X get https://api.walletapp.co/shops/:brand_id/orders/by-member-id
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"
-d '{"member_id": "<id>"}'

Response

{
    "success": "{boolean}",
    "data": [
        {
            "created_at": "{timestamp}",
            "processing_status": "{processing_status}",
            "processed_at": "{timestamp_or_null}",
            "number": "{number}",
            "currency": "{currency_code}",
            "total": "{amount}",
            "updated_at": "{timestamp}",
            "uuid": "{uuid}",
            "payment_id": "{payment_id_or_null}",
            "payment_status": "{payment_status_or_null}",
            "points_used": "{integer}",
            "total_order_points_price": "{integer}",
            "mail_delivered_in_inbox": "{boolean_integer}",
            "passes": [
                {
                    "qr_code": "{qr_code_or_empty_string}",
                    "expiration_date": "{timestamp}",
                    "status": "{status}",
                    "coupon": {
                        "external_reference": "{external_reference_or_null}",
                        "title": "{title}",
                        "identifier": "{identifier}"
                    }
                }
                // ...
            ],
            "member": {
                "email": "{email}",
                "name": "{name_or_null}",
                "identifier": "{identifier}"
            },
            "member_partner_id": "{member_partner_id_or_null}",
            "brand": {
                "name": "{brand_name}",
                "identifier": "{brand_identifier}"
            }
        }
        // ...
    ]
}

GET/shops/:brand_id/orders/:order_id/webhooks

Webhook calls

This endpoints allows you to fetch all webhook call made by Wallet App for a specific order.

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
shops.orders.get
Type
string
Description
The scope required to access this endpoint.

Route parameters

Name
brand_id
Type
string|Required
Description
The identifier of the brand.

Name
order_id
Type
string|Required
Description
The identifier of the order.

Request

GET

/shops/:brand_id/orders/:order_id/webhooks

curl -X GET https://api.walletapp.co/shops/:brand_id/orders/:order_id/webhooks
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"

Response

{
    "success": "{boolean}",
    "data": [
        {
            "delivered": "{boolean_integer}",
            "webhook_call_id": "{uuid}",
            "webhook_url": "{webhook_url}",
            "http_status_code": "{http_status_code}",
            "order_status": "{order_status}",
            "truncate_response": "{truncate_response_text}",
            "failed": "{boolean_integer}",
            "interval": "{time_interval}",
            "created_at": "{timestamp}"
        },
        // ...
    ]
}