Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Inputs

Overview

LinkAdditionalFieldValueInput

code
String!,non-null

Additional field's code

value
String!,non-null

Additional field's value

Sample
{ "code": "Example String", "value": "Example String" }

StringListAdditionalFieldValueInput

code
String!,non-null

Additional field's code

value
String!,non-null

Additional field's value

Sample
{ "code": "Example String", "value": "Example String" }

MultipleValuesStringListAdditionalFieldValueInput

code
String!,non-null

Additional field's code

value
[String!]!,non-null

Values of the additional field

Sample
{ "code": "Example String", "value": [ "Example String" ] }

NumericAdditionalFieldValueInput

code
String!,non-null

Additional field's code

value
String!,non-null

Additional field's value

Sample
{ "code": "Example String", "value": "Example String" }

RegexAdditionalFieldValueInput

code
String!,non-null

Additional field's code

value
String!,non-null

Additional field's value

Sample
{ "code": "Example String", "value": "Example String" }

StringAdditionalFieldValueInput

code
String!,non-null

Additional field's code

value
String!,non-null

Additional field's value

Sample
{ "code": "Example String", "value": "Example String" }

TextAreaAdditionalFieldValueInput

code
String!,non-null

Additional field's code

value
String!,non-null

Additional field's value

Sample
{ "code": "Example String", "value": "Example String" }

OfferFilter

Filter to apply on offers

product

Filter offers by product

premium

If true, returns only offers of premium shops. If false, returns only offers of shops that are not premium. Default to null, returns offers regardless of the shop's premium status

active

If false returns all offers. If true return only active offers. Default to true

states

List of offer states

channels

List of the channel codes to filter with. If specified, only offers that can be sold on the specified channel(s) will be returned. If not, offers will be returned regardless of their channels.

Filter used to pick prices on specifics criteria

Sample
{ "product": { "__typename": "OfferProductFilter" }, "premium": true, "active": true, "states": [ { "__typename": "OfferStateFilter" } ], "channels": [ { "__typename": "OfferChannelFilter" } ], "price": { "__typename": "OfferPriceFilter" } }

OfferPriceFilter

Represents the filter to pick prices according specifics criteria

customerOrganizationId

For Customer Pricing users only. Customer identifier code the API will use to return all prices and applicable price for this organization. Ignored if value does not exist.

Filter used to pick prices on a specific channel

Sample
{ "customerOrganizationId": "Example String", "channel": { "__typename": "OfferChannelFilter" } }
Referenced in

OfferChannelFilter

Represents a channel filter

code
String!,non-null

The channel code

Sample
{ "code": "Example String" }

OfferStateFilter

Represents an offer state

code
String!,non-null

Offer state code

Sample
{ "code": "Example String" }
Referenced in

Scalars

Overview