Get a country field using Admin API

This guide explains how to use the Admin API to return a country field collected during checkout.
Access scopes
To use the Admin API to access the information collected in the checkout, your app needs to request the read_order access scope for a ShopBase store. For more information on requesting access scopes when your app is installed, see API Access Scopes​
Collect a country field on the checkout
For this tutorial, you'll set the address of your shop to Brazil (since Brazilian merchants are required to collect a tax ID for government invoicing) and then complete checkout from your storefront:
1.Set the address of your shop to Brazil. Remember to change your address back when you've completed the tutorial.
1.From your storefront, add a product to your cart and then complete a checkout.
2.Complete the checkout.
Get the country field for an order
To get the client country code, use the ShopBase Admin API to retrieve the order.
GET https://shop-name.onshopbase.com/admin/orders/{order_id}.json
SAMPLE RESPONSE
1
{
2
   "order":{
3
        ...     
4
      "additional_information":null,
5
      "allow_refund":false,
6
      "client_country_code":"BR",
7
      ...
8
      "total_line_items_discount":0,
9
      "total_line_items_price":200,
10
      "total_price":200,
11
      "total_quantity":2,
12
      "total_tax":0,
13
      "total_weight":0,
14
      "total_weight_in_gram":0,
15
      "transaction_id":0,
16
      ...
17
   }
18
}
Copied!
Additional information
For additional information on editing orders, refer to the Admin API reference.

Manage fulfillments with Fulfillment and FulfillmentService resources

Next - Integrate a payment gateway

How to create your payment gateway on ShopBase

Last modified 11mo ago

Copy link

Contents

Access scopes

Collect a country field on the checkout

Get the country field for an order

Additional information