Queries#

Queries are read-only operations used to fetch data from the API. All queries are sent as POST requests to https://afosto.app/graphql.

Note:Some queries (such as account) require a user token obtained via logInCustomer. Most other queries work with a standard API key.

account#

Fetch the currently authenticated account. Requires a user token.

No arguments.

Returns: Account

Name	Type	Required	Description
`email`	String!	Required	Email address
`given_name`	String!	Required	First name
`additional_name`	String!	Required	Middle name
`family_name`	String!	Required	Last name

Example#

query {
  account {
    email
    given_name
    family_name
    orders(first: 10) {
      edges {
        node {
          id
          number
          total
        }
      }
    }
  }
}

address#

Fetch an address by ID.

Arguments:

Name	Type	Required	Description
`id`	String!	Required	The ID of the address

Returns: Address

Name	Type	Required	Description
`id`	ID!	Required	The ID
`address_line_1`	String!	Required	Street address line 1
`address_line_2`	String	Optional	Street address line 2
`locality`	String!	Required	City / locality

Example#

query GetAddress($id: String!) {
  address(id: $id) {
    id
    address_line_1
    address_line_2
    locality
    postal_code
    country_code
    administrative_area
    dependent_locality
  }
}

{
  "id": "adr_8f2e4a71-b3c9-4d5e-a1f0-6789abcd0123"
}

business#

Fetch a physical store location by ID.

Arguments:

Name	Type	Required	Description
`id`	String!	Required	The ID of the business

Returns: Business

Name	Type	Required	Description
`id`	ID!	Required	The ID
`type`	String!	Required	Business type
`name`	String!	Required	Name
`email`	String	Optional	Email address

Example#

query GetBusiness($id: String!) {
  business(id: $id) {
    id
    name
    email
    addressing {
      visiting {
        address_line_1
        locality
        postal_code
        country_code
      }
    }
    openings {
      day
      open
      close
    }
  }
}

{
  "id": "bus_3c7d1e5f-9a2b-4f8e-b6d0-1234abcd5678"
}

businesses#

Fetch a paginated list of business locations.

Arguments:

Name	Type	Required	Description
`first`	Int	Optional	Number of items to returnDefault: `10`
`after`	String	Optional	Cursor for forward pagination
`before`	String	Optional	Cursor for backward pagination
`type`	String	Optional	Filter by business type
`sort`	BusinessesSortInput▾	Optional	Sort order

Returns: Business

Name	Type	Required	Description
`id`	ID!	Required	The ID
`type`	String!	Required	Business type
`name`	String!	Required	Name
`email`	String	Optional	Email address

Example#

