UPS® Global Checkout GraphQL API

Welcome to the UPS® Global Checkout GraphQL API reference documentation.

The API lets you build apps and integrations that extend and enhance your experience with UPS. This page will help you get up and running with UPS®' Global Checkout GraphQL API.

Authentication

To access the UPS® Global Checkout GraphQL API, you will authenticate with OAuth

. Once authenticated, you will need to pass the your shipper number in all API requests so the server with the header shipperNumber.

YOUR SHIPPER NUMBER

shipperNumber: 5490YY

cURL
1
2
3
4
5
curl -X POST \
https://onlinetools.ups.com/api/globalcheckout/v1/graphql \
-H 'Content-Type: application/json' \
-H 'shipperNumber: 5490YY' \
-d '{your_query}'

Queries

GraphQL queries are executed by sending HTTP requests to the endpoint:

posthttps://onlinetools.ups.com/api/globalcheckout/v1/graphql

Queries begin with one of the objects listed under QueryRoot. The QueryRoot is the schema's entry-point for queries.Queries are equivalent to making a GET request in REST. The example shown is a query to get the id and description of the first 3 items.

cURL
1
2
3
4
5
6
7
curl -X POST \
https://onlinetools.ups.com/api/globalcheckout/v1/graphql \
-H 'Content-Type: application/json' \
-H 'shipperNumber: 5490YY' \
-d '{
    "query": "{ landedCosts(first: 10) { edges { node { id landedCostGuaranteeCode } }} }"
  }'

Was this page helpful?