This documentation for developers who want to use Chazki's endpoints for Shopify. This endpoints are used to complete integrations between Shopify shops and Chaski's system. Also, to create and keep track of orders generated.
These services are registered in the domain owned by chazki and are detailed in the section below. Find out more about Chazki here.
Shopify beta
List of endpoints to register a shop
This endpoint redirects the user to a site in order to finish the integration
Url that identifies a shop
Successfull operation
curl --request GET \
--url 'https://us-central1-chazki-link-beta.cloudfunctions.net/nintendo-cf-integrations/api/shopify/url-register?shop='
Successfull operation
This endpoint completes the integration. Obtains data needed to allow the communication between the API's. Register new endpoints that will be used by the shop when an order is generated. Also it redirects to the shop page.
Code used to generate a shopify token for the first time.
XXXXXXXXXXXXXXXXXXXXXXXSecurity code that identifies an authentic shopify client.
XXXXXXXXXXXXXXXXXXXXXXXXSecurity code that is stored.
XXXXXXXXXXXXXXXXXXXXXXXXSecurity method that identifies a client from chazki to shopify.
s%3Apruebasintegracionmyshopifycomcreandochazki1015Url that identifies a shop
https://pruebasintegracion.myshopify.com/Unsuccessfull response
curl --request GET \
--url https://us-central1-chazki-link-beta.cloudfunctions.net/nintendo-cf-integrations/api/shopify/code-client \
--header 'Content-Type: application/json'
{
"success": false,
"message": "ERROR_MSG"
}Unsuccessfull response
This endpoint allows a shop to recieve webhooks and register an endpoint in which the webhook will be sent
Url that identifies a shop
https://pruebasintegracion.myshopify.com/Key that allows query responses
XXXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXSuccessfull registration
Unsuccessfull registration
Unsuccessfull operation
curl --request POST \
--url https://us-central1-chazki-link-beta.cloudfunctions.net/nintendo-cf-integrations/api/shopify/register-webhook \
--header 'Content-Type: application/json' \
--data '{
"shop": "https://pruebasintegracion.myshopify.com/",
"access_token": "XXXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}'
{
"success": true,
"message": "REGISTERED WEBHOOK CORRECTLY.",
"response": {
"id": "xxxxxxxxxxxx"
}
}Successfull registration
This endpoint register an endpoint in which a 'shipping cost' query will be sent
Url that identifies a shop
https://pruebasintegracion.myshopify.com/Key that allows query responses
XXXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXSuccessfull registration
Unsuccessfull registration
Unsuccessfull operation
curl --request POST \
--url https://us-central1-chazki-link-beta.cloudfunctions.net/nintendo-cf-integrations/api/shopify/register-shipping-cost \
--header 'Content-Type: application/json' \
--data '{
"shop": "https://pruebasintegracion.myshopify.com/",
"access_token": "XXXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}'
{
"success": true,
"message": "SUCCESS",
"response": {
"id": 63000772833,
"name": "Chazki",
"active": true,
"service_discovery": true,
"carrier_service_type": "api",
"admin_graphql_api_id": "gid://shopify/DeliveryCarrierService/63000772833",
"format": "json",
"callback_url": "https://us-central1-chazki-link-dev.cloudfunctions.net/nintendo-cf-integrations/api/shopify/shipping-cost"
}
}Successfull registration
List of endpoints to manage orders
This endpoint recieves data from shopify for the purpose of creating an order
The globally-unique identifier of the Order in store within Shopify (used as trackCode)
4693237498081The ID of the app in Shopify for graphQl.
gid://shopify/Order/XXXXXXXXXXXXXThe ID of the app that created the order.
580119Whether the customer agreed to receive marketing materials.
The reason provided when the order was canceled. Returns null if the order wasn't canceled.
The date and time when the order was canceled. Returns null if the order wasn't canceled.
nullA unique value when referencing the checkout that's associated with the order.
32514734653665A unique value when referencing the checkout that's associated with the order.
ba416ed5402868d5a0fec4089f27ds7eInformation about the browser that the customer used when they placed their order:
The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed.
2008-01-10T11:00:00-05:00Whether inventory has been reserved for the order.
trueThe email address associated with the customer or contact.
test@mail.example.comThe autogenerated date and time (ISO 8601 format) when the order was created in Shopify. The value for this property cannot be changed.
2012-03-13T16:09:55-04:00The three-letter code (ISO 4217 format) for the shop currency.
CLPThe current subtotal price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds.
100The current subtotal price of the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds.
The current total discounts on the order in the shop currency. The value of this field reflects order edits, returns, and refunds.
The current total discounts on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds.
The current total duties charged on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds.
The current total price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds.
626The current total price of the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds.
The current total taxes charged on the order in the shop currency. The value of this field reflects order edits, returns, or refunds.
19The current total taxes charged on the order in shop and presentment currencies. The amount values associated with this field reflect order edits, returns, and refunds.
The two or three-letter language code, optionally followed by a region modifier.
esThe ID for the device.
A list of discounts applied to the order. Each discount object includes the following properties:
'Information about the browser that the customer used when they placed their order:'
The customer's email address.
shopping@mail.example.comWhether taxes on the order are estimated. Many factors can change between the time a customer places an order and the time the order is shipped, which could affect the calculation of taxes. This property returns false when taxes on the order are finalized and aren't subject to any changes.
The status of payments associated with the order. Can only be set when the order is created.
paidThe order's status in terms of fulfilled line items.
fulfilledThe payment gateway used.
shopify_paymentsThe order name, generated by combining the order_number property with the order prefix and suffix that are set in the merchant's general settings. This is different from the id property, which is the ID of the order used by the API. This field can also be set by the API to be any string value.
#1032An optional note that a shop owner can attach to the order.
Customer changed their mind.Extra information that is added to the order. Appears in the Additional details section of an order details page. Each array entry must contain a hash with name and value keys.
The order's position in the shop's count of orders. Numbers are sequential and start at 1.
32The order 's position in the shop's count of orders starting at 1001. Order numbers are sequential and start at 1001.
1032The URL pointing to the order status web page
https://checkout.shopify.com/112233/checkouts/4207896aad57dfb159/thank_you_token?key=753621327b9e8a64789651bf221dfe35The original total duties charged on the order in shop and presentment currencies.
The list of payment gateways used for the order.
[
"authorize_net",
"bogus"
]The customer's phone number for receiving SMS notifications.
+557734881234The presentment currency that was used to display prices to the customer.
CLPThe date and time (ISO 8601 format) when an order was processed. This value is the date that appears on your orders and that's used in the analytic reports.
2022-03-11T18:48:56-05:00How the payment was processed.
checkoutThe price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips.
100The subtotal of the order in shop and presentment currencies after discounts but before shipping, duties, taxes, and tips.
Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length.
loyalAn array of tax line objects, each of which details a tax applicable to the order.
Whether taxes are included in the order subtotal.
Whether this is a test order.
trueA unique value when referencing the order.
912aa9359d838d6dc7d402158816ef50The total discounts applied to the price of the order in the shop currency.
0.00The total discounts applied to the price of the order in shop and presentment currencies.
The sum of all line item prices in the shop currency.
100The total of all line item prices in shop and presentment currencies.
The total outstanding amount of the order in the shop currency.
The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.
6268The total price of the order in shop and presentment currencies.
The total price of the order in USD.
7.82The total shipping price of the order, excluding discounts and returns, in shop and presentment currencies. If taxes_included is set to true, then total_shipping_price_set includes taxes.
The sum of all the taxes applied to the order in the shop currency. Must be positive.
19The total tax applied to the order in shop and presentment currencies.
The sum of all the tips in the order in the shop currency.
The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order.
360The date and time (ISO 8601 format) when the order was last modified. Filtering orders by updated_at is not an effective method for fetching orders because its value can change when no visible fields of an order have been updated.
2022-03-11T18:48:58-05:00The ID of the user logged into Shopify POS who processed the order, if applicable.
31522279'The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method. It has the following properties:'
An ordered list of stacked discount applications. The discount_applications property includes 3 types: discount_code, manual, and script. All 3 types share a common structure and have some type specific attributes.
An array of fulfillments associated with the order.
[
"466157049",
"466157078"
]The terms and conditions under which a payment should be processed.
A list of refunds applied to the order.
'The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method. It has the following properties:'
'An array of objects, each of which details a shipping method used. Each object has the following properties:'
Successfull operation
Unsuccessfull operation
curl --request POST \
--url https://us-central1-chazki-link-beta.cloudfunctions.net/nintendo-cf-integrations/api/shopify/order-receiver \
--header 'Content-Type: application/json' \
--data '{
"id": 4693237498081,
"admin_graphql_api_id": "gid://shopify/Order/XXXXXXXXXXXXX",
"app_id": 580119,
"buyer_accepts_marketing": false,
"cancel_reason": null,
"cancelled_at": "null",
"checkout_id": 32514734653665,
"checkout_token": "ba416ed5402868d5a0fec4089f27ds7e",
"client_details": {
"accept_language": "es",
"browser_height": "900",
"browser_ip": "xxx.xxx.xxx.xxx",
"browser_width": "1000",
"session_hash": "9ad4d1f4e6a8977b9dd98eed1e477643",
"user_agent": "Mozilla/X.0 (X11; Linux x86_64) AppleWebKit/xxxxx (KHTML, like Gecko) Chrome/xxxxxx Safari/xxxxx"
},
"closed_at": "2008-01-10T11:00:00-05:00",
"confirmed": true,
"contact_email": "test@mail.example.com",
"created_at": "2012-03-13T16:09:55-04:00",
"currency": "CLP",
"current_subtotal_price": 100,
"current_subtotal_price_set": {
"shop_money": {
"amount": "100",
"currency_code": "CLP"
},
"presentment_money": {
"amount": "100",
"currency_code": "CLP"
}
},
"current_total_discounts": 0,
"current_total_discounts_set": {
"shop_money": {
"amount": "100",
"currency_code": "CLP"
},
"presentment_money": {
"amount": "100",
"currency_code": "CLP"
}
},
"current_total_duties_set": {
"shop_money": {
"amount": "100",
"currency_code": "CLP"
},
"presentment_money": {
"amount": "100",
"currency_code": "CLP"
}
},
"current_total_price": 626,
"current_total_price_set": {
"shop_money": {
"amount": "100",
"currency_code": "CLP"
},
"presentment_money": {
"amount": "100",
"currency_code": "CLP"
}
},
"current_total_tax": 19,
"current_total_tax_set": {
"shop_money": {
"amount": "100",
"currency_code": "CLP"
},
"presentment_money": {
"amount": "100",
"currency_code": "CLP"
}
},
"customer_locale": "es",
"device_id": null,
"discount_codes": [
{
"code": "SPRING30",
"amount": "30.00",
"type": "fixed_amount"
}
],
"email": "shopping@mail.example.com",
"estimated_taxes": false,
"financial_status": "paid",
"fulfillment_status": "fulfilled",
"gateway": "shopify_payments",
"name": "#1032",
"note": "Customer changed their mind.",
"note_attributes": [
{
"name": "custom name",
"value": "custom value"
}
],
"number": 32,
"order_number": 1032,
"order_status_url": "https://checkout.shopify.com/112233/checkouts/4207896aad57dfb159/thank_you_token?key=753621327b9e8a64789651bf221dfe35",
"original_total_duties_set": {
"shop_money": {
"amount": "100",
"currency_code": "CLP"
},
"presentment_money": {
"amount": "100",
"currency_code": "CLP"
}
},
"payment_gateway_names": [
"authorize_net",
"bogus"
],
"phone": "+557734881234",
"presentment_currency": "CLP",
"processed_at": "2022-03-11T18:48:56-05:00",
"processing_method": "checkout",
"subtotal_price": 100,
"subtotal_price_set": {
"shop_money": {
"amount": "100",
"currency_code": "CLP"
},
"presentment_money": {
"amount": "100",
"currency_code": "CLP"
}
},
"tags": "loyal",
"tax_lines": {
"price": 19,
"rate": 0.19,
"title": "VAT",
"price_set": {
"shop_money": {
"amount": "100",
"currency_code": "CLP"
},
"presentment_money": {
"amount": "100",
"currency_code": "CLP"
}
},
"channel_liable": false
},
"taxes_included": false,
"test": true,
"token": "912aa9359d838d6dc7d402158816ef50",
"total_discounts": "0.00",
"total_discounts_set": {
"shop_money": {
"amount": "100",
"currency_code": "CLP"
},
"presentment_money": {
"amount": "100",
"currency_code": "CLP"
}
},
"total_line_items_price": 100,
"total_line_items_price_set": {
"shop_money": {
"amount": "100",
"currency_code": "CLP"
},
"presentment_money": {
"amount": "100",
"currency_code": "CLP"
}
},
"total_outstanding": 0,
"total_price": 6268,
"total_price_set": {
"shop_money": {
"amount": "100",
"currency_code": "CLP"
},
"presentment_money": {
"amount": "100",
"currency_code": "CLP"
}
},
"total_price_usd": 7.82,
"total_shipping_price_set": {
"shop_money": {
"amount": "100",
"currency_code": "CLP"
},
"presentment_money": {
"amount": "100",
"currency_code": "CLP"
}
},
"total_tax": 19,
"total_tax_set": {
"shop_money": {
"amount": "100",
"currency_code": "CLP"
},
"presentment_money": {
"amount": "100",
"currency_code": "CLP"
}
},
"total_tip_received": 0,
"total_weight": 360,
"updated_at": "2022-03-11T18:48:58-05:00",
"user_id": 31522279,
"billing_address": {
"id": 7620158161121,
"customer_id": 6087092306145,
"first_name": "pruebas envio",
"last_name": "Chile",
"company": null,
"address1": "San Francisco 2511",
"address2": "Apartment 5",
"city": "San Miguel",
"province": "Santiago",
"country": "Chile",
"zip": "8320000",
"phone": "+(53)999888777",
"name": "pruebas envio Chile",
"latitude": -33.4777172,
"longitude": -70.6436693,
"country_code": "CL",
"province_code": "RM",
"country_name": "Chile",
"default": true
},
"customer": {
"id": 6087092306145,
"email": "test@shopping.com",
"accepts_marketing": false,
"created_at": "2022-02-21T09:31:56-05:00",
"updated_at": "2022-03-11T18:48:57-05:00",
"first_name": "pruebas envio",
"last_name": "Chile",
"orders_count": 5,
"state": "disabled",
"total_spent": 375.3,
"last_order_id": 234132602919,
"note": "Placed an order that had a fraud warning",
"verified_email": true,
"multipass_identifier": null,
"tax_exempt": false,
"phone": "555-625-1199",
"tags": "",
"last_order_name": "#1169",
"currency": "CLP",
"accepts_marketing_updated_at": "2022-02-21T09:31:56-05:00",
"tax_exemptions": [
"CA_STATUS_CARD_EXEMPTION",
"CA_BC_RESELLER_EXEMPTION"
],
"admin_graphql_api_id": "gid://shopify/Customer/6087092306145",
"default_address": {
"id": 7620158161121,
"customer_id": 6087092306145,
"first_name": "pruebas envio",
"last_name": "Chile",
"company": null,
"address1": "San Francisco 2511",
"address2": "Apartment 5",
"city": "San Miguel",
"province": "Santiago",
"country": "Chile",
"zip": "8320000",
"phone": "+(53)999888777",
"name": "pruebas envio Chile",
"latitude": -33.4777172,
"longitude": -70.6436693,
"country_code": "CL",
"province_code": "RM",
"country_name": "Chile",
"default": true
}
},
"discount_applications": [
{
"allocation_method": "across",
"code": "TENOFF",
"description": "customer deserved it",
"target_selection": "all",
"target_type": "shipping_line",
"title": "discount_code",
"type": "script",
"value": "10.0",
"value_type": "percentage"
}
],
"fulfillments": [
"466157049",
"466157078"
],
"line_items": [
{
"id": 12345,
"admin_graphql_api_id": "",
"destination_location": "",
"fulfillable_quantity": "",
"fulfillment_service": "",
"fulfillment_status": "",
"gift_card": "",
"grams": "800",
"name": "XXXXXXXXXX",
"origin_location": "",
"price": "400",
"price_set": "",
"product_exists": "",
"product_id": "xxxxxxxxxx",
"properties": "",
"quantity": "",
"requires_shipping": "true",
"sku": "",
"taxable": "true",
"title": "",
"total_discount": "",
"total_discount_set": "",
"variant_id": "xxxxxxxxxx",
"variant_inventory_management": "",
"variant_title": "",
"vendor": "XXXXXXXXXX",
"tax_lines": "",
"duties": "",
"discount_allocations": ""
}
],
"payment_terms": {
"amount": 70,
"currency": "CLP",
"payment_terms_name": "NET_30",
"payment_terms_type": "NET",
"due_in_days": 30,
"payment_schedules": [
{
"amount": 70,
"currency": "CAD",
"issued_at": "2020-07-29T13:02:43-04:00",
"due_at": "2020-08-29T13:02:43-04:00",
"completed_at": null,
"expected_payment_method": "shopify_payments"
}
]
},
"refunds": [
{
"id": 18423447608,
"order_id": 394481795128,
"created_at": "2018-03-06T09:35:37-05:00",
"note": null,
"user_id": null,
"processed_at": "2018-03-06T09:35:37-05:00"
}
],
"shipping_address": {
"id": 7620158161121,
"customer_id": 6087092306145,
"first_name": "pruebas envio",
"last_name": "Chile",
"company": null,
"address1": "San Francisco 2511",
"address2": "Apartment 5",
"city": "San Miguel",
"province": "Santiago",
"country": "Chile",
"zip": "8320000",
"phone": "+(53)999888777",
"name": "pruebas envio Chile",
"latitude": -33.4777172,
"longitude": -70.6436693,
"country_code": "CL",
"province_code": "RM",
"country_name": "Chile",
"default": true
},
"shipping_lines": [
{
"id": 3908143841505,
"carrier_identifier": "2ef11aec7f5303b57bc02decab250d6d",
"code": "NEXT DAY",
"delivery_category": null,
"discounted_price": 614,
"discounted_price_set": {
"amount": "100",
"currency_code": "CLP"
},
"phone": "999777004",
"price": 614,
"price_set": {
"amount": "100",
"currency_code": "CLP"
},
"requested_fulfillment_service_id": "third_party_fulfillment_service_id",
"source": "Chazki",
"title": "CHAZKI - NEXT DAY",
"tax_lines": [
{
"price": 19,
"rate": 0.19,
"title": "VAT",
"price_set": {
"shop_money": null,
"presentment_money": null
},
"channel_liable": false
}
],
"discount_allocations": [
{
"amount": 5,
"discount_application_index": 2,
"amount_set": {
"amount": null,
"currency_code": null
}
}
]
}
]
}'
{
"success": true,
"message": "Order Generated",
"response": {
"trackCode": 4693237498081,
"paymentMethodID": "PAGADO",
"paymentProofID": "BOLETA",
"serviceID": "REGULAR",
"packageEnvelope": "Paquete",
"packageWeight": 800,
"packageSizeID": "M",
"packageQuantity": 1,
"productDescription": "Umbro Shirts | Authentic Umbro Mexico",
"productPrice": 160,
"reverseLogistic": "NO",
"crossdocking": "NO",
"pickUpBranchID": "",
"pickUpAddress": "Siete de Noviembre, 07840 Ciudad de Mexico",
"pickUpPostalCode": "…",
"pickUpAddressReference": "Siete de Noviembre, 07840 Ciudad de Mexico,07840 Ciudad de Mexico DF,Mexico",
"pickUpPrimaryReference": "Ciudad de Mexico",
"pickUpSecondaryReference": "Ciudad de Mexico",
"pickUpNotes": "1010",
"pickUpContactName": "sucursal Paseo",
"pickUpContactPhone": "123456789",
"pickUpContactDocumentTypeID": "DNI",
"pickUpContactDocumentNumber": "xxxxxxxxx",
"pickUpContactEmail": "xxxxxx@yyyyyy.zzz",
"dropBranchID": "…",
"dropAddress": "Av. Ribera de San Cosme 74, San Rafael, 06470 Ciudad de Mexico, CDMX, Mexico",
"dropPostalCode": "",
"dropAddressReference": "Av. Ribera de San Cosme 74, San Rafael, 06470 Ciudad de Mexico, CDMX, Mexico, mexico, Ciudad de Mexico, Mexico",
"dropPrimaryReference": "MEXICO",
"dropSecondaryReference": "CIUDAD DE MEXICO",
"dropNotes": "",
"dropContactName": "name_seller",
"dropContactPhone": "123456789",
"dropContactDocumentTypeID": "DNI",
"dropContactDocumentNumber": "xxxxxxxxx",
"dropContactEmail": "xxxxxx@yyyyyy.zzz",
"packages": [
{
"ClientPackageID": "34572399894",
"envelope": "PAQUETE",
"weight": 200,
"weightUnit": "gramos",
"size": "M",
"quantity": 1,
"name": "Umbro Shirts | Authentic Umbro Mexico",
"currency": "CLP",
"unitaryProductPrice": "150"
}
]
}
}Successfull operation
Code used to generate a shopify token for the first time.
XXXXXXXXXXXXXXXXXXXXXXXSecurity code that identifies an authentic shopify client.
XXXXXXXXXXXXXXXXXXXXXXXXSecurity code that is stored.
XXXXXXXXXXXXXXXXXXXXXXXXSecurity method that identifies a client from chazki to shopify.
s%3Apruebasintegracionmyshopifycomcreandochazki1015Url that identifies a shop
https://pruebasintegracion.myshopify.com/Key that allows query responses
XXXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXCompany identifier, it is a hash generated by Chazki to identify the company, it is obtained once the company has been generated within Chazki by the commercial area.
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXUrl that identifies a shop
https://pruebasintegracion.myshopify.com/Key that allows query responses
XXXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXCode used as a identifier of a webhook subscription
xxxxxxxxxxxx/endpoint/{my_path_variable}