Integrations / Shopify find customer info
Searches customer and returns customer card with order info
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/integrations/shopify_find_customer_info
Method: GET
Authorisation: Minimum role: USER
Request Arguments
Request body example
Response object
Response status: 200 (OK)
Response type:
DTO_shopify_customer_with_orders_wrapper
Wrapper: DTO_response_wrap
Other response statuses: 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_shopify_find_customer_request
| Name | Type | ReadOnly | Description |
| email | String | | Email |
DTO_shopify_customer_with_orders_wrapper
DTO_shopify_customer
| Name | Type | ReadOnly | Description |
| first_name | String | | First name |
| last_name | String | | Last name |
| url_create_order | String | | Url create order |
| total_spent | Double (nullable) | | Total spent |
| total_spent_currency | String | | Total spent currency |
| total_order_count | Int32 | | Total order count |
| created | DateTime (nullable) | | Created |
| tags | String[] | | Tags |
DTO_shopify_order
| Name | Type | ReadOnly | Description |
| order_number | String | | Order number |
| financial_status | String | | Financial status |
| fulfillment_status | String | | Fulfillment status |
| url_edit | String | | Url edit |
| total_amount | Double (nullable) | | Total amount |
| total_amount_currency | String | | Total amount currency |
| shipping_address | DTO_shopify_address | | Shipping address |
| fulfillments | DTO_shopify_fulfillment[] | | Fulfillments |
| shipment_costs | DTO_shopify_shipment_cost[] | | Shipment costs |
| order_lines | DTO_shopify_order_line[] | | Order lines |
| created | DateTime (nullable) | | Created |
DTO_shopify_address
| Name | Type | ReadOnly | Description |
| name | String | | Name |
| address1 | String | | Address1 |
| address2 | String | | Address2 |
| city | String | | City |
| zip | String | | Zip |
| province | String | | Province |
| country | String | | Country |
| country_code | String | | Country code |
| phone | String | | Phone |
| company | String | | Company |
DTO_shopify_fulfillment_tracker
| Name | Type | ReadOnly | Description |
| tracking_number | String | | Tracking number |
| tracking_url | String | | Tracking url |
DTO_shopify_shipment_cost
| Name | Type | ReadOnly | Description |
| cost | Double (nullable) | | Cost |
| currency | String | | Currency |
| code | String | | Code |
DTO_shopify_order_line
| Name | Type | ReadOnly | Description |
| line_item_id | Int64 | | Line item id |
| name | String | | Name |
| sku | String | | Sku |
| quantity_ordered | Int32 | | Quantity ordered |
| quantity_fulfilled | Int32 | | Quantity fulfilled |
| quantity_refunded | Int32 | | Quantity refunded |
| price | Double (nullable) | | Price |
| currency | String | | Currency |
| vendor | String | | Vendor |
| product_id | Int64 | | Product id |
| title | String | | Title |
| status | ENUM integration_ecommerce_order_line_status | | Status |
| fulfillment_ids | Int64[] | | Fulfillment ids |
ENUM integration_ecommerce_order_line_status
| Value | Name | Description |
| 0 | UNKNOWN | UNKNOWN |
| 11 | PENDING | Pending |
| 21 | REFUNDED | Refunded |
| 31 | FULFILLED | Fulfilled |
| 41 | PARTIALLY_FULFILLED | Partially Fulfilled |