query ListBusinesses($first: Int) {
  businesses(first: $first) {
    edges {
      node {
        id
        name
        type
        email
        addressing {
          visiting {
            address_line_1
            locality
            country_code
          }
        }
        openings {
          day
          open
          close
        }
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "first": 10
}

cart#

Fetch a cart by ID.

Arguments:

Name	Type	Required	Description
`id`	String!	Required	The ID of the cart
`intent`	TrackingEvent▾	Optional	Optional tracking event

Returns: Cart

Name	Type	Required	Description
`id`	ID!	Required	The ID of the cart
`number`	String!	Required	Cart number
`total`	Money!▾	Required	Total value
`subtotal`	Money!▾	Required	Total before discounts

Example#

query GetCart($id: String!) {
  cart(id: $id) {
    id
    number
    total
    currency
    is_including_vat
    items {
      label
      quantity
      total
      sku
    }
    delivery {
      address {
        address_line_1
        locality
        postal_code
        country_code
      }
    }
    checkout {
      is_valid
      url
    }
  }
}

{"id": "crt_72fca344-2a6f-4c3e-b4ca-029920b2522a"}

channel#

Fetch a channel (storefront) by ID. If no ID is provided, the default channel is returned.

Arguments:

Name	Type	Required	Description
`id`	String	Optional	The ID of the channel (optional — omit for default)

Returns: Channel

Name	Type	Required	Description
`id`	ID!	Required	The ID
`name`	String!	Required	Channel name
`type`	String!	Required	Channel type
`locale`	String!	Required	Locale (e.g. nl_NL)

Example#

query GetChannel {
  channel {
    id
    name
    locale
    branding {
      colors {
        primary
        secondary
      }
    }
  }
}

contact#

Fetch a contact by ID.

Arguments:

Name	Type	Required	Description
`id`	String!	Required	The ID of the contact
`version`	String	Optional	Optional version string for cache busting

Returns: Contact

Name	Type	Required	Description
`id`	ID!	Required	The ID
`email`	String!	Required	Email address
`given_name`	String!	Required	First name
`family_name`	String	Optional	Last name

Example#

query GetContact($id: String!) {
  contact(id: $id) {
    id
    email
    given_name
    family_name
    is_verified
    addressing {
      shipping {
        primary {
          address_line_1
          locality
          postal_code
          country_code
        }
      }
    }
  }
}

{
  "id": "con_a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

invoice#

Fetch an invoice by ID.

Arguments:

Name	Type	Required	Description
`id`	String!	Required	The ID of the invoice

Returns: Invoice

Name	Type	Required	Description
`id`	ID!	Required	The ID
`number`	String!	Required	Invoice number
`total`	Money!▾	Required	Total value
`currency`	Currency!▾	Required	Currency code

Example#

query GetInvoice($id: String!) {
  invoice(id: $id) {
    id
    number
    total
    currency
    pdf_url
    billing_address {
      address_line_1
      locality
      postal_code
      country_code
    }
    lines {
      label
      quantity
      total
    }
    created_at
  }
}

{
  "id": "inv_d4e5f6a7-b8c9-0123-4567-890abcdef012"
}

item#

Fetch a single collection item (physical inventory item) by ID.

Arguments:

Name	Type	Required	Description
`id`	String!	Required	The ID of the item

Returns: CollectionItem

Name	Type	Required	Description
`id`	ID!	Required	The ID
`sku`	String!	Required	SKU
`label`	String!	Required	Display name
`product`	Product!▾	Required	The associated product

Example#

query GetItem($id: String!) {
  item(id: $id) {
    id
    sku
    label
    status
    is_available
    is_allocated
    product {
      sku
      label
    }
    order {
      id
      number
    }
  }
}

{
  "id": "ci_5a6b7c8d-9e0f-1234-5678-9abcdef01234"
}

items#

Fetch a paginated list of collection items (inventory items) with filtering.

Arguments:

Name	Type	Required	Description
`first`	Int	Optional	Number of items to returnDefault: `10`
`after`	String	Optional	Cursor for forward pagination
`before`	String	Optional	Cursor for backward pagination
`filters`	CollectionItemFilterInput!▾	Required	Filter criteria

Returns: CollectionItem

Name	Type	Required	Description
`id`	ID!	Required	The ID
`sku`	String!	Required	SKU
`label`	String!	Required	Display name
`product`	Product!▾	Required	The associated product

Example#

query ListItems($first: Int, $filters: CollectionItemFilterInput!) {
  items(first: $first, filters: $filters) {
    edges {
      node {
        id
        sku
        label
        status
        is_available
        is_allocated
        quantity
        order {
          id
          number
        }
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "first": 10,
  "filters": {
    "order_id": "ord_72fca344-2a6f-4c3e-b4ca-029920b2522a"
  }
}

order#

Fetch an order by ID.

Arguments:

Name	Type	Required	Description
`id`	String!	Required	The ID of the order
`options`	OrderOptionsInput▾	Optional	Options to control included pricing data

Returns: Order

Name	Type	Required	Description
`id`	ID!	Required	The ID
`number`	String!	Required	Order number
`total`	Money!▾	Required	Total value
`currency`	Currency!▾	Required	Currency code

Example#

query GetOrder($id: String!) {
  order(id: $id) {
    id
    number
    status
    total
    currency
    ordered_at
    customer {
      contact {
        email
        given_name
        family_name
      }
    }
    items {
      label
      sku
      quantity
      total
    }
    payments {
      amount
      details {
        status
      }
    }
  }
}

{"id": "ord_72fca344-2a6f-4c3e-b4ca-029920b2522a"}

orders#

Fetch a paginated list of orders with filtering.

Arguments:

Name	Type	Required	Description
`first`	Int	Optional	Number of items to returnDefault: `10`
`after`	String	Optional	Cursor for forward pagination
`before`	String	Optional	Cursor for backward pagination
`id`	IdFilter▾	Optional	Filter by order ID(s)
`progress`	OrderProgressFilter▾	Optional	Filter by progress
`created_at`	InequalityFilter▾	Optional	Filter by creation date
`number`	NumberFilter▾	Optional	Filter by order number
`email`	String	Optional	Filter by customer email

Returns: Order

Name	Type	Required	Description
`id`	ID!	Required	The ID
`number`	String!	Required	Order number
`total`	Money!▾	Required	Total value
`currency`	Currency!▾	Required	Currency code

Example#

query ListOrders($first: Int, $email: String) {
  orders(first: $first, email: $email) {
    edges {
      node {
        id
        number
        status
        total
        currency
        ordered_at
        customer {
          contact {
            email
            given_name
            family_name
          }
        }
        items {
          label
          sku
          quantity
          total
        }
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "first": 10,
  "email": "[email protected]"
}

organisation#

Fetch an organisation by ID.

Arguments:

Name	Type	Required	Description
`id`	String!	Required	The ID of the organisation
`version`	String	Optional	Optional version string

Returns: Organisation

Name	Type	Required	Description
`id`	ID!	Required	The ID
`name`	String	Optional	Organisation name
`type`	OrganisationType!▾	Required	Type of organisation
`number`	String	Optional	Organisation number

Example#

query GetOrganisation($id: String!) {
  organisation(id: $id) {
    id
    name
    coc_number
    registration {
      vat_number
      country_code
    }
    addressing {
      billing {
        primary {
          address_line_1
          locality
          country_code
        }
      }
    }
  }
}

{
  "id": "org_b2c3d4e5-f6a7-8901-2345-67890abcdef0"
}

parcel#

Fetch a parcel (shipment) by ID.

Arguments:

Name	Type	Required	Description
`id`	String!	Required	The ID of the parcel

Returns: Parcel

Name	Type	Required	Description
`id`	ID!	Required	The ID
`number`	String!	Required	Parcel number
`status`	ParcelStatus!▾	Required	Current status
`track_trace`	TrackTrace!▾	Required	Track & trace details

Example#

query GetParcel($id: String!) {
  parcel(id: $id) {
    id
    number
    status
    track_trace {
      number
      url
    }
    items {
      sku
      label
    }
    created_at
  }
}

{
  "id": "pcl_c3d4e5f6-a7b8-9012-3456-7890abcdef01"
}

parcels#

Fetch a paginated list of parcels with filtering.

Arguments:

Name	Type	Required	Description
`first`	Int	Optional	Number of items to returnDefault: `10`
`after`	String	Optional	Cursor for forward pagination
`id`	IdFilter▾	Optional	Filter by parcel ID(s)
`delivery_id`	IdFilter▾	Optional	Filter by delivery ID
`track_trace_number`	String	Optional	Filter by track & trace number

Returns: Parcel

Name	Type	Required	Description
`id`	ID!	Required	The ID
`number`	String!	Required	Parcel number
`status`	ParcelStatus!▾	Required	Current status
`track_trace`	TrackTrace!▾	Required	Track & trace details

Example#

query ListParcels($first: Int) {
  parcels(first: $first) {
    edges {
      node {
        id
        number
        status
        track_trace {
          number
          url
        }
        created_at
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "first": 10
}

paymentMethod#

Fetch a payment method by ID.

Arguments:

Name	Type	Required	Description
`id`	String!	Required	The ID of the payment method

Returns: PaymentMethod

Name	Type	Required	Description
`id`	ID!	Required	The ID
`code`	String!	Required	Payment method code
`name`	String!	Required	Display name
`is_enabled`	Boolean!	Required	Whether enabled

Example#

query GetPaymentMethod($id: String!) {
  paymentMethod(id: $id) {
    id
    code
    name
    description
    is_enabled
    pricing {
      amount
      is_including_vat
    }
    issuers {
      code
      name
    }
  }
}

{
  "id": "pm_e5f6a7b8-c9d0-1234-5678-90abcdef0123"
}

paymentMethods#

Fetch a paginated list of available payment methods.

Arguments:

Name	Type	Required	Description
`first`	Int	Optional	Number of items to returnDefault: `10`
`after`	String	Optional	Cursor for forward pagination
`before`	String	Optional	Cursor for backward pagination
`codes`	[String!]	Optional	Filter by payment method codes
`is_manual`	Boolean	Optional	Filter by manual payment methods
`sort`	PaymentMethodsOrderByInput▾	Optional	Sort order

Returns: PaymentMethod

Name	Type	Required	Description
`id`	ID!	Required	The ID
`code`	String!	Required	Payment method code
`name`	String!	Required	Display name
`is_enabled`	Boolean!	Required	Whether enabled

Example#

query ListPaymentMethods($first: Int) {
  paymentMethods(first: $first) {
    edges {
      node {
        id
        code
        name
        is_enabled
        is_manual
        pricing {
          amount
        }
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "first": 20
}

phoneNumber#

Fetch a phone number by ID.

Arguments:

Name	Type	Required	Description
`id`	String!	Required	The ID of the phone number

Returns: PhoneNumber

Name	Type	Required	Description
`id`	ID!	Required	The ID
`country_code`	String!	Required	Country calling code
`national`	String!	Required	National number
`number`	String!	Required	Full international number

Example#

query GetPhoneNumber($id: String!) {
  phoneNumber(id: $id) {
    id
    country_code
    national
    number
  }
}

{
  "id": "phn_f6a7b8c9-d0e1-2345-6789-0abcdef12345"
}

price#

Fetch a price from a price list by item ID.

Arguments:

Name	Type	Required	Description
`id`	String!	Required	The ID of the price entry

Returns: Price

Name	Type	Required	Description
`id`	ID!	Required	The ID
`sku`	String!	Required	SKU this price applies to
`amount`	Money!▾	Required	The price amount
`original_amount`	Money!▾	Required	Original undiscounted amount

Example#

query GetPrice($id: String!) {
  price(id: $id) {
    id
    sku
    amount
    original_amount
    list {
      id
      name
    }
    vat {
      percentage
    }
  }
}

{
  "id": "prc_a7b8c9d0-e1f2-3456-7890-abcdef012345"
}

product#

Fetch a product by SKU.

Arguments:

Name	Type	Required	Description
`sku`	String!	Required	The SKU of the product

Returns: Product

Name	Type	Required	Description
`sku`	String!	Required	SKU
`label`	String!	Required	Display name
`slug`	String!	Required	URL slug
`brand`	String!	Required	Brand name

Example#

query GetProduct($sku: String!) {
  product(sku: $sku) {
    sku
    label
    brand
    images {
      url
      position
    }
    filters {
      key
      value
    }
    prices {
      amount
      list {
        name
      }
    }
  }
}

{"sku": "BLK-HOODIE-M"}

products#

Fetch products by a list of SKUs.

Arguments:

Name	Type	Required	Description
`skus`	[String!]!	Required	List of SKUs to fetch

Returns: Product

Name	Type	Required	Description
`sku`	String!	Required	SKU
`label`	String!	Required	Display name
`slug`	String!	Required	URL slug
`brand`	String!	Required	Brand name

Example#

query GetProducts($skus: [String!]!) {
  products(skus: $skus) {
    sku
    label
    brand
    images {
      url
      position
    }
    prices {
      amount
      list {
        name
      }
    }
    created_at
  }
}

{
  "skus": ["BLK-HOODIE-M", "WHT-TEE-L", "NVY-JOGGER-S"]
}

productViewingHistory#

Fetch a product viewing history list by token.

Arguments:

Name	Type	Required	Description
`token`	String!	Required	The token of the viewing history

Returns: ProductViewingHistory

Name	Type	Required	Description
`label`	String!	Required	Label
`token`	String!	Required	Token identifier
`items`	[ViewingHistoryItem!]!▾	Required	Viewed items
`expires_at`	DateTime!▾	Required	Expiration date

Example#

query GetViewingHistory($token: String!) {
  productViewingHistory(token: $token) {
    token
    items {
      sku
      viewed_at
    }
  }
}

{
  "token": "pvh_b8c9d0e1-f2a3-4567-890a-bcdef0123456"
}

wishlist#

Fetch a wishlist by token.

Arguments:

Name	Type	Required	Description
`token`	String!	Required	The token of the wishlist

Returns: Wishlist

Name	Type	Required	Description
`label`	String!	Required	Label
`token`	String!	Required	Token identifier
`items`	[WishlistItem!]!▾	Required	Items on the wishlist
`expires_at`	DateTime!▾	Required	Expiration date

Example#

query GetWishlist($token: String!) {
  wishlist(token: $token) {
    token
    label
    items {
      sku
      added_at
    }
  }
}

{
  "token": "wl_c9d0e1f2-a3b4-5678-90ab-cdef01234567"
}

returnMethod#

Fetch a return method by ID.

Arguments:

Name	Type	Required	Description
`id`	String!	Required	The ID of the return method

Returns: ReturnMethod

Name	Type	Required	Description
`id`	String!	Required	The ID
`name`	String!	Required	Display name
`is_enabled`	Boolean!	Required	Whether enabled
`carrier`	String	Optional	Carrier name

Example#

query GetReturnMethod($id: String!) {
  returnMethod(id: $id) {
    id
    name
    is_enabled
    carrier
    description
    pricing {
      amount
    }
  }
}

{
  "id": "rm_d0e1f2a3-b4c5-6789-0abc-def012345678"
}

returnMethods#

Fetch a paginated list of return methods.

Arguments:

Name	Type	Required	Description
`first`	Int	Optional	Number of items to returnDefault: `10`
`after`	String	Optional	Cursor for forward pagination
`query`	QueryFilter	Optional	Search filter string

Returns: ReturnMethod

Name	Type	Required	Description
`id`	String!	Required	The ID
`name`	String!	Required	Display name
`is_enabled`	Boolean!	Required	Whether enabled
`carrier`	String	Optional	Carrier name

Example#

query ListReturnMethods($first: Int) {
  returnMethods(first: $first) {
    edges {
      node {
        id
        name
        is_enabled
        carrier
        pricing {
          amount
        }
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "first": 10
}

shippingMethod#

Fetch a shipping method by ID.

Arguments:

Name	Type	Required	Description
`id`	String!	Required	The ID of the shipping method

Returns: ShippingMethod

Name	Type	Required	Description
`id`	String!	Required	The ID
`name`	String!	Required	Display name
`is_enabled`	Boolean!	Required	Whether enabled
`carrier`	String	Optional	Carrier name

Example#

query GetShippingMethod($id: String!) {
  shippingMethod(id: $id) {
    id
    name
    is_enabled
    carrier
    pricing {
      amount
    }
    is_same_day
    is_pickup_point
    is_signed
  }
}

{
  "id": "sm_e1f2a3b4-c5d6-7890-abcd-ef0123456789"
}

shippingMethods#

Fetch a paginated list of shipping methods.

Arguments:

Name	Type	Required	Description
`first`	Int	Optional	Number of items to returnDefault: `10`
`after`	String	Optional	Cursor for forward pagination
`before`	String	Optional	Cursor for backward pagination
`sort`	ShippingMethodsOrderByInput▾	Optional	Sort order

Returns: ShippingMethod

Name	Type	Required	Description
`id`	String!	Required	The ID
`name`	String!	Required	Display name
`is_enabled`	Boolean!	Required	Whether enabled
`carrier`	String	Optional	Carrier name

Example#

query ListShippingMethods($first: Int) {
  shippingMethods(first: $first) {
    edges {
      node {
        id
        name
        is_enabled
        carrier
        is_same_day
        is_pickup_point
        pricing {
          amount
        }
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "first": 20
}