Integration guide

Atlas Pickup Points saves pickup point details to the Shopify order metafield.

How to access order metafields via API?

Shopify Admin REST API Shopify reference

GET https://{shop}.myshopify.com/admin/api/2024-01/orders/{order_id}/metafields.json

Shopify Admin GraphQL API Shopify reference

# POST https://{shop}.myshopify.com/admin/api/2024-01/graphql.json
query GetOrderWithPickupPoint($orderId: ID!) {
  order(id: $orderId) {
    id
    pickupPoint: metafield(namespace: "atlas_pickup_points", key: "point") {
      value
    }
  }
}

Webhooks Shopify reference

To ensure the metafield appears in the webhook payload, you must subscribe to it using the metafieldNamespaces attribute and specify atlas_pickup_points.

Learn more about metafield shape in the specification: metafield specification