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
Name Type Source
inputDTO_shopify_find_customer_requestQuery

  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
NameTypeReadOnlyDescription
emailStringEmail
DTO_shopify_customer_with_orders_wrapper
NameTypeReadOnlyDescription
customerDTO_shopify_customerCustomer
ordersDTO_shopify_order[]Orders
DTO_shopify_customer
NameTypeReadOnlyDescription
first_nameStringFirst name
last_nameStringLast name
url_create_orderStringUrl create order
total_spentDouble (nullable)Total spent
total_spent_currencyStringTotal spent currency
total_order_countInt32Total order count
createdDateTime (nullable)Created
tagsString[]Tags
DTO_shopify_order
NameTypeReadOnlyDescription
order_numberStringOrder number
financial_statusStringFinancial status
fulfillment_statusStringFulfillment status
url_editStringUrl edit
total_amountDouble (nullable)Total amount
total_amount_currencyStringTotal amount currency
shipping_addressDTO_shopify_addressShipping address
fulfillmentsDTO_shopify_fulfillment[]Fulfillments
shipment_costsDTO_shopify_shipment_cost[]Shipment costs
order_linesDTO_shopify_order_line[]Order lines
createdDateTime (nullable)Created
DTO_shopify_address
NameTypeReadOnlyDescription
nameStringName
address1StringAddress1
address2StringAddress2
cityStringCity
zipStringZip
provinceStringProvince
countryStringCountry
country_codeStringCountry code
phoneStringPhone
companyStringCompany
DTO_shopify_fulfillment
NameTypeReadOnlyDescription
fulfillment_idInt64Fulfillment id
serviceStringService
statusStringStatus
trackersDTO_shopify_fulfillment_tracker[]Trackers
DTO_shopify_fulfillment_tracker
NameTypeReadOnlyDescription
tracking_numberStringTracking number
tracking_urlStringTracking url
DTO_shopify_shipment_cost
NameTypeReadOnlyDescription
costDouble (nullable)Cost
currencyStringCurrency
codeStringCode
DTO_shopify_order_line
NameTypeReadOnlyDescription
line_item_idInt64Line item id
nameStringName
skuStringSku
quantity_orderedInt32Quantity ordered
quantity_fulfilledInt32Quantity fulfilled
quantity_refundedInt32Quantity refunded
priceDouble (nullable)Price
currencyStringCurrency
vendorStringVendor
product_idInt64Product id
titleStringTitle
statusENUM integration_ecommerce_order_line_statusStatus
fulfillment_idsInt64[]Fulfillment ids
ENUM integration_ecommerce_order_line_status
ValueNameDescription
0UNKNOWNUNKNOWN
11PENDINGPending
21REFUNDEDRefunded
31FULFILLEDFulfilled
41PARTIALLY_FULFILLEDPartially Fulfilled