# Delivery Gateway Documentation > Integration documentation for Delivery Gateway, a logistics and shipping platform for e-commerce merchants. Covers the checkout widget, backend integration, the Merchant API (orders, shipments, tracking, webhooks) and the Public API. This file contains all documentation content in a single document following the llmstxt.org standard. ## Authentication and authorization The Merchant API is available at `https://api.sandbox.deliverygateway.io/graphql/merchant` in the sandbox environment and `https://api.deliverygateway.io/graphql/merchant` in the production environment. To make any request to this single endpoint, you must create an access token using the Bearer Authentication schema. You can manage your access tokens via either the web interface or the API. An access token provides authentication and role-based authorization: each role has its own set of permissions. When creating a token, you must select one or more roles and the corresponding permissions. ## Create Bearer token on the web interface 1. [Log in to the Delivery Gateway admin interface](/admin/get-started/login). 1. Find **Access Tokens** on the left. 1. In the top right corner, click **New Access Tokens**. 1. Set a name and optionally, an expiration date. If you leave the expiration date empty, your token will never expire. For security reasons, we recommend regularly regenerating your tokens. 1. In the **Roles** dropdown menu, select all the roles you need. 1. Optionally, create an allowlist for the token: click **Add** to set IP addresses and HTTP referers that are allowed to send requests. You can add as many as you need: click **Add** again for more input fields. 1. When done, click **Create**. 1. Copy your token from the dialog. Note that if you close the dialog without copying the token, you won't be able to retrieve it again. ## Create Bearer token with the API Create a token with the `createToken` mutation. It requires a token name and the roles assigned to the token. You can set multiple roles in a comma-separated list. ```graphql mutation { createToken( input: { name: "my_new_token", roles: [MERCHANT_CONFIGURATION, MERCHANT_OPERATOR] } ) } ``` You can create an allowlist using the `allowlist` field. Set IP addresses and HTTP referers that are allowed to send requests: ```graphql mutation { createToken( input: { name: "my_new_token", roles: [MERCHANT_CONFIGURATION, MERCHANT_OPERATOR, MERCHANT_WEBHOOK], allowlist: { ips: "192.0.2.1", referers: "https://acmecorp.com" } } ) } ``` --- ## Connect the docs to your AI assistant (MCP) # Connect the docs to your AI assistant These docs are available over the **Model Context Protocol (MCP)**, so your coding assistant can search them directly and answer with links back to the exact section — instead of guessing from stale training data. **Server URL** ```text https://T3F23WL577.algolia.net/mcp/1/pBfsB0jvSvOHvUzkKTVcLA/mcp ``` No API key, no sign-up, no authentication. The connection is **read-only**: it searches our public documentation and nothing else. ## Add it to your client ```bash claude mcp add --transport http dgw-docs \ https://T3F23WL577.algolia.net/mcp/1/pBfsB0jvSvOHvUzkKTVcLA/mcp ``` Verify with `claude mcp list`. 1. Open **Settings → Security and login** and turn on **Developer mode**. 2. Open [ChatGPT Plugins](https://chatgpt.com/plugins) and click the **plus** button. 3. Set the name to **Delivery Gateway Docs** and add a short description. 4. Under **Connection**, enter the MCP server URL: `https://T3F23WL577.algolia.net/mcp/1/pBfsB0jvSvOHvUzkKTVcLA/mcp` 5. Create the connection, then review the discovered tools and metadata. 6. Start a new conversation and add **Delivery Gateway Docs** from the tools menu. :::note Availability Developer mode availability depends on your account and workspace policy. See the [official OpenAI setup guide](https://developers.openai.com/plugins/deploy/connect-chatgpt). ::: 1. Open [Settings → Connectors](https://claude.ai/settings/connectors) and click **Add custom connector**. 2. **Name:** Delivery Gateway Docs 3. **Remote MCP server URL:** `https://T3F23WL577.algolia.net/mcp/1/pBfsB0jvSvOHvUzkKTVcLA/mcp` 4. Leave **Advanced settings** empty, click **Add**, then **Connect**. 5. Enable the connector from the prompt bar. Tools appear in new conversations. :::note If you see a sign-in error The server needs no authentication, but the connector flow may still report that it *couldn't register with the sign-in service*. Press **Connect** again on the existing entry in your connectors list; if it persists, remove the connector and add it back. Adding the same URL twice returns *a server with this URL already exists* — that means the first attempt did create it, so connect to that one rather than adding a new one. ::: Add to `~/.cursor/mcp.json` (or `%USERPROFILE%\.cursor\mcp.json`): ```json { "mcpServers": { "dgw-docs": { "url": "https://T3F23WL577.algolia.net/mcp/1/pBfsB0jvSvOHvUzkKTVcLA/mcp" } } } ``` Or: **Cursor Settings → Tools and MCPs → Add MCP Server**, paste the URL, set Authentication to *none*, then enable it from the prompt bar. Add to `.vscode/mcp.json` in your workspace: ```json { "servers": { "dgw-docs": { "type": "http", "url": "https://T3F23WL577.algolia.net/mcp/1/pBfsB0jvSvOHvUzkKTVcLA/mcp" } } } ``` ## What your assistant gets | Tool | What it does | | --- | --- | | `algolia_search_index_docs` | Searches every published documentation page. Accepts up to five query variations in one call, each with its own facet filters. | | `algolia_search_for_facet_values` | Lists available values for a facet (`type`, `lang`, `version`). Rarely needed directly. | Every hit carries a `url` **and** an `anchor`, so the assistant can link to the exact section rather than the page. :::tip Get the code samples too Code blocks are not part of the search index — a hit tells your assistant *where* the answer lives, not what the snippet says. Deeper section records (heading-only results) may come back with `content: null` for the same reason. Every page is also published as raw Markdown: append `.md` to any docs URL, or point your assistant at [`/llms-full.txt`](/llms-full.txt). Most agents will fetch these on their own once they have the URL. ::: ## Prompts to start with ```text Using the Delivery Gateway docs, walk me through the minimal checkout integration — what goes on the backend versus the frontend? ``` ```text Search the Delivery Gateway docs for how to create a webhook and verify its signature, then show me the createWebhook mutation inputs. ``` ## Plain-text alternative If your tooling has no MCP support, the same content is available as static files: | File | Contents | | --- | --- | | [`/llms.txt`](/llms.txt) | Index of every documentation page | | [`/llms-full.txt`](/llms-full.txt) | Complete documentation in one file | | [`/llms-integration.txt`](/llms-integration.txt) | Getting started and integration guides only | | [`/llms-merchant-api.txt`](/llms-merchant-api.txt) | Merchant API reference only | Any page also returns Markdown if you append `.md` to its URL. ## Limits - **Read-only, documentation only.** The connector cannot reach your account, orders or shipments. For that, use the [Merchant API](/api/merchant/introduction). - **Public content only.** Nothing behind authentication is exposed. - **Search queries reach Algolia.** Tool calls send your query, plus the original prompt that triggered them, to Algolia for search analytics. - **Not a support channel.** For account-specific questions, contact the [Help Center](https://help.deliverygateway.io/). - Answers are generated by your assistant. Verify against the linked page before shipping to production. --- ## Quickstart Delivery Gateway is an all-in-one logistics platform designed to simplify and automate your e-commerce shipping processes. We provide a single, centralized solution that connects your webshop with multiple courier service providers, enabling seamless delivery management from a single interface. Our platform helps you save time, reduce costs, and improve customer satisfaction by offering flexible delivery options and transparent tracking. ## Integrate Delivery Gateway to your platform Delivery Gateway offers two types of integrations: - A lightweight frontend integration: you connect DGW to your website and our Web Plugin will do the rest. - Full backend integration: take advantage of our GraphQL API to manage the entire ordering and shipping process with all the features Delivery Gateway offers. In this quickstart guide, we'll show you a quick frontend integration by setting up a delivery method selector. When your customer wants to place an order, they will be able to select from home delivery or pickup point delivery: when they select one, its available options - providers, locations, and so on - will open in a separate modal. :::tip For all available options, read the [full guide about frontend integration](/dev/how-tos/frontend-integration/set-up-dgw-on-frontend). ::: ### Before you start Before you start the integration process, we recommend familiarizing yourself with the most important parts of Delivery Gateway. Read about: - [The Admin Dashboard](/admin/get-started/dashboard). - [They key concepts of Delivery Gateway](/admin/get-started/key-dgw-concepts). ### Part 1: Get your merchant ID You need the merchant ID to integrate Delivery Gateway to your website. 1. [Log in to the Dashboard](/admin/get-started/login). 1. Select your merchant on the top left corner. 1. Go to **Merchant**. 1. Copy the ID from under the merchant name. ### Part 2: Enable delivery options 1. In the **Merchant** configuration, find **Display**. 1. Enable the delivery types you want to offer. ### Part 3: Connect Delivery Gateway to your website Add the following script to your website where you want to use the Delivery Gateway integration: ```html ``` The script calls the `window.DGWOnLoad` callback (if present) with the global DGW object as its parameter. The global DGW object will also be accessible as `window.DGW`. ### Part 4: Configure the DGW widget Mount an instance of the `DGW` object in a function and call that function: ```js function deliveryMethodSelector(DGW) { DGW.mount({ containerId: "delivery-gateway", merchantId: "5441a8c6-5dfb-4744-b6ae-f0d221d4718c", view: { type: "delivery-method-selection", openSelectedMethodInModal: true, operatorsAsSeparateMethods: true, }, }); } if (window.DGW) { deliveryMethodSelector(window.DGW); } else { window.DGWOnLoad = deliveryMethodSelector; } ``` Replace the following values with your own: - `containerId`: The HTML ID of the container that will contain the Delivery Gateway widget. - `merchantId`: Paste your merchant ID here. Your website should now be able to allow customers to select from different delivery methods. ### Part 5: Next steps To start using Delivery Gateway, you need to configure a few more things: - [Enable at least one provider](/admin/how-tos/provider-config/enable-provider). - [Create a pricing rule](/admin/how-tos/create-pricing). - [Configure sender information](/admin/how-tos/merchant-config/configure-sender-information). - [Create your own store for store pickup](/admin/how-tos/create-stores). ## Get started with the API Delivery Gateway uses a GraphQL API called the Merchant API. The API is fully featured for a robust backend integration. To get started: 1. Learn about GraphQL. 1. Create a Bearer access token. 1. Set up a GraphQL client. 1. Test the Merchant API in a sandbox environment. ### API environments Delivery Gateway offers two environments for you: the sandbox and the production environments. - The sandbox environment allows you to test our API without any real-world consequences. You can access it at the `https://api.sandbox.deliverygateway.io/graphql/merchant`. - The production environment is our public Merchant API endpoint that you can use to configure your Delivery Gateway integrations: `https://api.deliverygateway.io/graphql/merchant`. --- ## About GraphQL Delivery Gateway uses GraphQL for building its API. This guide walks you through the basics of GraphQL. ## About GraphQL GraphQL is a query language and runtime system. Clients send requests to GraphQL services by using the GraphQL query language, and the service returns the data in a response. A GraphQL API has a single endpoint for all data. The GraphQL type system describes the data that can be requested from the API. The collection of those data descriptions is called the GraphQL service's *schema*. To read or write data, the client must form GraphQL requests using the types defined in the service's schema: - Queries: Requests to retrieve data. Essentially, the client is asking for specific fields on pre-defined objects. They're similar to a `GET` request in a REST API. - Mutations: Requests to create and update data. They're similar to a `POST` or `PATCH` method in a REST API. ## Queries A GraphQL query requests data from specific fields of one or more objects defined in the schema of the GraphQL service. The GraphQL request format is similar to JSON but it doesn't use quotation marks for field names. GraphQL services return responses in JSON format. A simple query and response could look something like this: ```graphql title="GraphQL query" query { providers { id name } } ``` ```json title="JSON response" { "data": { "providers": { "id": "RIV", "name": "Red Ivorp" } } } ``` All GraphQL operations start with a root operation type: in this case, it's `query`. From there you specify the selection set of fields you're interested in: in the example, we're requesting the data from the `sender_name` field of the `merchant` object. The request's result will be returned in a top-level `data` key. If the request raised errors, the relevant information will be included in a top-level `errors` key. ## Mutations In a REST API, you send a `POST` request to a specific endpoint to create or update data. In GraphQL, you use mutations. Mutations are sent to a single endpoint and use the `POST` HTTP method. A GraphQL mutation requires: - A mutation field name: for example, `updateMerchantConfiguration`. They are defined in the GraphQL schema. - Input data passed as an argument to the mutation field. This is the data that you create or modify. - A list of fields that should be included in the JSON response. GraphQL nly returns the data you specifically ask for. In the example, we create a new delivery zone for a merchant with the `createZone` mutation and request that the GraphQL API returns the new `id`, `name`, and `country` fields. ```graphql title="GraphQL mutation" mutation { createZone( input: { name: "Hungary", countries: HU } ) { id name countries } } ``` ```json title="JSON response" { "data": { "createZone": { "id": "45678", "name": "Hungary", "countries": [ "HU" ] } } } ``` ## Arguments A GraphQL service can pass arguments to fields: this means that the client must provide a value for the required argument when sending a query or a mutation. For example, you can specify the ID of a provider to query pickup point availability: ```graphql title="GraphQL query" query { shipment(id: 215099) { provider mode } } ``` ```json title="JSON response" { "data": { "shipment": { "provider": "Red Ivorp", "mode": "SENDER_TO_RECIPIENT" } } } ``` ## Variables Variables allow you to reuse the same GraphQL requests with dynamic values. Variables are declared after the `query` or `mutation` keyword, like passing an argument to a function. They always begin with the `$` symbol. A variable declaration works this way: - Declare a `$variableName`. - Specify the type of the variable, for example, `createShipmentInput!`. - Replace the static value in the query or mutation with `$variableName`. ```graphql mutation($input: createShipmentInput!) { createShipment(input: $input) {...} } ``` Define the actual values for the variable in a separate variables dictionary that's usually in a JSON format. ```json { "input": { "provider":"Pro Vider", "referenceId":"12345", "recipient":{ "firstName":"Fictitious", "lastName":"Customer", "language":"EN" }, "destination":{ "pickupPointId":"12345" } } } ``` ## Nested objects In both queries and mutations, you will often need to use nested objects. In GraphQL, nested objects let you query multiple related data points in a single request, instead of using multiple endpoints like in a REST API. For example, you can query the ID and name of all providers in a single request by using nesting: ```graphql title="GraphQL query" query { providers { id name } } ``` Nesting applies to both responses and inputs. Many mutations have nested inputs. For example, the `OrderBillingInput` type requires multiple fields, including name, email, and phone number: ```graphql title="GraphQL mutation" mutation { upsertOrder( input: { billing: { name: "Most Excellent Customer", email: "examplemail@example.org", phone: "00 01 123 4567", vatNumber: "8337961152" isCompany: true } } ) } ``` You can nest within nested objects, too: ```graphql title="GraphQL mutation" mutation { upsertOrder( input: { billing: { name: "Most Excellent Customer", email: "examplemail@example.org", phone: "00 01 123 4567", vatNumber: "8337961152" isCompany: true, address: { country: CA, state: "Ontario" city: "Ottawa", postalCode: "K2C 0A6", addressLine1: "1026 Baseline Rd", addressLine2: "Building B, 4th floor" note: "The receptionist is grumpy" } } } ) } ``` In this example, we added an `address` field that requires the `AddressInput` type. For a valid mutation containing the `address` field, you need to specify multiple fields in a nested object, including country, state, and city. ## Multiple queries in the same request You can submit multiple queries or mutations in a single GraphQL request. These operations can be different or you can also query the field or run the same mutation multiple times with different arguments. To submit multiple queries or mutations: - Declare whether the operation is a query or a mutation. - Give each operation a custom alias and place it before the name of the query or mutation: `custom-alias: updateMerchantConfiguration`. In this example, we create three different pricing rules: ```graphql title="GraphQL mutation" mutation { BasicPricing: createPricing( input: { name: "Basic rule" price: { amount: 5, currency: EUR } } ){ name } HomeDeliveryPricing: createPricing( input: { name: "Home Delivery Pricing" price: { amount: 5, currency: EUR, condition: { isHomeDelivery: true, } } } ){ name } PickupPricing: createPricing( input: { name: "Home Delivery Pricing" price: { amount: 5, currency: EUR, condition: { isPickupPoint: true, } } } ){ name } } ``` --- ## Merchant API Delivery Gateway offers a robust GraphQL API that allows developers to access all core features—like shipment creation, label generation, and status tracking. To get started, check out our API documentation, which covers endpoints, authentication, and integration details. This makes it easy to connect your custom webshop or platform and automate your logistics workflow. ## Authentication All requests to the Merchant API must be authenticated with a valid access token. Include your token as a Bearer token on all API requests. Learn more about [authentication and authorization](/dev/getting-started/authentication). ## API reference Please refer to the [Merchant API reference](/api/merchant/introduction) for detailed information on available queries, mutations, and data types. --- ## SDKs Delivery Gateway provides SDKs to help you integrate our services into your applications quickly and efficiently. ## PHP SDK Our [PHP SDK](https://github.com/deliverygateway/php-sdk) makes it easier for your developers to work with the Merchant API. ### Install the SDK 1. [Install Composer](https://getcomposer.org/download/). 1. Run the following command in a bash shell: ```bash composer require deliverygateway/php-sdk ``` --- ## Set up GraphQL clients As Delivery Gateway uses a GraphQL API with a single endpoint, we recommend setting up a GraphQL client IDE to access it. There are multiple open source IDEs you can use. Check out the full list in the GraphQL organization tool directory: [Tools and libraries](https://graphql.org/community/tools-and-libraries/?tags=client). :::tip Learn more about GraphQL in our introductory guide: [GraphQL](/dev/getting-started/graphql) ::: To set up a GraphQL IDE: 1. Select a client. Popular examples include Altair, Apollo, Insomnia, or Relay. 1. Set the Delivery Gateway Merchant API endpoint in the client: `https://api.deliverygateway.io/graphql/merchant`. 1. Add an authorization header: `Authorization: Bearer `. Replace `` with your personal access token: [Create Bearer access token](/dev/getting-started/authentication). Different clients have different ways of adding the header: for example, some clients offer the option of selecting Bearer from a list of authentication options and you only need to manually input the actual token. 1. Set the client's request method to `POST`. All GraphQL requests, including queries, are POST requests. :::note Some clients offer a GraphQL mode. If it's available, use it. ::: 1. If needed, fetch the schema to render documentation with an introspection query: ``` query IntrospectionQuery { __schema { types { name } } } ``` :::note Most clients automatically fetch the schema and render the documentation in a Docs panel. ::: When done, test the client: run some queries and mutations to make sure everything works as it should. To test things, we recommend using our sandbox environment. --- ## Create an address selector and profile address list Delivery Gateway provides two views for working with home delivery addresses: - `address-selection` lets users select an existing address or enter a new one as part of a delivery flow. You can render it inline or open it in a modal. - `profile-page-address-list` is an address management view that you can embed in a user profile page. It lets users create, edit, and delete their saved addresses. Both views require a container element and either a merchant ID or a session ID when calling `DGW.mount(opts)`. ## Create an address selector Set the `type` property of `view` to `address-selection`. The optional `openInModal` property opens the selector in a modal, while `hideMainLoadingIndicator` hides the page-level loading indicator during initialization and after selection. ```js window.DGW.mount({ merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", containerId: "address-selector", view: { type: "address-selection", openInModal: true, hideMainLoadingIndicator: true, }, onAddressSelected: (result) => { console.log("Selected address:", result); }, }); ``` ### Validate the selected address Use the optional `onAddressSelected` callback to validate the address and recipient data. If the callback returns a `Promise`, the Web Plugin waits for it. When `isValid` is `false`, the selector shows the recipient form again and displays the supplied field errors. This example validates the user's email address with a custom `isEmailValid` function: ```js window.DGW.mount({ merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", containerId: "address-selector", view: { type: "address-selection", }, onAddressSelected: (result) => { if (!isEmailValid(result.recipient.email)) { return Promise.resolve({ isValid: false, errors: { email: "Oops, your email address does not appear to be valid!", }, }); } return Promise.resolve({isValid: true}); }, }); ``` ## Add an address list to a profile page Set the `type` property of `view` to `profile-page-address-list` to embed an address management interface in a user profile page. Users can create new addresses and edit or delete their existing ones without leaving the page. For authenticated customers, pass a session ID created using the Merchant API. This connects the view to the customer's saved addresses. :::important Saved addresses only work with a session created using the Merchant API. Mounting the view with only a merchant ID creates a guest session, so its addresses are not persisted for future sessions. ::: ```js window.DGW.mount({ sessionId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", containerId: "profile-address-list", view: { type: "profile-page-address-list", }, }); ``` You can use callbacks such as `onAddressCreated`, `onAddressUpdated`, and `onAddressDeleted` to react to changes made in the profile address list. For all available properties and callbacks of the `opts` object, check [DGW.mount(opts)](/dev/reference/dgw-mount-opts-properties). ## Complete example The following page demonstrates both views. When the page opens, it creates a temporary session through the Public API with three sample addresses. It then uses the returned session ID to open the address selector in a modal and render the profile address list inline. The [Public API](/api/public/introduction) does not require a Merchant Bearer token and is suitable for this browser-based demo. For persistent customer addresses in a production profile page, create the session through your backend using the Merchant API. ```html

Address selector


      

Profile page address list

Creating demo session...

``` ## Try it now When this page opens, it creates one temporary Public API session containing three sample addresses: **Home**, **Office**, and **Weekend house**. Both demos below use the returned session ID, so changes made in either view apply to the same demo session. ### Address selector Open the modal selector and enter or select an address: {() => } ### Profile page address list Create, edit, or delete addresses in the inline profile view: {() => } --- ## Create a delivery method selector Set up a delivery method selector for the Delivery Gateway embedded UI: the selector allows your customers to choose between the available delivery methods, such as home delivery, pickup point delivery, or store pickup. Your delivery method selector will display all delivery methods that you enabled for your Delivery Gateway merchant. Define the delivery method selector with the `view` field of `DGW.mount(opts)`: - As always, you need to define the container element and pass either the merchant ID or a session ID to the DGW instance. - Set the `type` property of `view` to `delivery-method-selection`. ```js window.DGW.mount({ containerId: "delivery-gateway", merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", view: { type: "delivery-method-selection", }, }); ``` When the customer selects a delivery method, the next steps - such as setting a delivery address or selecting a pickup point - can either open in a modal or in place. Use the `openSelectedMethodInModal` boolean to define the behavior: ```js window.DGW.mount({ containerId: "delivery-gateway", merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", view: { type: "delivery-method-selection", openSelectedMethodInModal: true, }, }); ``` For pickup point delivery, you can present each operator as a separate checkbox at the initial method selection: customers can immediately select a specific operator. Then the customer selects a location: the options are filtered to the selected operator. You can define this behavior with the `operatorsAsSeparateMethods` field: ```js window.DGW.mount({ containerId: "delivery-gateway", merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", view: { type: "delivery-method-selection", operatorsAsSeparateMethods, true, }, }); ``` For home delivery, you can display the icons of the available providers on the delivery method selector with `showHomeDeliveryOperatorIcons`: ```js window.DGW.mount({ containerId: "delivery-gateway", merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", view: { type: "delivery-method-selection", showHomeDeliveryOperatorIcons: true, }, }); ``` For all available properties of the `opts` object, check [DGW.mount(opts)](/dev/reference/dgw-mount-opts-properties). ## Complete example You can copy this full HTML example into your own page: ```html
``` ## Try it now You can try the same example directly on this page: {() => } --- ## Create a location verification view Use the location verification view when you already have a delivery location and want the customer to confirm or adjust the exact coordinates on the map. - As always, define the container element and pass either the merchant ID or a session ID to the DGW instance. - Set the `type` property of `view` to `location-verification`. - Pass `initialLocation` with the default latitude and longitude shown on the map. ```js window.DGW.mount({ merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", container: document.getElementById("delivery-gateway"), view: { type: "location-verification", initialLocation: { latitude: 47.4979, longitude: 19.0402, }, }, }); ``` The view is interactive by default. Use `onLocationChange` if you want to store the coordinates selected by the customer: ```js window.DGW.mount({ merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", container: document.getElementById("delivery-gateway"), view: { type: "location-verification", initialLocation: { latitude: 47.4979, longitude: 19.0402, }, zoomLevel: 16, onLocationChange: (latitude, longitude) => { updateDeliveryLocation({ latitude, longitude }); }, }, }); ``` Use `interactive: false` to render a static Mapbox image instead of the interactive map. This reduces map loading delay and cost when the customer only needs to inspect the location. ```js window.DGW.mount({ merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", container: document.getElementById("delivery-gateway"), view: { type: "location-verification", initialLocation: { latitude: 47.4979, longitude: 19.0402, }, interactive: false, zoomLevel: 16, }, }); ``` Static mode uses the same map style and zoom level as the interactive map. The image size is calculated from the rendered map container and the custom React marker is displayed over the image, so switching between static and interactive mode stays visually consistent. Use `hideInterface: true` if you want to keep the interactive map but hide the message and action containers: ```js window.DGW.mount({ merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", container: document.getElementById("delivery-gateway"), view: { type: "location-verification", initialLocation: { latitude: 47.4979, longitude: 19.0402, }, hideInterface: true, }, }); ``` You can toggle a mounted location verification view between interactive and static mode with `DGW.execute`: ```js window.DGW.execute("location-verification.toggleInteractive", false); window.DGW.execute("location-verification.toggleInteractive", true); window.DGW.execute("location-verification.toggleInteractive"); ``` The second argument is optional. Pass `true` to force interactive mode, `false` to force static mode, or omit it to toggle the current mode. The Web Plugin also dispatches an event whenever the visible location verification message changes: ```js window.addEventListener("api.deliverygateway.io/location-verification-message", (event) => { console.log(event.detail.messageKey); }); ``` `event.detail.messageKey` is one of `initial`, `thankYou`, or `tooFarAway`. For all available properties of the `opts` object, check [DGW.mount(opts)](/dev/reference/dgw-mount-opts-properties). ## Complete example The location verification view is embedded directly into its container. The following complete HTML example renders the interactive map inline and displays the coordinates selected by the customer: ```html

Verify delivery location

Latitude: 47.497900, longitude: 19.040200

``` ## Try it now The location verification view below is embedded directly into this page. Move the map to adjust the marker's coordinates: {() => } --- ## Create a pickup point selector When a customer selects pickup point delivery, they need to select an exact location. Configure the pickup point selector on the Delivery Gateway embedded UI with the `view` field of `DGW.mount(opts)`: - As always, you need to define the container element and pass either the merchant ID or a session ID to the DGW instance. - Set the `type` property of `view` to `pickup-point-selection`. ```js window.DGW.mount({ merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", container: document.getElementById("delivery-gateway"), view: { type: "pickup-point-selection", }, }); ``` You can configure the pickup point selector to always open in a modal: set `openInModal` to `true`. For example, you can use this setting to open a pickup point selection modal in response to a button click. :::tip We recommend setting `hideMainLoadingIndicator` to `true` as well: this hides the main loading indicator normally visible during initialization and after a pickup point has been selected. ::: ```js window.DGW.mount({ merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", container: document.getElementById("delivery-gateway"), view: { type: "pickup-point-selection", openInModal: true, hideMainLoadingIndicator: true, }, }); ``` You can filter for operators with `selectedOperatorFilters`: it takes an array of operator names which you can find on the [Admin Dashboard](/admin/get-started/dashboard). The map on the selector will only show the locations of the operators in the array. ```js window.DGW.mount({ merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", container: document.getElementById("delivery-gateway"), view: { type: "pickup-point-selection", openInModal: true, hideMainLoadingIndicator: true, selectedOperatorFilters: ["GLS", "DPD"], }, }); ``` For all available properties of the `opts` object, check [DGW.mount(opts)](/dev/reference/dgw-mount-opts-properties). ## Complete example You can copy this full HTML example into your own page: ```html
``` ## Try it now You can try the same example directly on this page: {() => } --- ## Example configurations for the embedded UI You can create many different types of DGW configurations, depending on what your webshop and ordering process needs. Check out our example configurations to familiarize yourself with the available options. - [Render a delivery method selector](#render-a-delivery-method-selector-with-custom-email-validation) - [Open a pickup point selection modal in response to a button click](#open-a-pickup-point-selection-modal-in-response-to-a-button-click) - [Integrate an address selector to a profile page](#integrate-an-address-selector-to-a-profile-page) - [Render a location verification view](#render-a-location-verification-view) ### Render a delivery method selector with custom email validation Set up a function that checks if an email is valid and another that manages addresses: ```js function isEmailValid(email) { // Merchant custom email validation. return true; } function handleAddress(address) { // Display, save, etc. the selected address. } ``` Mount a DGW instance: - In `containerID`, add the ID of the HTML element containing the instance. - Set the `merchantID`: you can find it in the **Merchant** menu of the Delivery Gateway admin interface. With this, the web plugin will automatically obtain the session ID for your instance. - In the `view`object, set `type` to `delivery-method-selection`. - Set `openSelectedMethodInModal` to `true` to open the pickup point selector and address selector components in a modal window. - Set `operatorsAsSeparateMethods` to `true` to render all pickup point providers as separate checkboxes. ```js const instance = DGW.mount({ containerId: "delivery-gateway", merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", view: { type: "delivery-method-selection", openSelectedMethodInModal: true, operatorsAsSeparateMethods: true, }, }); ``` For all available properties of the `opts` object, check [DGW.mount(opts)](/dev/reference/dgw-mount-opts-properties). Set up email validation within the instance using the previously created functions and the `onAddressSelected` and `recipient`properties: ```js const instance = DGW.mount({ [...] onAddressSelected: (result) => { if (!isEmailValid(result.recipient.email)) { return Promise.resolve({ isValid: false, errors: { email: "Oops, your email address does not appear to be valid!", }, }); } handleAddress(result); }, recipient: { email: "account@domain.tld", }, }); ``` Unmount the session if the user cancels the process. ```js const instance = DGW.mount({ [...] }); cancelButton.onclick = () => { instance.unmount(); } ``` Your full configuration could look something like this: ```js function isEmailValid(email) { // Merchant custom email validation. return true; } function handleAddress(address) { // Display, save etc. the selected address. } const instance = DGW.mount({ containerId: "delivery-gateway", merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", view: { type: "delivery-method-selection", openSelectedMethodInModal: true, operatorsAsSeparateMethods: true, }, onAddressSelected: (result) => { if (!isEmailValid(result.recipient.email)) { return Promise.resolve({ isValid: false, errors: { email: "Oops, your email address does not appear to be valid!", }, }); } handleAddress(result); }, recipient: { email: "account@domain.tld", }, }); cancelButton.onclick = () => { instance.unmount(); } ``` ### Open a pickup point selection modal in response to a button click Mount a DGW instance with the following basic properties: - `merchantId`: Get the merchant ID from the Delivery Gateway admin interface. With this, the web plugin will automatically obtain the session ID for your instance. - `container`: Add the HTML element that will contain your instance. In the example, we're using `document.getElementById` to return the HTML element we need. ```js window.DGW.mount({ merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", container: document.getElementById("delivery-gateway"), }); ``` In the `view` property, add the following fields: - `type: "pickup-point-selection"`: Adds the pickup point selector to the view. - `openInModal: true`: The pickup point selector modal will open immediately. - `hideMainLoadingIndicator: true`: Hides the main loading indicator. - `ownShopFilterSelected: true`: The filter for your own shops will be selected by default. - `selectedOperatorFilters: ["Operator1", "Operator2", "Operator3"]`: These operators will be selected in the operator filter panel by default. ```js window.DGW.mount({ merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", container: document.getElementById("delivery-gateway"), view: { type: "pickup-point-selection", openInModal: true, hideMainLoadingIndicator: true, ownShopFilterSelected: true, selectedOperatorFilters: ["Operator1", "Operator2", "Operator3"], }, }); ``` Create a function that handles customer addresses called `handleAddress`. Add the `onAddressSelected: handleAddress` callback. It is called when the user has selected a pickup point. ```js function handleAddress(address) { // Display, save etc. the selected address. } window.DGW.mount({ merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", container: document.getElementById("delivery-gateway"), view: { type: "pickup-point-selection", openInModal: true, hideMainLoadingIndicator: true, ownShopFilterSelected: true, selectedOperatorFilters: ["Operator1", "Operator2", "Operator3"], }, onAddressSelected: handleAddress }); ``` ### Integrate an address selector to a profile page Create and call a function that mounts an instance with the address selector. ```js function mountAddressSelector(DGW) { DGW.mount({ containerId: "address-selector", merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", view: { type: "profile-page-addresses", }, }); } if (window.DGW) { mountAddressSelector(window.DGW); } else { window.DGWOnLoad = mountAddressSelector; } ``` ### Render a location verification view Use the location verification view when you already have delivery coordinates and want the customer to confirm or adjust the exact location. ```js const instance = DGW.mount({ containerId: "delivery-gateway", merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", view: { type: "location-verification", initialLocation: { latitude: 47.4979, longitude: 19.0402, }, zoomLevel: 16, interactive: true, onLocationChange: (latitude, longitude) => { updateDeliveryLocation({ latitude, longitude }); }, }, }); window.addEventListener("api.deliverygateway.io/location-verification-message", (event) => { console.log(event.detail.messageKey); }); window.DGW.execute("location-verification.toggleInteractive", false); window.DGW.execute("location-verification.toggleInteractive", true); ``` Set `interactive` to `false` to render a static Mapbox image. Static mode uses the same map style and zoom level, calculates the image size from the rendered map container, and displays the custom React marker over the image. --- ## Manage sessions for frontend integration There are two ways to provide a session ID when using the Delivery Gateway embedded UI: - Use your merchant ID - Pass the session ID from a backend service. For a lightweight frontend integration, we recommend using the merchant ID: you pass it to the DGW instance and our Web Plugin will initalize the instance: ```js const instance = DGW.mount({ containerId: "delivery-gateway", merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", }); ``` For all available properties of the `opts` object, check [DGW.mount(opts)](/dev/reference/dgw-mount-opts-properties). Get the merchant ID from either: - The [Admin Dashboard](/admin/get-started/dashboard). - The Merchant API. To make sure that only authorized entities can use your merchant ID to initialize Delivery Gateway sessions with the Web Plugin, set up allowed HTTP referrers: [HTTP referrers for the embedded UI](/admin/how-tos/merchant-config/configure-http-referrers). --- ## Connect Delivery Gateway to your frontend ## About the frontend integration Connect Delivery Gateway features to your webshop using a frontend integration. This uses the Delivery Gateway SDK and enables to use of features such as DGW's delivery method selector, the interactive map-based pickup point selector, or the custom address pinpointing feature. Frontend initialization works like this: - You set up DGW in your own platform's frontend. - The web plugin handles creating a DGW session and passing it to the frontend logic. Note that when using frontend initialization for your sessions, certain settings can't be overridden for the session. They are applied according to the merchant configuration or the customer's browser settings. | Setting | Data source | |--------------------------------------------------------|------------------------| | Currency | Merchant configuration | | Language | Customer browser | | Authenticated customer (addresses) | Not available | | Pickup point delivery settings (enablement, pricing) | Merchant configuration | | Home delivery settings (enablement, pricing) | Merchant configuration | To set up DGW using vanilla Javascript, you need to: 1. Include the standalone DGW script. 1. Mount DGW instances using `DGW.mount`. :::note For React applications, we recommend using our official React bindings, available at `delivery-gateway-react-bindings`. They come with Typescript typings, which are also available separately in the `delivery-gateway-typings` package. ::: ## Enable the DGW object To implement DGW features, you need to enable access to the DGW object. The first step is to include the standalone Delivery Gateway script on every page where you want to use Delivery Gateway. ```html ``` Please note that Delivery Gateway's standalone script is available in multiple languages. Make sure to select the one that best suits your needs. For example, if you want to use the Dutch version of the script, you would include it like this: ```html ``` The script calls the `window.DGWOnLoad` callback (if present) with the global `DGW` object as its parameter. The global `DGW` object will also be accessible as `window.DGW`. You can use the following pattern to make sure the `DGW` object is available: ```js function mountDeliveryGateway(DGW) { // Initialize Delivery Gateway using DGW.mount(...); } if (window.DGW) { mountDeliveryGateway(window.DGW); } else { window.DGWOnLoad = mountDeliveryGateway; } ``` ## Mount DGW instances to HTML containers Mounting a Delivery Gateway instance means creating a DGW configuration that implements a DGW feature in your page. For example, you can set up a delivery method selector that is presented to users when they place an order. The `DGW` object exposes `.mount(opts)` to mount a DGW instance in a specified container, and `.execute(command, ...args)` to send commands to mounted DGW views. The `.mount(opts)` method returns a `DgwInstance` object. ```js window.DGW.mount({}) ``` The `opts` object of the `.mount()` method must contain properties that fully define the instance and its configuration. This includes the id of the HTML container that will contain the instance, the session ID for the instance user, and the view to be displayed. ```js window.DGW.mount({ merchantId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", containerId: "delivery-gateway", view: { type: } }) ``` The returned `DgwInstance` object contains the following fields: - `unmount(): void` Immediately unmounts the instance, removing all content from the container. - `isMounted(): boolean` Returns a boolean indicating whether the instance is still mounted. For all available properties of the `opts` object, check [DGW.mount(opts)](/dev/reference/dgw-mount-opts-properties). ## Configure the embedded UI - [Create a delivery method selector](create-delivery-selector) - [Create a pickup point selector](create-pickup-point-selector) - [Create an address selector](create-address-selector) - [Create a location verification view](create-location-verification) - [Example configurations](example-configurations) --- ## Add payment and billing information to an order ## Add payment information Add payment information to an order with the `payment` field that takes the `OrderPaymentInput` type. You need to specify: - A payment `method`. The field requires a string: you can pass the value from your system. - The payment `status`: you can check [the available options in `PaymentStatusEnum`](/api/merchant/types/enums/payment-status-enum). ```graphql title="GraphQL mutation" mutation { upsertOrder( input: { referenceId: "123456", createdAt: $date, payment: { method: "card" status: PENDING } } ) } ``` If the customer wants to pay for the order upon delivery, set the `cashOnDelivery` field which requires a `MoneyInput` type: ```graphql title="GraphQL mutation" mutation { upsertOrder( input: { referenceId: "123456", createdAt: $date, cashOnDelivery: { amount: 13599, currency: HUF } } ) } ``` When the order is paid, change the payment status and add the date of payment: the `paidAt` field requires a date in the `Y-m-d\TH:i:sP` format. ```graphql title="GraphQL mutation" mutation { upsertOrder( input: { referenceId: "123456", createdAt: $date, payment: { method: "card" status: PAID, paidAt: "2026-01-17T14:32:10+01:00" } } ) } ``` ## Add billing information When creating or updating an order, you can add billing information with the `billing` field of the `upsertOrder` mutation. You can provide: - A name - An email address - A phone number - An address - A VAT number, if applicable With the `isCompany` field, you can also specify if the bill will be paid by a company or a private individual. ```graphql title="GraphQL mutation" mutation { upsertOrder( input: { referenceId: "123456", createdAt: $date, billing: { name: "Most Excellent Customer", email: "examplemail@example.org", phone: "00 01 123 4567", vatNumber: "8337961152" isCompany: true } } ) } ``` To add the address, as a minimum you need: - `country`: See the [available country codes](/api/merchant/types/enums/country-enum). - `city` - `postalCode` - `addressLine1` In addition: - You can add a `state` field: it can be used for any type of administrative subdivision of a country, if you need it. - If the address is longer and more complex, you can add `addressLine2`. - Add a `note` to include additional information about the address. ```graphql title="GraphQL mutation" mutation { upsertOrder( input: { referenceId: "123456", createdAt: $date, billing: { name: "Most Excellent Customer", email: "examplemail@example.org", phone: "00 01 123 4567", vatNumber: "8337961152" isCompany: true, address: { country: CA, state: "Ontario" city: "Ottawa", postalCode: "K2C 0A6", addressLine1: "1026 Baseline Rd", addressLine2: "Building B, 4th floor" note: "The receptionist is grumpy" } } } ) } ``` --- ## Add shipping information to an order Add shipping information to an order with the `shipping` field. It requires the `OrderShippingInput` input type which provides fields for all relevant shipping information. You can specify: - The customer information, such as name, email, and phone. - A delivery method: check [ShippingMethodEnum](/api/merchant/types/enums/shipping-method-enum) for the options. - A provider that will perform the delivery. - The shipment [status](/api/merchant/types/enums/shipment-status-enum). In addition, if the selected delivery method is pickup point delivery, you can add a pickup point ID. ```graphql mutation { upsertOrder( input: { [...], shipping: { name: "Example Customer", email: "ec@example.org", phone: "0036701234567", method: PICKUP_POINT, provider: "Red Ivorp", status: IN_PROGRESS, } } ) } ``` Iff the selected delivery method is pickup point delivery, you can add a pickup point ID. That's where the order will be shipped to: ```graphql mutation { upsertOrder( input: { [...], shipping: { name: "Example Customer", email: "ec@example.org", phone: "0036701234567", pickupPointId: "123abc", method: PICKUP_POINT, provider: "Red Ivorp", status: IN_PROGRESS, } } ) } ``` For home delivery, add an address. An address requires [a country code](/api/merchant/types/enums/country-enum), a city, a postal code, and an address: :::note You can pass the address from the `customer` field of a session: [Manage authenticated customers](/dev/how-tos/sessions/authenticate-customers). ::: ```graphql mutation { upsertOrder( input: { [...], shipping: { name: "Example Customer", email: "ec@example.org", phone: "0036701234567", pickupPointId: "123abc", method: HOME_DELIVERY, provider: "Red Ivorp", status: IN_PROGRESS, address: { country: GB, city: "Manchester" postalCode: "M16 0RA" addressLine1: "Sir Matt Busby Way" } } } ) } ``` --- ## Create an order ## About orders An order is a customer's request to purchase one or more products and have them delivered via a specified method. With the Delivery Gateway backend integration, you can create orders, assign all the relevant information to them, and manage them throughout the order's lifecycle. An order requires the following data: - A reference ID: an automatically generated ID assigned by your system. - When the order was created. - The total price of the order. You must specify both the net and gross values. - The items included in the order. ### Order items You can pass extensive information about items in a given order to the Merchant API. The `OrderItemInput` type allows assigning different identifiers such as a name, a reference ID or an SKU. You can specify categories for your items (for example, "Electronics"), and variants (for example, 128 GB or 256 GB smartphone models). #### Global identifiers Delivery Gateway enables the use of global identifier standards in your orders: for example, GTIN, EAN, or ISBN. These are available under the `globalIdentifiers` field of the `upsertOrder` mutation. #### Item price Item price is calculated from the unit price and quantity of each item. The unit price consists of the net price, gross price, and the VAT value. You can calculate the total price of items from the unit price and quantity of each item. When setting a quantity, you can select the unit: piece, kilogramm, liter, or other. ## Create an order Create and update orders with the `upsertOrder` mutation. ### Part 1: Assign an ID First, assign the order an ID and set the time of its creation: - Generate an ID and pass it to `referenceId`. - Pass the time in `Y-m-d\TH:i:sP` format to `createdAt`. ```graphql title="GraphQL mutation" mutation { upsertOrder( input: { referenceId: "123456", createdAt: $date } ) } ``` ### Part 2: Add items Add the items to the order. If you have multiple items, include them as an array. Each item must have a name, a unit price, a quantity, and a total price. - The `unit` field sets the unit price. The `net` and `gross` subfields both require an amount and a currency and you also need to specify the VAT in the `vat` subfield. - The `quantity` field requires `count` which takes a float, and `type` which defines the measurement. In addition to the pre-defined values, you can set it to `OTHER` and specify ta custom type with the `typeOther` field. - The `total`, like the unit prices, requires both a net and a gross amount. The total price should be calculated as the unit price multiplied by the item quantity. ```graphql title="GraphQL mutation" mutation ( $netPrice: # calculated net price of order $grossPrice: # calculated gross price of order ){ upsertOrder( input: { referenceId: "123456", createdAt: "2025-12-10\\CET16:17:52+01:00", items: { name: "HAL-9000" unit: { net: { amount: 55000, currency: HUF }, vat: 27, gross: { amount: 69850, currency: HUF } } quantity: { count: 1, type: PIECE } total: { net: { amount: $netPrice currency: HUF }, gross: { amount: $grossPrice currency: HUF } } isShipping: true, isPayment: true, isDiscount: false }, } ) } ``` ### Part 3: Calculate the total The final total price of the order is set in the `total` field. This also requires a `net` and a `gross` subfields. You can calculate the total price by adding all unit price totals. ```graphql title="GraphQL mutation" mutation ( $netPrice: # calculated net price of order $grossPrice: # calculated gross price of order $totalnetPrice: # a calculated total net price of all items $totalgrossPrice: # a calculated total gross price of all items ){ upsertOrder( input: { referenceId: "123456", createdAt: "2025-12-10\\CET16:17:52+01:00", total: { net: { amount: 55000, currency: HUF } gross: { amount: 69850, currency: HUF } }, items: [{ name: "HAL-9000" unit: { net: { amount: 55000, currency: HUF }, vat: 27, gross: { amount: 69850, currency: HUF } } quantity: { count: 1, type: PIECE } total: { net: { amount: $netPrice currency: HUF }, gross: { amount: $grossPrice currency: HUF } } isShipping: true, isPayment: true, isDiscount: false }, ] } ) } ``` ## Assign a customer and a session to an order The `upsertOrder` mutation allows assigning a customer ID and a session ID to an order, allowing your system to easily associate an order with a registered customer. You need a `sessionId` and a `customerId`: - The `sessionId` field is automatically generated by the Delivery Gateway API when initializing a session. - The `customerId` is generated by your own system. ```graphql title="GraphQL mutation" mutation { upsertOrder( input: { referenceId: "123456", createdAt: $date, customerId: "efgh4567", sessionId: "asdf-efht-1345-2346" } ) } ``` --- ## End-to-End Checkout Integration ## Overview This guide describes the complete flow for integrating Delivery Gateway into your webshop checkout process. It covers the entire journey from the backend session creation through frontend widget integration to order and shipment management. ## Architecture The integration involves four main components: - **User/Customer**: Initiates the checkout process - **Frontend (Webshop)**: Frontend client running on the browser - **Frontend (Delivery Gateway Widget)**: Handles delivery method selection and address management - **Backend (Webshop)**: Your backend system - **Backend (Delivery Gateway)**: Processes sessions, orders, and shipments ### Integration Sequence ```mermaid sequenceDiagram participant User participant Frontend as Frontend
(Webshop) participant DGWFrontend as Frontend
(DGW Widget) participant Backend as Backend
(Webshop) participant DGWBackend as Backend
(DGW) User->>Frontend: I need delivery Frontend->>Backend: Request session creation Backend->>DGWBackend: createSession() DGWBackend-->>Backend: session id Backend-->>Frontend: session id Frontend->>DGWFrontend: initialize DGW.mount() with sessionId DGWFrontend->>User: Display delivery options User->>DGWFrontend: Select delivery method DGWFrontend-->>Frontend: onSelection callback Frontend->>Backend: Confirm delivery selection Backend->>DGWBackend: Query session DGWBackend-->>Backend: Selected delivery details Backend-->>Frontend: Delivery confirmed Frontend->>User: Ready for payment User->>Frontend: Submit order Frontend->>Backend: Create order Backend->>DGWBackend: upsertOrder() DGWBackend-->>Backend: order id Backend->>DGWBackend: createShipment() DGWBackend-->>Backend: shipment id + label URL Backend-->>Frontend: Order confirmation Frontend-->>User: Show shipment details DGWBackend->>Backend: SHIPMENT_UPDATED webhook Backend-->>User: Status updates ``` ## Step 1: Create a Session on the Backend When a customer reaches the shipping method selection step in your checkout, initiate a session from your backend. ### Why start with a session? Creating a session allows you to: - Associate delivery options and pricing with a specific customer journey - Pass custom data (such as shipping costs) to the frontend widget - Obtain a `sessionId` that connects the frontend interactions to your backend ### Create a session Use the `createSession` mutation to create a new session: ```graphql title="GraphQL mutation" mutation { createSession(input: { # Optional: pass delivery options and pricing items: [ { name: "Standard Delivery" price: { net: { amount: 1000, currency: HUF } gross: { amount: 1270, currency: HUF } vat: 27 } } ] }) { session { id } } } ``` **Response:** ```json { "data": { "createSession": { "session": { "id": "session_abc123xyz" } } } } ``` Store the `sessionId` to use in the next steps. **Reference:** [Create Session](/dev/how-tos/sessions/create-session) ## Step 2: Load the Delivery Gateway Frontend SDK On your checkout page, load the Delivery Gateway JavaScript SDK: ```html ``` For details on SDK setup, see: [Set Up DGW on Frontend](/dev/how-tos/frontend-integration/set-up-dgw-on-frontend) ## Step 3: Render the Delivery Selection Widget When a customer reaches the delivery method selection step, render the appropriate widget based on their choice. ### For store/pickup point delivery If the customer selects "Store Pickup" or "Pickup Point Delivery": ```javascript window.DGW.mount({ sessionId: 'session_abc123xyz', type: 'pickup-point-selection', ownShopFilterSelected: true, // true for your own stores, false for third-party pickup points container: '#dgw-widget', onAddressSelected: (data) => { console.log('Selected pickup point:', data); } }); ``` **Reference:** [Create Pickup Point Selector](/dev/how-tos/frontend-integration/create-pickup-point-selector) ### For home delivery If the customer selects home delivery and needs to enter or modify their address: ```javascript window.DGW.mount({ sessionId: 'session_abc123xyz', type: 'address-selection', container: '#dgw-widget', onAddressSelected: (data) => { console.log('Selected address:', data); } }); ``` **Reference:** [Create Address Selector](/dev/how-tos/frontend-integration/create-address-selector) ## Step 4: Handle Widget Callbacks When a customer completes their selection in the widget, the callback is triggered with the selected delivery information. `onAddressSelected`: Triggered when the customer successfully selects a delivery method and location. The callback receives an object containing: - Selected delivery method details - Pickup point or address information - Session metadata **Reference:** [Callback Options](/dev/reference/dgw-mount-opts-properties#callback-options) ### Store the delivery details While you receive delivery information in the frontend callback, **we strongly recommend querying the session from your backend** for security reasons. This prevents tampering with delivery data. ```javascript // In your frontend callback, you might show a confirmation // But verify on the backend: onAddressSelected: (data) => { fetch('/your-api/confirm-delivery-selection', { method: 'POST', body: JSON.stringify({ sessionId: 'session_abc123xyz' }) }); } ``` On your backend, retrieve the verified session data: ```graphql title="GraphQL query" query { session(id: "session_abc123xyz") { id selectedDeliveryMethod { id name } selectedPickupPoint { id name address } selectedAddress { street city postalCode country } pricing { net { amount, currency } gross { amount, currency } vat } } } ``` Store the delivery method, pickup point, or address in your checkout data. **Reference:** [Query Session](/dev/reference/dgw-mount-opts-properties#query-session) ## Step 5: Create an Order When the order is finalized and ready to be shipped, create an order in Delivery Gateway. We recommend that your **ERP system creates the order** rather than the webshop, since this keeps order creation logic in one place. ### Using the upsertOrder mutation ```graphql title="GraphQL mutation" mutation { upsertOrder(input: { referenceId: "order_12345" createdAt: "2025-04-16T14:30:00+02:00" items: [ { name: "Product Name" sku: "SKU-001" quantity: { count: 1, type: PIECE } unit: { net: { amount: 10000, currency: HUF } gross: { amount: 12700, currency: HUF } vat: 27 } total: { net: { amount: 10000, currency: HUF } gross: { amount: 12700, currency: HUF } } isShipping: true isPayment: true } ] total: { net: { amount: 10000, currency: HUF } gross: { amount: 12700, currency: HUF } } }) { order { id referenceId status } } } ``` **Reference:** [Create an Order](/dev/how-tos/orders/create-an-order) ## Step 6: Create a Shipment Once your order is created and ready to ship, create a shipment. You can either: 1. **Pass order data within the shipment creation** (recommended for simple workflows) 2. **Create the order first, then reference it** (recommended for complex workflows) ### Creating a shipment with inline order data ```graphql title="GraphQL mutation" mutation { createShipment(input: { order: { referenceId: "order_12345" # ... order data } selectedDeliveryMethod: "pickup-point" pickupPointId: "pp_xyz789" sender: { name: "Your Shop Name" address: { street: "123 Main St" city: "Budapest" postalCode: "1011" country: "HU" } email: "shop@example.com" phone: "+36-1-234-5678" } }) { shipment { id status parcels { label { url } } } } } ``` **The response includes the parcel label URL:** ```json { "data": { "createShipment": { "shipment": { "id": "shipment_abc123", "status": "PENDING", "parcels": [ { "label": { "url": "https://dgw-labels.example.com/label_xyz789.pdf" } } ] } } } } ``` Retrieve and store the label URL for printing or sending to the customer. **Reference:** [Create Shipment](/dev/how-tos/orders/create-shipment) ## Step 7: Monitor Shipment Status Track shipment status using one of two methods: ### Option 1: Webhooks (Recommended) Subscribe to `SHIPMENT_UPDATED` webhooks to receive real-time status updates without polling: ```json { "event": "SHIPMENT_UPDATED", "data": { "shipmentId": "shipment_abc123", "status": "PICKED_UP", "updatedAt": "2025-04-16T15:45:00+02:00" } } ``` You can configure webhooks: - **Via code**: Subscribe programmatically during integration - **Via Admin Panel**: Set up once, then automatically receive updates for all shipments **Reference:** [Configure Webhooks](/dev/how-tos/configure-webhooks) ### Option 2: Polling Query the shipment status on-demand: ```graphql title="GraphQL query" query { shipment(id: "shipment_abc123") { id status trackingNumber estimatedDeliveryDate parcels { id status tracking { url number } } } } ``` Use polling only if you cannot use webhooks. Webhooks reduce server load and provide faster updates. **Reference:** [Query Shipment](/dev/reference/dgw-shipment-queries) ## Complete Flow Summary 1. **Backend initiates**: Create a session with delivery options and pricing 2. **Frontend renders**: Load the SDK and display the widget 3. **Customer selects**: Chooses delivery method and location via widget 4. **Backend verifies**: Query the session to confirm the delivery selection 5. **Backend prepares**: Store delivery details in your checkout 6. **ERP creates**: Generate the finalized order 7. **Backend ships**: Create a shipment and retrieve the label URL 8. **Monitor**: Track shipment status via webhooks or polling ## Best Practices - **Security**: Always verify delivery selections on your backend before proceeding with orders - **Order creation**: Have your ERP system create orders to centralize order management logic - **Webhooks**: Use webhooks for real-time shipment status updates instead of polling - **Labels**: Retrieve and securely store label URLs immediately after shipment creation - **Error handling**: Implement proper error handling for each step (session creation, widget interaction, order/shipment creation) --- ## Create webhooks Webhooks allow you to send notifications of Delivery Gateway events to a third-party service. For example, you can set up a webhook to send an event notification when a shipment is created or when a customer updates their address. Our webhooks send a JSON payload, the content of which depends on the triggering event. One webhook is one event: create a webhook for each of the events you need to send notifications about. ## Create a webhook Use the `createWebhook` mutation to create a new webhook. It creates a `Webhook` object. ```graphql mutation { createWebhook(input: {...}) { id url } } ``` To create a webhook, you need three inputs: - `webhook`: The event that triggers the webhook. For the full list, see [WebhookEnum](/api/merchant/types/enums/webhook-enum). - `url`: The service URL that will receive the JSON payload when an event triggers the webhook. - `transport`: The transport type. Currently, only REST is available. ```graphql mutation { createWebhook( input: { webhook: SHIPMENT_CREATED, url: "example.org", transport: REST, } ) { id url } } ``` ## Set a secret key for webhook signature We recommend setting a secret key for webhook signature. It is a shared secret used to prove that a webhook request really came from Delivery Gateway and was not tampered with in transit. The secret key must be configured for the merchant, using the `updateMerchantConfiguration` mutation: ```graphql title="GraphQL mutation" mutation { updateMerchantConfiguration( input: { key: WEBHOOK_SIGNATURE value: Q2hhbmdlVGhpcy1Ub1JhbmRvbVNlY3JldCE= } ) { key value } } --- ## Manage waybills A waybill is a shipping document that contains essential information about the transported shipment. It tells the carrier what is being shipped, who it's from, where it's going, and how it should be handled. ## Create a waybill A waybill on Delivery Gateway requires the following information: - A provider: the company transporting the shipment. - A reference ID: an automatically generated ID assigned by your system. - One or more shipment IDs. You don't have to assign the ID when creating a waybill: you can do so later with the `assignShipmentToWaybill` mutation. First, create at least one shipment. Each shipment will have an autogenerated `id`: you will need to pass this ID to the waybill. Create the waybill with the `createWaybill` mutation. Add the reference ID as a string: ```graphql mutation { createWaybill( input: { referenceId: "123abc", } ) { id } } ``` Set a provider from the list of [available providers](/api/merchant/types/scalars/provider-enum): ```graphql mutation { createWaybill( input: { provider: GLS, referenceId: "123abc", } ) { id } } ``` Optionally, you can assign a shipment ID during creation: ```graphql mutation { createWaybill( input: { provider: BestEx, referenceId: "123abc", shipments: ["24e8ff69-2889-4fbb-9868-b576ac21b95c"] } ) { id } } ``` ## Assign a waybill to a shipment If you didn't add a shipment ID when you created a waybill, you can assign it later with the `assignShipmentToWaybill` mutation. It requires two input fields: the waybill ID and the shipment ID. ```graphql mutation { assignShipmentToWaybill( input: { waybillId: "123abc", shipmentId: "456def", } ) { id } } ``` If you successfully assigned a waybill, you can always query it for the shipment: ```graphql query { shipment(id: "456def") { waybill { id } } } ``` ## Close a waybill After a shipment is successfully delivered (or returned to the sender), you should close the waybill. You need the ID of the waybill as the argument of the `closeWaybill` mutation. In the example, we're closing the waybill and querying which provider it was assigned to and its creation time and closing time. ```graphql title="GraphQL mutation" mutation { closeWaybill(id: "asdf1357") { provider { id } createdAt closedAt } } ``` ## Delete a waybill You can delete a waybill at any time with the `deleteWaybill` mutation. It requires the waybill ID as an argument. ```graphql title="GraphQL mutation" mutation { deleteWaybill(id: "asdf1357") { provider { id } } } ``` --- ## Create custom pickup point You can create your own custom pickup points: these are pickup locations that you, the merchant, operate and control. For example, your own physical stores. ## Create the pickup point To create a custom pickup point, use the `createPickupPoint` mutation. It requires: - `referenceId`: A unique ID that identifies the pickup point. You can use an ID generated by your own system. - `name`: A human-readable name that is shown to customers. - `phone`: A phone number. - `address`: The address of the pickup point. - `location`: The exact coordinates of the pickup point. ### Part 1: Basic information First, we set the id, the name, and the phone number as these are simple strings. ```graphql title="GraphQL mutation" mutation { createPickupPoint( input: { referenceId: "123abc", name: "My Store", phone: "01 234 5678", } ) } ``` ### Part 2: The address To add the address, you need the `addressInput` type. It requires: - `country`: See the [available country codes](/api/merchant/types/enums/country-enum). - `city` - `postalCode` - `addressLine1` So the bare minimum address input looks like this: ```graphql title="GraphQL mutation" mutation { createPickupPoint( input: { referenceId: "123abc", name: "My Store", phone: "01 234 5678", address: { country: HU, city: "Budapest", postalCode: "1061", addressLine1: "Nyugati tér 1." } } ) } ``` - You can add a `state` field: it can be used for any type of administrative subdivision of a country, if you need it. - If the address is longer and more complex, you can add `addressLine2`. - Add a `note` to include additional information about the address. ```graphql title="GraphQL mutation" mutation { createPickupPoint( input: { referenceId: "123abc", name: "My Store", phone: "01 234 5678", address: { country: CA, state: "Ontario" city: "Ottawa", postalCode: "K2C 0A6", addressLine1: "1026 Baseline Rd", addressLine2: "Building B, 4th floor" note: "The receptionist is grumpy" } } ) } ``` ### Part 3: Exact coordinates You must specify the exact location of the custom pickup point with a latitude and longitude value: ```graphql title="GraphQL mutation" mutation { createPickupPoint( input: { referenceId: "123abc", name: "My Store", phone: "01 234 5678", address: { country: HU, city: "Budapest", postalCode: "1061", addressLine1: "Nyugati tér 1." } location: { latitude: 47.50969187518572, longitude: 19.05571832644608 } } ) } ``` ### Part 4: Activate the pickup point To enable the pickup point for customers, you must set the `isActive` boolean to `true`. ```graphql title="GraphQL mutation" mutation { createPickupPoint( input: { referenceId: "123abc", name: "My Store", phone: "01 234 5678", address: { country: HU, city: "Budapest", postalCode: "1061", addressLine1: "Nyugati tér 1." } location: { latitude: 47.50969187518572, longitude: 19.05571832644608 } isActive: true } ) } ``` ### Set opening hours The opening hours of a pickup point is important information for your customers. To set it, you need the `openingHours` field which requires the `PickupPointOpeningHoursInput` type: - It requires a `timezone` in the format [specified in the `TimezoneEnum`](/api/merchant/types/enums/timezone-enum). - An `openingHours` field which requires the `OpeningHourInput` type. Each day is a separate object in an array, with `day`, `start`, and `end` fields. - `day` fields require [the `DayEnum`](/api/merchant/types/enums/day-enum). - `start` and `end` fields both require `hour` and `minute` fields which take integers. ```graphql title="GraphQL mutation" mutation { createPickupPoint( input: { referenceId: "123abc", name: "My Store", phone: "01 234 5678", address: { country: HU, city: "Budapest", postalCode: "1061", addressLine1: "Nyugati tér 1." } location: { latitude: 47.50969187518572, longitude: 19.05571832644608 } isActive: true, openingHours: { timezone: EUROPE_BUDAPEST, openingHours: [ { day: MONDAY, start: { hour: 8, minute: 0 }, end: { hour: 17, minute: 0 } }, { day: TUESDAY, start: { hour: 9, minute: 0 }, end: { hour: 18, minute: 0 } } ] } } ) } ``` ### Additional information You can indicate whether your store is wheelchair accessible with the `hasWheelChairAccess` field. ```graphql title="GraphQL mutation" mutation { createPickupPoint( input: { referenceId: "123abc", name: "My Store", phone: "01 234 5678", address: { country: HU, city: "Budapest", postalCode: "1061", addressLine1: "Nyugati tér 1." } location: { latitude: 47.50969187518572, longitude: 19.05571832644608 } isActive: true, hasWheelChairAccess: true } ) } ``` You can also configure a "cash on delivery" option, allowing customers to pay for their order in the store. The `cashOnDelivery` field accepts two payment methods, `CASH` and `CARD`. To enable both, include them in an array: ```graphql title="GraphQL mutation" mutation { createPickupPoint( input: { referenceId: "123abc", name: "My Store", phone: "01 234 5678", address: { country: HU, city: "Budapest", postalCode: "1061", addressLine1: "Nyugati tér 1." } location: { latitude: 47.50969187518572, longitude: 19.05571832644608 } isActive: true, cashOnDelivery: [ CASH, CARD ] } ) } ``` --- ## Create packaging You can configure packaging information to use for deliveries: set the dimensions of different package types and use them in your shipments to set the physical size of the shipment. When creating a package, you need to set a human-readable name and an identifying handle: ```graphql mutation { createPackaging( input: { name: "Normal", handle: "normal", } ) } ``` To set the size of the package, use the `dimensions` field. Provide all dimension values in meters. Fractions are allowed: ```graphql mutation { createPackaging( input: { name: "Normal", handle: "normal", dimensions: { width: 1.5, length: 5.3, height: 2.2, }, } ) } ``` You must specify whether the created package should be the default option with the `isDefault` field: ```graphql mutation { createPackaging( input: { name: "Normal", handle: "normal", dimensions: { width: 1.5, length: 5.3, height: 2.2, }, isDefault: true } ) { name } } ``` --- ## Create pricing rules Pricing rules are a set of configurations that determine the price of a delivery. You can set conditions and priority to a pricing rule so Delivery Gateway can automatically set the one you need during the order process. Read more about how pricing rules work: [About pricing](/admin/how-tos/create-pricing#about-pricing-rules). You can create and update pricing rules at any point with the API. Delivery Gateway will automatically use your pricing rules unless you directly specify prices during a session. ## Create a pricing rule Use the `createPricing` mutation to create a pricing rule. A "basic" pricing rule has only two requirements: a name and a price. Such a rule will match every possible condition and therefore will be available for all deliveries. As always, the `price` field requires the `amount` and `currency` subfields. ```graphql mutation { createPricing( input: { name: "Basic rule" price: { amount: 5, currency: EUR } } ){ name } } ``` Add the `condition` field to specify possible conditions. The conditions are: - The delivery method. - The pricing zone: the country or countries the price applies to. - The delivery provider: different companies charge different prices. For example, let's set a pricing rule for pickup point delivery in the United States by a provider called BestEx, applicable only to parcel lockers. We must disable this pricing rule for home delivery, specify the available pickup point types, and add the zone. :::note By default, there are no zones in the Delivery Gateway system: you need to create them and use the zone ID here. ::: ```graphql mutation { createPricing( input: { name: "Basic rule" price: { amount: 5, currency: EUR }, condition: { isHomeDelivery: false, isPickupPoint: true, pickupPointTypes: LOCKER, providers: BESTEX, zoneId: "123" } } ){ name } } ``` ## Update a pricing rule You can modify a pricing rule at any time with the `updatePricing` mutation. It requires the `id` and the `name` of an existing pricing rule: ```graphql title="GraphQL mutation" mutation { updatePricing( input: { id: "123abc", name: "My rule", price: { amount: 1200, currency: HUF } } ) { id } } ``` ## Delete a pricing rule To delete a pricing rule, you just need to pass the ID of the rule as an argument to the `deletePricing` mutation: ```graphql title="GraphQL mutation" mutation { deletePricing(id: "123abc") } ``` --- ## Create a shipment Create shipments to and then update it when necessary during its lifecycle. ## Create a shipment When an order is ready to be shipped, create a shipment with the `createShipment` mutation. It creates a `Shipment` object that contains all the relevant information about the shipment. ```graphql title="GraphQL mutation" mutation { createShipment(input: {...}) { id } } ``` The `createShipmentInput` type requires the following fields as a minimum: - `provider`: Specifies a provider with a `ProviderEnum!`. - `referenceId`: The ID of the shipment. - `recipient`: The name and the selected language of the customer who will receive the shipment. - `destination`: The address to where the shipment will be delivered. Depending on the order, this can be home delivery, a pickup point, or a store pickup. In the example, we're creating a shipment that will be delivered using the provider RIV to a pickup point for Fictitious Customer: ```graphql title="GraphQL mutation" mutation { createShipment( input: { provider: "RIV", referenceId: "12345", recipient: { firstName: "Fictitious", lastName: "Customer", language: HU }, destination: { pickupPointId: "12345" } } ) { id } } ``` ### Specify shipment address and location The shipment's `destination` can be a pickup point, an address, and/or a precise location. The simplest way is to specify the pickup point ID: ```graphql title="GraphQL mutation" mutation { createShipment( input: { provider: "RIV", referenceId: "12345", recipient: { firstName: "Fictitious", lastName: "Customer", language: HU }, destination: { pickupPointId: "12345" } } ) { id } } ``` To set the full address, you need the `address` field which requires: - `country`: See the [available country codes](/api/merchant/types/enums/country-enum). - `city` - `postalCode` - `addressLine1` ```graphql title="GraphQL mutation" mutation { createShipment( input: { provider: "RIV", referenceId: "12345", recipient: { firstName: "Fictitious", lastName: "Customer", language: HU }, destination: { address: { country: HU, city: "Budapest", postalCode: "1061", addressLine1: "Nyugati tér 1." } } } ) { id } } ``` - You can add a `state` field: it can be used for any type of administrative subdivision of a country, if you need it. - If the address is longer and more complex, you can add `addressLine2`. - Add a `note` to include additional information about the address. ```graphql title="GraphQL mutation" mutation { createShipment( input: { provider: "RIV", referenceId: "12345", recipient: { firstName: "Fictitious", lastName: "Customer", language: HU }, destination: { address: { country: CA, state: "Ontario" city: "Ottawa", postalCode: "K2C 0A6", addressLine1: "1026 Baseline Rd", addressLine2: "Building B, 4th floor" note: "The receptionist is grumpy" } } } ) { id } } ``` You can specify a precise location with the `location` field that requires a `latitude` and a `longitude` fields: ```graphql title="GraphQL mutation" mutation { createShipment( input: { provider: "RIV", referenceId: "12345", recipient: { firstName: "Fictitious", lastName: "Customer", language: HU }, destination: { location: { latitude: 12.000245, longitude: 23.101214 } } } ) { id } } ``` ### Shipment recipient The shipment recipient is the customer who will receive the shipment. The `createShipment` mutation requires its name and language as a minimum but you can add additional contact information: email and phone number, both as strings. ```graphql title="GraphQL mutation" mutation { createShipment( input: { [...] recipient: { firstName: "Fictitious", lastName: "Customer", language: HU, email: "example_customer@example.org", phone: "00 01 234 5678" }, } ) { id } } ``` ### Shipment sender You can specify a sender for your shipment with the `sender` field. It is an optional field: it allows you to pass the name, email, phone number, and the bank account number of the shipment's sender. The field requires the `name` field only. ```graphql title="GraphQL mutation" mutation { createShipment( input: { [...] sender: { firstName: "Fictitious", lastName: "Sender", email: "example_customer@example.org", phone: "00 01 234 5678", bankAccountNumber: "HU99111122223333444400000000" }, } ) { id } } ``` ### Shipment origin You can set an origin for the shipment. This can be a specific address or a pickup point ID, or even exact coordinates, depending on the shipment mode. The `origin` field uses the [`ShipmentOriginInput` type](/api/merchant/types/inputs/shipment-origin-input). In the example, we're setting an address with an exact location. ```graphql title="GraphQL mutation" mutation { createShipment( input: { [...] origin: { address: { country: HU, city: "Budapest", postalCode: "1061", addressLine1: "Nyugati tér 1." }, location: { latitude: 12.000245, longitude: 23.101214 } } } ) { id } } ``` ### Add a waybill to a shipment You can add a waybill to your shipment when creating it. It requires an existing waybill ID. :::note You can assign a waybill to your shipment later with the `assignShipmentToWaybill` mutation. ::: ```graphql title="GraphQL mutation" mutation { createShipment( input: { provider: "RIV", referenceId: "12345", recipient: { firstName: "Fictitious", lastName: "Customer", language: HU }, destination: { pickupPointId: "12345" }, waybillId: "abc123" } ) { id } } ``` ### Add parcels to a shipment You can specify the exact contents of a shipment with the `parcels` field. It requires: - A `referenceId`: A unique identifier for the parcel. - A `weight` field: The weight of the parcel in kilograms. Accepts a float as a value. ```graphql title="GraphQL mutation" mutation { createShipment( input: { provider: "RIV", referenceId: "12345", recipient: { firstName: "Fictitious", lastName: "Customer", language: HU }, destination: { pickupPointId: "12345" }, parcels: { referenceId: "asdf4567", weight: 1.5 } } ) { id } } ``` #### Parcel dimensions You can specify the dimensions of the parcel: length, width, and height, all in meters. ```graphql title="GraphQL mutation" mutation { createShipment( input: { provider: "RIV", referenceId: "12345", recipient: { firstName: "Fictitious", lastName: "Customer", language: HU }, destination: { pickupPointId: "12345" }, parcels: { referenceId: "asdf4567", weight: 1.5, dimensions: { width: 0.5, height: 0.5, length: 0.7 } } } ) { id } } ``` #### Parcel payment If the recipient must pay for their parcel on delivery, set the `cashOnDelivery` field. It requires an `amount` and a `currency` field: ```graphql title="GraphQL mutation" mutation { createShipment( input: { provider: "RIV", referenceId: "12345", recipient: { firstName: "Fictitious", lastName: "Customer", language: HU }, destination: { pickupPointId: "12345" }, parcels: { referenceId: "asdf4567", weight: 1.5, cashOnDelivery: { amount: 1500, currency: HUF } } } ) { id } } ``` ## Update the shipment information Use the `updateShipment` mutation to modify an existing shipment. When updating a shipment, you must set the shipment mode in the `mode` field. It can be one of three options: - Sender to recipient: The shipment is sent from the merchant to the customer. - Recipient to sender: The shipment is sent from the customer to the merchant. For example, the customer returns a previously ordered item. - Third-party to third-party: For example, a fulfillment center shipping to a logistics provider. ```graphql title="GraphQL mutation" mutation { updateShipment( input: { id: "12345" referenceId: "12345", recipient: { firstName: "Fictitious", lastName: "Customer", language: HU }, destination: { pickupPointId: "12345" }, mode: SENDER_TO_RECIPIENT } ) { id status { status } } } ``` The `updateShipment` mutation lets you modify all fields that you can set with the `createShipment` input. --- ## Create zones If your webshop delivers to more than one country, you can create zones. A zone consists of one or more countries and you can apply specific configurations, such as pricing rules, for each zone. ## Create a zone Create zones with the `createZone` mutation: it requires a name, and an array of countries. Refer to the countries by their country code: [CountryEnum](/api/merchant/types/enums/country-enum). ```graphql mutation { createZone( input: { name: "Zone 1", countries: [HU, SK] } ) { id } } ``` The mutation returns an automatically generated an ID that you can use to refer to the zone: ```json { "data": { "createZone": { "id": "69e70342-e740-4e67-83b3-9c5efabadff2" } } } ``` ## Delete a zone To delete a zone, you just need to pass the ID of the zone as an argument to the `deleteZone` mutation: ```graphql title="GraphQL mutation" mutation { deleteZone(id: "123abc") } ``` --- ## Configure delivery options for merchant You can configure delivery options for your merchants. This means: - Enabling the different delivery types. - Adding default information for the different delivery types. ## Enable delivery types Enabling a given delivery type means that customers can select it when placing an order. Delivery options need to be enabled for the merchant, as well as each provider. Use the `updateMerchantConfigurations` mutation. Its input field takes an array of objects that each need a key and a value. - For home delivery, the key is `HOME_DELIVERY_ENABLED`. - For pickup point delivery, the key is `PICKUP_POINT_ENABLED`. ```graphql title="GraphQL mutation" mutation { updateMerchantConfigurations( input: [{ key: HOME_DELIVERY_ENABLED, value: "true", }, { key: PICKUP_POINT_ENABLED, value: "true" }] ) { key value } } ``` ## Set delivery information Delivery information is additional text that is shown on the Delivery Gateway embedded UI when selecting a delivery method. You can specify different information for home delivery and pickup point delivery. Use the `updateMerchantConfigurations` mutation. Its input field takes an array of objects that each need a provider ID, a key, and a value. - For home delivery information, the key is `HOME_DELIVERY_INFORMATION`. - For pickup point delivery information, the key is `PICKUP_POINT_INFORMATION`. ```graphql title="GraphQL mutation" mutation { updateMerchantConfigurations( input: [{ key: HOME_DELIVERY_INFORMATION, value: "24 hour availability!", }, { key: PICKUP_POINT_INFORMATION, value: "We have over 1500 locations", }] ) { key value } } ``` --- ## Configure sender information For each merchant, we recommend configuring default sender information, such as your name, email, and address. You can set up Delivery Gateway to always send shipments with the default sender which makes the process much simpler. Use the `updateMerchantConfigurations` mutation to set up default sender information with the following keys: * `SENDER_ADDRESS_LINE1` * `SENDER_ADDRESS_LINE2` * `SENDER_CITY` * `SENDER_COUNTRY` * `SENDER_EMAIL` * `SENDER_NAME` * `SENDER_PHONE` * `SENDER_POSTAL_CODE` * `SENDER_STATE` :::note You can set these up on the Admin Dashboard, too. For each setting and their description, see [Merchant reference](/admin/reference/merchant#general-settings). ::: For example, to configure the default name and email address for your sender: ```graphql mutation { updateMerchantConfigurations( input: [{ key: SENDER_NAME, value: "Shoppiest Shop", }, { key: SENDER_EMAIL, value: "shoppiestshop@shoppiest.com", }] ) { key value } } ``` --- ## HTTP referrers for the embedded UI You can restrict access to the Delivery Gateway embedded UI: define allowed HTTP referrers to make sure only authorized platforms and services can integrate the UI with your merchant ID. :::warning We strongly recommend setting allowed HTTP referrers. Without it, anyone with access to your merchant ID can set up the Delivery Gateway frontend integration using your account. ::: To set up allowed HTTP referrers, use the `updateMerchantConfiguration` mutation with the `UI_ALLOWED_REFERRERS` key. :::note You can use a wildcard character for subdomain and path: for example, `https://*.beta.deliverygateway.io/*` ::: ```graphql mutation { updateMerchantConfiguration( input: { key: UI_ALLOWED_REFERRERS, value: "https://*.beta.deliverygateway.io/*" }, ) { key value } } --- ## Configure operators Operators manage pickup point locations. On Delivery Gateway, you can configure two things for the available operators: a title that allows easier identification and a priority. Use the `updateOperatorConfigurations` mutation to modify these settings for an operator. It requires: - An `operator`: you can see the available options at [OperatorEnum](/api/merchant/types/enums/operator-enum#values). - A `key` and a `value` field for each setting: the respective keys are `PRIORITY` and `TITLE`. ```graphql title="GraphQL mutation" mutation { updateOperatorConfigurations( input: [ { operator: MOE, key: PRIORITY, value: "1" }, { operator: MOE, key: TITLE, value: "Most Excellent Operator" } ] ) } ``` --- ## Configure delivery options for providers You can configure delivery options separately for each provider. This includes: - Enabling home delivery and pickup point delivery. - Setting information for both delivery types. :::note You can perform all these actions in the Delivery Gateway Admin Dashboard. ::: ## Enable the provider Your customers can only select a specific provider if it is enabled. To enable the provider, use the `updateProviderConfigurations` mutation and set the `AVAILABLE` key to `true`: ```graphql title="GraphQL mutation" mutation { updateProviderConfigurations( input: [{ provider: BEST_PROV, key: AVAILABLE, value: "true", },] ) { key value } } ``` ## Enable delivery types Enabling a given delivery type means that customers can select it when placing an order. You need to enable delivery options for each provider. Use the `updateProviderConfigurations` mutation. Its input field takes an array of objects that each need a provider ID, a key, and a value. - For home delivery, the key is `HOME_DELIVERY_AVAILABLE`. - For pickup point delivery, the key is `PICKUP_POINT_AVAILABLE`. To enable both: ```graphql title="GraphQL mutation" mutation { updateProviderConfigurations( input: [{ provider: BEST_PROV, key: HOME_DELIVERY_AVAILABLE, value: "true", }, { provider: BEST_PROV, key: PICKUP_POINT_AVAILABLE, value: "true" }] ) { key value } } ``` ## Set delivery information Delivery information is additional text that is shown on the Delivery Gateway embedded UI when selecting a provider. You can specify different information for home delivery and pickup point delivery. Use the `updateProviderConfigurations` mutation. Its input field takes an array of objects that each need a provider ID, a key, and a value. - For home delivery information, the key is `HOME_DELIVERY_INFORMATION`. - For pickup point delivery information, the key is `PICKUP_POINT_INFORMATION`. ```graphql title="GraphQL mutation" mutation { updateProviderConfigurations( input: [{ provider: BEST_PROV, key: HOME_DELIVERY_INFORMATION, value: "24 hour availability!", }, { provider: BEST_PROV, key: PICKUP_POINT_INFORMATION, value: "We have over 1500 locations" }] ) { key value } } ``` --- ## Configure required address fields You can set different address requirements for each provider. Address requirements define what information the customer must provide when selecting a delivery method and a provider. You can set the required information separately for home delivery and for pickup point delivery. ```graphql mutation { updateProviderConfigurations( input: [{ provider: "GLS", key: REQUIRED_ADDRESS_FIELDS_FOR_HOME_DELIVERY, value: "first_name,last_name,email,phone,country,city,postal_code,address_line1,address_line2,location", }, { provider: "GLS", key: REQUIRED_ADDRESS_FIELDS_FOR_PICKUP_POINT_DELIVERY, value: "first_name,last_name,email,phone", }] ) { key value } } ``` --- ## Enable a provider To make providers available for customers, you need authentication data. The exact requirements differ based on the provider. For example, a provider might need a merchant API key, a merchant tracking API key, a customer ID and a client ID. You can configure these with the `updateProviderConfigurations` mutation. ```graphql title="GraphQL mutation" mutation { updateProviderConfigurations( input: [ { provider: BestProv, key: API_KEY, value: "12315789-abcdefg", }, { provider: BestProv, key: TRACKING_API_KEY, value: "12315789-abcdefg", }, { provider: BestProv, key: CUSTOMER_ID, value: "abc123" }, { provider: BestProv, key: CLIENT_ID, value: "abc123" },] ) { provider key value } } ``` Check out the required data for each provider: [Required credentials](/admin/reference/providers). In addition, you must set the provider to available: ```graphql title="GraphQL mutation" mutation { updateProviderConfigurations( input: [{ provider: BEST_PROV, key: AVAILABLE, value: "true", },] ) { key value } } ``` --- ## Add parcel information to session There are two ways of passing parcel information to a session: - Create a packaging and set it as the default. - Add parcel information during the session. If you create a default packaging and you don't provide parcel details during a session, the default packaging will be used. To add packaging information during session creation, use the `parcels` field. It requires two fields: - `weight`: The weight of the parcel in kilogramms. The field takes a float as a value. - `dimensions`: The length, width, and height of the parcel in meters. Takes floats as values. ```graphql mutation { session( input: { parcels: { weight: 2, dimensions: { width: 1.5, length: 2, height: 0.5 } } } ) { id, parcels { weight } } } ``` You can add additional costs to your parcels: - Add insurance costs for parcel insurance. - Add a cash on delivery cost. :::note All the relevant fields require [the `Money` object type](/api/merchant/types/objects/money), with the amount and the currency specified. ::: ```graphql mutation { session( input: { parcels: { weight: 2, dimensions: { width: 1.5, length: 2, height: 0.5 }, cashOnDelivery: { amount: 1.5, currency: EUR }, insurance: { amount: 5, currency: EUR } } } ) { id, parcels { weight } } } ``` --- ## Manage authenticated customers Authenticated customers can access additional features during a session, such managing customer addresses. To enable it, generate a `referenceId` string in your backend system for authenticated customers. When creating or updating the session, add the `customer` input field and identify the customer with the `referenceId` field. ```graphql mutation { session( input: { id: "4fa5697b-2c7f-44ff-973a-6238f26e473c" customer: { referenceId: "123abc" } } ) { id } } ``` ```curl curl 'https://api.deliverygateway.io/graphql/merchant' -H 'Accept-Encoding: gzip, deflate, br' -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Connection: keep-alive' -H 'Authorization: ' --data-binary '{"query":"mutation {\n session(\n input: {\n id: \"4fa5697b-2c7f-44ff-973a-6238f26e473c\"\n customer: {\n referenceId: \"123abc\"\n }\n }\n )\n {\n id\n }\n}","variables":{}}' --compressed ``` You can set an already existing address to the customer. To do that, the address also needs a `referenceId` to identify it. You can also give it a custom label with the `label` field which takes a string: ```graphql mutation { session( input: { id: "4fa5697b-2c7f-44ff-973a-6238f26e473c" customer: { referenceId: "123abc", addresses: [{ referenceId: "address123xyz", label: "Custom label for Address 123 XYZ", }] } } ) { id } } ``` Each address has three components: - Recipient: The name of the addressee, the communication language, and their email address and phone number. - Address: The actual postal address, including country, city, and street. - Location: The precise location, defined by latitude and longitude coordinates. This is optional by default but you can configure your merchant to always require it from customers. Both latitude and longitude values take floats as values: ```graphql mutation { session( input: { id: "4fa5697b-2c7f-44ff-973a-6238f26e473c" customer: { referenceId: "123abc", addresses: [{ referenceId: "address123xyz", label: "Custom label for Address 123 XYZ", recipient: { firstName: String! lastName: String! # Communication language for the addressee. language: LanguageEnum! email: String phone: String } address: { country: CountryEnum! state: String city: String! postalCode: String! addressLine1: String! addressLine2: String note: String } location: { latitude: Float! longitude: Float! } }] } } ) { id } } ``` --- ## Create and update a session Create a session with the `session` mutation. A bare minimum session requires no inputs and returns its automatically generated ID: ```graphql mutation { session( input: { } ) { id } } ``` When you need to update an existing session, you just need the `id` to retrieve it: ```graphql mutation { session( input: { id: "72f1b7aa-ae56-4c84-b289-863f33e7c219" } ) { id } } ``` The `SessionInput` type allows you to configure session details. By default, currency is configured in the merchant configuration, while the language is defined by the OS or browser locale. To override them, set a currency and a language for the session: ```graphql mutation { session( input: { currency: EUR, language: EN } ) { id } } ``` --- ## Manage delivery methods During a session, you can override the pre-configured delivery method settings. You can enable or disable home delivery and pickup point delivery, select different providers, or set up new pricing configurations. ## Enable a delivery method during a session By default, the merchant configuration determines if pickup point delivery or home delivery is available for a customer. You can override the setting when creating or updating a session by using `enabled` which takes a boolean: ```graphql mutation { session( input: { pickupPoint: { enabled: true } } ) { id } } ``` ```graphql mutation { session( input: { homeDelivery: { enabled: true } } ) { id } } ``` ## Enable specific providers Provider availability is defined by the provider configuration. You can override it during a session with the `providers` field, both for home delivery and pickup point delivery. If the `provider` field is not used or left blank, all enabled providers will be available. To check the list of available providers, see [ProviderEnum](/api/merchant/types/scalars/provider-enum). ```graphql mutation { session( input: { pickupPoint: { enabled: true, provider: "Red Ivorp" } } ) { id } } ``` ```graphql mutation { session( input: { homeDelivery: { enabled: true, provider: "Red Ivorp" } } ) { id } } ``` ## Enforce precise location for home delivery You can ask the customer to check and provide an exact location, with coordinates. By default, you can configure this in the merchant configuration but you can override the setting here. To enable it, set the `location` field of `homeDelivery` to `true`. ```graphql mutation { session( input: { homeDelivery: { enabled: true, location: true } } ) { id } } ``` ## Set recipient details for pickup point delivery Pickup point delivery requires recipient details such as name, language, email address and phone number. You can set this information in the `recipient` field of `pickupPoint` during a session. Unless all the information is available, Delivery Gateway will ask the customer to provide the details. :::note Authenticated customers can use saved addresses. In this case, you don't need to handle recipient details separately. See [Manage authenticated customers](/dev/how-tos/sessions/authenticate-customers) for details. ::: The `recipient` field's subfields all take strings, with the exception of language. For the list of available languages, see [LanguageEnum](/api/merchant/types/enums/language-enum). ```graphql mutation { session( input: { pickupPoint: { recipient: { firstName: true, lastName: true, language: email: phone: } } } ) { id } } ``` --- ## Update pricing during a session ### Update pricing for all delivery types You can update pricing information during a session, instead of using the pre-configured pricing rules. Use the `price` field when creating and/or updating a session: ```graphql mutation { session( input: { price: [{}] } ) { id } } ``` The `SessionPriceInput` type has two fields: `provider` and `price`. The `provider` field allows you to select a provider to whom the session pricing applies. If left blank, it will apply to all available providers. To check the list of available providers, see [ProviderEnum](/api/merchant/types/scalars/provider-enum). ```graphql mutation { session( input: { price: [{ provider: "Red Ivorp" }] } ) { id } } ``` To update the price, set the currency and the amount in the `price` field. In this example, the new price of €4.5 will apply to the provider Red Ivorp. ```graphql mutation { session( input: { price: [{ provider: "Red Ivorp", price: { currency: EUR, amount: 4.5, } }] } ) { id } } ``` ### Update pricing for a specific delivery type Instead of updating pricing for all deliveries, you can create a new pricing for either home delivery or pickup point delivery. The `price` field is available for both `homeDelivery` and `pickupPoint`: ```graphql title="Price of home delivery" mutation { session( input: { homeDelivery: { enabled: true, price: [{ price: { amount: 4, currency: USD } }] } } ) { id } } ``` ```graphql title="Price of pickup point delivery" mutation { session( input: { pickupPoint: { enabled: true, price: [{ price: { amount: 4, currency: USD } }] } } ) { id } } ``` --- ## Roles and permissions reference | Role | Permissions | Description | |------|-------------|-------------| | `merchant:token` | - `merchant:token:create`- `merchant:token:list`- `merchant:token:delete` | Create, list, and delete [Bearer access tokens](/dev/getting-started/authentication). | | `merchant:provider` | - `merchant:provider:list` | List the available providers. | | `merchant:operator` | - `merchant:operator:list` | List the available operators. | | `merchant:configuration` | - `merchant:configuration:list`- `merchant:configuration:get`- `merchant:configuration:update` | View and update everything in the [merchant configuration](/admin/how-tos/merchant-config). See the [available settings](/admin/reference/merchant). | | `merchant:webhook` | - `merchant:webhook:create`- `merchant:webhook:list`- `merchant:webhook:get`- `merchant:webhook:update`- `merchant:webhook:delete` | Create, list, update, and delete [webhooks](/dev/how-tos/configure-webhooks). | | `merchant:shipment` | - `merchant:shipment:create`- `merchant:shipment:list`- `merchant:shipment:get`- `merchant:shipment:update`- `merchant:shipment:delete` | Create, list update, and delete [shipments](/dev/how-tos/create-shipment). | | `merchant:waybill` | - `merchant:waybill:create`- `merchant:waybill:list`- `merchant:waybill:get`- `merchant:waybill:update`- `merchant:waybill:delete` | Create, list, update, and delete waybills. | | `merchant:session` | - `merchant:session:create`- `merchant:session:get` | Initialize a new Delivery Gateway session and retrieve an existing session's data. | | `merchant:zone` | - `merchant:zone:create`- `merchant:zone:list`- `merchant:zone:get`- `merchant:zone:update`- `merchant:zone:delete` | Create, list, update, and delete [geographical zones](/admin/how-tos/create-zones). | | `merchant:pricing` | - `merchant:pricing:create`- `merchant:pricing:list`- `merchant:pricing:get`- `merchant:pricing:update`- `merchant:pricing:delete` | Create, list, update, and delete [pricing rules](/admin/how-tos/create-pricing). | | `merchant:theme` | - `merchant:theme:create`- `merchant:theme:list`- `merchant:theme:get`- `merchant:theme:update`- `merchant:theme:delete` | Create, list, update, and delete [themes](/admin/how-tos/integrations/theming). | | `merchant:packaging` | - `merchant:packaging:create`- `merchant:packaging:list`- `merchant:packaging:get`- `merchant:packaging:update`- `merchant:packaging:delete` | Create, list, update, and delete [packagings](/admin/how-tos/create-packaging) | --- ## DGW.mount Usage: `DGW.mount(opts)`; ## Mount Initialization Options Use these options when calling DGW.mount(opts). ### Core options | Parameter | Type | Required | Description | |---|---|---|---| | containerId | string | Conditionally | ID of the container element where the plugin will be rendered. Use this or container. | | container | HTMLElement | Conditionally | Direct DOM element where the plugin will be rendered. Use this or containerId. | | portalRootContainer | HTMLDivElement | No | Custom portal root for modals and overlays. Useful if you need popups rendered into a specific DOM subtree. | | overrideThemeVars | DgwThemeVars | No | Runtime theme variable overrides (brand color, rounding, font family). | | view | DgwView | Yes | Defines which plugin view is rendered. | | sessionId | string | Conditionally | Existing session ID to load. Use this or merchantId. | | merchantId | string | Conditionally | Merchant ID for plugin-managed session creation. Use this or sessionId. | | themeHandle | string | No | Applies a configured theme by handle. | | sessionInitOpts | CreateSessionInput | No | Session creation payload used with merchant-based initialization. | | disableShadowDOM | boolean | No | Disables Shadow DOM encapsulation so host page styles can affect plugin internals more directly. | ### Callback options | Parameter | Description | |---|---| | onAddressSelected | Triggered when user selects an address or pickup point. Can return validation result to block/allow continuation. | | onAddressSelectionSucceeded | Triggered after a successful address or pickup selection flow. | | onAddressBeforeCreate | Called before creating an address. Can modify flow data (for example referenceId). | | onAddressCreated | Called after an address is created. | | onAddressBeforeUpdate | Called before updating an address. Can modify flow data (for example referenceId). | | onAddressUpdated | Called after an address is updated. | | onAddressDeleted | Called after an address is deleted. | | onSessionLoaded | Called when session data has finished loading. | | onClosed | Called when the plugin UI is closed (for example modal close). | ### Theme override object (overrideThemeVars) | Field | Type | Description | |---|---|---| | brand_color | string \| null | Primary brand color override. | | surface_rounding | rounded \| square \| null | Controls surface corner style. | | button_rounding | full \| default \| square \| null | Controls button corner style. | | font_family | string \| null | Global font family override. | ## View-specific options ### delivery-method-selection | Parameter | Type | Required | Description | |---|---|---|---| | type | delivery-method-selection | Yes | Selects the delivery method selector view. | | openSelectedMethodInModal | boolean | No | Opens pickup/address step in modal instead of inline flow. | | operatorsAsSeparateMethods | boolean | No | Renders pickup operators as separate delivery method options. | | showHomeDeliveryOperatorIcons | boolean | No | Displays operator icons for home delivery methods. | | homeDeliveryOverride | object | No | Customizes home-delivery selection behavior. | | homeDeliveryOverride.onSelect | `() => boolean \| Promise \| undefined` | No | Intercepts selection and can allow/deny custom logic. | | homeDeliveryOverride.initialSelected | boolean | No | Sets initial selected state for home-delivery override flow. | | customPickupPointAsSeparateMethod | boolean | No | Renders custom pickup points (merchant's stores) as separate delivery method options in the delivery method selection step. | | showFiltersByDefault | boolean | No | Controls whether the filter sidebar is open by default (default: `false`) | ### pickup-point-selection | Parameter | Type | Required | Description | |---|---|---|---| | type | pickup-point-selection | Yes | Selects standalone pickup point selector view. | | openInModal | boolean | No | Opens selector in modal mode. | | hideMainLoadingIndicator | boolean | No | Hides main loading indicator during init and post-selection states. | | selectedOperatorFilters | OperatorEnum[] | No | Preselects operator filters. | | ownShopFilterSelected | boolean | No | Preselects own-shop filter. | | showFiltersByDefault | boolean | No | Controls whether the filter sidebar is open by default (default: `false`) | ### address-selection | Parameter | Type | Required | Description | |---|---|---|---| | type | address-selection | Yes | Selects standalone address selector view. | | openInModal | boolean | No | Opens selector in modal mode. | | hideMainLoadingIndicator | boolean | No | Hides main loading indicator. | ### location-verification | Parameter | Type | Required | Description | |---|---|---|---| | type | location-verification | Yes | Selects standalone location verification view. | | initialLocation | `{ latitude: number; longitude: number }` | Yes | Default location shown on the map. | | interactive | boolean | No | Shows the interactive Mapbox map when `true`, or a static Mapbox image when `false`. Default: `true`. | | zoomLevel | number | No | Sets the zoom level for both the interactive map and static image. Values are clamped to the Mapbox range `0`-`22`. | | hideInterface | boolean | No | Hides the message and action containers in interactive mode. Default: `false`. | | onLocationChange | `(latitude: number, longitude: number) => void` | No | Called when the user changes the selected location in interactive mode. | Static mode uses the same map style as the interactive map, calculates the image size from the rendered map container, and displays the custom marker over the image. ### profile-page-address-list | Parameter | Type | Required | Description | |---|---|---|---| | type | profile-page-address-list | Yes | Renders profile address management page/list view. | ## Related DGW API | Method | Signature | Description | |---|---|---| | preloadSession | `preloadSession({ apiUrl, sessionId, merchantId, sessionInitOpts }): Promise` | Preloads session-related data before mount to reduce perceived latency on first open. | | getI18nLanguage | getI18nLanguage(): HU \| EN \| NL | Returns the active plugin language code. | | execute | `execute(command, ...args): void` | Sends a command to mounted DGW views. | ### Supported execute commands | Command | Arguments | Description | |---|---|---| | location-verification.toggleInteractive | `interactive?: boolean` | Toggles mounted location verification views between interactive and static mode. Pass `true` to force interactive mode, `false` to force static mode, or omit the argument to toggle the current mode. | ## Browser events | Event name | Detail | Description | |---|---|---| | api.deliverygateway.io/location-verification-message | `{ messageKey: "initial" \| "thankYou" \| "tooFarAway" }` | Dispatched whenever the location verification message changes. | ### The returned DGW instance fields | Field name and format | Type | Description | |---|---|---| | unmount() | `() => void` | Immediately unmounts the instance, removing all content from the container. | | isMounted() | `() => boolean` | Returns a boolean indicating whether the instance is still mounted. | --- ## Shipment statuses The following shipment statuses are available in the `ShipmentStatusEnum` type: - `WAITING_FOR_COLLECTION`: The provider has accepted the shipment and they're expecting its arrival. - `IN_PROGRESS`: The delivery is underway. - `DELIVERING`: The shipment is either with the courier or it is being transported to a pickup point. - `RECEIVABLE`: You can pick up the shipment at a pickup point. - `DELIVERED`: The final status: the recipient has received the shipment. - `FAILING`: The delivery can't be successfully completed. Usually this means the shipment is getting sent back to the sender. - `FAILED`: The delivery failed. The `reason` field will contain the nature of the problem. --- ## Merchant API reference Delivery Gateway offers a robust GraphQL API that allows developers to access all core features—like shipment creation, label generation, and status tracking. It enables you to connect your custom webshop or platform and automate your logistics workflow. Our API documentation covers endpoints, authentication, and integration details. ## Authentication All requests to the Merchant API must be authenticated with a valid access token. Include your token as a Bearer token on all API requests. Learn more about [authentication and authorization](/dev/getting-started/authentication). ## Endpoints and queries GraphQL queries are executed by sending `POST` HTTP requests to the endpoint: - `https://api.sandbox.deliverygateway.io/graphql/merchant` in the sandbox environment and - `https://api.deliverygateway.io/graphql/merchant` in the production environment. You can use cURL or an HTTP client such as [Postman](https://www.postman.com/) or [Insomnia](https://insomnia.rest/) to query the API. ### Postman collection You can import our [Postman collection](https://www.postman.com/deliverygateway) to explore and test the Merchant API endpoints. [![Run In Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/50417061-5e1d77f4-d5e6-4d26-b781-2531832f19e6?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D50417061-5e1d77f4-d5e6-4d26-b781-2531832f19e6%26entityType%3Dcollection%26workspaceId%3D35899d1c-cf0f-4eb3-8c12-1c221e07fbab#?env%5BSandbox%5D=W3sia2V5IjoiYmFzZV91cmwiLCJ2YWx1ZSI6Imh0dHBzOi8vYXBpLnNhbmRib3guZGVsaXZlcnlnYXRld2F5LmlvL2dyYXBocWwvbWVyY2hhbnQiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsInNlc3Npb25WYWx1ZSI6Imh0dHBzOi8vYXBpLnNhbmRib3guZGVsaXZlcnlnYXRld2F5LmlvL2dyYXBocWwvbWVyY2hhbnQiLCJjb21wbGV0ZVNlc3Npb25WYWx1ZSI6Imh0dHBzOi8vYXBpLnNhbmRib3guZGVsaXZlcnlnYXRld2F5LmlvL2dyYXBocWwvbWVyY2hhbnQiLCJzZXNzaW9uSW5kZXgiOjB9LHsia2V5IjoiYXBpX3Rva2VuIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoic2VjcmV0Iiwic2Vzc2lvblZhbHVlIjoiTndhcVFYcTM3MG51NGpmS3NNeW9wRzRLQXZDNk04NGZHWHhzVHJ2VSIsImNvbXBsZXRlU2Vzc2lvblZhbHVlIjoiTndhcVFYcTM3MG51NGpmS3NNeW9wRzRLQXZDNk04NGZHWHhzVHJ2VSIsInNlc3Npb25JbmRleCI6MX1d) ### cURL example ```bash title="Example cURL request" curl -X POST https://api.sandbox.deliverygateway.io/graphql/merchant \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{"query": "query { me { id name } }"}' ``` ```graphql title="GraphQL query" query { me { id name } } ``` The response will look like this: ```json title="GraphQL response" { "data": { "me": { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "name": "Merchant Name" } } } ``` ## Rate limiting Not implemented yet, but will be in the future. ## Status and error codes All API queries return HTTP status codes that contain more information about the response. ### 200 OK GraphQL HTTP status codes are different from REST API status codes. Most importantly, the GraphQL API can return a `200 OK` response code in cases that would typically produce 4xx or 5xx errors in REST. ### Error handling The response for the errors object contains additional detail to help you debug your operation. The response for mutations contains additional detail to help debug your query. --- ## activateSubscription export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql activateSubscription( input: MerchantSubscriptionActivationInput! ): MerchantSubscriptionConfirmation ``` ### Arguments #### [activateSubscription.input](#)[MerchantSubscriptionActivationInput!](/api/merchant/types/inputs/merchant-subscription-activation-input.mdx) ### Type #### [MerchantSubscriptionConfirmation](/api/merchant/types/objects/merchant-subscription-confirmation.mdx) --- ## assignShipmentToWaybill export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql assignShipmentToWaybill( input: AssignShipmentToWaybillInput! ): Shipment! ``` ### Arguments #### [assignShipmentToWaybill.input](#)[AssignShipmentToWaybillInput!](/api/merchant/types/inputs/assign-shipment-to-waybill-input.mdx) ### Type #### [Shipment](/api/merchant/types/objects/shipment.mdx) --- ## closeWaybill export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql closeWaybill( id: ID! ): Waybill! ``` ### Arguments #### [closeWaybill.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Waybill](/api/merchant/types/objects/waybill.mdx) --- ## createPackaging export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql createPackaging( input: CreatePackagingInput! ): Packaging! ``` ### Arguments #### [createPackaging.input](#)[CreatePackagingInput!](/api/merchant/types/inputs/create-packaging-input.mdx) ### Type #### [Packaging](/api/merchant/types/objects/packaging.mdx) --- ## createPickupPoint export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql createPickupPoint( input: CreatePickupPointInput! ): PickupPoint! ``` ### Arguments #### [createPickupPoint.input](#)[CreatePickupPointInput!](/api/merchant/types/inputs/create-pickup-point-input.mdx) ### Type #### [PickupPoint](/api/merchant/types/objects/pickup-point.mdx) --- ## createPricing export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql createPricing( input: CreatePricingInput! ): Pricing! ``` ### Arguments #### [createPricing.input](#)[CreatePricingInput!](/api/merchant/types/inputs/create-pricing-input.mdx) ### Type #### [Pricing](/api/merchant/types/objects/pricing.mdx) --- ## createShipment export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql createShipment( input: CreateShipmentInput! ): Shipment! ``` ### Arguments #### [createShipment.input](#)[CreateShipmentInput!](/api/merchant/types/inputs/create-shipment-input.mdx) ### Type #### [Shipment](/api/merchant/types/objects/shipment.mdx) --- ## createTheme export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql createTheme( input: CreateThemeInput! ): Theme! ``` ### Arguments #### [createTheme.input](#)[CreateThemeInput!](/api/merchant/types/inputs/create-theme-input.mdx) ### Type #### [Theme](/api/merchant/types/objects/theme.mdx) --- ## createToken export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql createToken( input: CreateTokenInput! ): String! ``` ### Arguments #### [createToken.input](#)[CreateTokenInput!](/api/merchant/types/inputs/create-token-input.mdx) ### Type #### [String](/api/merchant/types/scalars/string.mdx) The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text. --- ## createUser export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql createUser( input: CreateUserInput! ): User! ``` ### Arguments #### [createUser.input](#)[CreateUserInput!](/api/merchant/types/inputs/create-user-input.mdx) ### Type #### [User](/api/merchant/types/objects/user.mdx) --- ## createWaybill export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql createWaybill( input: CreateWaybillInput! ): Waybill! ``` ### Arguments #### [createWaybill.input](#)[CreateWaybillInput!](/api/merchant/types/inputs/create-waybill-input.mdx) ### Type #### [Waybill](/api/merchant/types/objects/waybill.mdx) --- ## createWebhook export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql createWebhook( input: CreateWebhookInput! ): Webhook! ``` ### Arguments #### [createWebhook.input](#)[CreateWebhookInput!](/api/merchant/types/inputs/create-webhook-input.mdx) ### Type #### [Webhook](/api/merchant/types/objects/webhook.mdx) --- ## createZone export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql createZone( input: CreateZoneInput! ): Zone! ``` ### Arguments #### [createZone.input](#)[CreateZoneInput!](/api/merchant/types/inputs/create-zone-input.mdx) ### Type #### [Zone](/api/merchant/types/objects/zone.mdx) --- ## deletePackaging export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql deletePackaging( id: ID! ): Void ``` ### Arguments #### [deletePackaging.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Void](/api/merchant/types/scalars/void.mdx) A return type for void mutations. --- ## deletePricing export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql deletePricing( id: ID! ): Void ``` ### Arguments #### [deletePricing.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Void](/api/merchant/types/scalars/void.mdx) A return type for void mutations. --- ## deleteShipment export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql deleteShipment( id: ID! ): Void ``` ### Arguments #### [deleteShipment.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Void](/api/merchant/types/scalars/void.mdx) A return type for void mutations. --- ## deleteTheme export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql deleteTheme( id: ID! ): Void ``` ### Arguments #### [deleteTheme.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Void](/api/merchant/types/scalars/void.mdx) A return type for void mutations. --- ## deleteToken export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql deleteToken( id: ID! ): Void ``` ### Arguments #### [deleteToken.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Void](/api/merchant/types/scalars/void.mdx) A return type for void mutations. --- ## deleteUser export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql deleteUser( id: ID! ): Void ``` ### Arguments #### [deleteUser.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Void](/api/merchant/types/scalars/void.mdx) A return type for void mutations. --- ## deleteWaybill export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql deleteWaybill( id: ID! ): Waybill! ``` ### Arguments #### [deleteWaybill.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Waybill](/api/merchant/types/objects/waybill.mdx) --- ## deleteWebhook export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql deleteWebhook( id: ID! ): Void ``` ### Arguments #### [deleteWebhook.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Void](/api/merchant/types/scalars/void.mdx) A return type for void mutations. --- ## deleteZone export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql deleteZone( id: ID! ): Void ``` ### Arguments #### [deleteZone.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Void](/api/merchant/types/scalars/void.mdx) A return type for void mutations. --- ## inactivatePickupPoint export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql inactivatePickupPoint( id: ID referenceId: String ): PickupPoint! ``` ### Arguments #### [inactivatePickupPoint.id](#)[ID](/api/merchant/types/scalars/id.mdx) #### [inactivatePickupPoint.referenceId](#)[String](/api/merchant/types/scalars/string.mdx) ### Type #### [PickupPoint](/api/merchant/types/objects/pickup-point.mdx) --- ## obtainWebhook export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql obtainWebhook( input: ObtainWebhookInput! ): Webhook! ``` ### Arguments #### [obtainWebhook.input](#)[ObtainWebhookInput!](/api/merchant/types/inputs/obtain-webhook-input.mdx) ### Type #### [Webhook](/api/merchant/types/objects/webhook.mdx) --- ## ping export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql ping: String! ``` ### Type #### [String](/api/merchant/types/scalars/string.mdx) The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text. --- ## sessionToShipment export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql sessionToShipment( input: SessionToShipmentInput! ): Shipment! ``` ### Arguments #### [sessionToShipment.input](#)[SessionToShipmentInput!](/api/merchant/types/inputs/session-to-shipment-input.mdx) ### Type #### [Shipment](/api/merchant/types/objects/shipment.mdx) --- ## session export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql session( input: SessionInput ): Session! ``` ### Arguments #### [session.input](#)[SessionInput](/api/merchant/types/inputs/session-input.mdx) ### Type #### [Session](/api/merchant/types/objects/session.mdx) --- ## subscribe export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql subscribe( input: MerchantSubscriptionInput! ): MerchantSubscriptionConfirmation ``` ### Arguments #### [subscribe.input](#)[MerchantSubscriptionInput!](/api/merchant/types/inputs/merchant-subscription-input.mdx) ### Type #### [MerchantSubscriptionConfirmation](/api/merchant/types/objects/merchant-subscription-confirmation.mdx) --- ## unassignShipmentFromWaybill export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql unassignShipmentFromWaybill( id: ID! ): Shipment! ``` ### Arguments #### [unassignShipmentFromWaybill.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Shipment](/api/merchant/types/objects/shipment.mdx) --- ## unsubscribe export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql unsubscribe: Void ``` ### Type #### [Void](/api/merchant/types/scalars/void.mdx) A return type for void mutations. --- ## updateFulfillmentConfiguration export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql updateFulfillmentConfiguration( input: UpdateFulfillmentConfigurationInput! ): FulfillmentConfiguration! ``` ### Arguments #### [updateFulfillmentConfiguration.input](#)[UpdateFulfillmentConfigurationInput!](/api/merchant/types/inputs/update-fulfillment-configuration-input.mdx) ### Type #### [FulfillmentConfiguration](/api/merchant/types/objects/fulfillment-configuration.mdx) --- ## updateFulfillmentConfigurations export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql updateFulfillmentConfigurations( input: [UpdateFulfillmentConfigurationInput!]! ): [FulfillmentConfiguration!]! ``` ### Arguments #### [updateFulfillmentConfigurations.input](#)[[UpdateFulfillmentConfigurationInput!]!](/api/merchant/types/inputs/update-fulfillment-configuration-input.mdx) ### Type #### [FulfillmentConfiguration](/api/merchant/types/objects/fulfillment-configuration.mdx) --- ## updateMerchantConfiguration export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql updateMerchantConfiguration( input: UpdateMerchantConfigurationInput! ): MerchantConfiguration! ``` ### Arguments #### [updateMerchantConfiguration.input](#)[UpdateMerchantConfigurationInput!](/api/merchant/types/inputs/update-merchant-configuration-input.mdx) ### Type #### [MerchantConfiguration](/api/merchant/types/objects/merchant-configuration.mdx) --- ## updateMerchantConfigurations export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql updateMerchantConfigurations( input: [UpdateMerchantConfigurationInput!]! ): [MerchantConfiguration!]! ``` ### Arguments #### [updateMerchantConfigurations.input](#)[[UpdateMerchantConfigurationInput!]!](/api/merchant/types/inputs/update-merchant-configuration-input.mdx) ### Type #### [MerchantConfiguration](/api/merchant/types/objects/merchant-configuration.mdx) --- ## updateMerchantIcon export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql updateMerchantIcon( input: Upload ): Merchant! ``` ### Arguments #### [updateMerchantIcon.input](#)[Upload](/api/merchant/types/scalars/upload.mdx) ### Type #### [Merchant](/api/merchant/types/objects/merchant.mdx) --- ## updateOperatorConfiguration export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql updateOperatorConfiguration( input: UpdateOperatorConfigurationInput! ): OperatorConfiguration! ``` ### Arguments #### [updateOperatorConfiguration.input](#)[UpdateOperatorConfigurationInput!](/api/merchant/types/inputs/update-operator-configuration-input.mdx) ### Type #### [OperatorConfiguration](/api/merchant/types/objects/operator-configuration.mdx) --- ## updateOperatorConfigurations export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql updateOperatorConfigurations( input: [UpdateOperatorConfigurationInput!]! ): [OperatorConfiguration!]! ``` ### Arguments #### [updateOperatorConfigurations.input](#)[[UpdateOperatorConfigurationInput!]!](/api/merchant/types/inputs/update-operator-configuration-input.mdx) ### Type #### [OperatorConfiguration](/api/merchant/types/objects/operator-configuration.mdx) --- ## updatePackaging export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql updatePackaging( input: UpdatePackagingInput! ): Packaging! ``` ### Arguments #### [updatePackaging.input](#)[UpdatePackagingInput!](/api/merchant/types/inputs/update-packaging-input.mdx) ### Type #### [Packaging](/api/merchant/types/objects/packaging.mdx) --- ## updatePickupPoint export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql updatePickupPoint( input: UpdatePickupPointInput! ): PickupPoint! ``` ### Arguments #### [updatePickupPoint.input](#)[UpdatePickupPointInput!](/api/merchant/types/inputs/update-pickup-point-input.mdx) ### Type #### [PickupPoint](/api/merchant/types/objects/pickup-point.mdx) --- ## updatePricing export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql updatePricing( input: UpdatePricingInput! ): Pricing! ``` ### Arguments #### [updatePricing.input](#)[UpdatePricingInput!](/api/merchant/types/inputs/update-pricing-input.mdx) ### Type #### [Pricing](/api/merchant/types/objects/pricing.mdx) --- ## updateProviderConfiguration export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql updateProviderConfiguration( input: UpdateProviderConfigurationInput! ): ProviderConfiguration! ``` ### Arguments #### [updateProviderConfiguration.input](#)[UpdateProviderConfigurationInput!](/api/merchant/types/inputs/update-provider-configuration-input.mdx) ### Type #### [ProviderConfiguration](/api/merchant/types/objects/provider-configuration.mdx) --- ## updateProviderConfigurations export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql updateProviderConfigurations( input: [UpdateProviderConfigurationInput!]! ): [ProviderConfiguration!]! ``` ### Arguments #### [updateProviderConfigurations.input](#)[[UpdateProviderConfigurationInput!]!](/api/merchant/types/inputs/update-provider-configuration-input.mdx) ### Type #### [ProviderConfiguration](/api/merchant/types/objects/provider-configuration.mdx) --- ## updateShipment export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql updateShipment( input: UpdateShipmentInput! ): Shipment! ``` ### Arguments #### [updateShipment.input](#)[UpdateShipmentInput!](/api/merchant/types/inputs/update-shipment-input.mdx) ### Type #### [Shipment](/api/merchant/types/objects/shipment.mdx) --- ## updateTheme export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql updateTheme( input: UpdateThemeInput! ): Theme! ``` ### Arguments #### [updateTheme.input](#)[UpdateThemeInput!](/api/merchant/types/inputs/update-theme-input.mdx) ### Type #### [Theme](/api/merchant/types/objects/theme.mdx) --- ## updateWebhook export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql updateWebhook( input: UpdateWebhookInput! ): Webhook! ``` ### Arguments #### [updateWebhook.input](#)[UpdateWebhookInput!](/api/merchant/types/inputs/update-webhook-input.mdx) ### Type #### [Webhook](/api/merchant/types/objects/webhook.mdx) --- ## updateZone export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql updateZone( input: UpdateZoneInput! ): Zone! ``` ### Arguments #### [updateZone.input](#)[UpdateZoneInput!](/api/merchant/types/inputs/update-zone-input.mdx) ### Type #### [Zone](/api/merchant/types/objects/zone.mdx) --- ## upsertOrder export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql upsertOrder( input: OrderInput! ): Void ``` ### Arguments #### [upsertOrder.input](#)[OrderInput!](/api/merchant/types/inputs/order-input.mdx) ### Type #### [Void](/api/merchant/types/scalars/void.mdx) A return type for void mutations. --- ## fulfillments export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql fulfillments: [Fulfillment!]! ``` ### Type #### [Fulfillment](/api/merchant/types/objects/fulfillment.mdx) --- ## me export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql me: Merchant! ``` ### Type #### [Merchant](/api/merchant/types/objects/merchant.mdx) --- ## operators export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql operators: [Operator!]! ``` ### Type #### [Operator](/api/merchant/types/objects/operator.mdx) --- ## packaging export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql packaging( id: ID! ): Packaging ``` ### Arguments #### [packaging.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Packaging](/api/merchant/types/objects/packaging.mdx) --- ## packagings export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql packagings( first: Int! page: Int ): PackagingPaginator! ``` ### Arguments #### [packagings.first](#)[Int!](/api/merchant/types/scalars/int.mdx) Limits number of fetched items. #### [packagings.page](#)[Int](/api/merchant/types/scalars/int.mdx) The offset from which items are returned. ### Type #### [PackagingPaginator](/api/merchant/types/objects/packaging-paginator.mdx) A paginated list of Packaging items. --- ## pickupPoint export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql pickupPoint( id: ID! ): PickupPoint ``` ### Arguments #### [pickupPoint.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [PickupPoint](/api/merchant/types/objects/pickup-point.mdx) --- ## pickupPoints export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql pickupPoints( filters: PickupPointFilterInput sortBy: PickupPointSortInput first: Int! page: Int ): PickupPointPaginator! ``` ### Arguments #### [pickupPoints.filters](#)[PickupPointFilterInput](/api/merchant/types/inputs/pickup-point-filter-input.mdx) #### [pickupPoints.sortBy](#)[PickupPointSortInput](/api/merchant/types/inputs/pickup-point-sort-input.mdx) #### [pickupPoints.first](#)[Int!](/api/merchant/types/scalars/int.mdx) Limits number of fetched items. #### [pickupPoints.page](#)[Int](/api/merchant/types/scalars/int.mdx) The offset from which items are returned. ### Type #### [PickupPointPaginator](/api/merchant/types/objects/pickup-point-paginator.mdx) A paginated list of PickupPoint items. --- ## ping(Queries) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql ping: String! ``` ### Type #### [String](/api/merchant/types/scalars/string.mdx) The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text. --- ## pricing export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql pricing( id: ID! ): Pricing ``` ### Arguments #### [pricing.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Pricing](/api/merchant/types/objects/pricing.mdx) --- ## pricings export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql pricings( first: Int! page: Int ): PricingPaginator! ``` ### Arguments #### [pricings.first](#)[Int!](/api/merchant/types/scalars/int.mdx) Limits number of fetched items. #### [pricings.page](#)[Int](/api/merchant/types/scalars/int.mdx) The offset from which items are returned. ### Type #### [PricingPaginator](/api/merchant/types/objects/pricing-paginator.mdx) A paginated list of Pricing items. --- ## providers export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql providers: [Provider!]! ``` ### Type #### [Provider](/api/merchant/types/objects/provider.mdx) --- ## session(Queries) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql session( id: ID! ): Session ``` ### Arguments #### [session.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Session](/api/merchant/types/objects/session.mdx) --- ## shipment export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql shipment( id: ID! ): Shipment ``` ### Arguments #### [shipment.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Shipment](/api/merchant/types/objects/shipment.mdx) --- ## shipments export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql shipments( filters: ShipmentFilterInput sortBy: ShipmentSortInput first: Int! page: Int ): ShipmentPaginator! ``` ### Arguments #### [shipments.filters](#)[ShipmentFilterInput](/api/merchant/types/inputs/shipment-filter-input.mdx) #### [shipments.sortBy](#)[ShipmentSortInput](/api/merchant/types/inputs/shipment-sort-input.mdx) #### [shipments.first](#)[Int!](/api/merchant/types/scalars/int.mdx) Limits number of fetched items. #### [shipments.page](#)[Int](/api/merchant/types/scalars/int.mdx) The offset from which items are returned. ### Type #### [ShipmentPaginator](/api/merchant/types/objects/shipment-paginator.mdx) A paginated list of Shipment items. --- ## subscriptionPlans export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql subscriptionPlans( language: LanguageEnum = EN ): [MerchantSubscriptionPlan!]! ``` ### Arguments #### [subscriptionPlans.language](#)[LanguageEnum](/api/merchant/types/enums/language-enum.mdx) ### Type #### [MerchantSubscriptionPlan](/api/merchant/types/objects/merchant-subscription-plan.mdx) --- ## subscriptions export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql subscriptions( filters: MerchantSubscriptionFilterInput sortBy: MerchantSubscriptionSortInput first: Int! page: Int ): MerchantSubscriptionPaginator! ``` ### Arguments #### [subscriptions.filters](#)[MerchantSubscriptionFilterInput](/api/merchant/types/inputs/merchant-subscription-filter-input.mdx) #### [subscriptions.sortBy](#)[MerchantSubscriptionSortInput](/api/merchant/types/inputs/merchant-subscription-sort-input.mdx) #### [subscriptions.first](#)[Int!](/api/merchant/types/scalars/int.mdx) Limits number of fetched items. #### [subscriptions.page](#)[Int](/api/merchant/types/scalars/int.mdx) The offset from which items are returned. ### Type #### [MerchantSubscriptionPaginator](/api/merchant/types/objects/merchant-subscription-paginator.mdx) A paginated list of MerchantSubscription items. --- ## theme export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql theme( id: ID! ): Theme ``` ### Arguments #### [theme.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Theme](/api/merchant/types/objects/theme.mdx) --- ## themes export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql themes( first: Int! page: Int ): ThemePaginator! ``` ### Arguments #### [themes.first](#)[Int!](/api/merchant/types/scalars/int.mdx) Limits number of fetched items. #### [themes.page](#)[Int](/api/merchant/types/scalars/int.mdx) The offset from which items are returned. ### Type #### [ThemePaginator](/api/merchant/types/objects/theme-paginator.mdx) A paginated list of Theme items. --- ## token export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql token: Token! ``` ### Type #### [Token](/api/merchant/types/objects/token.mdx) --- ## tokens export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql tokens( first: Int! page: Int ): TokenPaginator! ``` ### Arguments #### [tokens.first](#)[Int!](/api/merchant/types/scalars/int.mdx) Limits number of fetched items. #### [tokens.page](#)[Int](/api/merchant/types/scalars/int.mdx) The offset from which items are returned. ### Type #### [TokenPaginator](/api/merchant/types/objects/token-paginator.mdx) A paginated list of Token items. --- ## user export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql user( id: ID! ): User ``` ### Arguments #### [user.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [User](/api/merchant/types/objects/user.mdx) --- ## users export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql users( filters: UserFilterInput sortBy: UserSortInput first: Int! page: Int ): UserPaginator! ``` ### Arguments #### [users.filters](#)[UserFilterInput](/api/merchant/types/inputs/user-filter-input.mdx) #### [users.sortBy](#)[UserSortInput](/api/merchant/types/inputs/user-sort-input.mdx) #### [users.first](#)[Int!](/api/merchant/types/scalars/int.mdx) Limits number of fetched items. #### [users.page](#)[Int](/api/merchant/types/scalars/int.mdx) The offset from which items are returned. ### Type #### [UserPaginator](/api/merchant/types/objects/user-paginator.mdx) A paginated list of User items. --- ## waybill export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql waybill( id: ID! ): Waybill ``` ### Arguments #### [waybill.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Waybill](/api/merchant/types/objects/waybill.mdx) --- ## waybills export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql waybills( filters: WaybillFilterInput sortBy: WaybillSortInput first: Int! page: Int ): WaybillPaginator! ``` ### Arguments #### [waybills.filters](#)[WaybillFilterInput](/api/merchant/types/inputs/waybill-filter-input.mdx) #### [waybills.sortBy](#)[WaybillSortInput](/api/merchant/types/inputs/waybill-sort-input.mdx) #### [waybills.first](#)[Int!](/api/merchant/types/scalars/int.mdx) Limits number of fetched items. #### [waybills.page](#)[Int](/api/merchant/types/scalars/int.mdx) The offset from which items are returned. ### Type #### [WaybillPaginator](/api/merchant/types/objects/waybill-paginator.mdx) A paginated list of Waybill items. --- ## webhook export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql webhook( id: ID! ): Webhook ``` ### Arguments #### [webhook.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Webhook](/api/merchant/types/objects/webhook.mdx) --- ## webhooks export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql webhooks( first: Int! page: Int ): WebhookPaginator! ``` ### Arguments #### [webhooks.first](#)[Int!](/api/merchant/types/scalars/int.mdx) Limits number of fetched items. #### [webhooks.page](#)[Int](/api/merchant/types/scalars/int.mdx) The offset from which items are returned. ### Type #### [WebhookPaginator](/api/merchant/types/objects/webhook-paginator.mdx) A paginated list of Webhook items. --- ## zone export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql zone( id: ID! ): Zone ``` ### Arguments #### [zone.id](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Type #### [Zone](/api/merchant/types/objects/zone.mdx) --- ## zones export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql zones( first: Int! page: Int ): ZonePaginator! ``` ### Arguments #### [zones.first](#)[Int!](/api/merchant/types/scalars/int.mdx) Limits number of fetched items. #### [zones.page](#)[Int](/api/merchant/types/scalars/int.mdx) The offset from which items are returned. ### Type #### [ZonePaginator](/api/merchant/types/objects/zone-paginator.mdx) A paginated list of Zone items. --- ## AddressFieldEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum AddressFieldEnum { ADDRESS_LINE1 ADDRESS_LINE2 CITY COUNTRY EMAIL FIRST_NAME LANGUAGE LAST_NAME LOCATION PHONE POSTAL_CODE STATE } ``` ### Values #### [AddressFieldEnum.ADDRESS_LINE1](#) #### [AddressFieldEnum.ADDRESS_LINE2](#) #### [AddressFieldEnum.CITY](#) #### [AddressFieldEnum.COUNTRY](#) #### [AddressFieldEnum.EMAIL](#) #### [AddressFieldEnum.FIRST_NAME](#) #### [AddressFieldEnum.LANGUAGE](#) #### [AddressFieldEnum.LAST_NAME](#) #### [AddressFieldEnum.LOCATION](#) #### [AddressFieldEnum.PHONE](#) #### [AddressFieldEnum.POSTAL_CODE](#) #### [AddressFieldEnum.STATE](#) --- ## ConfigurationGroupEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum ConfigurationGroupEnum { CASH_ON_DELIVERY DISPLAY GENERAL INTEGRATION } ``` ### Values #### [ConfigurationGroupEnum.CASH_ON_DELIVERY](#) #### [ConfigurationGroupEnum.DISPLAY](#) #### [ConfigurationGroupEnum.GENERAL](#) #### [ConfigurationGroupEnum.INTEGRATION](#) ### Member Of [`FulfillmentConfiguration`](/api/merchant/types/objects/fulfillment-configuration.mdx) [`MerchantConfiguration`](/api/merchant/types/objects/merchant-configuration.mdx) [`OperatorConfiguration`](/api/merchant/types/objects/operator-configuration.mdx) [`ProviderConfiguration`](/api/merchant/types/objects/provider-configuration.mdx) --- ## CountryEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum CountryEnum { AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW } ``` ### Values #### [CountryEnum.AD](#) #### [CountryEnum.AE](#) #### [CountryEnum.AF](#) #### [CountryEnum.AG](#) #### [CountryEnum.AI](#) #### [CountryEnum.AL](#) #### [CountryEnum.AM](#) #### [CountryEnum.AO](#) #### [CountryEnum.AQ](#) #### [CountryEnum.AR](#) #### [CountryEnum.AS](#) #### [CountryEnum.AT](#) #### [CountryEnum.AU](#) #### [CountryEnum.AW](#) #### [CountryEnum.AX](#) #### [CountryEnum.AZ](#) #### [CountryEnum.BA](#) #### [CountryEnum.BB](#) #### [CountryEnum.BD](#) #### [CountryEnum.BE](#) #### [CountryEnum.BF](#) #### [CountryEnum.BG](#) #### [CountryEnum.BH](#) #### [CountryEnum.BI](#) #### [CountryEnum.BJ](#) #### [CountryEnum.BL](#) #### [CountryEnum.BM](#) #### [CountryEnum.BN](#) #### [CountryEnum.BO](#) #### [CountryEnum.BQ](#) #### [CountryEnum.BR](#) #### [CountryEnum.BS](#) #### [CountryEnum.BT](#) #### [CountryEnum.BV](#) #### [CountryEnum.BW](#) #### [CountryEnum.BY](#) #### [CountryEnum.BZ](#) #### [CountryEnum.CA](#) #### [CountryEnum.CC](#) #### [CountryEnum.CD](#) #### [CountryEnum.CF](#) #### [CountryEnum.CG](#) #### [CountryEnum.CH](#) #### [CountryEnum.CI](#) #### [CountryEnum.CK](#) #### [CountryEnum.CL](#) #### [CountryEnum.CM](#) #### [CountryEnum.CN](#) #### [CountryEnum.CO](#) #### [CountryEnum.CR](#) #### [CountryEnum.CU](#) #### [CountryEnum.CV](#) #### [CountryEnum.CW](#) #### [CountryEnum.CX](#) #### [CountryEnum.CY](#) #### [CountryEnum.CZ](#) #### [CountryEnum.DE](#) #### [CountryEnum.DJ](#) #### [CountryEnum.DK](#) #### [CountryEnum.DM](#) #### [CountryEnum.DO](#) #### [CountryEnum.DZ](#) #### [CountryEnum.EC](#) #### [CountryEnum.EE](#) #### [CountryEnum.EG](#) #### [CountryEnum.EH](#) #### [CountryEnum.ER](#) #### [CountryEnum.ES](#) #### [CountryEnum.ET](#) #### [CountryEnum.FI](#) #### [CountryEnum.FJ](#) #### [CountryEnum.FK](#) #### [CountryEnum.FM](#) #### [CountryEnum.FO](#) #### [CountryEnum.FR](#) #### [CountryEnum.GA](#) #### [CountryEnum.GB](#) #### [CountryEnum.GD](#) #### [CountryEnum.GE](#) #### [CountryEnum.GF](#) #### [CountryEnum.GG](#) #### [CountryEnum.GH](#) #### [CountryEnum.GI](#) #### [CountryEnum.GL](#) #### [CountryEnum.GM](#) #### [CountryEnum.GN](#) #### [CountryEnum.GP](#) #### [CountryEnum.GQ](#) #### [CountryEnum.GR](#) #### [CountryEnum.GS](#) #### [CountryEnum.GT](#) #### [CountryEnum.GU](#) #### [CountryEnum.GW](#) #### [CountryEnum.GY](#) #### [CountryEnum.HK](#) #### [CountryEnum.HM](#) #### [CountryEnum.HN](#) #### [CountryEnum.HR](#) #### [CountryEnum.HT](#) #### [CountryEnum.HU](#) #### [CountryEnum.ID](#) #### [CountryEnum.IE](#) #### [CountryEnum.IL](#) #### [CountryEnum.IM](#) #### [CountryEnum.IN](#) #### [CountryEnum.IO](#) #### [CountryEnum.IQ](#) #### [CountryEnum.IR](#) #### [CountryEnum.IS](#) #### [CountryEnum.IT](#) #### [CountryEnum.JE](#) #### [CountryEnum.JM](#) #### [CountryEnum.JO](#) #### [CountryEnum.JP](#) #### [CountryEnum.KE](#) #### [CountryEnum.KG](#) #### [CountryEnum.KH](#) #### [CountryEnum.KI](#) #### [CountryEnum.KM](#) #### [CountryEnum.KN](#) #### [CountryEnum.KP](#) #### [CountryEnum.KR](#) #### [CountryEnum.KW](#) #### [CountryEnum.KY](#) #### [CountryEnum.KZ](#) #### [CountryEnum.LA](#) #### [CountryEnum.LB](#) #### [CountryEnum.LC](#) #### [CountryEnum.LI](#) #### [CountryEnum.LK](#) #### [CountryEnum.LR](#) #### [CountryEnum.LS](#) #### [CountryEnum.LT](#) #### [CountryEnum.LU](#) #### [CountryEnum.LV](#) #### [CountryEnum.LY](#) #### [CountryEnum.MA](#) #### [CountryEnum.MC](#) #### [CountryEnum.MD](#) #### [CountryEnum.ME](#) #### [CountryEnum.MF](#) #### [CountryEnum.MG](#) #### [CountryEnum.MH](#) #### [CountryEnum.MK](#) #### [CountryEnum.ML](#) #### [CountryEnum.MM](#) #### [CountryEnum.MN](#) #### [CountryEnum.MO](#) #### [CountryEnum.MP](#) #### [CountryEnum.MQ](#) #### [CountryEnum.MR](#) #### [CountryEnum.MS](#) #### [CountryEnum.MT](#) #### [CountryEnum.MU](#) #### [CountryEnum.MV](#) #### [CountryEnum.MW](#) #### [CountryEnum.MX](#) #### [CountryEnum.MY](#) #### [CountryEnum.MZ](#) #### [CountryEnum.NA](#) #### [CountryEnum.NC](#) #### [CountryEnum.NE](#) #### [CountryEnum.NF](#) #### [CountryEnum.NG](#) #### [CountryEnum.NI](#) #### [CountryEnum.NL](#) #### [CountryEnum.NO](#) #### [CountryEnum.NP](#) #### [CountryEnum.NR](#) #### [CountryEnum.NU](#) #### [CountryEnum.NZ](#) #### [CountryEnum.OM](#) #### [CountryEnum.PA](#) #### [CountryEnum.PE](#) #### [CountryEnum.PF](#) #### [CountryEnum.PG](#) #### [CountryEnum.PH](#) #### [CountryEnum.PK](#) #### [CountryEnum.PL](#) #### [CountryEnum.PM](#) #### [CountryEnum.PN](#) #### [CountryEnum.PR](#) #### [CountryEnum.PS](#) #### [CountryEnum.PT](#) #### [CountryEnum.PW](#) #### [CountryEnum.PY](#) #### [CountryEnum.QA](#) #### [CountryEnum.RE](#) #### [CountryEnum.RO](#) #### [CountryEnum.RS](#) #### [CountryEnum.RU](#) #### [CountryEnum.RW](#) #### [CountryEnum.SA](#) #### [CountryEnum.SB](#) #### [CountryEnum.SC](#) #### [CountryEnum.SD](#) #### [CountryEnum.SE](#) #### [CountryEnum.SG](#) #### [CountryEnum.SH](#) #### [CountryEnum.SI](#) #### [CountryEnum.SJ](#) #### [CountryEnum.SK](#) #### [CountryEnum.SL](#) #### [CountryEnum.SM](#) #### [CountryEnum.SN](#) #### [CountryEnum.SO](#) #### [CountryEnum.SR](#) #### [CountryEnum.SS](#) #### [CountryEnum.ST](#) #### [CountryEnum.SV](#) #### [CountryEnum.SX](#) #### [CountryEnum.SY](#) #### [CountryEnum.SZ](#) #### [CountryEnum.TC](#) #### [CountryEnum.TD](#) #### [CountryEnum.TF](#) #### [CountryEnum.TG](#) #### [CountryEnum.TH](#) #### [CountryEnum.TJ](#) #### [CountryEnum.TK](#) #### [CountryEnum.TL](#) #### [CountryEnum.TM](#) #### [CountryEnum.TN](#) #### [CountryEnum.TO](#) #### [CountryEnum.TR](#) #### [CountryEnum.TT](#) #### [CountryEnum.TV](#) #### [CountryEnum.TW](#) #### [CountryEnum.TZ](#) #### [CountryEnum.UA](#) #### [CountryEnum.UG](#) #### [CountryEnum.UM](#) #### [CountryEnum.US](#) #### [CountryEnum.UY](#) #### [CountryEnum.UZ](#) #### [CountryEnum.VA](#) #### [CountryEnum.VC](#) #### [CountryEnum.VE](#) #### [CountryEnum.VG](#) #### [CountryEnum.VI](#) #### [CountryEnum.VN](#) #### [CountryEnum.VU](#) #### [CountryEnum.WF](#) #### [CountryEnum.WS](#) #### [CountryEnum.YE](#) #### [CountryEnum.YT](#) #### [CountryEnum.ZA](#) #### [CountryEnum.ZM](#) #### [CountryEnum.ZW](#) ### Member Of [`Address`](/api/merchant/types/objects/address.mdx) [`AddressInput`](/api/merchant/types/inputs/address-input.mdx) [`CreateZoneInput`](/api/merchant/types/inputs/create-zone-input.mdx) [`PartialAddress`](/api/merchant/types/objects/partial-address.mdx) [`PartialAddressInput`](/api/merchant/types/inputs/partial-address-input.mdx) [`PickupPointFilterInput`](/api/merchant/types/inputs/pickup-point-filter-input.mdx) [`ProviderNetworkEdge`](/api/merchant/types/objects/provider-network-edge.mdx) [`SessionHomeDeliveryZoneInput`](/api/merchant/types/inputs/session-home-delivery-zone-input.mdx) [`SessionPickupPointZoneInput`](/api/merchant/types/inputs/session-pickup-point-zone-input.mdx) [`SessionZoneInput`](/api/merchant/types/inputs/session-zone-input.mdx) [`ShipmentFilterInput`](/api/merchant/types/inputs/shipment-filter-input.mdx) [`UpdateZoneInput`](/api/merchant/types/inputs/update-zone-input.mdx) [`Zone`](/api/merchant/types/objects/zone.mdx) --- ## CurrencyEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum CurrencyEnum { AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BOV BRL BSD BTN BWP BYN BZD CAD CDF CHE CHF CHW CLF CLP CNY COP COU CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB EUR FJD FKP GBP GEL GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS INR IQD IRR ISK JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LYD MAD MDL MGA MKD MMK MNT MOP MRU MUR MVR MWK MXN MXV MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLE SOS SRD SSP STN SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USD USN UYI UYU UZS VED VEF VND VUV WST XAF XCD XDR XOF XPF XSU XUA YER ZAR ZMW ZWL } ``` ### Values #### [CurrencyEnum.AED](#) #### [CurrencyEnum.AFN](#) #### [CurrencyEnum.ALL](#) #### [CurrencyEnum.AMD](#) #### [CurrencyEnum.ANG](#) #### [CurrencyEnum.AOA](#) #### [CurrencyEnum.ARS](#) #### [CurrencyEnum.AUD](#) #### [CurrencyEnum.AWG](#) #### [CurrencyEnum.AZN](#) #### [CurrencyEnum.BAM](#) #### [CurrencyEnum.BBD](#) #### [CurrencyEnum.BDT](#) #### [CurrencyEnum.BGN](#) #### [CurrencyEnum.BHD](#) #### [CurrencyEnum.BIF](#) #### [CurrencyEnum.BMD](#) #### [CurrencyEnum.BND](#) #### [CurrencyEnum.BOB](#) #### [CurrencyEnum.BOV](#) #### [CurrencyEnum.BRL](#) #### [CurrencyEnum.BSD](#) #### [CurrencyEnum.BTN](#) #### [CurrencyEnum.BWP](#) #### [CurrencyEnum.BYN](#) #### [CurrencyEnum.BZD](#) #### [CurrencyEnum.CAD](#) #### [CurrencyEnum.CDF](#) #### [CurrencyEnum.CHE](#) #### [CurrencyEnum.CHF](#) #### [CurrencyEnum.CHW](#) #### [CurrencyEnum.CLF](#) #### [CurrencyEnum.CLP](#) #### [CurrencyEnum.CNY](#) #### [CurrencyEnum.COP](#) #### [CurrencyEnum.COU](#) #### [CurrencyEnum.CRC](#) #### [CurrencyEnum.CUC](#) #### [CurrencyEnum.CUP](#) #### [CurrencyEnum.CVE](#) #### [CurrencyEnum.CZK](#) #### [CurrencyEnum.DJF](#) #### [CurrencyEnum.DKK](#) #### [CurrencyEnum.DOP](#) #### [CurrencyEnum.DZD](#) #### [CurrencyEnum.EGP](#) #### [CurrencyEnum.ERN](#) #### [CurrencyEnum.ETB](#) #### [CurrencyEnum.EUR](#) #### [CurrencyEnum.FJD](#) #### [CurrencyEnum.FKP](#) #### [CurrencyEnum.GBP](#) #### [CurrencyEnum.GEL](#) #### [CurrencyEnum.GHS](#) #### [CurrencyEnum.GIP](#) #### [CurrencyEnum.GMD](#) #### [CurrencyEnum.GNF](#) #### [CurrencyEnum.GTQ](#) #### [CurrencyEnum.GYD](#) #### [CurrencyEnum.HKD](#) #### [CurrencyEnum.HNL](#) #### [CurrencyEnum.HRK](#) #### [CurrencyEnum.HTG](#) #### [CurrencyEnum.HUF](#) #### [CurrencyEnum.IDR](#) #### [CurrencyEnum.ILS](#) #### [CurrencyEnum.INR](#) #### [CurrencyEnum.IQD](#) #### [CurrencyEnum.IRR](#) #### [CurrencyEnum.ISK](#) #### [CurrencyEnum.JMD](#) #### [CurrencyEnum.JOD](#) #### [CurrencyEnum.JPY](#) #### [CurrencyEnum.KES](#) #### [CurrencyEnum.KGS](#) #### [CurrencyEnum.KHR](#) #### [CurrencyEnum.KMF](#) #### [CurrencyEnum.KPW](#) #### [CurrencyEnum.KRW](#) #### [CurrencyEnum.KWD](#) #### [CurrencyEnum.KYD](#) #### [CurrencyEnum.KZT](#) #### [CurrencyEnum.LAK](#) #### [CurrencyEnum.LBP](#) #### [CurrencyEnum.LKR](#) #### [CurrencyEnum.LRD](#) #### [CurrencyEnum.LSL](#) #### [CurrencyEnum.LYD](#) #### [CurrencyEnum.MAD](#) #### [CurrencyEnum.MDL](#) #### [CurrencyEnum.MGA](#) #### [CurrencyEnum.MKD](#) #### [CurrencyEnum.MMK](#) #### [CurrencyEnum.MNT](#) #### [CurrencyEnum.MOP](#) #### [CurrencyEnum.MRU](#) #### [CurrencyEnum.MUR](#) #### [CurrencyEnum.MVR](#) #### [CurrencyEnum.MWK](#) #### [CurrencyEnum.MXN](#) #### [CurrencyEnum.MXV](#) #### [CurrencyEnum.MYR](#) #### [CurrencyEnum.MZN](#) #### [CurrencyEnum.NAD](#) #### [CurrencyEnum.NGN](#) #### [CurrencyEnum.NIO](#) #### [CurrencyEnum.NOK](#) #### [CurrencyEnum.NPR](#) #### [CurrencyEnum.NZD](#) #### [CurrencyEnum.OMR](#) #### [CurrencyEnum.PAB](#) #### [CurrencyEnum.PEN](#) #### [CurrencyEnum.PGK](#) #### [CurrencyEnum.PHP](#) #### [CurrencyEnum.PKR](#) #### [CurrencyEnum.PLN](#) #### [CurrencyEnum.PYG](#) #### [CurrencyEnum.QAR](#) #### [CurrencyEnum.RON](#) #### [CurrencyEnum.RSD](#) #### [CurrencyEnum.RUB](#) #### [CurrencyEnum.RWF](#) #### [CurrencyEnum.SAR](#) #### [CurrencyEnum.SBD](#) #### [CurrencyEnum.SCR](#) #### [CurrencyEnum.SDG](#) #### [CurrencyEnum.SEK](#) #### [CurrencyEnum.SGD](#) #### [CurrencyEnum.SHP](#) #### [CurrencyEnum.SLE](#) #### [CurrencyEnum.SOS](#) #### [CurrencyEnum.SRD](#) #### [CurrencyEnum.SSP](#) #### [CurrencyEnum.STN](#) #### [CurrencyEnum.SVC](#) #### [CurrencyEnum.SYP](#) #### [CurrencyEnum.SZL](#) #### [CurrencyEnum.THB](#) #### [CurrencyEnum.TJS](#) #### [CurrencyEnum.TMT](#) #### [CurrencyEnum.TND](#) #### [CurrencyEnum.TOP](#) #### [CurrencyEnum.TRY](#) #### [CurrencyEnum.TTD](#) #### [CurrencyEnum.TWD](#) #### [CurrencyEnum.TZS](#) #### [CurrencyEnum.UAH](#) #### [CurrencyEnum.UGX](#) #### [CurrencyEnum.USD](#) #### [CurrencyEnum.USN](#) #### [CurrencyEnum.UYI](#) #### [CurrencyEnum.UYU](#) #### [CurrencyEnum.UZS](#) #### [CurrencyEnum.VED](#) #### [CurrencyEnum.VEF](#) #### [CurrencyEnum.VND](#) #### [CurrencyEnum.VUV](#) #### [CurrencyEnum.WST](#) #### [CurrencyEnum.XAF](#) #### [CurrencyEnum.XCD](#) #### [CurrencyEnum.XDR](#) #### [CurrencyEnum.XOF](#) #### [CurrencyEnum.XPF](#) #### [CurrencyEnum.XSU](#) #### [CurrencyEnum.XUA](#) #### [CurrencyEnum.YER](#) #### [CurrencyEnum.ZAR](#) #### [CurrencyEnum.ZMW](#) #### [CurrencyEnum.ZWL](#) ### Member Of [`MerchantSubscription`](/api/merchant/types/objects/merchant-subscription.mdx) [`MerchantSubscriptionFilterInput`](/api/merchant/types/inputs/merchant-subscription-filter-input.mdx) [`MerchantSubscriptionInput`](/api/merchant/types/inputs/merchant-subscription-input.mdx) [`Money`](/api/merchant/types/objects/money.mdx) [`MoneyInput`](/api/merchant/types/inputs/money-input.mdx) [`MoneyRange`](/api/merchant/types/objects/money-range.mdx) [`SessionInput`](/api/merchant/types/inputs/session-input.mdx) --- ## DayEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum DayEnum { FRIDAY MONDAY SATURDAY SUNDAY THURSDAY TUESDAY WEDNESDAY } ``` ### Values #### [DayEnum.FRIDAY](#) #### [DayEnum.MONDAY](#) #### [DayEnum.SATURDAY](#) #### [DayEnum.SUNDAY](#) #### [DayEnum.THURSDAY](#) #### [DayEnum.TUESDAY](#) #### [DayEnum.WEDNESDAY](#) ### Member Of [`OpeningHour`](/api/merchant/types/objects/opening-hour.mdx) [`OpeningHourInput`](/api/merchant/types/inputs/opening-hour-input.mdx) --- ## FulfillmentConfigurationEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum FulfillmentConfigurationEnum { API_KEY AVAILABLE PASSWORD USERNAME } ``` ### Values #### [FulfillmentConfigurationEnum.API_KEY](#) #### [FulfillmentConfigurationEnum.AVAILABLE](#) #### [FulfillmentConfigurationEnum.PASSWORD](#) #### [FulfillmentConfigurationEnum.USERNAME](#) ### Member Of [`FulfillmentConfiguration`](/api/merchant/types/objects/fulfillment-configuration.mdx) [`UpdateFulfillmentConfigurationInput`](/api/merchant/types/inputs/update-fulfillment-configuration-input.mdx) --- ## FulfillmentEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum FulfillmentEnum { PACTIC WEBSHIPPY } ``` ### Values #### [FulfillmentEnum.PACTIC](#) #### [FulfillmentEnum.WEBSHIPPY](#) ### Member Of [`Fulfillment`](/api/merchant/types/objects/fulfillment.mdx) [`FulfillmentConfiguration`](/api/merchant/types/objects/fulfillment-configuration.mdx) [`UpdateFulfillmentConfigurationInput`](/api/merchant/types/inputs/update-fulfillment-configuration-input.mdx) --- ## GlobalIdentifierEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum GlobalIdentifierEnum { EAN GTIN ISBN JAN MPN NIQ OTHER UPC } ``` ### Values #### [GlobalIdentifierEnum.EAN](#) #### [GlobalIdentifierEnum.GTIN](#) #### [GlobalIdentifierEnum.ISBN](#) #### [GlobalIdentifierEnum.JAN](#) #### [GlobalIdentifierEnum.MPN](#) #### [GlobalIdentifierEnum.NIQ](#) #### [GlobalIdentifierEnum.OTHER](#) #### [GlobalIdentifierEnum.UPC](#) ### Member Of [`GlobalIdentifier`](/api/merchant/types/objects/global-identifier.mdx) [`GlobalIdentifierInput`](/api/merchant/types/inputs/global-identifier-input.mdx) --- ## LanguageEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum LanguageEnum { AA AB AE AF AK AM AN AR AS AV AY AZ BA BE BG BH BI BM BN BO BR BS CA CE CH CO CR CS CU CV CY DA DE DV DZ EE EL EN EO ES ET EU FA FF FI FJ FO FR FY GA GD GL GN GU GV HA HE HI HO HR HT HU HY HZ IA ID IE IG II IK IO IS IT IU JA JV KA KG KI KJ KK KL KM KN KO KR KS KU KV KW KY LA LB LG LI LN LO LT LU LV MG MH MI MK ML MN MR MS MT MY NA NB ND NE NG NL NN NO NR NV NY OC OJ OM OR OS PA PI PL PS PT QU RM RN RO RU RW SA SC SD SE SG SI SK SL SM SN SO SQ SR SS ST SU SV SW TA TE TG TH TI TK TL TN TO TR TS TT TW TY UG UK UR UZ VE VI VO WA WO XH YI YO ZA ZH ZU } ``` ### Values #### [LanguageEnum.AA](#) #### [LanguageEnum.AB](#) #### [LanguageEnum.AE](#) #### [LanguageEnum.AF](#) #### [LanguageEnum.AK](#) #### [LanguageEnum.AM](#) #### [LanguageEnum.AN](#) #### [LanguageEnum.AR](#) #### [LanguageEnum.AS](#) #### [LanguageEnum.AV](#) #### [LanguageEnum.AY](#) #### [LanguageEnum.AZ](#) #### [LanguageEnum.BA](#) #### [LanguageEnum.BE](#) #### [LanguageEnum.BG](#) #### [LanguageEnum.BH](#) #### [LanguageEnum.BI](#) #### [LanguageEnum.BM](#) #### [LanguageEnum.BN](#) #### [LanguageEnum.BO](#) #### [LanguageEnum.BR](#) #### [LanguageEnum.BS](#) #### [LanguageEnum.CA](#) #### [LanguageEnum.CE](#) #### [LanguageEnum.CH](#) #### [LanguageEnum.CO](#) #### [LanguageEnum.CR](#) #### [LanguageEnum.CS](#) #### [LanguageEnum.CU](#) #### [LanguageEnum.CV](#) #### [LanguageEnum.CY](#) #### [LanguageEnum.DA](#) #### [LanguageEnum.DE](#) #### [LanguageEnum.DV](#) #### [LanguageEnum.DZ](#) #### [LanguageEnum.EE](#) #### [LanguageEnum.EL](#) #### [LanguageEnum.EN](#) #### [LanguageEnum.EO](#) #### [LanguageEnum.ES](#) #### [LanguageEnum.ET](#) #### [LanguageEnum.EU](#) #### [LanguageEnum.FA](#) #### [LanguageEnum.FF](#) #### [LanguageEnum.FI](#) #### [LanguageEnum.FJ](#) #### [LanguageEnum.FO](#) #### [LanguageEnum.FR](#) #### [LanguageEnum.FY](#) #### [LanguageEnum.GA](#) #### [LanguageEnum.GD](#) #### [LanguageEnum.GL](#) #### [LanguageEnum.GN](#) #### [LanguageEnum.GU](#) #### [LanguageEnum.GV](#) #### [LanguageEnum.HA](#) #### [LanguageEnum.HE](#) #### [LanguageEnum.HI](#) #### [LanguageEnum.HO](#) #### [LanguageEnum.HR](#) #### [LanguageEnum.HT](#) #### [LanguageEnum.HU](#) #### [LanguageEnum.HY](#) #### [LanguageEnum.HZ](#) #### [LanguageEnum.IA](#) #### [LanguageEnum.ID](#) #### [LanguageEnum.IE](#) #### [LanguageEnum.IG](#) #### [LanguageEnum.II](#) #### [LanguageEnum.IK](#) #### [LanguageEnum.IO](#) #### [LanguageEnum.IS](#) #### [LanguageEnum.IT](#) #### [LanguageEnum.IU](#) #### [LanguageEnum.JA](#) #### [LanguageEnum.JV](#) #### [LanguageEnum.KA](#) #### [LanguageEnum.KG](#) #### [LanguageEnum.KI](#) #### [LanguageEnum.KJ](#) #### [LanguageEnum.KK](#) #### [LanguageEnum.KL](#) #### [LanguageEnum.KM](#) #### [LanguageEnum.KN](#) #### [LanguageEnum.KO](#) #### [LanguageEnum.KR](#) #### [LanguageEnum.KS](#) #### [LanguageEnum.KU](#) #### [LanguageEnum.KV](#) #### [LanguageEnum.KW](#) #### [LanguageEnum.KY](#) #### [LanguageEnum.LA](#) #### [LanguageEnum.LB](#) #### [LanguageEnum.LG](#) #### [LanguageEnum.LI](#) #### [LanguageEnum.LN](#) #### [LanguageEnum.LO](#) #### [LanguageEnum.LT](#) #### [LanguageEnum.LU](#) #### [LanguageEnum.LV](#) #### [LanguageEnum.MG](#) #### [LanguageEnum.MH](#) #### [LanguageEnum.MI](#) #### [LanguageEnum.MK](#) #### [LanguageEnum.ML](#) #### [LanguageEnum.MN](#) #### [LanguageEnum.MR](#) #### [LanguageEnum.MS](#) #### [LanguageEnum.MT](#) #### [LanguageEnum.MY](#) #### [LanguageEnum.NA](#) #### [LanguageEnum.NB](#) #### [LanguageEnum.ND](#) #### [LanguageEnum.NE](#) #### [LanguageEnum.NG](#) #### [LanguageEnum.NL](#) #### [LanguageEnum.NN](#) #### [LanguageEnum.NO](#) #### [LanguageEnum.NR](#) #### [LanguageEnum.NV](#) #### [LanguageEnum.NY](#) #### [LanguageEnum.OC](#) #### [LanguageEnum.OJ](#) #### [LanguageEnum.OM](#) #### [LanguageEnum.OR](#) #### [LanguageEnum.OS](#) #### [LanguageEnum.PA](#) #### [LanguageEnum.PI](#) #### [LanguageEnum.PL](#) #### [LanguageEnum.PS](#) #### [LanguageEnum.PT](#) #### [LanguageEnum.QU](#) #### [LanguageEnum.RM](#) #### [LanguageEnum.RN](#) #### [LanguageEnum.RO](#) #### [LanguageEnum.RU](#) #### [LanguageEnum.RW](#) #### [LanguageEnum.SA](#) #### [LanguageEnum.SC](#) #### [LanguageEnum.SD](#) #### [LanguageEnum.SE](#) #### [LanguageEnum.SG](#) #### [LanguageEnum.SI](#) #### [LanguageEnum.SK](#) #### [LanguageEnum.SL](#) #### [LanguageEnum.SM](#) #### [LanguageEnum.SN](#) #### [LanguageEnum.SO](#) #### [LanguageEnum.SQ](#) #### [LanguageEnum.SR](#) #### [LanguageEnum.SS](#) #### [LanguageEnum.ST](#) #### [LanguageEnum.SU](#) #### [LanguageEnum.SV](#) #### [LanguageEnum.SW](#) #### [LanguageEnum.TA](#) #### [LanguageEnum.TE](#) #### [LanguageEnum.TG](#) #### [LanguageEnum.TH](#) #### [LanguageEnum.TI](#) #### [LanguageEnum.TK](#) #### [LanguageEnum.TL](#) #### [LanguageEnum.TN](#) #### [LanguageEnum.TO](#) #### [LanguageEnum.TR](#) #### [LanguageEnum.TS](#) #### [LanguageEnum.TT](#) #### [LanguageEnum.TW](#) #### [LanguageEnum.TY](#) #### [LanguageEnum.UG](#) #### [LanguageEnum.UK](#) #### [LanguageEnum.UR](#) #### [LanguageEnum.UZ](#) #### [LanguageEnum.VE](#) #### [LanguageEnum.VI](#) #### [LanguageEnum.VO](#) #### [LanguageEnum.WA](#) #### [LanguageEnum.WO](#) #### [LanguageEnum.XH](#) #### [LanguageEnum.YI](#) #### [LanguageEnum.YO](#) #### [LanguageEnum.ZA](#) #### [LanguageEnum.ZH](#) #### [LanguageEnum.ZU](#) ### Member Of [`CustomerRecipientInput`](/api/merchant/types/inputs/customer-recipient-input.mdx) [`LocalizedString`](/api/merchant/types/objects/localized-string.mdx) [`LocalizedStringInput`](/api/merchant/types/inputs/localized-string-input.mdx) [`SessionInput`](/api/merchant/types/inputs/session-input.mdx) [`SessionRecipient`](/api/merchant/types/objects/session-recipient.mdx) [`ShipmentRecipient`](/api/merchant/types/objects/shipment-recipient.mdx) [`ShipmentRecipientInput`](/api/merchant/types/inputs/shipment-recipient-input.mdx) [`subscriptionPlans`](/api/merchant/operations/queries/subscription-plans.mdx) --- ## MerchantConfigurationEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum MerchantConfigurationEnum { ALWAYS_CONFIRM_RECIPIENT ASK_FOR_REQUIRED_ADDRESS_FIELDS COD_RECIPIENT_BANK_ACCOUNT COD_RECIPIENT_BANK_NAME COD_RECIPIENT_NAME CURRENCY CUSTOM_PICKUP_POINT_ENABLED CUSTOM_PICKUP_POINT_INFORMATION CUSTOM_PICKUP_POINT_TITLE DEFAULT_LANGUAGE FORCE_DEFAULT_ORIGIN FORCE_DEFAULT_SENDER GOOGLE_MAPS_CLIENT_KEY GOOGLE_MAPS_SERVER_KEY HOME_DELIVERY_CUSTOMIZATION HOME_DELIVERY_ENABLED HOME_DELIVERY_INFORMATION HOME_DELIVERY_PROVIDER HOME_DELIVERY_TITLE MODE PICKUP_POINT_ENABLED PICKUP_POINT_INFORMATION PICKUP_POINT_TITLE PREPARE_TIME REQUIRE_ADDRESS_LOCATION SENDER_ADDRESS_LINE1 SENDER_ADDRESS_LINE2 SENDER_CITY SENDER_COUNTRY SENDER_EMAIL SENDER_NAME SENDER_PHONE SENDER_POSTAL_CODE SENDER_STATE SHOW_PICKUP_POINT_TAGS SHOW_UNAVAILABLE_PICKUP_POINTS UI_ALLOWED_REFERRERS WEBHOOK_SIGNATURE } ``` ### Values #### [MerchantConfigurationEnum.ALWAYS_CONFIRM_RECIPIENT](#) #### [MerchantConfigurationEnum.ASK_FOR_REQUIRED_ADDRESS_FIELDS](#) #### [MerchantConfigurationEnum.COD_RECIPIENT_BANK_ACCOUNT](#) #### [MerchantConfigurationEnum.COD_RECIPIENT_BANK_NAME](#) #### [MerchantConfigurationEnum.COD_RECIPIENT_NAME](#) #### [MerchantConfigurationEnum.CURRENCY](#) #### [MerchantConfigurationEnum.CUSTOM_PICKUP_POINT_ENABLED](#) #### [MerchantConfigurationEnum.CUSTOM_PICKUP_POINT_INFORMATION](#) #### [MerchantConfigurationEnum.CUSTOM_PICKUP_POINT_TITLE](#) #### [MerchantConfigurationEnum.DEFAULT_LANGUAGE](#) #### [MerchantConfigurationEnum.FORCE_DEFAULT_ORIGIN](#) #### [MerchantConfigurationEnum.FORCE_DEFAULT_SENDER](#) #### [MerchantConfigurationEnum.GOOGLE_MAPS_CLIENT_KEY](#) #### [MerchantConfigurationEnum.GOOGLE_MAPS_SERVER_KEY](#) #### [MerchantConfigurationEnum.HOME_DELIVERY_CUSTOMIZATION](#) #### [MerchantConfigurationEnum.HOME_DELIVERY_ENABLED](#) #### [MerchantConfigurationEnum.HOME_DELIVERY_INFORMATION](#) #### [MerchantConfigurationEnum.HOME_DELIVERY_PROVIDER](#) #### [MerchantConfigurationEnum.HOME_DELIVERY_TITLE](#) #### [MerchantConfigurationEnum.MODE](#) #### [MerchantConfigurationEnum.PICKUP_POINT_ENABLED](#) #### [MerchantConfigurationEnum.PICKUP_POINT_INFORMATION](#) #### [MerchantConfigurationEnum.PICKUP_POINT_TITLE](#) #### [MerchantConfigurationEnum.PREPARE_TIME](#) #### [MerchantConfigurationEnum.REQUIRE_ADDRESS_LOCATION](#) #### [MerchantConfigurationEnum.SENDER_ADDRESS_LINE1](#) #### [MerchantConfigurationEnum.SENDER_ADDRESS_LINE2](#) #### [MerchantConfigurationEnum.SENDER_CITY](#) #### [MerchantConfigurationEnum.SENDER_COUNTRY](#) #### [MerchantConfigurationEnum.SENDER_EMAIL](#) #### [MerchantConfigurationEnum.SENDER_NAME](#) #### [MerchantConfigurationEnum.SENDER_PHONE](#) #### [MerchantConfigurationEnum.SENDER_POSTAL_CODE](#) #### [MerchantConfigurationEnum.SENDER_STATE](#) #### [MerchantConfigurationEnum.SHOW_PICKUP_POINT_TAGS](#) #### [MerchantConfigurationEnum.SHOW_UNAVAILABLE_PICKUP_POINTS](#) #### [MerchantConfigurationEnum.UI_ALLOWED_REFERRERS](#) #### [MerchantConfigurationEnum.WEBHOOK_SIGNATURE](#) ### Member Of [`MerchantConfiguration`](/api/merchant/types/objects/merchant-configuration.mdx) [`UpdateMerchantConfigurationInput`](/api/merchant/types/inputs/update-merchant-configuration-input.mdx) --- ## MerchantSubscriptionPlanEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum MerchantSubscriptionPlanEnum { BASIC CUSTOM FREE PREMIUM PROFESSIONAL } ``` ### Values #### [MerchantSubscriptionPlanEnum.BASIC](#) #### [MerchantSubscriptionPlanEnum.CUSTOM](#) #### [MerchantSubscriptionPlanEnum.FREE](#) #### [MerchantSubscriptionPlanEnum.PREMIUM](#) #### [MerchantSubscriptionPlanEnum.PROFESSIONAL](#) ### Member Of [`MerchantSubscriptionPlan`](/api/merchant/types/objects/merchant-subscription-plan.mdx) --- ## MerchantSubscriptionProviderEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum MerchantSubscriptionProviderEnum { SHOPIFY } ``` ### Values #### [MerchantSubscriptionProviderEnum.SHOPIFY](#) ### Member Of [`MerchantSubscriptionActivationInput`](/api/merchant/types/inputs/merchant-subscription-activation-input.mdx) [`MerchantSubscriptionInput`](/api/merchant/types/inputs/merchant-subscription-input.mdx) --- ## MerchantSubscriptionSortEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum MerchantSubscriptionSortEnum { PERIOD CURRENCY STATUS } ``` ### Values #### [MerchantSubscriptionSortEnum.PERIOD](#) #### [MerchantSubscriptionSortEnum.CURRENCY](#) #### [MerchantSubscriptionSortEnum.STATUS](#) ### Member Of [`MerchantSubscriptionSortInput`](/api/merchant/types/inputs/merchant-subscription-sort-input.mdx) --- ## MerchantSubscriptionStatusEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum MerchantSubscriptionStatusEnum { ACTIVE CANCELED EXPIRED PENDING SUSPENDED VOIDED } ``` ### Values #### [MerchantSubscriptionStatusEnum.ACTIVE](#) #### [MerchantSubscriptionStatusEnum.CANCELED](#) #### [MerchantSubscriptionStatusEnum.EXPIRED](#) #### [MerchantSubscriptionStatusEnum.PENDING](#) #### [MerchantSubscriptionStatusEnum.SUSPENDED](#) #### [MerchantSubscriptionStatusEnum.VOIDED](#) ### Member Of [`MerchantSubscription`](/api/merchant/types/objects/merchant-subscription.mdx) [`MerchantSubscriptionFilterInput`](/api/merchant/types/inputs/merchant-subscription-filter-input.mdx) [`MerchantSubscriptionPeriod`](/api/merchant/types/objects/merchant-subscription-period.mdx) --- ## OperatorConfigurationEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum OperatorConfigurationEnum { PRIORITY TITLE } ``` ### Values #### [OperatorConfigurationEnum.PRIORITY](#) #### [OperatorConfigurationEnum.TITLE](#) ### Member Of [`OperatorConfiguration`](/api/merchant/types/objects/operator-configuration.mdx) [`UpdateOperatorConfigurationInput`](/api/merchant/types/inputs/update-operator-configuration-input.mdx) --- ## OperatorEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum OperatorEnum { ALLWYN ALZA_BOX AVANTI AVEC AVIA BILLA BIZ BP BUDNI CESKA_POSTA COOP CORNER CUSTOM CZ_POST DHL DISKA DPD ECONT EURONICS EXPRESS_ONE FED_EX FOX_POST GENIKI GLS HERMES HR_POST INTERSPORT KAUFLAND KKIOSK LIDL MEDIA_MARKT MOL MPL MYFLEXBOX NKD OMV ONE OTHER OX_POINT PACKETA PAGRO PATRONBOLT PLAYERSROOM PLAYMAX POST_NORD PPL RAIFFEISEN REAL RELAY_INMEDIO ROBOT_GURU SAME_DAY SATURN SEUR SHELL SK_POST SPAR SPEEDEX SPORTFACTORY SPRING SPRINTER TAMBURI TNT TRANS_SPED TWO_TWO_ZERO_VOLT UPS WOLT } ``` ### Values #### [OperatorEnum.ALLWYN](#) #### [OperatorEnum.ALZA_BOX](#) #### [OperatorEnum.AVANTI](#) #### [OperatorEnum.AVEC](#) #### [OperatorEnum.AVIA](#) #### [OperatorEnum.BILLA](#) #### [OperatorEnum.BIZ](#) #### [OperatorEnum.BP](#) #### [OperatorEnum.BUDNI](#) #### [OperatorEnum.CESKA_POSTA](#) #### [OperatorEnum.COOP](#) #### [OperatorEnum.CORNER](#) #### [OperatorEnum.CUSTOM](#) #### [OperatorEnum.CZ_POST](#) #### [OperatorEnum.DHL](#) #### [OperatorEnum.DISKA](#) #### [OperatorEnum.DPD](#) #### [OperatorEnum.ECONT](#) #### [OperatorEnum.EURONICS](#) #### [OperatorEnum.EXPRESS_ONE](#) #### [OperatorEnum.FED_EX](#) #### [OperatorEnum.FOX_POST](#) #### [OperatorEnum.GENIKI](#) #### [OperatorEnum.GLS](#) #### [OperatorEnum.HERMES](#) #### [OperatorEnum.HR_POST](#) #### [OperatorEnum.INTERSPORT](#) #### [OperatorEnum.KAUFLAND](#) #### [OperatorEnum.KKIOSK](#) #### [OperatorEnum.LIDL](#) #### [OperatorEnum.MEDIA_MARKT](#) #### [OperatorEnum.MOL](#) #### [OperatorEnum.MPL](#) #### [OperatorEnum.MYFLEXBOX](#) #### [OperatorEnum.NKD](#) #### [OperatorEnum.OMV](#) #### [OperatorEnum.ONE](#) #### [OperatorEnum.OTHER](#) #### [OperatorEnum.OX_POINT](#) #### [OperatorEnum.PACKETA](#) #### [OperatorEnum.PAGRO](#) #### [OperatorEnum.PATRONBOLT](#) #### [OperatorEnum.PLAYERSROOM](#) #### [OperatorEnum.PLAYMAX](#) #### [OperatorEnum.POST_NORD](#) #### [OperatorEnum.PPL](#) #### [OperatorEnum.RAIFFEISEN](#) #### [OperatorEnum.REAL](#) #### [OperatorEnum.RELAY_INMEDIO](#) #### [OperatorEnum.ROBOT_GURU](#) #### [OperatorEnum.SAME_DAY](#) #### [OperatorEnum.SATURN](#) #### [OperatorEnum.SEUR](#) #### [OperatorEnum.SHELL](#) #### [OperatorEnum.SK_POST](#) #### [OperatorEnum.SPAR](#) #### [OperatorEnum.SPEEDEX](#) #### [OperatorEnum.SPORTFACTORY](#) #### [OperatorEnum.SPRING](#) #### [OperatorEnum.SPRINTER](#) #### [OperatorEnum.TAMBURI](#) #### [OperatorEnum.TNT](#) #### [OperatorEnum.TRANS_SPED](#) #### [OperatorEnum.TWO_TWO_ZERO_VOLT](#) #### [OperatorEnum.UPS](#) #### [OperatorEnum.WOLT](#) ### Member Of [`Operator`](/api/merchant/types/objects/operator.mdx) [`OperatorConfiguration`](/api/merchant/types/objects/operator-configuration.mdx) [`PickupPoint`](/api/merchant/types/objects/pickup-point.mdx) [`PickupPointOperatorFilterInput`](/api/merchant/types/inputs/pickup-point-operator-filter-input.mdx) [`UpdateOperatorConfigurationInput`](/api/merchant/types/inputs/update-operator-configuration-input.mdx) --- ## OrderByRelationAggregateFunction export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; Aggregate functions when ordering by a relation without specifying a column. ```graphql enum OrderByRelationAggregateFunction { COUNT } ``` ### Values #### [OrderByRelationAggregateFunction.COUNT](#) Amount of items. --- ## OrderByRelationWithColumnAggregateFunction export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; Aggregate functions when ordering by a relation that may specify a column. ```graphql enum OrderByRelationWithColumnAggregateFunction { AVG MIN MAX SUM COUNT } ``` ### Values #### [OrderByRelationWithColumnAggregateFunction.AVG](#) Average. #### [OrderByRelationWithColumnAggregateFunction.MIN](#) Minimum. #### [OrderByRelationWithColumnAggregateFunction.MAX](#) Maximum. #### [OrderByRelationWithColumnAggregateFunction.SUM](#) Sum. #### [OrderByRelationWithColumnAggregateFunction.COUNT](#) Amount of items. --- ## OrderDirectionEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum OrderDirectionEnum { ASC DESC } ``` ### Values #### [OrderDirectionEnum.ASC](#) #### [OrderDirectionEnum.DESC](#) ### Member Of [`MerchantSubscriptionSortInput`](/api/merchant/types/inputs/merchant-subscription-sort-input.mdx) [`PickupPointSortInput`](/api/merchant/types/inputs/pickup-point-sort-input.mdx) [`ShipmentSortInput`](/api/merchant/types/inputs/shipment-sort-input.mdx) [`UserSortInput`](/api/merchant/types/inputs/user-sort-input.mdx) [`WaybillSortInput`](/api/merchant/types/inputs/waybill-sort-input.mdx) --- ## OrderItemCategoryTypeEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum OrderItemCategoryTypeEnum { GOOGLE OTHER } ``` ### Values #### [OrderItemCategoryTypeEnum.GOOGLE](#) #### [OrderItemCategoryTypeEnum.OTHER](#) ### Member Of [`OrderItemCategory`](/api/merchant/types/objects/order-item-category.mdx) [`OrderItemCategoryInput`](/api/merchant/types/inputs/order-item-category-input.mdx) --- ## OrderItemQuantityUnitEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum OrderItemQuantityUnitEnum { KILOGRAM LITER OTHER PIECE } ``` ### Values #### [OrderItemQuantityUnitEnum.KILOGRAM](#) #### [OrderItemQuantityUnitEnum.LITER](#) #### [OrderItemQuantityUnitEnum.OTHER](#) #### [OrderItemQuantityUnitEnum.PIECE](#) ### Member Of [`OrderItemQuantity`](/api/merchant/types/objects/order-item-quantity.mdx) [`OrderItemQuantityInput`](/api/merchant/types/inputs/order-item-quantity-input.mdx) --- ## PaymentMethodEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum PaymentMethodEnum { CARD CASH } ``` ### Values #### [PaymentMethodEnum.CARD](#) #### [PaymentMethodEnum.CASH](#) ### Member Of [`CreatePickupPointInput`](/api/merchant/types/inputs/create-pickup-point-input.mdx) [`PickupPoint`](/api/merchant/types/objects/pickup-point.mdx) [`PickupPointFilterInput`](/api/merchant/types/inputs/pickup-point-filter-input.mdx) [`UpdatePickupPointInput`](/api/merchant/types/inputs/update-pickup-point-input.mdx) --- ## PaymentStatusEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum PaymentStatusEnum { AUTHORIZED PAID PARTIALLY_RAID PARTIALLY_REFUNDED PENDING REFUNDED VOIDED } ``` ### Values #### [PaymentStatusEnum.AUTHORIZED](#) #### [PaymentStatusEnum.PAID](#) #### [PaymentStatusEnum.PARTIALLY_RAID](#) #### [PaymentStatusEnum.PARTIALLY_REFUNDED](#) #### [PaymentStatusEnum.PENDING](#) #### [PaymentStatusEnum.REFUNDED](#) #### [PaymentStatusEnum.VOIDED](#) ### Member Of [`OrderPayment`](/api/merchant/types/objects/order-payment.mdx) [`OrderPaymentInput`](/api/merchant/types/inputs/order-payment-input.mdx) --- ## PeriodEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum PeriodEnum { MONTH YEAR } ``` ### Values #### [PeriodEnum.MONTH](#) #### [PeriodEnum.YEAR](#) ### Member Of [`MerchantSubscription`](/api/merchant/types/objects/merchant-subscription.mdx) [`MerchantSubscriptionFilterInput`](/api/merchant/types/inputs/merchant-subscription-filter-input.mdx) [`MerchantSubscriptionInput`](/api/merchant/types/inputs/merchant-subscription-input.mdx) --- ## PickupPointSortEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum PickupPointSortEnum { NAME DISTANCE } ``` ### Values #### [PickupPointSortEnum.NAME](#) #### [PickupPointSortEnum.DISTANCE](#) ### Member Of [`PickupPointSortInput`](/api/merchant/types/inputs/pickup-point-sort-input.mdx) --- ## PickupPointTypeEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum PickupPointTypeEnum { LOCKER POST_OFFICE SHOP } ``` ### Values #### [PickupPointTypeEnum.LOCKER](#) #### [PickupPointTypeEnum.POST_OFFICE](#) #### [PickupPointTypeEnum.SHOP](#) ### Member Of [`PickupPoint`](/api/merchant/types/objects/pickup-point.mdx) [`PickupPointFilterInput`](/api/merchant/types/inputs/pickup-point-filter-input.mdx) [`PickupPointOperatorFilterInput`](/api/merchant/types/inputs/pickup-point-operator-filter-input.mdx) [`PickupPointProviderFilterInput`](/api/merchant/types/inputs/pickup-point-provider-filter-input.mdx) [`PricingCondition`](/api/merchant/types/objects/pricing-condition.mdx) [`PricingConditionInput`](/api/merchant/types/inputs/pricing-condition-input.mdx) [`SessionPickupPointPriceInput`](/api/merchant/types/inputs/session-pickup-point-price-input.mdx) [`SessionPickupPointProviderInput`](/api/merchant/types/inputs/session-pickup-point-provider-input.mdx) --- ## ProviderConfigurationEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum ProviderConfigurationEnum { ACCOUNTING_CODE ACCOUNT_NUMBER ADDRESS_ID AGREEMENT API_KEY API_URL AUTOMATICALLY_GENERATE_WAYBILL_FOR_SHIPMENT AVAILABLE BU_CODE CASH_ON_DELIVERY_ENABLED CLIENT_ID CLIENT_NUMBER CLIENT_SECRET COLLECTION_PLACE_ID CONTACT_ID CUSTOMER_ID DEFAULT_SERVICE FULFILLMENT HOME_DELIVERY_AVAILABLE HOME_DELIVERY_INFORMATION LABEL_SIZE PASSWORD PAYLOAD_SIGNATURE PICKUP_END PICKUP_POINT_AVAILABLE PICKUP_POINT_INFORMATION PICKUP_START PRIORITY PROVIDER_PRICING REQUIRED_ADDRESS_FIELDS_FOR_HOME_DELIVERY REQUIRED_ADDRESS_FIELDS_FOR_PICKUP_POINT_DELIVERY SPEDITOR_NAME TITLE TRACKING_API_KEY USERNAME } ``` ### Values #### [ProviderConfigurationEnum.ACCOUNTING_CODE](#) #### [ProviderConfigurationEnum.ACCOUNT_NUMBER](#) #### [ProviderConfigurationEnum.ADDRESS_ID](#) #### [ProviderConfigurationEnum.AGREEMENT](#) #### [ProviderConfigurationEnum.API_KEY](#) #### [ProviderConfigurationEnum.API_URL](#) #### [ProviderConfigurationEnum.AUTOMATICALLY_GENERATE_WAYBILL_FOR_SHIPMENT](#) #### [ProviderConfigurationEnum.AVAILABLE](#) #### [ProviderConfigurationEnum.BU_CODE](#) #### [ProviderConfigurationEnum.CASH_ON_DELIVERY_ENABLED](#) #### [ProviderConfigurationEnum.CLIENT_ID](#) #### [ProviderConfigurationEnum.CLIENT_NUMBER](#) #### [ProviderConfigurationEnum.CLIENT_SECRET](#) #### [ProviderConfigurationEnum.COLLECTION_PLACE_ID](#) #### [ProviderConfigurationEnum.CONTACT_ID](#) #### [ProviderConfigurationEnum.CUSTOMER_ID](#) #### [ProviderConfigurationEnum.DEFAULT_SERVICE](#) #### [ProviderConfigurationEnum.FULFILLMENT](#) #### [ProviderConfigurationEnum.HOME_DELIVERY_AVAILABLE](#) #### [ProviderConfigurationEnum.HOME_DELIVERY_INFORMATION](#) #### [ProviderConfigurationEnum.LABEL_SIZE](#) #### [ProviderConfigurationEnum.PASSWORD](#) #### [ProviderConfigurationEnum.PAYLOAD_SIGNATURE](#) #### [ProviderConfigurationEnum.PICKUP_END](#) #### [ProviderConfigurationEnum.PICKUP_POINT_AVAILABLE](#) #### [ProviderConfigurationEnum.PICKUP_POINT_INFORMATION](#) #### [ProviderConfigurationEnum.PICKUP_START](#) #### [ProviderConfigurationEnum.PRIORITY](#) #### [ProviderConfigurationEnum.PROVIDER_PRICING](#) #### [ProviderConfigurationEnum.REQUIRED_ADDRESS_FIELDS_FOR_HOME_DELIVERY](#) #### [ProviderConfigurationEnum.REQUIRED_ADDRESS_FIELDS_FOR_PICKUP_POINT_DELIVERY](#) #### [ProviderConfigurationEnum.SPEDITOR_NAME](#) #### [ProviderConfigurationEnum.TITLE](#) #### [ProviderConfigurationEnum.TRACKING_API_KEY](#) #### [ProviderConfigurationEnum.USERNAME](#) ### Member Of [`ProviderConfiguration`](/api/merchant/types/objects/provider-configuration.mdx) [`UpdateProviderConfigurationInput`](/api/merchant/types/inputs/update-provider-configuration-input.mdx) --- ## RoleEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum RoleEnum { MERCHANT_CONFIGURATION MERCHANT_OPERATOR MERCHANT_PACKAGING MERCHANT_PICKUP_POINT MERCHANT_PRICING MERCHANT_PROVIDER MERCHANT_SESSION MERCHANT_SHIPMENT MERCHANT_SUBSCRIPTION MERCHANT_THEME MERCHANT_TOKEN MERCHANT_USER MERCHANT_WAYBILL MERCHANT_WEBHOOK MERCHANT_ZONE MERCHANT__ SHOPIFY } ``` ### Values #### [RoleEnum.MERCHANT_CONFIGURATION](#) #### [RoleEnum.MERCHANT_OPERATOR](#) #### [RoleEnum.MERCHANT_PACKAGING](#) #### [RoleEnum.MERCHANT_PICKUP_POINT](#) #### [RoleEnum.MERCHANT_PRICING](#) #### [RoleEnum.MERCHANT_PROVIDER](#) #### [RoleEnum.MERCHANT_SESSION](#) #### [RoleEnum.MERCHANT_SHIPMENT](#) #### [RoleEnum.MERCHANT_SUBSCRIPTION](#) #### [RoleEnum.MERCHANT_THEME](#) #### [RoleEnum.MERCHANT_TOKEN](#) #### [RoleEnum.MERCHANT_USER](#) #### [RoleEnum.MERCHANT_WAYBILL](#) #### [RoleEnum.MERCHANT_WEBHOOK](#) #### [RoleEnum.MERCHANT_ZONE](#) #### [RoleEnum.MERCHANT__](#) #### [RoleEnum.SHOPIFY](#) ### Member Of [`CreateTokenInput`](/api/merchant/types/inputs/create-token-input.mdx) [`Token`](/api/merchant/types/objects/token.mdx) --- ## ShipmentActorEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum ShipmentActorEnum { PROVIDER RECIPIENT SENDER UNKNOWN } ``` ### Values #### [ShipmentActorEnum.PROVIDER](#) #### [ShipmentActorEnum.RECIPIENT](#) #### [ShipmentActorEnum.SENDER](#) #### [ShipmentActorEnum.UNKNOWN](#) ### Member Of [`ShipmentEvent`](/api/merchant/types/objects/shipment-event.mdx) --- ## ShipmentEventEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum ShipmentEventEnum { CANCELED COLLECTED COLLECTING CREATED DELIVERED DELIVERING FAILED IN_PROGRESS RECEIVABLE RETURNED RETURNING SUSPENDED UNKNOWN } ``` ### Values #### [ShipmentEventEnum.CANCELED](#) #### [ShipmentEventEnum.COLLECTED](#) #### [ShipmentEventEnum.COLLECTING](#) #### [ShipmentEventEnum.CREATED](#) #### [ShipmentEventEnum.DELIVERED](#) #### [ShipmentEventEnum.DELIVERING](#) #### [ShipmentEventEnum.FAILED](#) #### [ShipmentEventEnum.IN_PROGRESS](#) #### [ShipmentEventEnum.RECEIVABLE](#) #### [ShipmentEventEnum.RETURNED](#) #### [ShipmentEventEnum.RETURNING](#) #### [ShipmentEventEnum.SUSPENDED](#) #### [ShipmentEventEnum.UNKNOWN](#) ### Member Of [`ShipmentEvent`](/api/merchant/types/objects/shipment-event.mdx) --- ## ShipmentModeEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum ShipmentModeEnum { RECIPIENT_TO_SENDER SENDER_TO_RECIPIENT THIRD_PARTY_TO_THIRD_PARTY } ``` ### Values #### [ShipmentModeEnum.RECIPIENT_TO_SENDER](#) #### [ShipmentModeEnum.SENDER_TO_RECIPIENT](#) #### [ShipmentModeEnum.THIRD_PARTY_TO_THIRD_PARTY](#) ### Member Of [`CreateShipmentInput`](/api/merchant/types/inputs/create-shipment-input.mdx) [`PickupPointFilterInput`](/api/merchant/types/inputs/pickup-point-filter-input.mdx) [`Session`](/api/merchant/types/objects/session.mdx) [`SessionInput`](/api/merchant/types/inputs/session-input.mdx) [`SessionToShipmentInput`](/api/merchant/types/inputs/session-to-shipment-input.mdx) [`Shipment`](/api/merchant/types/objects/shipment.mdx) [`UpdateShipmentInput`](/api/merchant/types/inputs/update-shipment-input.mdx) --- ## ShipmentResolutionEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum ShipmentResolutionEnum { CANCELED_BY_RECIPIENT CANCELED_BY_SENDER OBLITERATED RECEIVED UNDELIVERABLE } ``` ### Values #### [ShipmentResolutionEnum.CANCELED_BY_RECIPIENT](#) #### [ShipmentResolutionEnum.CANCELED_BY_SENDER](#) #### [ShipmentResolutionEnum.OBLITERATED](#) #### [ShipmentResolutionEnum.RECEIVED](#) #### [ShipmentResolutionEnum.UNDELIVERABLE](#) ### Member Of [`OrderShipping`](/api/merchant/types/objects/order-shipping.mdx) [`OrderShippingInput`](/api/merchant/types/inputs/order-shipping-input.mdx) [`ShipmentStatus`](/api/merchant/types/objects/shipment-status.mdx) --- ## ShipmentSortEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum ShipmentSortEnum { CREATED_AT } ``` ### Values #### [ShipmentSortEnum.CREATED_AT](#) ### Member Of [`ShipmentSortInput`](/api/merchant/types/inputs/shipment-sort-input.mdx) --- ## ShipmentStatusEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum ShipmentStatusEnum { DELIVERED DELIVERING FAILED FAILING IN_PROGRESS RECEIVABLE WAITING_FOR_COLLECTION } ``` ### Values #### [ShipmentStatusEnum.DELIVERED](#) #### [ShipmentStatusEnum.DELIVERING](#) #### [ShipmentStatusEnum.FAILED](#) #### [ShipmentStatusEnum.FAILING](#) #### [ShipmentStatusEnum.IN_PROGRESS](#) #### [ShipmentStatusEnum.RECEIVABLE](#) #### [ShipmentStatusEnum.WAITING_FOR_COLLECTION](#) ### Member Of [`OrderShipping`](/api/merchant/types/objects/order-shipping.mdx) [`OrderShippingInput`](/api/merchant/types/inputs/order-shipping-input.mdx) [`ShipmentStatus`](/api/merchant/types/objects/shipment-status.mdx) --- ## ShippingMethodEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum ShippingMethodEnum { HOME_DELIVERY ONLINE PICKUP_POINT STORE } ``` ### Values #### [ShippingMethodEnum.HOME_DELIVERY](#) #### [ShippingMethodEnum.ONLINE](#) #### [ShippingMethodEnum.PICKUP_POINT](#) #### [ShippingMethodEnum.STORE](#) ### Member Of [`OrderShipping`](/api/merchant/types/objects/order-shipping.mdx) [`OrderShippingInput`](/api/merchant/types/inputs/order-shipping-input.mdx) --- ## SortOrder export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; Directions for ordering a list of records. ```graphql enum SortOrder { ASC DESC } ``` ### Values #### [SortOrder.ASC](#) Sort records in ascending order. #### [SortOrder.DESC](#) Sort records in descending order. ### Member Of [`OrderByClause`](/api/merchant/types/inputs/order-by-clause.mdx) --- ## ThemeConfigurationEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum ThemeConfigurationEnum { BRAND_COLOR BUTTON_ROUNDING FONT_FAMILY SURFACE_ROUNDING } ``` ### Values #### [ThemeConfigurationEnum.BRAND_COLOR](#) #### [ThemeConfigurationEnum.BUTTON_ROUNDING](#) #### [ThemeConfigurationEnum.FONT_FAMILY](#) #### [ThemeConfigurationEnum.SURFACE_ROUNDING](#) ### Member Of [`ThemeOption`](/api/merchant/types/objects/theme-option.mdx) [`ThemeOptionInput`](/api/merchant/types/inputs/theme-option-input.mdx) --- ## TimezoneEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum TimezoneEnum { AFRICA_ABIDJAN AFRICA_ALGIERS AFRICA_BISSAU AFRICA_CAIRO AFRICA_CASABLANCA AFRICA_CEUTA AFRICA_EL_AAIUN AFRICA_JOHANNESBURG AFRICA_JUBA AFRICA_KHARTOUM AFRICA_LAGOS AFRICA_MAPUTO AFRICA_MONROVIA AFRICA_NAIROBI AFRICA_NDJAMENA AFRICA_SAO_TOME AFRICA_TRIPOLI AFRICA_TUNIS AFRICA_WINDHOEK AMERICA_ADAK AMERICA_ANCHORAGE AMERICA_ARAGUAINA AMERICA_ARGENTINA_BUENOS_AIRES AMERICA_ARGENTINA_CATAMARCA AMERICA_ARGENTINA_CORDOBA AMERICA_ARGENTINA_JUJUY AMERICA_ARGENTINA_LA_RIOJA AMERICA_ARGENTINA_MENDOZA AMERICA_ARGENTINA_RIO_GALLEGOS AMERICA_ARGENTINA_SALTA AMERICA_ARGENTINA_SAN_JUAN AMERICA_ARGENTINA_SAN_LUIS AMERICA_ARGENTINA_TUCUMAN AMERICA_ARGENTINA_USHUAIA AMERICA_ASUNCION AMERICA_BAHIA AMERICA_BAHIA_BANDERAS AMERICA_BARBADOS AMERICA_BELEM AMERICA_BELIZE AMERICA_BOA_VISTA AMERICA_BOGOTA AMERICA_BOISE AMERICA_CAMBRIDGE_BAY AMERICA_CAMPO_GRANDE AMERICA_CANCUN AMERICA_CARACAS AMERICA_CAYENNE AMERICA_CHICAGO AMERICA_CHIHUAHUA AMERICA_CIUDAD_JUAREZ AMERICA_COSTA_RICA AMERICA_CUIABA AMERICA_DANMARKSHAVN AMERICA_DAWSON AMERICA_DAWSON_CREEK AMERICA_DENVER AMERICA_DETROIT AMERICA_EDMONTON AMERICA_EIRUNEPE AMERICA_EL_SALVADOR AMERICA_FORTALEZA AMERICA_FORT_NELSON AMERICA_GLACE_BAY AMERICA_GOOSE_BAY AMERICA_GRAND_TURK AMERICA_GUATEMALA AMERICA_GUAYAQUIL AMERICA_GUYANA AMERICA_HALIFAX AMERICA_HAVANA AMERICA_HERMOSILLO AMERICA_INDIANA_INDIANAPOLIS AMERICA_INDIANA_KNOX AMERICA_INDIANA_MARENGO AMERICA_INDIANA_PETERSBURG AMERICA_INDIANA_TELL_CITY AMERICA_INDIANA_VEVAY AMERICA_INDIANA_VINCENNES AMERICA_INDIANA_WINAMAC AMERICA_INUVIK AMERICA_IQALUIT AMERICA_JAMAICA AMERICA_JUNEAU AMERICA_KENTUCKY_LOUISVILLE AMERICA_KENTUCKY_MONTICELLO AMERICA_LA_PAZ AMERICA_LIMA AMERICA_LOS_ANGELES AMERICA_MACEIO AMERICA_MANAGUA AMERICA_MANAUS AMERICA_MARTINIQUE AMERICA_MATAMOROS AMERICA_MAZATLAN AMERICA_MENOMINEE AMERICA_MERIDA AMERICA_METLAKATLA AMERICA_MEXICO_CITY AMERICA_MIQUELON AMERICA_MONCTON AMERICA_MONTERREY AMERICA_MONTEVIDEO AMERICA_NEW_YORK AMERICA_NOME AMERICA_NORONHA AMERICA_NORTH_DAKOTA_BEULAH AMERICA_NORTH_DAKOTA_CENTER AMERICA_NORTH_DAKOTA_NEW_SALEM AMERICA_NUUK AMERICA_OJINAGA AMERICA_PANAMA AMERICA_PARAMARIBO AMERICA_PHOENIX AMERICA_PORTAU_PRINCE AMERICA_PORTO_VELHO AMERICA_PUERTO_RICO AMERICA_PUNTA_ARENAS AMERICA_RANKIN_INLET AMERICA_RECIFE AMERICA_REGINA AMERICA_RESOLUTE AMERICA_RIO_BRANCO AMERICA_SANTAREM AMERICA_SANTIAGO AMERICA_SANTO_DOMINGO AMERICA_SAO_PAULO AMERICA_SCORESBYSUND AMERICA_SITKA AMERICA_ST_JOHNS AMERICA_SWIFT_CURRENT AMERICA_TEGUCIGALPA AMERICA_THULE AMERICA_TIJUANA AMERICA_TORONTO AMERICA_VANCOUVER AMERICA_WHITEHORSE AMERICA_WINNIPEG AMERICA_YAKUTAT ANTARCTICA_CASEY ANTARCTICA_DAVIS ANTARCTICA_MACQUARIE ANTARCTICA_MAWSON ANTARCTICA_PALMER ANTARCTICA_ROTHERA ANTARCTICA_TROLL ASIA_ALMATY ASIA_AMMAN ASIA_ANADYR ASIA_AQTAU ASIA_AQTOBE ASIA_ASHGABAT ASIA_ATYRAU ASIA_BAGHDAD ASIA_BAKU ASIA_BANGKOK ASIA_BARNAUL ASIA_BEIRUT ASIA_BISHKEK ASIA_CHITA ASIA_CHOIBALSAN ASIA_COLOMBO ASIA_DAMASCUS ASIA_DHAKA ASIA_DILI ASIA_DUBAI ASIA_DUSHANBE ASIA_FAMAGUSTA ASIA_GAZA ASIA_HEBRON ASIA_HONG_KONG ASIA_HOVD ASIA_HO_CHI_MINH ASIA_IRKUTSK ASIA_JAKARTA ASIA_JAYAPURA ASIA_JERUSALEM ASIA_KABUL ASIA_KAMCHATKA ASIA_KARACHI ASIA_KATHMANDU ASIA_KHANDYGA ASIA_KOLKATA ASIA_KRASNOYARSK ASIA_KUCHING ASIA_MACAU ASIA_MAGADAN ASIA_MAKASSAR ASIA_MANILA ASIA_NICOSIA ASIA_NOVOKUZNETSK ASIA_NOVOSIBIRSK ASIA_OMSK ASIA_ORAL ASIA_PONTIANAK ASIA_PYONGYANG ASIA_QATAR ASIA_QOSTANAY ASIA_QYZYLORDA ASIA_RIYADH ASIA_SAKHALIN ASIA_SAMARKAND ASIA_SEOUL ASIA_SHANGHAI ASIA_SINGAPORE ASIA_SREDNEKOLYMSK ASIA_TAIPEI ASIA_TASHKENT ASIA_TBILISI ASIA_TEHRAN ASIA_THIMPHU ASIA_TOKYO ASIA_TOMSK ASIA_ULAANBAATAR ASIA_URUMQI ASIA_UST_NERA ASIA_VLADIVOSTOK ASIA_YAKUTSK ASIA_YANGON ASIA_YEKATERINBURG ASIA_YEREVAN ATLANTIC_AZORES ATLANTIC_BERMUDA ATLANTIC_CANARY ATLANTIC_CAPE_VERDE ATLANTIC_FAROE ATLANTIC_MADEIRA ATLANTIC_SOUTH_GEORGIA ATLANTIC_STANLEY AUSTRALIA_ADELAIDE AUSTRALIA_BRISBANE AUSTRALIA_BROKEN_HILL AUSTRALIA_DARWIN AUSTRALIA_EUCLA AUSTRALIA_HOBART AUSTRALIA_LINDEMAN AUSTRALIA_LORD_HOWE AUSTRALIA_MELBOURNE AUSTRALIA_PERTH AUSTRALIA_SYDNEY EUROPE_ANDORRA EUROPE_ASTRAKHAN EUROPE_ATHENS EUROPE_BELGRADE EUROPE_BERLIN EUROPE_BRUSSELS EUROPE_BUCHAREST EUROPE_BUDAPEST EUROPE_CHISINAU EUROPE_DUBLIN EUROPE_GIBRALTAR EUROPE_HELSINKI EUROPE_ISTANBUL EUROPE_KALININGRAD EUROPE_KIROV EUROPE_KYIV EUROPE_LISBON EUROPE_LONDON EUROPE_MADRID EUROPE_MALTA EUROPE_MINSK EUROPE_MOSCOW EUROPE_PARIS EUROPE_PRAGUE EUROPE_RIGA EUROPE_ROME EUROPE_SAMARA EUROPE_SARATOV EUROPE_SIMFEROPOL EUROPE_SOFIA EUROPE_TALLINN EUROPE_TIRANE EUROPE_ULYANOVSK EUROPE_VIENNA EUROPE_VILNIUS EUROPE_VOLGOGRAD EUROPE_WARSAW EUROPE_ZURICH INDIAN_CHAGOS INDIAN_MALDIVES INDIAN_MAURITIUS PACIFIC_APIA PACIFIC_AUCKLAND PACIFIC_BOUGAINVILLE PACIFIC_CHATHAM PACIFIC_EASTER PACIFIC_EFATE PACIFIC_FAKAOFO PACIFIC_FIJI PACIFIC_GALAPAGOS PACIFIC_GAMBIER PACIFIC_GUADALCANAL PACIFIC_GUAM PACIFIC_HONOLULU PACIFIC_KANTON PACIFIC_KIRITIMATI PACIFIC_KOSRAE PACIFIC_KWAJALEIN PACIFIC_MARQUESAS PACIFIC_NAURU PACIFIC_NIUE PACIFIC_NORFOLK PACIFIC_NOUMEA PACIFIC_PAGO_PAGO PACIFIC_PALAU PACIFIC_PITCAIRN PACIFIC_PORT_MORESBY PACIFIC_RAROTONGA PACIFIC_TAHITI PACIFIC_TARAWA PACIFIC_TONGATAPU } ``` ### Values #### [TimezoneEnum.AFRICA_ABIDJAN](#) #### [TimezoneEnum.AFRICA_ALGIERS](#) #### [TimezoneEnum.AFRICA_BISSAU](#) #### [TimezoneEnum.AFRICA_CAIRO](#) #### [TimezoneEnum.AFRICA_CASABLANCA](#) #### [TimezoneEnum.AFRICA_CEUTA](#) #### [TimezoneEnum.AFRICA_EL_AAIUN](#) #### [TimezoneEnum.AFRICA_JOHANNESBURG](#) #### [TimezoneEnum.AFRICA_JUBA](#) #### [TimezoneEnum.AFRICA_KHARTOUM](#) #### [TimezoneEnum.AFRICA_LAGOS](#) #### [TimezoneEnum.AFRICA_MAPUTO](#) #### [TimezoneEnum.AFRICA_MONROVIA](#) #### [TimezoneEnum.AFRICA_NAIROBI](#) #### [TimezoneEnum.AFRICA_NDJAMENA](#) #### [TimezoneEnum.AFRICA_SAO_TOME](#) #### [TimezoneEnum.AFRICA_TRIPOLI](#) #### [TimezoneEnum.AFRICA_TUNIS](#) #### [TimezoneEnum.AFRICA_WINDHOEK](#) #### [TimezoneEnum.AMERICA_ADAK](#) #### [TimezoneEnum.AMERICA_ANCHORAGE](#) #### [TimezoneEnum.AMERICA_ARAGUAINA](#) #### [TimezoneEnum.AMERICA_ARGENTINA_BUENOS_AIRES](#) #### [TimezoneEnum.AMERICA_ARGENTINA_CATAMARCA](#) #### [TimezoneEnum.AMERICA_ARGENTINA_CORDOBA](#) #### [TimezoneEnum.AMERICA_ARGENTINA_JUJUY](#) #### [TimezoneEnum.AMERICA_ARGENTINA_LA_RIOJA](#) #### [TimezoneEnum.AMERICA_ARGENTINA_MENDOZA](#) #### [TimezoneEnum.AMERICA_ARGENTINA_RIO_GALLEGOS](#) #### [TimezoneEnum.AMERICA_ARGENTINA_SALTA](#) #### [TimezoneEnum.AMERICA_ARGENTINA_SAN_JUAN](#) #### [TimezoneEnum.AMERICA_ARGENTINA_SAN_LUIS](#) #### [TimezoneEnum.AMERICA_ARGENTINA_TUCUMAN](#) #### [TimezoneEnum.AMERICA_ARGENTINA_USHUAIA](#) #### [TimezoneEnum.AMERICA_ASUNCION](#) #### [TimezoneEnum.AMERICA_BAHIA](#) #### [TimezoneEnum.AMERICA_BAHIA_BANDERAS](#) #### [TimezoneEnum.AMERICA_BARBADOS](#) #### [TimezoneEnum.AMERICA_BELEM](#) #### [TimezoneEnum.AMERICA_BELIZE](#) #### [TimezoneEnum.AMERICA_BOA_VISTA](#) #### [TimezoneEnum.AMERICA_BOGOTA](#) #### [TimezoneEnum.AMERICA_BOISE](#) #### [TimezoneEnum.AMERICA_CAMBRIDGE_BAY](#) #### [TimezoneEnum.AMERICA_CAMPO_GRANDE](#) #### [TimezoneEnum.AMERICA_CANCUN](#) #### [TimezoneEnum.AMERICA_CARACAS](#) #### [TimezoneEnum.AMERICA_CAYENNE](#) #### [TimezoneEnum.AMERICA_CHICAGO](#) #### [TimezoneEnum.AMERICA_CHIHUAHUA](#) #### [TimezoneEnum.AMERICA_CIUDAD_JUAREZ](#) #### [TimezoneEnum.AMERICA_COSTA_RICA](#) #### [TimezoneEnum.AMERICA_CUIABA](#) #### [TimezoneEnum.AMERICA_DANMARKSHAVN](#) #### [TimezoneEnum.AMERICA_DAWSON](#) #### [TimezoneEnum.AMERICA_DAWSON_CREEK](#) #### [TimezoneEnum.AMERICA_DENVER](#) #### [TimezoneEnum.AMERICA_DETROIT](#) #### [TimezoneEnum.AMERICA_EDMONTON](#) #### [TimezoneEnum.AMERICA_EIRUNEPE](#) #### [TimezoneEnum.AMERICA_EL_SALVADOR](#) #### [TimezoneEnum.AMERICA_FORTALEZA](#) #### [TimezoneEnum.AMERICA_FORT_NELSON](#) #### [TimezoneEnum.AMERICA_GLACE_BAY](#) #### [TimezoneEnum.AMERICA_GOOSE_BAY](#) #### [TimezoneEnum.AMERICA_GRAND_TURK](#) #### [TimezoneEnum.AMERICA_GUATEMALA](#) #### [TimezoneEnum.AMERICA_GUAYAQUIL](#) #### [TimezoneEnum.AMERICA_GUYANA](#) #### [TimezoneEnum.AMERICA_HALIFAX](#) #### [TimezoneEnum.AMERICA_HAVANA](#) #### [TimezoneEnum.AMERICA_HERMOSILLO](#) #### [TimezoneEnum.AMERICA_INDIANA_INDIANAPOLIS](#) #### [TimezoneEnum.AMERICA_INDIANA_KNOX](#) #### [TimezoneEnum.AMERICA_INDIANA_MARENGO](#) #### [TimezoneEnum.AMERICA_INDIANA_PETERSBURG](#) #### [TimezoneEnum.AMERICA_INDIANA_TELL_CITY](#) #### [TimezoneEnum.AMERICA_INDIANA_VEVAY](#) #### [TimezoneEnum.AMERICA_INDIANA_VINCENNES](#) #### [TimezoneEnum.AMERICA_INDIANA_WINAMAC](#) #### [TimezoneEnum.AMERICA_INUVIK](#) #### [TimezoneEnum.AMERICA_IQALUIT](#) #### [TimezoneEnum.AMERICA_JAMAICA](#) #### [TimezoneEnum.AMERICA_JUNEAU](#) #### [TimezoneEnum.AMERICA_KENTUCKY_LOUISVILLE](#) #### [TimezoneEnum.AMERICA_KENTUCKY_MONTICELLO](#) #### [TimezoneEnum.AMERICA_LA_PAZ](#) #### [TimezoneEnum.AMERICA_LIMA](#) #### [TimezoneEnum.AMERICA_LOS_ANGELES](#) #### [TimezoneEnum.AMERICA_MACEIO](#) #### [TimezoneEnum.AMERICA_MANAGUA](#) #### [TimezoneEnum.AMERICA_MANAUS](#) #### [TimezoneEnum.AMERICA_MARTINIQUE](#) #### [TimezoneEnum.AMERICA_MATAMOROS](#) #### [TimezoneEnum.AMERICA_MAZATLAN](#) #### [TimezoneEnum.AMERICA_MENOMINEE](#) #### [TimezoneEnum.AMERICA_MERIDA](#) #### [TimezoneEnum.AMERICA_METLAKATLA](#) #### [TimezoneEnum.AMERICA_MEXICO_CITY](#) #### [TimezoneEnum.AMERICA_MIQUELON](#) #### [TimezoneEnum.AMERICA_MONCTON](#) #### [TimezoneEnum.AMERICA_MONTERREY](#) #### [TimezoneEnum.AMERICA_MONTEVIDEO](#) #### [TimezoneEnum.AMERICA_NEW_YORK](#) #### [TimezoneEnum.AMERICA_NOME](#) #### [TimezoneEnum.AMERICA_NORONHA](#) #### [TimezoneEnum.AMERICA_NORTH_DAKOTA_BEULAH](#) #### [TimezoneEnum.AMERICA_NORTH_DAKOTA_CENTER](#) #### [TimezoneEnum.AMERICA_NORTH_DAKOTA_NEW_SALEM](#) #### [TimezoneEnum.AMERICA_NUUK](#) #### [TimezoneEnum.AMERICA_OJINAGA](#) #### [TimezoneEnum.AMERICA_PANAMA](#) #### [TimezoneEnum.AMERICA_PARAMARIBO](#) #### [TimezoneEnum.AMERICA_PHOENIX](#) #### [TimezoneEnum.AMERICA_PORTAU_PRINCE](#) #### [TimezoneEnum.AMERICA_PORTO_VELHO](#) #### [TimezoneEnum.AMERICA_PUERTO_RICO](#) #### [TimezoneEnum.AMERICA_PUNTA_ARENAS](#) #### [TimezoneEnum.AMERICA_RANKIN_INLET](#) #### [TimezoneEnum.AMERICA_RECIFE](#) #### [TimezoneEnum.AMERICA_REGINA](#) #### [TimezoneEnum.AMERICA_RESOLUTE](#) #### [TimezoneEnum.AMERICA_RIO_BRANCO](#) #### [TimezoneEnum.AMERICA_SANTAREM](#) #### [TimezoneEnum.AMERICA_SANTIAGO](#) #### [TimezoneEnum.AMERICA_SANTO_DOMINGO](#) #### [TimezoneEnum.AMERICA_SAO_PAULO](#) #### [TimezoneEnum.AMERICA_SCORESBYSUND](#) #### [TimezoneEnum.AMERICA_SITKA](#) #### [TimezoneEnum.AMERICA_ST_JOHNS](#) #### [TimezoneEnum.AMERICA_SWIFT_CURRENT](#) #### [TimezoneEnum.AMERICA_TEGUCIGALPA](#) #### [TimezoneEnum.AMERICA_THULE](#) #### [TimezoneEnum.AMERICA_TIJUANA](#) #### [TimezoneEnum.AMERICA_TORONTO](#) #### [TimezoneEnum.AMERICA_VANCOUVER](#) #### [TimezoneEnum.AMERICA_WHITEHORSE](#) #### [TimezoneEnum.AMERICA_WINNIPEG](#) #### [TimezoneEnum.AMERICA_YAKUTAT](#) #### [TimezoneEnum.ANTARCTICA_CASEY](#) #### [TimezoneEnum.ANTARCTICA_DAVIS](#) #### [TimezoneEnum.ANTARCTICA_MACQUARIE](#) #### [TimezoneEnum.ANTARCTICA_MAWSON](#) #### [TimezoneEnum.ANTARCTICA_PALMER](#) #### [TimezoneEnum.ANTARCTICA_ROTHERA](#) #### [TimezoneEnum.ANTARCTICA_TROLL](#) #### [TimezoneEnum.ASIA_ALMATY](#) #### [TimezoneEnum.ASIA_AMMAN](#) #### [TimezoneEnum.ASIA_ANADYR](#) #### [TimezoneEnum.ASIA_AQTAU](#) #### [TimezoneEnum.ASIA_AQTOBE](#) #### [TimezoneEnum.ASIA_ASHGABAT](#) #### [TimezoneEnum.ASIA_ATYRAU](#) #### [TimezoneEnum.ASIA_BAGHDAD](#) #### [TimezoneEnum.ASIA_BAKU](#) #### [TimezoneEnum.ASIA_BANGKOK](#) #### [TimezoneEnum.ASIA_BARNAUL](#) #### [TimezoneEnum.ASIA_BEIRUT](#) #### [TimezoneEnum.ASIA_BISHKEK](#) #### [TimezoneEnum.ASIA_CHITA](#) #### [TimezoneEnum.ASIA_CHOIBALSAN](#) #### [TimezoneEnum.ASIA_COLOMBO](#) #### [TimezoneEnum.ASIA_DAMASCUS](#) #### [TimezoneEnum.ASIA_DHAKA](#) #### [TimezoneEnum.ASIA_DILI](#) #### [TimezoneEnum.ASIA_DUBAI](#) #### [TimezoneEnum.ASIA_DUSHANBE](#) #### [TimezoneEnum.ASIA_FAMAGUSTA](#) #### [TimezoneEnum.ASIA_GAZA](#) #### [TimezoneEnum.ASIA_HEBRON](#) #### [TimezoneEnum.ASIA_HONG_KONG](#) #### [TimezoneEnum.ASIA_HOVD](#) #### [TimezoneEnum.ASIA_HO_CHI_MINH](#) #### [TimezoneEnum.ASIA_IRKUTSK](#) #### [TimezoneEnum.ASIA_JAKARTA](#) #### [TimezoneEnum.ASIA_JAYAPURA](#) #### [TimezoneEnum.ASIA_JERUSALEM](#) #### [TimezoneEnum.ASIA_KABUL](#) #### [TimezoneEnum.ASIA_KAMCHATKA](#) #### [TimezoneEnum.ASIA_KARACHI](#) #### [TimezoneEnum.ASIA_KATHMANDU](#) #### [TimezoneEnum.ASIA_KHANDYGA](#) #### [TimezoneEnum.ASIA_KOLKATA](#) #### [TimezoneEnum.ASIA_KRASNOYARSK](#) #### [TimezoneEnum.ASIA_KUCHING](#) #### [TimezoneEnum.ASIA_MACAU](#) #### [TimezoneEnum.ASIA_MAGADAN](#) #### [TimezoneEnum.ASIA_MAKASSAR](#) #### [TimezoneEnum.ASIA_MANILA](#) #### [TimezoneEnum.ASIA_NICOSIA](#) #### [TimezoneEnum.ASIA_NOVOKUZNETSK](#) #### [TimezoneEnum.ASIA_NOVOSIBIRSK](#) #### [TimezoneEnum.ASIA_OMSK](#) #### [TimezoneEnum.ASIA_ORAL](#) #### [TimezoneEnum.ASIA_PONTIANAK](#) #### [TimezoneEnum.ASIA_PYONGYANG](#) #### [TimezoneEnum.ASIA_QATAR](#) #### [TimezoneEnum.ASIA_QOSTANAY](#) #### [TimezoneEnum.ASIA_QYZYLORDA](#) #### [TimezoneEnum.ASIA_RIYADH](#) #### [TimezoneEnum.ASIA_SAKHALIN](#) #### [TimezoneEnum.ASIA_SAMARKAND](#) #### [TimezoneEnum.ASIA_SEOUL](#) #### [TimezoneEnum.ASIA_SHANGHAI](#) #### [TimezoneEnum.ASIA_SINGAPORE](#) #### [TimezoneEnum.ASIA_SREDNEKOLYMSK](#) #### [TimezoneEnum.ASIA_TAIPEI](#) #### [TimezoneEnum.ASIA_TASHKENT](#) #### [TimezoneEnum.ASIA_TBILISI](#) #### [TimezoneEnum.ASIA_TEHRAN](#) #### [TimezoneEnum.ASIA_THIMPHU](#) #### [TimezoneEnum.ASIA_TOKYO](#) #### [TimezoneEnum.ASIA_TOMSK](#) #### [TimezoneEnum.ASIA_ULAANBAATAR](#) #### [TimezoneEnum.ASIA_URUMQI](#) #### [TimezoneEnum.ASIA_UST_NERA](#) #### [TimezoneEnum.ASIA_VLADIVOSTOK](#) #### [TimezoneEnum.ASIA_YAKUTSK](#) #### [TimezoneEnum.ASIA_YANGON](#) #### [TimezoneEnum.ASIA_YEKATERINBURG](#) #### [TimezoneEnum.ASIA_YEREVAN](#) #### [TimezoneEnum.ATLANTIC_AZORES](#) #### [TimezoneEnum.ATLANTIC_BERMUDA](#) #### [TimezoneEnum.ATLANTIC_CANARY](#) #### [TimezoneEnum.ATLANTIC_CAPE_VERDE](#) #### [TimezoneEnum.ATLANTIC_FAROE](#) #### [TimezoneEnum.ATLANTIC_MADEIRA](#) #### [TimezoneEnum.ATLANTIC_SOUTH_GEORGIA](#) #### [TimezoneEnum.ATLANTIC_STANLEY](#) #### [TimezoneEnum.AUSTRALIA_ADELAIDE](#) #### [TimezoneEnum.AUSTRALIA_BRISBANE](#) #### [TimezoneEnum.AUSTRALIA_BROKEN_HILL](#) #### [TimezoneEnum.AUSTRALIA_DARWIN](#) #### [TimezoneEnum.AUSTRALIA_EUCLA](#) #### [TimezoneEnum.AUSTRALIA_HOBART](#) #### [TimezoneEnum.AUSTRALIA_LINDEMAN](#) #### [TimezoneEnum.AUSTRALIA_LORD_HOWE](#) #### [TimezoneEnum.AUSTRALIA_MELBOURNE](#) #### [TimezoneEnum.AUSTRALIA_PERTH](#) #### [TimezoneEnum.AUSTRALIA_SYDNEY](#) #### [TimezoneEnum.EUROPE_ANDORRA](#) #### [TimezoneEnum.EUROPE_ASTRAKHAN](#) #### [TimezoneEnum.EUROPE_ATHENS](#) #### [TimezoneEnum.EUROPE_BELGRADE](#) #### [TimezoneEnum.EUROPE_BERLIN](#) #### [TimezoneEnum.EUROPE_BRUSSELS](#) #### [TimezoneEnum.EUROPE_BUCHAREST](#) #### [TimezoneEnum.EUROPE_BUDAPEST](#) #### [TimezoneEnum.EUROPE_CHISINAU](#) #### [TimezoneEnum.EUROPE_DUBLIN](#) #### [TimezoneEnum.EUROPE_GIBRALTAR](#) #### [TimezoneEnum.EUROPE_HELSINKI](#) #### [TimezoneEnum.EUROPE_ISTANBUL](#) #### [TimezoneEnum.EUROPE_KALININGRAD](#) #### [TimezoneEnum.EUROPE_KIROV](#) #### [TimezoneEnum.EUROPE_KYIV](#) #### [TimezoneEnum.EUROPE_LISBON](#) #### [TimezoneEnum.EUROPE_LONDON](#) #### [TimezoneEnum.EUROPE_MADRID](#) #### [TimezoneEnum.EUROPE_MALTA](#) #### [TimezoneEnum.EUROPE_MINSK](#) #### [TimezoneEnum.EUROPE_MOSCOW](#) #### [TimezoneEnum.EUROPE_PARIS](#) #### [TimezoneEnum.EUROPE_PRAGUE](#) #### [TimezoneEnum.EUROPE_RIGA](#) #### [TimezoneEnum.EUROPE_ROME](#) #### [TimezoneEnum.EUROPE_SAMARA](#) #### [TimezoneEnum.EUROPE_SARATOV](#) #### [TimezoneEnum.EUROPE_SIMFEROPOL](#) #### [TimezoneEnum.EUROPE_SOFIA](#) #### [TimezoneEnum.EUROPE_TALLINN](#) #### [TimezoneEnum.EUROPE_TIRANE](#) #### [TimezoneEnum.EUROPE_ULYANOVSK](#) #### [TimezoneEnum.EUROPE_VIENNA](#) #### [TimezoneEnum.EUROPE_VILNIUS](#) #### [TimezoneEnum.EUROPE_VOLGOGRAD](#) #### [TimezoneEnum.EUROPE_WARSAW](#) #### [TimezoneEnum.EUROPE_ZURICH](#) #### [TimezoneEnum.INDIAN_CHAGOS](#) #### [TimezoneEnum.INDIAN_MALDIVES](#) #### [TimezoneEnum.INDIAN_MAURITIUS](#) #### [TimezoneEnum.PACIFIC_APIA](#) #### [TimezoneEnum.PACIFIC_AUCKLAND](#) #### [TimezoneEnum.PACIFIC_BOUGAINVILLE](#) #### [TimezoneEnum.PACIFIC_CHATHAM](#) #### [TimezoneEnum.PACIFIC_EASTER](#) #### [TimezoneEnum.PACIFIC_EFATE](#) #### [TimezoneEnum.PACIFIC_FAKAOFO](#) #### [TimezoneEnum.PACIFIC_FIJI](#) #### [TimezoneEnum.PACIFIC_GALAPAGOS](#) #### [TimezoneEnum.PACIFIC_GAMBIER](#) #### [TimezoneEnum.PACIFIC_GUADALCANAL](#) #### [TimezoneEnum.PACIFIC_GUAM](#) #### [TimezoneEnum.PACIFIC_HONOLULU](#) #### [TimezoneEnum.PACIFIC_KANTON](#) #### [TimezoneEnum.PACIFIC_KIRITIMATI](#) #### [TimezoneEnum.PACIFIC_KOSRAE](#) #### [TimezoneEnum.PACIFIC_KWAJALEIN](#) #### [TimezoneEnum.PACIFIC_MARQUESAS](#) #### [TimezoneEnum.PACIFIC_NAURU](#) #### [TimezoneEnum.PACIFIC_NIUE](#) #### [TimezoneEnum.PACIFIC_NORFOLK](#) #### [TimezoneEnum.PACIFIC_NOUMEA](#) #### [TimezoneEnum.PACIFIC_PAGO_PAGO](#) #### [TimezoneEnum.PACIFIC_PALAU](#) #### [TimezoneEnum.PACIFIC_PITCAIRN](#) #### [TimezoneEnum.PACIFIC_PORT_MORESBY](#) #### [TimezoneEnum.PACIFIC_RAROTONGA](#) #### [TimezoneEnum.PACIFIC_TAHITI](#) #### [TimezoneEnum.PACIFIC_TARAWA](#) #### [TimezoneEnum.PACIFIC_TONGATAPU](#) ### Member Of [`PickupPointOpeningHoursInput`](/api/merchant/types/inputs/pickup-point-opening-hours-input.mdx) --- ## TransportEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum TransportEnum { REST } ``` ### Values #### [TransportEnum.REST](#) ### Member Of [`CreateWebhookInput`](/api/merchant/types/inputs/create-webhook-input.mdx) [`ObtainWebhookInput`](/api/merchant/types/inputs/obtain-webhook-input.mdx) [`Webhook`](/api/merchant/types/objects/webhook.mdx) --- ## Trashed export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; Specify if you want to include or exclude trashed results from a query. ```graphql enum Trashed { ONLY WITH WITHOUT } ``` ### Values #### [Trashed.ONLY](#) Only return trashed results. #### [Trashed.WITH](#) Return both trashed and non-trashed results. #### [Trashed.WITHOUT](#) Only return non-trashed results. --- ## UserSortEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum UserSortEnum { NAME EMAIL } ``` ### Values #### [UserSortEnum.NAME](#) #### [UserSortEnum.EMAIL](#) ### Member Of [`UserSortInput`](/api/merchant/types/inputs/user-sort-input.mdx) --- ## WaybillSortEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum WaybillSortEnum { CLOSED_AT CREATED_AT } ``` ### Values #### [WaybillSortEnum.CLOSED_AT](#) #### [WaybillSortEnum.CREATED_AT](#) ### Member Of [`WaybillSortInput`](/api/merchant/types/inputs/waybill-sort-input.mdx) --- ## WebhookEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum WebhookEnum { ADDRESS_CREATED ADDRESS_DELETED ADDRESS_UPDATED CONFIGURATION_UPDATED SHIPMENT_CREATED SHIPMENT_DELETED SHIPMENT_UPDATED SUBSCRIPTION_LIMIT_CHANGED } ``` ### Values #### [WebhookEnum.ADDRESS_CREATED](#) #### [WebhookEnum.ADDRESS_DELETED](#) #### [WebhookEnum.ADDRESS_UPDATED](#) #### [WebhookEnum.CONFIGURATION_UPDATED](#) #### [WebhookEnum.SHIPMENT_CREATED](#) #### [WebhookEnum.SHIPMENT_DELETED](#) #### [WebhookEnum.SHIPMENT_UPDATED](#) #### [WebhookEnum.SUBSCRIPTION_LIMIT_CHANGED](#) ### Member Of [`CreateWebhookInput`](/api/merchant/types/inputs/create-webhook-input.mdx) [`ObtainWebhookInput`](/api/merchant/types/inputs/obtain-webhook-input.mdx) [`Webhook`](/api/merchant/types/objects/webhook.mdx) --- ## AddressInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input AddressInput { country: CountryEnum! state: String city: String! postalCode: String! addressLine1: String! addressLine2: String note: String } ``` ### Fields #### [AddressInput.country](#)[CountryEnum!](/api/merchant/types/enums/country-enum.mdx) #### [AddressInput.state](#)[String](/api/merchant/types/scalars/string.mdx) #### [AddressInput.city](#)[String!](/api/merchant/types/scalars/string.mdx) #### [AddressInput.postalCode](#)[String!](/api/merchant/types/scalars/string.mdx) #### [AddressInput.addressLine1](#)[String!](/api/merchant/types/scalars/string.mdx) #### [AddressInput.addressLine2](#)[String](/api/merchant/types/scalars/string.mdx) #### [AddressInput.note](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`CreatePickupPointInput`](/api/merchant/types/inputs/create-pickup-point-input.mdx) [`CustomerAddressInput`](/api/merchant/types/inputs/customer-address-input.mdx) [`OrderBillingInput`](/api/merchant/types/inputs/order-billing-input.mdx) [`OrderShippingInput`](/api/merchant/types/inputs/order-shipping-input.mdx) [`PickupPointProviderPickupFilterInput`](/api/merchant/types/inputs/pickup-point-provider-pickup-filter-input.mdx) [`SessionOriginInput`](/api/merchant/types/inputs/session-origin-input.mdx) [`ShipmentDestinationInput`](/api/merchant/types/inputs/shipment-destination-input.mdx) [`ShipmentOriginInput`](/api/merchant/types/inputs/shipment-origin-input.mdx) [`UpdatePickupPointInput`](/api/merchant/types/inputs/update-pickup-point-input.mdx) --- ## AssignShipmentToWaybillInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input AssignShipmentToWaybillInput { waybillId: ID! shipmentId: ID! } ``` ### Fields #### [AssignShipmentToWaybillInput.waybillId](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [AssignShipmentToWaybillInput.shipmentId](#)[ID!](/api/merchant/types/scalars/id.mdx) ### Member Of [`assignShipmentToWaybill`](/api/merchant/operations/mutations/assign-shipment-to-waybill.mdx) --- ## CreatePackagingInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input CreatePackagingInput { name: String! handle: ID! dimensions: DimensionInput! isDefault: Boolean! } ``` ### Fields #### [CreatePackagingInput.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [CreatePackagingInput.handle](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [CreatePackagingInput.dimensions](#)[DimensionInput!](/api/merchant/types/inputs/dimension-input.mdx) #### [CreatePackagingInput.isDefault](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) ### Member Of [`createPackaging`](/api/merchant/operations/mutations/create-packaging.mdx) --- ## CreatePickupPointInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input CreatePickupPointInput { referenceId: String! references: [PickupPointProviderReferenceInput!] name: String! phone: String cashOnDelivery: [PaymentMethodEnum!] hasWheelchairAccess: Boolean address: AddressInput! location: LocationInput! openingHours: PickupPointOpeningHoursInput tags: [PickupPointTagInput!] isActive: Boolean! } ``` ### Fields #### [CreatePickupPointInput.referenceId](#)[String!](/api/merchant/types/scalars/string.mdx) #### [CreatePickupPointInput.references](#)[[PickupPointProviderReferenceInput!]](/api/merchant/types/inputs/pickup-point-provider-reference-input.mdx) #### [CreatePickupPointInput.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [CreatePickupPointInput.phone](#)[String](/api/merchant/types/scalars/string.mdx) #### [CreatePickupPointInput.cashOnDelivery](#)[[PaymentMethodEnum!]](/api/merchant/types/enums/payment-method-enum.mdx) #### [CreatePickupPointInput.hasWheelchairAccess](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [CreatePickupPointInput.address](#)[AddressInput!](/api/merchant/types/inputs/address-input.mdx) #### [CreatePickupPointInput.location](#)[LocationInput!](/api/merchant/types/inputs/location-input.mdx) #### [CreatePickupPointInput.openingHours](#)[PickupPointOpeningHoursInput](/api/merchant/types/inputs/pickup-point-opening-hours-input.mdx) #### [CreatePickupPointInput.tags](#)[[PickupPointTagInput!]](/api/merchant/types/inputs/pickup-point-tag-input.mdx) #### [CreatePickupPointInput.isActive](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) ### Member Of [`createPickupPoint`](/api/merchant/operations/mutations/create-pickup-point.mdx) --- ## CreatePricingInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input CreatePricingInput { name: String! condition: PricingConditionInput price: MoneyInput! priority: Int } ``` ### Fields #### [CreatePricingInput.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [CreatePricingInput.condition](#)[PricingConditionInput](/api/merchant/types/inputs/pricing-condition-input.mdx) #### [CreatePricingInput.price](#)[MoneyInput!](/api/merchant/types/inputs/money-input.mdx) #### [CreatePricingInput.priority](#)[Int](/api/merchant/types/scalars/int.mdx) ### Member Of [`createPricing`](/api/merchant/operations/mutations/create-pricing.mdx) --- ## CreateShipmentInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input CreateShipmentInput { provider: ProviderEnum! referenceId: String! sourceId: String waybillId: ID mode: ShipmentModeEnum direct: Boolean! origin: ShipmentOriginInput sender: ShipmentSenderInput destination: ShipmentDestinationInput! recipient: ShipmentRecipientInput! parcels: [ParcelInput!] order: OrderInput } ``` ### Fields #### [CreateShipmentInput.provider](#)[ProviderEnum!](/api/merchant/types/scalars/provider-enum.mdx) #### [CreateShipmentInput.referenceId](#)[String!](/api/merchant/types/scalars/string.mdx) #### [CreateShipmentInput.sourceId](#)[String](/api/merchant/types/scalars/string.mdx) #### [CreateShipmentInput.waybillId](#)[ID](/api/merchant/types/scalars/id.mdx) #### [CreateShipmentInput.mode](#)[ShipmentModeEnum](/api/merchant/types/enums/shipment-mode-enum.mdx) #### [CreateShipmentInput.direct](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [CreateShipmentInput.origin](#)[ShipmentOriginInput](/api/merchant/types/inputs/shipment-origin-input.mdx) #### [CreateShipmentInput.sender](#)[ShipmentSenderInput](/api/merchant/types/inputs/shipment-sender-input.mdx) #### [CreateShipmentInput.destination](#)[ShipmentDestinationInput!](/api/merchant/types/inputs/shipment-destination-input.mdx) #### [CreateShipmentInput.recipient](#)[ShipmentRecipientInput!](/api/merchant/types/inputs/shipment-recipient-input.mdx) #### [CreateShipmentInput.parcels](#)[[ParcelInput!]](/api/merchant/types/inputs/parcel-input.mdx) #### [CreateShipmentInput.order](#)[OrderInput](/api/merchant/types/inputs/order-input.mdx) ### Member Of [`createShipment`](/api/merchant/operations/mutations/create-shipment.mdx) --- ## CreateThemeInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input CreateThemeInput { handle: ID! isEnabled: Boolean! isDefault: Boolean! options: [ThemeOptionInput!]! } ``` ### Fields #### [CreateThemeInput.handle](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [CreateThemeInput.isEnabled](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [CreateThemeInput.isDefault](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [CreateThemeInput.options](#)[[ThemeOptionInput!]!](/api/merchant/types/inputs/theme-option-input.mdx) ### Member Of [`createTheme`](/api/merchant/operations/mutations/create-theme.mdx) --- ## CreateTokenInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input CreateTokenInput { name: String! roles: [RoleEnum!] allowlist: TokenAllowlistInput } ``` ### Fields #### [CreateTokenInput.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [CreateTokenInput.roles](#)[[RoleEnum!]](/api/merchant/types/enums/role-enum.mdx) #### [CreateTokenInput.allowlist](#)[TokenAllowlistInput](/api/merchant/types/inputs/token-allowlist-input.mdx) ### Member Of [`createToken`](/api/merchant/operations/mutations/create-token.mdx) --- ## CreateUserInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input CreateUserInput { name: String! email: String! } ``` ### Fields #### [CreateUserInput.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [CreateUserInput.email](#)[String!](/api/merchant/types/scalars/string.mdx) ### Member Of [`createUser`](/api/merchant/operations/mutations/create-user.mdx) --- ## CreateWaybillInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input CreateWaybillInput { provider: ProviderEnum! referenceId: String! shipments: [ID!] } ``` ### Fields #### [CreateWaybillInput.provider](#)[ProviderEnum!](/api/merchant/types/scalars/provider-enum.mdx) #### [CreateWaybillInput.referenceId](#)[String!](/api/merchant/types/scalars/string.mdx) #### [CreateWaybillInput.shipments](#)[[ID!]](/api/merchant/types/scalars/id.mdx) ### Member Of [`createWaybill`](/api/merchant/operations/mutations/create-waybill.mdx) --- ## CreateWebhookInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input CreateWebhookInput { webhook: WebhookEnum! transport: TransportEnum! url: String! } ``` ### Fields #### [CreateWebhookInput.webhook](#)[WebhookEnum!](/api/merchant/types/enums/webhook-enum.mdx) #### [CreateWebhookInput.transport](#)[TransportEnum!](/api/merchant/types/enums/transport-enum.mdx) #### [CreateWebhookInput.url](#)[String!](/api/merchant/types/scalars/string.mdx) ### Member Of [`createWebhook`](/api/merchant/operations/mutations/create-webhook.mdx) --- ## CreateZoneInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input CreateZoneInput { name: String! countries: [CountryEnum!]! availableHomeDeliveryProviders: [ProviderEnum!]! availablePickupPointProviders: [ProviderEnum!]! } ``` ### Fields #### [CreateZoneInput.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [CreateZoneInput.countries](#)[[CountryEnum!]!](/api/merchant/types/enums/country-enum.mdx) #### [CreateZoneInput.availableHomeDeliveryProviders](#)[[ProviderEnum!]!](/api/merchant/types/scalars/provider-enum.mdx) #### [CreateZoneInput.availablePickupPointProviders](#)[[ProviderEnum!]!](/api/merchant/types/scalars/provider-enum.mdx) ### Member Of [`createZone`](/api/merchant/operations/mutations/create-zone.mdx) --- ## CustomerAddressInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input CustomerAddressInput { referenceId: String label: String recipient: CustomerRecipientInput address: AddressInput! location: LocationInput } ``` ### Fields #### [CustomerAddressInput.referenceId](#)[String](/api/merchant/types/scalars/string.mdx) #### [CustomerAddressInput.label](#)[String](/api/merchant/types/scalars/string.mdx) #### [CustomerAddressInput.recipient](#)[CustomerRecipientInput](/api/merchant/types/inputs/customer-recipient-input.mdx) #### [CustomerAddressInput.address](#)[AddressInput!](/api/merchant/types/inputs/address-input.mdx) #### [CustomerAddressInput.location](#)[LocationInput](/api/merchant/types/inputs/location-input.mdx) ### Member Of [`CustomerInput`](/api/merchant/types/inputs/customer-input.mdx) --- ## CustomerInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input CustomerInput { referenceId: String addresses: [CustomerAddressInput!] } ``` ### Fields #### [CustomerInput.referenceId](#)[String](/api/merchant/types/scalars/string.mdx) #### [CustomerInput.addresses](#)[[CustomerAddressInput!]](/api/merchant/types/inputs/customer-address-input.mdx) ### Member Of [`SessionInput`](/api/merchant/types/inputs/session-input.mdx) --- ## CustomerRecipientInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input CustomerRecipientInput { firstName: String lastName: String language: LanguageEnum email: String phone: String } ``` ### Fields #### [CustomerRecipientInput.firstName](#)[String](/api/merchant/types/scalars/string.mdx) #### [CustomerRecipientInput.lastName](#)[String](/api/merchant/types/scalars/string.mdx) #### [CustomerRecipientInput.language](#)[LanguageEnum](/api/merchant/types/enums/language-enum.mdx) #### [CustomerRecipientInput.email](#)[String](/api/merchant/types/scalars/string.mdx) #### [CustomerRecipientInput.phone](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`CustomerAddressInput`](/api/merchant/types/inputs/customer-address-input.mdx) [`SessionHomeDeliveryInput`](/api/merchant/types/inputs/session-home-delivery-input.mdx) [`SessionPickupPointInput`](/api/merchant/types/inputs/session-pickup-point-input.mdx) --- ## DateRangeFilter export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input DateRangeFilter { start: Date end: Date } ``` ### Fields #### [DateRangeFilter.start](#)[Date](/api/merchant/types/scalars/date.mdx) #### [DateRangeFilter.end](#)[Date](/api/merchant/types/scalars/date.mdx) --- ## DateTimeRangeFilter export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input DateTimeRangeFilter { start: DateTimeTz end: DateTimeTz } ``` ### Fields #### [DateTimeRangeFilter.start](#)[DateTimeTz](/api/merchant/types/scalars/date-time-tz.mdx) #### [DateTimeRangeFilter.end](#)[DateTimeTz](/api/merchant/types/scalars/date-time-tz.mdx) ### Member Of [`MerchantSubscriptionFilterInput`](/api/merchant/types/inputs/merchant-subscription-filter-input.mdx) [`WaybillFilterInput`](/api/merchant/types/inputs/waybill-filter-input.mdx) --- ## DimensionInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input DimensionInput { width: Float! length: Float! height: Float! } ``` ### Fields #### [DimensionInput.width](#)[Float!](/api/merchant/types/scalars/float.mdx) #### [DimensionInput.length](#)[Float!](/api/merchant/types/scalars/float.mdx) #### [DimensionInput.height](#)[Float!](/api/merchant/types/scalars/float.mdx) ### Member Of [`CreatePackagingInput`](/api/merchant/types/inputs/create-packaging-input.mdx) [`ParcelInput`](/api/merchant/types/inputs/parcel-input.mdx) [`SessionParcelInput`](/api/merchant/types/inputs/session-parcel-input.mdx) [`UpdatePackagingInput`](/api/merchant/types/inputs/update-packaging-input.mdx) --- ## FloatRangeFilter export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input FloatRangeFilter { start: Float end: Float } ``` ### Fields #### [FloatRangeFilter.start](#)[Float](/api/merchant/types/scalars/float.mdx) #### [FloatRangeFilter.end](#)[Float](/api/merchant/types/scalars/float.mdx) --- ## GlobalIdentifierInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input GlobalIdentifierInput { id: ID! type: GlobalIdentifierEnum! typeOther: String } ``` ### Fields #### [GlobalIdentifierInput.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [GlobalIdentifierInput.type](#)[GlobalIdentifierEnum!](/api/merchant/types/enums/global-identifier-enum.mdx) #### [GlobalIdentifierInput.typeOther](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`OrderItemInput`](/api/merchant/types/inputs/order-item-input.mdx) --- ## IntRangeFilter export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input IntRangeFilter { start: Int end: Int } ``` ### Fields #### [IntRangeFilter.start](#)[Int](/api/merchant/types/scalars/int.mdx) #### [IntRangeFilter.end](#)[Int](/api/merchant/types/scalars/int.mdx) --- ## KeyValueInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input KeyValueInput { key: String! value: String } ``` ### Fields #### [KeyValueInput.key](#)[String!](/api/merchant/types/scalars/string.mdx) #### [KeyValueInput.value](#)[String](/api/merchant/types/scalars/string.mdx) --- ## LocalizedStringInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input LocalizedStringInput { language: LanguageEnum! value: String! } ``` ### Fields #### [LocalizedStringInput.language](#)[LanguageEnum!](/api/merchant/types/enums/language-enum.mdx) #### [LocalizedStringInput.value](#)[String!](/api/merchant/types/scalars/string.mdx) ### Member Of [`PickupPointTagInput`](/api/merchant/types/inputs/pickup-point-tag-input.mdx) --- ## LocationInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input LocationInput { latitude: Float! longitude: Float! } ``` ### Fields #### [LocationInput.latitude](#)[Float!](/api/merchant/types/scalars/float.mdx) #### [LocationInput.longitude](#)[Float!](/api/merchant/types/scalars/float.mdx) ### Member Of [`CreatePickupPointInput`](/api/merchant/types/inputs/create-pickup-point-input.mdx) [`CustomerAddressInput`](/api/merchant/types/inputs/customer-address-input.mdx) [`PickupPointBoundingBoxFilterInput`](/api/merchant/types/inputs/pickup-point-bounding-box-filter-input.mdx) [`PickupPointDistanceFilterInput`](/api/merchant/types/inputs/pickup-point-distance-filter-input.mdx) [`PickupPointSortInput`](/api/merchant/types/inputs/pickup-point-sort-input.mdx) [`SessionOriginInput`](/api/merchant/types/inputs/session-origin-input.mdx) [`ShipmentDestinationInput`](/api/merchant/types/inputs/shipment-destination-input.mdx) [`ShipmentOriginInput`](/api/merchant/types/inputs/shipment-origin-input.mdx) [`UpdatePickupPointInput`](/api/merchant/types/inputs/update-pickup-point-input.mdx) --- ## MerchantSubscriptionActivationInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input MerchantSubscriptionActivationInput { id: ID! provider: MerchantSubscriptionProviderEnum configuration: MerchantSubscriptionProviderConfiguration } ``` ### Fields #### [MerchantSubscriptionActivationInput.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [MerchantSubscriptionActivationInput.provider](#)[MerchantSubscriptionProviderEnum](/api/merchant/types/enums/merchant-subscription-provider-enum.mdx) #### [MerchantSubscriptionActivationInput.configuration](#)[MerchantSubscriptionProviderConfiguration](/api/merchant/types/inputs/merchant-subscription-provider-configuration.mdx) ### Member Of [`activateSubscription`](/api/merchant/operations/mutations/activate-subscription.mdx) --- ## MerchantSubscriptionFilterInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input MerchantSubscriptionFilterInput { id: [ID!] plan: ID period: PeriodEnum currency: CurrencyEnum status: MerchantSubscriptionStatusEnum from: DateTimeRangeFilter to: DateTimeRangeFilter } ``` ### Fields #### [MerchantSubscriptionFilterInput.id](#)[[ID!]](/api/merchant/types/scalars/id.mdx) #### [MerchantSubscriptionFilterInput.plan](#)[ID](/api/merchant/types/scalars/id.mdx) #### [MerchantSubscriptionFilterInput.period](#)[PeriodEnum](/api/merchant/types/enums/period-enum.mdx) #### [MerchantSubscriptionFilterInput.currency](#)[CurrencyEnum](/api/merchant/types/enums/currency-enum.mdx) #### [MerchantSubscriptionFilterInput.status](#)[MerchantSubscriptionStatusEnum](/api/merchant/types/enums/merchant-subscription-status-enum.mdx) #### [MerchantSubscriptionFilterInput.from](#)[DateTimeRangeFilter](/api/merchant/types/inputs/date-time-range-filter.mdx) #### [MerchantSubscriptionFilterInput.to](#)[DateTimeRangeFilter](/api/merchant/types/inputs/date-time-range-filter.mdx) ### Member Of [`subscriptions`](/api/merchant/operations/queries/subscriptions.mdx) --- ## MerchantSubscriptionInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input MerchantSubscriptionInput { plan: ID! currency: CurrencyEnum! period: PeriodEnum! provider: MerchantSubscriptionProviderEnum configuration: MerchantSubscriptionProviderConfiguration } ``` ### Fields #### [MerchantSubscriptionInput.plan](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [MerchantSubscriptionInput.currency](#)[CurrencyEnum!](/api/merchant/types/enums/currency-enum.mdx) #### [MerchantSubscriptionInput.period](#)[PeriodEnum!](/api/merchant/types/enums/period-enum.mdx) #### [MerchantSubscriptionInput.provider](#)[MerchantSubscriptionProviderEnum](/api/merchant/types/enums/merchant-subscription-provider-enum.mdx) #### [MerchantSubscriptionInput.configuration](#)[MerchantSubscriptionProviderConfiguration](/api/merchant/types/inputs/merchant-subscription-provider-configuration.mdx) ### Member Of [`subscribe`](/api/merchant/operations/mutations/subscribe.mdx) --- ## MerchantSubscriptionProviderConfiguration export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input MerchantSubscriptionProviderConfiguration { shopify: MerchantSubscriptionShopifyProviderConfiguration } ``` ### Fields #### [MerchantSubscriptionProviderConfiguration.shopify](#)[MerchantSubscriptionShopifyProviderConfiguration](/api/merchant/types/inputs/merchant-subscription-shopify-provider-configuration.mdx) ### Member Of [`MerchantSubscriptionActivationInput`](/api/merchant/types/inputs/merchant-subscription-activation-input.mdx) [`MerchantSubscriptionInput`](/api/merchant/types/inputs/merchant-subscription-input.mdx) --- ## MerchantSubscriptionShopifyProviderConfiguration export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input MerchantSubscriptionShopifyProviderConfiguration { shop: String! redirectUrl: String! } ``` ### Fields #### [MerchantSubscriptionShopifyProviderConfiguration.shop](#)[String!](/api/merchant/types/scalars/string.mdx) #### [MerchantSubscriptionShopifyProviderConfiguration.redirectUrl](#)[String!](/api/merchant/types/scalars/string.mdx) ### Member Of [`MerchantSubscriptionProviderConfiguration`](/api/merchant/types/inputs/merchant-subscription-provider-configuration.mdx) --- ## MerchantSubscriptionSortInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input MerchantSubscriptionSortInput { field: MerchantSubscriptionSortEnum! direction: OrderDirectionEnum } ``` ### Fields #### [MerchantSubscriptionSortInput.field](#)[MerchantSubscriptionSortEnum!](/api/merchant/types/enums/merchant-subscription-sort-enum.mdx) #### [MerchantSubscriptionSortInput.direction](#)[OrderDirectionEnum](/api/merchant/types/enums/order-direction-enum.mdx) ### Member Of [`subscriptions`](/api/merchant/operations/queries/subscriptions.mdx) --- ## MoneyInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input MoneyInput { amount: Float! currency: CurrencyEnum! } ``` ### Fields #### [MoneyInput.amount](#)[Float!](/api/merchant/types/scalars/float.mdx) #### [MoneyInput.currency](#)[CurrencyEnum!](/api/merchant/types/enums/currency-enum.mdx) ### Member Of [`CreatePricingInput`](/api/merchant/types/inputs/create-pricing-input.mdx) [`OrderInput`](/api/merchant/types/inputs/order-input.mdx) [`OrderTotalPriceInput`](/api/merchant/types/inputs/order-total-price-input.mdx) [`OrderUnitPriceInput`](/api/merchant/types/inputs/order-unit-price-input.mdx) [`ParcelInput`](/api/merchant/types/inputs/parcel-input.mdx) [`SessionParcelInput`](/api/merchant/types/inputs/session-parcel-input.mdx) [`SessionPickupPointPriceInput`](/api/merchant/types/inputs/session-pickup-point-price-input.mdx) [`SessionPriceInput`](/api/merchant/types/inputs/session-price-input.mdx) [`UpdatePricingInput`](/api/merchant/types/inputs/update-pricing-input.mdx) --- ## ObtainWebhookInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input ObtainWebhookInput { webhook: WebhookEnum! transport: TransportEnum! url: String! } ``` ### Fields #### [ObtainWebhookInput.webhook](#)[WebhookEnum!](/api/merchant/types/enums/webhook-enum.mdx) #### [ObtainWebhookInput.transport](#)[TransportEnum!](/api/merchant/types/enums/transport-enum.mdx) #### [ObtainWebhookInput.url](#)[String!](/api/merchant/types/scalars/string.mdx) ### Member Of [`obtainWebhook`](/api/merchant/operations/mutations/obtain-webhook.mdx) --- ## OpeningHourInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input OpeningHourInput { day: DayEnum! start: TimeInput! end: TimeInput! } ``` ### Fields #### [OpeningHourInput.day](#)[DayEnum!](/api/merchant/types/enums/day-enum.mdx) #### [OpeningHourInput.start](#)[TimeInput!](/api/merchant/types/inputs/time-input.mdx) #### [OpeningHourInput.end](#)[TimeInput!](/api/merchant/types/inputs/time-input.mdx) ### Member Of [`PickupPointOpeningHoursInput`](/api/merchant/types/inputs/pickup-point-opening-hours-input.mdx) --- ## OrderBillingInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input OrderBillingInput { name: String email: String phone: String vatNumber: String isCompany: Boolean address: AddressInput } ``` ### Fields #### [OrderBillingInput.name](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderBillingInput.email](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderBillingInput.phone](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderBillingInput.vatNumber](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderBillingInput.isCompany](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [OrderBillingInput.address](#)[AddressInput](/api/merchant/types/inputs/address-input.mdx) ### Member Of [`OrderInput`](/api/merchant/types/inputs/order-input.mdx) --- ## OrderByClause export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; Allows ordering a list of records. ```graphql input OrderByClause { column: String! order: SortOrder! } ``` ### Fields #### [OrderByClause.column](#)[String!](/api/merchant/types/scalars/string.mdx) The column that is used for ordering. #### [OrderByClause.order](#)[SortOrder!](/api/merchant/types/enums/sort-order.mdx) The direction that is used for ordering. --- ## OrderInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input OrderInput { referenceId: ID! createdAt: DateTimeTz! customerId: ID sessionId: ID billing: OrderBillingInput shipping: OrderShippingInput payment: OrderPaymentInput total: OrderTotalPriceInput! items: [OrderItemInput!]! cashOnDelivery: MoneyInput } ``` ### Fields #### [OrderInput.referenceId](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [OrderInput.createdAt](#)[DateTimeTz!](/api/merchant/types/scalars/date-time-tz.mdx) #### [OrderInput.customerId](#)[ID](/api/merchant/types/scalars/id.mdx) #### [OrderInput.sessionId](#)[ID](/api/merchant/types/scalars/id.mdx) #### [OrderInput.billing](#)[OrderBillingInput](/api/merchant/types/inputs/order-billing-input.mdx) #### [OrderInput.shipping](#)[OrderShippingInput](/api/merchant/types/inputs/order-shipping-input.mdx) #### [OrderInput.payment](#)[OrderPaymentInput](/api/merchant/types/inputs/order-payment-input.mdx) #### [OrderInput.total](#)[OrderTotalPriceInput!](/api/merchant/types/inputs/order-total-price-input.mdx) #### [OrderInput.items](#)[[OrderItemInput!]!](/api/merchant/types/inputs/order-item-input.mdx) #### [OrderInput.cashOnDelivery](#)[MoneyInput](/api/merchant/types/inputs/money-input.mdx) ### Member Of [`CreateShipmentInput`](/api/merchant/types/inputs/create-shipment-input.mdx) [`SessionToShipmentInput`](/api/merchant/types/inputs/session-to-shipment-input.mdx) [`UpdateShipmentInput`](/api/merchant/types/inputs/update-shipment-input.mdx) [`upsertOrder`](/api/merchant/operations/mutations/upsert-order.mdx) --- ## OrderItemCategoryInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input OrderItemCategoryInput { name: String! type: OrderItemCategoryTypeEnum! typeOther: String } ``` ### Fields #### [OrderItemCategoryInput.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [OrderItemCategoryInput.type](#)[OrderItemCategoryTypeEnum!](/api/merchant/types/enums/order-item-category-type-enum.mdx) #### [OrderItemCategoryInput.typeOther](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`OrderItemInput`](/api/merchant/types/inputs/order-item-input.mdx) --- ## OrderItemInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input OrderItemInput { name: String! sku: String referenceId: ID categories: [OrderItemCategoryInput!] variant: String globalIdentifiers: [GlobalIdentifierInput!] note: String unit: OrderUnitPriceInput! quantity: OrderItemQuantityInput! total: OrderTotalPriceInput! isShipping: Boolean! isPayment: Boolean! isDiscount: Boolean! } ``` ### Fields #### [OrderItemInput.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [OrderItemInput.sku](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderItemInput.referenceId](#)[ID](/api/merchant/types/scalars/id.mdx) #### [OrderItemInput.categories](#)[[OrderItemCategoryInput!]](/api/merchant/types/inputs/order-item-category-input.mdx) #### [OrderItemInput.variant](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderItemInput.globalIdentifiers](#)[[GlobalIdentifierInput!]](/api/merchant/types/inputs/global-identifier-input.mdx) #### [OrderItemInput.note](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderItemInput.unit](#)[OrderUnitPriceInput!](/api/merchant/types/inputs/order-unit-price-input.mdx) #### [OrderItemInput.quantity](#)[OrderItemQuantityInput!](/api/merchant/types/inputs/order-item-quantity-input.mdx) #### [OrderItemInput.total](#)[OrderTotalPriceInput!](/api/merchant/types/inputs/order-total-price-input.mdx) #### [OrderItemInput.isShipping](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [OrderItemInput.isPayment](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [OrderItemInput.isDiscount](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) ### Member Of [`OrderInput`](/api/merchant/types/inputs/order-input.mdx) --- ## OrderItemQuantityInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input OrderItemQuantityInput { count: Float! type: OrderItemQuantityUnitEnum! typeOther: String } ``` ### Fields #### [OrderItemQuantityInput.count](#)[Float!](/api/merchant/types/scalars/float.mdx) #### [OrderItemQuantityInput.type](#)[OrderItemQuantityUnitEnum!](/api/merchant/types/enums/order-item-quantity-unit-enum.mdx) #### [OrderItemQuantityInput.typeOther](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`OrderItemInput`](/api/merchant/types/inputs/order-item-input.mdx) --- ## OrderPaymentInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input OrderPaymentInput { method: String! status: PaymentStatusEnum! paidAt: DateTimeTz } ``` ### Fields #### [OrderPaymentInput.method](#)[String!](/api/merchant/types/scalars/string.mdx) #### [OrderPaymentInput.status](#)[PaymentStatusEnum!](/api/merchant/types/enums/payment-status-enum.mdx) #### [OrderPaymentInput.paidAt](#)[DateTimeTz](/api/merchant/types/scalars/date-time-tz.mdx) ### Member Of [`OrderInput`](/api/merchant/types/inputs/order-input.mdx) --- ## OrderShippingInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input OrderShippingInput { name: String email: String phone: String pickupPointId: ID address: AddressInput method: ShippingMethodEnum provider: String status: ShipmentStatusEnum resolution: ShipmentResolutionEnum } ``` ### Fields #### [OrderShippingInput.name](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderShippingInput.email](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderShippingInput.phone](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderShippingInput.pickupPointId](#)[ID](/api/merchant/types/scalars/id.mdx) #### [OrderShippingInput.address](#)[AddressInput](/api/merchant/types/inputs/address-input.mdx) #### [OrderShippingInput.method](#)[ShippingMethodEnum](/api/merchant/types/enums/shipping-method-enum.mdx) #### [OrderShippingInput.provider](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderShippingInput.status](#)[ShipmentStatusEnum](/api/merchant/types/enums/shipment-status-enum.mdx) #### [OrderShippingInput.resolution](#)[ShipmentResolutionEnum](/api/merchant/types/enums/shipment-resolution-enum.mdx) ### Member Of [`OrderInput`](/api/merchant/types/inputs/order-input.mdx) --- ## OrderTotalPriceInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input OrderTotalPriceInput { net: MoneyInput! gross: MoneyInput! } ``` ### Fields #### [OrderTotalPriceInput.net](#)[MoneyInput!](/api/merchant/types/inputs/money-input.mdx) #### [OrderTotalPriceInput.gross](#)[MoneyInput!](/api/merchant/types/inputs/money-input.mdx) ### Member Of [`OrderInput`](/api/merchant/types/inputs/order-input.mdx) [`OrderItemInput`](/api/merchant/types/inputs/order-item-input.mdx) --- ## OrderUnitPriceInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input OrderUnitPriceInput { net: MoneyInput! vat: Float! gross: MoneyInput! } ``` ### Fields #### [OrderUnitPriceInput.net](#)[MoneyInput!](/api/merchant/types/inputs/money-input.mdx) #### [OrderUnitPriceInput.vat](#)[Float!](/api/merchant/types/scalars/float.mdx) #### [OrderUnitPriceInput.gross](#)[MoneyInput!](/api/merchant/types/inputs/money-input.mdx) ### Member Of [`OrderItemInput`](/api/merchant/types/inputs/order-item-input.mdx) --- ## ParcelInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input ParcelInput { referenceId: String! weight: Float! dimensions: DimensionInput isReadyForWaybill: Boolean! cashOnDelivery: MoneyInput value: MoneyInput insurance: MoneyInput restrictions: ParcelRestrictionsInput } ``` ### Fields #### [ParcelInput.referenceId](#)[String!](/api/merchant/types/scalars/string.mdx) #### [ParcelInput.weight](#)[Float!](/api/merchant/types/scalars/float.mdx) #### [ParcelInput.dimensions](#)[DimensionInput](/api/merchant/types/inputs/dimension-input.mdx) #### [ParcelInput.isReadyForWaybill](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [ParcelInput.cashOnDelivery](#)[MoneyInput](/api/merchant/types/inputs/money-input.mdx) #### [ParcelInput.value](#)[MoneyInput](/api/merchant/types/inputs/money-input.mdx) #### [ParcelInput.insurance](#)[MoneyInput](/api/merchant/types/inputs/money-input.mdx) #### [ParcelInput.restrictions](#)[ParcelRestrictionsInput](/api/merchant/types/inputs/parcel-restrictions-input.mdx) ### Member Of [`CreateShipmentInput`](/api/merchant/types/inputs/create-shipment-input.mdx) [`SessionToShipmentInput`](/api/merchant/types/inputs/session-to-shipment-input.mdx) [`UpdateShipmentInput`](/api/merchant/types/inputs/update-shipment-input.mdx) --- ## ParcelRestrictionsInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input ParcelRestrictionsInput { isPinRequired: Boolean ageLimit: Int isIdentityCheckRequired: Boolean } ``` ### Fields #### [ParcelRestrictionsInput.isPinRequired](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [ParcelRestrictionsInput.ageLimit](#)[Int](/api/merchant/types/scalars/int.mdx) #### [ParcelRestrictionsInput.isIdentityCheckRequired](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) ### Member Of [`ParcelInput`](/api/merchant/types/inputs/parcel-input.mdx) --- ## PartialAddressInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PartialAddressInput { country: CountryEnum state: String city: String postalCode: String addressLine1: String addressLine2: String note: String } ``` ### Fields #### [PartialAddressInput.country](#)[CountryEnum](/api/merchant/types/enums/country-enum.mdx) #### [PartialAddressInput.state](#)[String](/api/merchant/types/scalars/string.mdx) #### [PartialAddressInput.city](#)[String](/api/merchant/types/scalars/string.mdx) #### [PartialAddressInput.postalCode](#)[String](/api/merchant/types/scalars/string.mdx) #### [PartialAddressInput.addressLine1](#)[String](/api/merchant/types/scalars/string.mdx) #### [PartialAddressInput.addressLine2](#)[String](/api/merchant/types/scalars/string.mdx) #### [PartialAddressInput.note](#)[String](/api/merchant/types/scalars/string.mdx) --- ## PickupPointBoundingBoxFilterInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PickupPointBoundingBoxFilterInput { southWest: LocationInput! northEast: LocationInput! } ``` ### Fields #### [PickupPointBoundingBoxFilterInput.southWest](#)[LocationInput!](/api/merchant/types/inputs/location-input.mdx) #### [PickupPointBoundingBoxFilterInput.northEast](#)[LocationInput!](/api/merchant/types/inputs/location-input.mdx) ### Member Of [`PickupPointFilterInput`](/api/merchant/types/inputs/pickup-point-filter-input.mdx) --- ## PickupPointDistanceFilterInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PickupPointDistanceFilterInput { location: LocationInput! distance: Int! } ``` ### Fields #### [PickupPointDistanceFilterInput.location](#)[LocationInput!](/api/merchant/types/inputs/location-input.mdx) #### [PickupPointDistanceFilterInput.distance](#)[Int!](/api/merchant/types/scalars/int.mdx) ### Member Of [`PickupPointFilterInput`](/api/merchant/types/inputs/pickup-point-filter-input.mdx) --- ## PickupPointFilterInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PickupPointFilterInput { mode: ShipmentModeEnum isCustom: Boolean providers: [PickupPointProviderFilterInput!] operators: [PickupPointOperatorFilterInput!] boundingBox: PickupPointBoundingBoxFilterInput distance: PickupPointDistanceFilterInput search: String country: CountryEnum postalCode: String cashOnDelivery: [PaymentMethodEnum!] hasWheelchairAccess: Boolean type: [PickupPointTypeEnum!] isPickUpAvailable: Boolean isDropOffAvailable: Boolean tags: [ID!] } ``` ### Fields #### [PickupPointFilterInput.mode](#)[ShipmentModeEnum](/api/merchant/types/enums/shipment-mode-enum.mdx) #### [PickupPointFilterInput.isCustom](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [PickupPointFilterInput.providers](#)[[PickupPointProviderFilterInput!]](/api/merchant/types/inputs/pickup-point-provider-filter-input.mdx) #### [PickupPointFilterInput.operators](#)[[PickupPointOperatorFilterInput!]](/api/merchant/types/inputs/pickup-point-operator-filter-input.mdx) #### [PickupPointFilterInput.boundingBox](#)[PickupPointBoundingBoxFilterInput](/api/merchant/types/inputs/pickup-point-bounding-box-filter-input.mdx) #### [PickupPointFilterInput.distance](#)[PickupPointDistanceFilterInput](/api/merchant/types/inputs/pickup-point-distance-filter-input.mdx) #### [PickupPointFilterInput.search](#)[String](/api/merchant/types/scalars/string.mdx) #### [PickupPointFilterInput.country](#)[CountryEnum](/api/merchant/types/enums/country-enum.mdx) #### [PickupPointFilterInput.postalCode](#)[String](/api/merchant/types/scalars/string.mdx) #### [PickupPointFilterInput.cashOnDelivery](#)[[PaymentMethodEnum!]](/api/merchant/types/enums/payment-method-enum.mdx) #### [PickupPointFilterInput.hasWheelchairAccess](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [PickupPointFilterInput.type](#)[[PickupPointTypeEnum!]](/api/merchant/types/enums/pickup-point-type-enum.mdx) #### [PickupPointFilterInput.isPickUpAvailable](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [PickupPointFilterInput.isDropOffAvailable](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [PickupPointFilterInput.tags](#)[[ID!]](/api/merchant/types/scalars/id.mdx) ### Member Of [`pickupPoints`](/api/merchant/operations/queries/pickup-points.mdx) --- ## PickupPointOpeningHoursInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PickupPointOpeningHoursInput { timezone: TimezoneEnum! openingHours: [OpeningHourInput!]! } ``` ### Fields #### [PickupPointOpeningHoursInput.timezone](#)[TimezoneEnum!](/api/merchant/types/enums/timezone-enum.mdx) #### [PickupPointOpeningHoursInput.openingHours](#)[[OpeningHourInput!]!](/api/merchant/types/inputs/opening-hour-input.mdx) ### Member Of [`CreatePickupPointInput`](/api/merchant/types/inputs/create-pickup-point-input.mdx) [`UpdatePickupPointInput`](/api/merchant/types/inputs/update-pickup-point-input.mdx) --- ## PickupPointOperatorFilterInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PickupPointOperatorFilterInput { operator: OperatorEnum! type: [PickupPointTypeEnum!] } ``` ### Fields #### [PickupPointOperatorFilterInput.operator](#)[OperatorEnum!](/api/merchant/types/enums/operator-enum.mdx) #### [PickupPointOperatorFilterInput.type](#)[[PickupPointTypeEnum!]](/api/merchant/types/enums/pickup-point-type-enum.mdx) ### Member Of [`PickupPointFilterInput`](/api/merchant/types/inputs/pickup-point-filter-input.mdx) --- ## PickupPointProviderFilterInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PickupPointProviderFilterInput { provider: ProviderEnum! type: [PickupPointTypeEnum!] pickup: PickupPointProviderPickupFilterInput } ``` ### Fields #### [PickupPointProviderFilterInput.provider](#)[ProviderEnum!](/api/merchant/types/scalars/provider-enum.mdx) #### [PickupPointProviderFilterInput.type](#)[[PickupPointTypeEnum!]](/api/merchant/types/enums/pickup-point-type-enum.mdx) #### [PickupPointProviderFilterInput.pickup](#)[PickupPointProviderPickupFilterInput](/api/merchant/types/inputs/pickup-point-provider-pickup-filter-input.mdx) ### Member Of [`PickupPointFilterInput`](/api/merchant/types/inputs/pickup-point-filter-input.mdx) --- ## PickupPointProviderPickupFilterInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PickupPointProviderPickupFilterInput { destination: AddressInput! scheduledAt: DateTimeTz } ``` ### Fields #### [PickupPointProviderPickupFilterInput.destination](#)[AddressInput!](/api/merchant/types/inputs/address-input.mdx) #### [PickupPointProviderPickupFilterInput.scheduledAt](#)[DateTimeTz](/api/merchant/types/scalars/date-time-tz.mdx) ### Member Of [`PickupPointProviderFilterInput`](/api/merchant/types/inputs/pickup-point-provider-filter-input.mdx) --- ## PickupPointProviderReferenceInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PickupPointProviderReferenceInput { provider: ProviderEnum! referenceId: String! } ``` ### Fields #### [PickupPointProviderReferenceInput.provider](#)[ProviderEnum!](/api/merchant/types/scalars/provider-enum.mdx) #### [PickupPointProviderReferenceInput.referenceId](#)[String!](/api/merchant/types/scalars/string.mdx) ### Member Of [`CreatePickupPointInput`](/api/merchant/types/inputs/create-pickup-point-input.mdx) [`UpdatePickupPointInput`](/api/merchant/types/inputs/update-pickup-point-input.mdx) --- ## PickupPointSortInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PickupPointSortInput { field: PickupPointSortEnum! direction: OrderDirectionEnum location: LocationInput } ``` ### Fields #### [PickupPointSortInput.field](#)[PickupPointSortEnum!](/api/merchant/types/enums/pickup-point-sort-enum.mdx) #### [PickupPointSortInput.direction](#)[OrderDirectionEnum](/api/merchant/types/enums/order-direction-enum.mdx) #### [PickupPointSortInput.location](#)[LocationInput](/api/merchant/types/inputs/location-input.mdx) ### Member Of [`pickupPoints`](/api/merchant/operations/queries/pickup-points.mdx) --- ## PickupPointTagInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PickupPointTagInput { name: String! localizations: [LocalizedStringInput!] } ``` ### Fields #### [PickupPointTagInput.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [PickupPointTagInput.localizations](#)[[LocalizedStringInput!]](/api/merchant/types/inputs/localized-string-input.mdx) ### Member Of [`CreatePickupPointInput`](/api/merchant/types/inputs/create-pickup-point-input.mdx) [`SessionPickupPointTagInput`](/api/merchant/types/inputs/session-pickup-point-tag-input.mdx) [`UpdatePickupPointInput`](/api/merchant/types/inputs/update-pickup-point-input.mdx) --- ## PricingConditionInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PricingConditionInput { isHomeDelivery: Boolean isPickupPoint: Boolean pickupPointTypes: [PickupPointTypeEnum!] providers: [ProviderEnum!] isCustom: Boolean zoneId: ID } ``` ### Fields #### [PricingConditionInput.isHomeDelivery](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [PricingConditionInput.isPickupPoint](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [PricingConditionInput.pickupPointTypes](#)[[PickupPointTypeEnum!]](/api/merchant/types/enums/pickup-point-type-enum.mdx) #### [PricingConditionInput.providers](#)[[ProviderEnum!]](/api/merchant/types/scalars/provider-enum.mdx) #### [PricingConditionInput.isCustom](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [PricingConditionInput.zoneId](#)[ID](/api/merchant/types/scalars/id.mdx) ### Member Of [`CreatePricingInput`](/api/merchant/types/inputs/create-pricing-input.mdx) [`UpdatePricingInput`](/api/merchant/types/inputs/update-pricing-input.mdx) --- ## SessionHomeDeliveryInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionHomeDeliveryInput { enabled: Boolean! recipient: CustomerRecipientInput location: Boolean providers: [ProviderEnum!] dropOffAt: DateTimeTz price: [SessionPriceInput!] zones: [SessionHomeDeliveryZoneInput!] } ``` ### Fields #### [SessionHomeDeliveryInput.enabled](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [SessionHomeDeliveryInput.recipient](#)[CustomerRecipientInput](/api/merchant/types/inputs/customer-recipient-input.mdx) #### [SessionHomeDeliveryInput.location](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [SessionHomeDeliveryInput.providers](#)[[ProviderEnum!]](/api/merchant/types/scalars/provider-enum.mdx) #### [SessionHomeDeliveryInput.dropOffAt](#)[DateTimeTz](/api/merchant/types/scalars/date-time-tz.mdx) #### [SessionHomeDeliveryInput.price](#)[[SessionPriceInput!]](/api/merchant/types/inputs/session-price-input.mdx) #### [SessionHomeDeliveryInput.zones](#)[[SessionHomeDeliveryZoneInput!]](/api/merchant/types/inputs/session-home-delivery-zone-input.mdx) ### Member Of [`SessionInput`](/api/merchant/types/inputs/session-input.mdx) --- ## SessionHomeDeliveryZoneInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionHomeDeliveryZoneInput { countries: [CountryEnum!]! providers: [ProviderEnum!]! } ``` ### Fields #### [SessionHomeDeliveryZoneInput.countries](#)[[CountryEnum!]!](/api/merchant/types/enums/country-enum.mdx) #### [SessionHomeDeliveryZoneInput.providers](#)[[ProviderEnum!]!](/api/merchant/types/scalars/provider-enum.mdx) ### Member Of [`SessionHomeDeliveryInput`](/api/merchant/types/inputs/session-home-delivery-input.mdx) --- ## SessionInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionInput { id: ID mode: ShipmentModeEnum currency: CurrencyEnum language: LanguageEnum customer: CustomerInput sender: SessionSenderInput origin: SessionOriginInput parcels: [SessionParcelInput!] price: [SessionPriceInput!] zones: [SessionZoneInput!] pickupPoint: SessionPickupPointInput homeDelivery: SessionHomeDeliveryInput } ``` ### Fields #### [SessionInput.id](#)[ID](/api/merchant/types/scalars/id.mdx) #### [SessionInput.mode](#)[ShipmentModeEnum](/api/merchant/types/enums/shipment-mode-enum.mdx) #### [SessionInput.currency](#)[CurrencyEnum](/api/merchant/types/enums/currency-enum.mdx) #### [SessionInput.language](#)[LanguageEnum](/api/merchant/types/enums/language-enum.mdx) #### [SessionInput.customer](#)[CustomerInput](/api/merchant/types/inputs/customer-input.mdx) #### [SessionInput.sender](#)[SessionSenderInput](/api/merchant/types/inputs/session-sender-input.mdx) #### [SessionInput.origin](#)[SessionOriginInput](/api/merchant/types/inputs/session-origin-input.mdx) #### [SessionInput.parcels](#)[[SessionParcelInput!]](/api/merchant/types/inputs/session-parcel-input.mdx) #### [SessionInput.price](#)[[SessionPriceInput!]](/api/merchant/types/inputs/session-price-input.mdx) #### [SessionInput.zones](#)[[SessionZoneInput!]](/api/merchant/types/inputs/session-zone-input.mdx) #### [SessionInput.pickupPoint](#)[SessionPickupPointInput](/api/merchant/types/inputs/session-pickup-point-input.mdx) #### [SessionInput.homeDelivery](#)[SessionHomeDeliveryInput](/api/merchant/types/inputs/session-home-delivery-input.mdx) ### Member Of [`session`](/api/merchant/operations/mutations/session.mdx) --- ## SessionOriginInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionOriginInput { pickupPointId: ID address: AddressInput location: LocationInput } ``` ### Fields #### [SessionOriginInput.pickupPointId](#)[ID](/api/merchant/types/scalars/id.mdx) #### [SessionOriginInput.address](#)[AddressInput](/api/merchant/types/inputs/address-input.mdx) #### [SessionOriginInput.location](#)[LocationInput](/api/merchant/types/inputs/location-input.mdx) ### Member Of [`SessionInput`](/api/merchant/types/inputs/session-input.mdx) --- ## SessionParcelInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionParcelInput { weight: Float! dimensions: DimensionInput! cashOnDelivery: MoneyInput value: MoneyInput insurance: MoneyInput } ``` ### Fields #### [SessionParcelInput.weight](#)[Float!](/api/merchant/types/scalars/float.mdx) #### [SessionParcelInput.dimensions](#)[DimensionInput!](/api/merchant/types/inputs/dimension-input.mdx) #### [SessionParcelInput.cashOnDelivery](#)[MoneyInput](/api/merchant/types/inputs/money-input.mdx) #### [SessionParcelInput.value](#)[MoneyInput](/api/merchant/types/inputs/money-input.mdx) #### [SessionParcelInput.insurance](#)[MoneyInput](/api/merchant/types/inputs/money-input.mdx) ### Member Of [`SessionInput`](/api/merchant/types/inputs/session-input.mdx) --- ## SessionPickupPointCustomAllowInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionPickupPointCustomAllowInput { id: ID referenceId: ID } ``` ### Fields #### [SessionPickupPointCustomAllowInput.id](#)[ID](/api/merchant/types/scalars/id.mdx) #### [SessionPickupPointCustomAllowInput.referenceId](#)[ID](/api/merchant/types/scalars/id.mdx) ### Member Of [`SessionPickupPointCustomInput`](/api/merchant/types/inputs/session-pickup-point-custom-input.mdx) --- ## SessionPickupPointCustomInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionPickupPointCustomInput { enabled: Boolean! allowlist: [SessionPickupPointCustomAllowInput!] } ``` ### Fields #### [SessionPickupPointCustomInput.enabled](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [SessionPickupPointCustomInput.allowlist](#)[[SessionPickupPointCustomAllowInput!]](/api/merchant/types/inputs/session-pickup-point-custom-allow-input.mdx) ### Member Of [`SessionPickupPointInput`](/api/merchant/types/inputs/session-pickup-point-input.mdx) --- ## SessionPickupPointDisallowInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionPickupPointDisallowInput { id: ID referenceId: ID hide: Boolean } ``` ### Fields #### [SessionPickupPointDisallowInput.id](#)[ID](/api/merchant/types/scalars/id.mdx) #### [SessionPickupPointDisallowInput.referenceId](#)[ID](/api/merchant/types/scalars/id.mdx) #### [SessionPickupPointDisallowInput.hide](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) ### Member Of [`SessionPickupPointInput`](/api/merchant/types/inputs/session-pickup-point-input.mdx) --- ## SessionPickupPointInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionPickupPointInput { enabled: Boolean! recipient: CustomerRecipientInput providers: [SessionPickupPointProviderInput!] price: [SessionPickupPointPriceInput!] disallow: [SessionPickupPointDisallowInput!] tags: [SessionPickupPointTagInput!] custom: SessionPickupPointCustomInput zones: [SessionPickupPointZoneInput!] } ``` ### Fields #### [SessionPickupPointInput.enabled](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [SessionPickupPointInput.recipient](#)[CustomerRecipientInput](/api/merchant/types/inputs/customer-recipient-input.mdx) #### [SessionPickupPointInput.providers](#)[[SessionPickupPointProviderInput!]](/api/merchant/types/inputs/session-pickup-point-provider-input.mdx) #### [SessionPickupPointInput.price](#)[[SessionPickupPointPriceInput!]](/api/merchant/types/inputs/session-pickup-point-price-input.mdx) #### [SessionPickupPointInput.disallow](#)[[SessionPickupPointDisallowInput!]](/api/merchant/types/inputs/session-pickup-point-disallow-input.mdx) #### [SessionPickupPointInput.tags](#)[[SessionPickupPointTagInput!]](/api/merchant/types/inputs/session-pickup-point-tag-input.mdx) #### [SessionPickupPointInput.custom](#)[SessionPickupPointCustomInput](/api/merchant/types/inputs/session-pickup-point-custom-input.mdx) #### [SessionPickupPointInput.zones](#)[[SessionPickupPointZoneInput!]](/api/merchant/types/inputs/session-pickup-point-zone-input.mdx) ### Member Of [`SessionInput`](/api/merchant/types/inputs/session-input.mdx) --- ## SessionPickupPointPriceInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionPickupPointPriceInput { provider: ProviderEnum pickupPointType: PickupPointTypeEnum price: MoneyInput! } ``` ### Fields #### [SessionPickupPointPriceInput.provider](#)[ProviderEnum](/api/merchant/types/scalars/provider-enum.mdx) #### [SessionPickupPointPriceInput.pickupPointType](#)[PickupPointTypeEnum](/api/merchant/types/enums/pickup-point-type-enum.mdx) #### [SessionPickupPointPriceInput.price](#)[MoneyInput!](/api/merchant/types/inputs/money-input.mdx) ### Member Of [`SessionPickupPointInput`](/api/merchant/types/inputs/session-pickup-point-input.mdx) --- ## SessionPickupPointProviderInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionPickupPointProviderInput { provider: ProviderEnum! pickupPointTypes: [PickupPointTypeEnum!] } ``` ### Fields #### [SessionPickupPointProviderInput.provider](#)[ProviderEnum!](/api/merchant/types/scalars/provider-enum.mdx) #### [SessionPickupPointProviderInput.pickupPointTypes](#)[[PickupPointTypeEnum!]](/api/merchant/types/enums/pickup-point-type-enum.mdx) ### Member Of [`SessionPickupPointInput`](/api/merchant/types/inputs/session-pickup-point-input.mdx) --- ## SessionPickupPointTagInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionPickupPointTagInput { id: ID referenceId: ID tags: [PickupPointTagInput!] hide: Boolean } ``` ### Fields #### [SessionPickupPointTagInput.id](#)[ID](/api/merchant/types/scalars/id.mdx) #### [SessionPickupPointTagInput.referenceId](#)[ID](/api/merchant/types/scalars/id.mdx) #### [SessionPickupPointTagInput.tags](#)[[PickupPointTagInput!]](/api/merchant/types/inputs/pickup-point-tag-input.mdx) #### [SessionPickupPointTagInput.hide](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) ### Member Of [`SessionPickupPointInput`](/api/merchant/types/inputs/session-pickup-point-input.mdx) --- ## SessionPickupPointZoneInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionPickupPointZoneInput { countries: [CountryEnum!]! providers: [ProviderEnum!]! } ``` ### Fields #### [SessionPickupPointZoneInput.countries](#)[[CountryEnum!]!](/api/merchant/types/enums/country-enum.mdx) #### [SessionPickupPointZoneInput.providers](#)[[ProviderEnum!]!](/api/merchant/types/scalars/provider-enum.mdx) ### Member Of [`SessionPickupPointInput`](/api/merchant/types/inputs/session-pickup-point-input.mdx) --- ## SessionPriceInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionPriceInput { provider: ProviderEnum price: MoneyInput! } ``` ### Fields #### [SessionPriceInput.provider](#)[ProviderEnum](/api/merchant/types/scalars/provider-enum.mdx) #### [SessionPriceInput.price](#)[MoneyInput!](/api/merchant/types/inputs/money-input.mdx) ### Member Of [`SessionHomeDeliveryInput`](/api/merchant/types/inputs/session-home-delivery-input.mdx) [`SessionInput`](/api/merchant/types/inputs/session-input.mdx) --- ## SessionSenderInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionSenderInput { name: String! email: String phone: String bankAccountNumber: String } ``` ### Fields #### [SessionSenderInput.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [SessionSenderInput.email](#)[String](/api/merchant/types/scalars/string.mdx) #### [SessionSenderInput.phone](#)[String](/api/merchant/types/scalars/string.mdx) #### [SessionSenderInput.bankAccountNumber](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`SessionInput`](/api/merchant/types/inputs/session-input.mdx) --- ## SessionToShipmentInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionToShipmentInput { sessionId: ID! referenceId: String! sourceId: String waybillId: ID mode: ShipmentModeEnum direct: Boolean! origin: ShipmentOriginInput sender: ShipmentSenderInput parcels: [ParcelInput!] order: OrderInput } ``` ### Fields #### [SessionToShipmentInput.sessionId](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [SessionToShipmentInput.referenceId](#)[String!](/api/merchant/types/scalars/string.mdx) #### [SessionToShipmentInput.sourceId](#)[String](/api/merchant/types/scalars/string.mdx) #### [SessionToShipmentInput.waybillId](#)[ID](/api/merchant/types/scalars/id.mdx) #### [SessionToShipmentInput.mode](#)[ShipmentModeEnum](/api/merchant/types/enums/shipment-mode-enum.mdx) #### [SessionToShipmentInput.direct](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [SessionToShipmentInput.origin](#)[ShipmentOriginInput](/api/merchant/types/inputs/shipment-origin-input.mdx) #### [SessionToShipmentInput.sender](#)[ShipmentSenderInput](/api/merchant/types/inputs/shipment-sender-input.mdx) #### [SessionToShipmentInput.parcels](#)[[ParcelInput!]](/api/merchant/types/inputs/parcel-input.mdx) #### [SessionToShipmentInput.order](#)[OrderInput](/api/merchant/types/inputs/order-input.mdx) ### Member Of [`sessionToShipment`](/api/merchant/operations/mutations/session-to-shipment.mdx) --- ## SessionZoneInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionZoneInput { countries: [CountryEnum!]! providers: [ProviderEnum!]! } ``` ### Fields #### [SessionZoneInput.countries](#)[[CountryEnum!]!](/api/merchant/types/enums/country-enum.mdx) #### [SessionZoneInput.providers](#)[[ProviderEnum!]!](/api/merchant/types/scalars/provider-enum.mdx) ### Member Of [`SessionInput`](/api/merchant/types/inputs/session-input.mdx) --- ## ShipmentDestinationInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input ShipmentDestinationInput { pickupPointId: ID address: AddressInput location: LocationInput dropOffAt: DateTimeTz } ``` ### Fields #### [ShipmentDestinationInput.pickupPointId](#)[ID](/api/merchant/types/scalars/id.mdx) #### [ShipmentDestinationInput.address](#)[AddressInput](/api/merchant/types/inputs/address-input.mdx) #### [ShipmentDestinationInput.location](#)[LocationInput](/api/merchant/types/inputs/location-input.mdx) #### [ShipmentDestinationInput.dropOffAt](#)[DateTimeTz](/api/merchant/types/scalars/date-time-tz.mdx) ### Member Of [`CreateShipmentInput`](/api/merchant/types/inputs/create-shipment-input.mdx) [`UpdateShipmentInput`](/api/merchant/types/inputs/update-shipment-input.mdx) --- ## ShipmentFilterInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input ShipmentFilterInput { id: [ID!] provider: [ProviderEnum!] senderName: String senderEmail: String senderPhone: String originPickupPointId: ID originCountry: CountryEnum originState: String originCity: String originPostalCode: String originAddressLine1: String originAddressLine2: String originNote: String recipientName: String recipientEmail: String recipientPhone: String destinationPickupPointId: ID destinationCountry: CountryEnum destinationState: String destinationCity: String destinationPostalCode: String destinationAddressLine1: String destinationAddressLine2: String destinationNote: String trackingCode: [String!] } ``` ### Fields #### [ShipmentFilterInput.id](#)[[ID!]](/api/merchant/types/scalars/id.mdx) #### [ShipmentFilterInput.provider](#)[[ProviderEnum!]](/api/merchant/types/scalars/provider-enum.mdx) #### [ShipmentFilterInput.senderName](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentFilterInput.senderEmail](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentFilterInput.senderPhone](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentFilterInput.originPickupPointId](#)[ID](/api/merchant/types/scalars/id.mdx) #### [ShipmentFilterInput.originCountry](#)[CountryEnum](/api/merchant/types/enums/country-enum.mdx) #### [ShipmentFilterInput.originState](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentFilterInput.originCity](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentFilterInput.originPostalCode](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentFilterInput.originAddressLine1](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentFilterInput.originAddressLine2](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentFilterInput.originNote](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentFilterInput.recipientName](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentFilterInput.recipientEmail](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentFilterInput.recipientPhone](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentFilterInput.destinationPickupPointId](#)[ID](/api/merchant/types/scalars/id.mdx) #### [ShipmentFilterInput.destinationCountry](#)[CountryEnum](/api/merchant/types/enums/country-enum.mdx) #### [ShipmentFilterInput.destinationState](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentFilterInput.destinationCity](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentFilterInput.destinationPostalCode](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentFilterInput.destinationAddressLine1](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentFilterInput.destinationAddressLine2](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentFilterInput.destinationNote](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentFilterInput.trackingCode](#)[[String!]](/api/merchant/types/scalars/string.mdx) ### Member Of [`shipments`](/api/merchant/operations/queries/shipments.mdx) --- ## ShipmentOriginInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input ShipmentOriginInput { pickupPointId: ID address: AddressInput location: LocationInput } ``` ### Fields #### [ShipmentOriginInput.pickupPointId](#)[ID](/api/merchant/types/scalars/id.mdx) #### [ShipmentOriginInput.address](#)[AddressInput](/api/merchant/types/inputs/address-input.mdx) #### [ShipmentOriginInput.location](#)[LocationInput](/api/merchant/types/inputs/location-input.mdx) ### Member Of [`CreateShipmentInput`](/api/merchant/types/inputs/create-shipment-input.mdx) [`SessionToShipmentInput`](/api/merchant/types/inputs/session-to-shipment-input.mdx) [`UpdateShipmentInput`](/api/merchant/types/inputs/update-shipment-input.mdx) --- ## ShipmentRecipientInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input ShipmentRecipientInput { firstName: String! lastName: String! language: LanguageEnum! email: String phone: String } ``` ### Fields #### [ShipmentRecipientInput.firstName](#)[String!](/api/merchant/types/scalars/string.mdx) #### [ShipmentRecipientInput.lastName](#)[String!](/api/merchant/types/scalars/string.mdx) #### [ShipmentRecipientInput.language](#)[LanguageEnum!](/api/merchant/types/enums/language-enum.mdx) #### [ShipmentRecipientInput.email](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentRecipientInput.phone](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`CreateShipmentInput`](/api/merchant/types/inputs/create-shipment-input.mdx) [`UpdateShipmentInput`](/api/merchant/types/inputs/update-shipment-input.mdx) --- ## ShipmentSenderInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input ShipmentSenderInput { name: String! email: String phone: String bankAccountNumber: String } ``` ### Fields #### [ShipmentSenderInput.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [ShipmentSenderInput.email](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentSenderInput.phone](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentSenderInput.bankAccountNumber](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`CreateShipmentInput`](/api/merchant/types/inputs/create-shipment-input.mdx) [`SessionToShipmentInput`](/api/merchant/types/inputs/session-to-shipment-input.mdx) [`UpdateShipmentInput`](/api/merchant/types/inputs/update-shipment-input.mdx) --- ## ShipmentSortInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input ShipmentSortInput { field: ShipmentSortEnum! direction: OrderDirectionEnum } ``` ### Fields #### [ShipmentSortInput.field](#)[ShipmentSortEnum!](/api/merchant/types/enums/shipment-sort-enum.mdx) #### [ShipmentSortInput.direction](#)[OrderDirectionEnum](/api/merchant/types/enums/order-direction-enum.mdx) ### Member Of [`shipments`](/api/merchant/operations/queries/shipments.mdx) --- ## SubscriptionPeriodFilterInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SubscriptionPeriodFilterInput { isCurrent: Boolean } ``` ### Fields #### [SubscriptionPeriodFilterInput.isCurrent](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) --- ## ThemeOptionInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input ThemeOptionInput { key: ThemeConfigurationEnum! value: String } ``` ### Fields #### [ThemeOptionInput.key](#)[ThemeConfigurationEnum!](/api/merchant/types/enums/theme-configuration-enum.mdx) #### [ThemeOptionInput.value](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`CreateThemeInput`](/api/merchant/types/inputs/create-theme-input.mdx) [`UpdateThemeInput`](/api/merchant/types/inputs/update-theme-input.mdx) --- ## TimeInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input TimeInput { hour: Int! minute: Int! } ``` ### Fields #### [TimeInput.hour](#)[Int!](/api/merchant/types/scalars/int.mdx) #### [TimeInput.minute](#)[Int!](/api/merchant/types/scalars/int.mdx) ### Member Of [`OpeningHourInput`](/api/merchant/types/inputs/opening-hour-input.mdx) --- ## TokenAllowlistInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input TokenAllowlistInput { ips: [IP!] referers: [String!] } ``` ### Fields #### [TokenAllowlistInput.ips](#)[[IP!]](/api/merchant/types/scalars/ip.mdx) #### [TokenAllowlistInput.referers](#)[[String!]](/api/merchant/types/scalars/string.mdx) ### Member Of [`CreateTokenInput`](/api/merchant/types/inputs/create-token-input.mdx) --- ## UpdateFulfillmentConfigurationInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input UpdateFulfillmentConfigurationInput { fulfillment: FulfillmentEnum! key: FulfillmentConfigurationEnum! value: String } ``` ### Fields #### [UpdateFulfillmentConfigurationInput.fulfillment](#)[FulfillmentEnum!](/api/merchant/types/enums/fulfillment-enum.mdx) #### [UpdateFulfillmentConfigurationInput.key](#)[FulfillmentConfigurationEnum!](/api/merchant/types/enums/fulfillment-configuration-enum.mdx) #### [UpdateFulfillmentConfigurationInput.value](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`updateFulfillmentConfiguration`](/api/merchant/operations/mutations/update-fulfillment-configuration.mdx) [`updateFulfillmentConfigurations`](/api/merchant/operations/mutations/update-fulfillment-configurations.mdx) --- ## UpdateMerchantConfigurationInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input UpdateMerchantConfigurationInput { key: MerchantConfigurationEnum! value: String } ``` ### Fields #### [UpdateMerchantConfigurationInput.key](#)[MerchantConfigurationEnum!](/api/merchant/types/enums/merchant-configuration-enum.mdx) #### [UpdateMerchantConfigurationInput.value](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`updateMerchantConfiguration`](/api/merchant/operations/mutations/update-merchant-configuration.mdx) [`updateMerchantConfigurations`](/api/merchant/operations/mutations/update-merchant-configurations.mdx) --- ## UpdateOperatorConfigurationInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input UpdateOperatorConfigurationInput { operator: OperatorEnum! key: OperatorConfigurationEnum! value: String } ``` ### Fields #### [UpdateOperatorConfigurationInput.operator](#)[OperatorEnum!](/api/merchant/types/enums/operator-enum.mdx) #### [UpdateOperatorConfigurationInput.key](#)[OperatorConfigurationEnum!](/api/merchant/types/enums/operator-configuration-enum.mdx) #### [UpdateOperatorConfigurationInput.value](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`updateOperatorConfiguration`](/api/merchant/operations/mutations/update-operator-configuration.mdx) [`updateOperatorConfigurations`](/api/merchant/operations/mutations/update-operator-configurations.mdx) --- ## UpdatePackagingInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input UpdatePackagingInput { id: ID! name: String! handle: ID! dimensions: DimensionInput! isDefault: Boolean! } ``` ### Fields #### [UpdatePackagingInput.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [UpdatePackagingInput.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [UpdatePackagingInput.handle](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [UpdatePackagingInput.dimensions](#)[DimensionInput!](/api/merchant/types/inputs/dimension-input.mdx) #### [UpdatePackagingInput.isDefault](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) ### Member Of [`updatePackaging`](/api/merchant/operations/mutations/update-packaging.mdx) --- ## UpdatePickupPointInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input UpdatePickupPointInput { id: ID referenceId: String! references: [PickupPointProviderReferenceInput!] name: String! phone: String cashOnDelivery: [PaymentMethodEnum!] hasWheelchairAccess: Boolean address: AddressInput! location: LocationInput! openingHours: PickupPointOpeningHoursInput tags: [PickupPointTagInput!] isActive: Boolean! } ``` ### Fields #### [UpdatePickupPointInput.id](#)[ID](/api/merchant/types/scalars/id.mdx) #### [UpdatePickupPointInput.referenceId](#)[String!](/api/merchant/types/scalars/string.mdx) #### [UpdatePickupPointInput.references](#)[[PickupPointProviderReferenceInput!]](/api/merchant/types/inputs/pickup-point-provider-reference-input.mdx) #### [UpdatePickupPointInput.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [UpdatePickupPointInput.phone](#)[String](/api/merchant/types/scalars/string.mdx) #### [UpdatePickupPointInput.cashOnDelivery](#)[[PaymentMethodEnum!]](/api/merchant/types/enums/payment-method-enum.mdx) #### [UpdatePickupPointInput.hasWheelchairAccess](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [UpdatePickupPointInput.address](#)[AddressInput!](/api/merchant/types/inputs/address-input.mdx) #### [UpdatePickupPointInput.location](#)[LocationInput!](/api/merchant/types/inputs/location-input.mdx) #### [UpdatePickupPointInput.openingHours](#)[PickupPointOpeningHoursInput](/api/merchant/types/inputs/pickup-point-opening-hours-input.mdx) #### [UpdatePickupPointInput.tags](#)[[PickupPointTagInput!]](/api/merchant/types/inputs/pickup-point-tag-input.mdx) #### [UpdatePickupPointInput.isActive](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) ### Member Of [`updatePickupPoint`](/api/merchant/operations/mutations/update-pickup-point.mdx) --- ## UpdatePricingInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input UpdatePricingInput { id: ID! name: String! condition: PricingConditionInput price: MoneyInput! priority: Int } ``` ### Fields #### [UpdatePricingInput.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [UpdatePricingInput.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [UpdatePricingInput.condition](#)[PricingConditionInput](/api/merchant/types/inputs/pricing-condition-input.mdx) #### [UpdatePricingInput.price](#)[MoneyInput!](/api/merchant/types/inputs/money-input.mdx) #### [UpdatePricingInput.priority](#)[Int](/api/merchant/types/scalars/int.mdx) ### Member Of [`updatePricing`](/api/merchant/operations/mutations/update-pricing.mdx) --- ## UpdateProviderConfigurationInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input UpdateProviderConfigurationInput { provider: ProviderEnum! key: ProviderConfigurationEnum! value: String } ``` ### Fields #### [UpdateProviderConfigurationInput.provider](#)[ProviderEnum!](/api/merchant/types/scalars/provider-enum.mdx) #### [UpdateProviderConfigurationInput.key](#)[ProviderConfigurationEnum!](/api/merchant/types/enums/provider-configuration-enum.mdx) #### [UpdateProviderConfigurationInput.value](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`updateProviderConfiguration`](/api/merchant/operations/mutations/update-provider-configuration.mdx) [`updateProviderConfigurations`](/api/merchant/operations/mutations/update-provider-configurations.mdx) --- ## UpdateShipmentInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input UpdateShipmentInput { id: ID! referenceId: String! sourceId: String waybillId: ID mode: ShipmentModeEnum! direct: Boolean! origin: ShipmentOriginInput sender: ShipmentSenderInput destination: ShipmentDestinationInput! recipient: ShipmentRecipientInput! parcels: [ParcelInput!] order: OrderInput } ``` ### Fields #### [UpdateShipmentInput.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [UpdateShipmentInput.referenceId](#)[String!](/api/merchant/types/scalars/string.mdx) #### [UpdateShipmentInput.sourceId](#)[String](/api/merchant/types/scalars/string.mdx) #### [UpdateShipmentInput.waybillId](#)[ID](/api/merchant/types/scalars/id.mdx) #### [UpdateShipmentInput.mode](#)[ShipmentModeEnum!](/api/merchant/types/enums/shipment-mode-enum.mdx) #### [UpdateShipmentInput.direct](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [UpdateShipmentInput.origin](#)[ShipmentOriginInput](/api/merchant/types/inputs/shipment-origin-input.mdx) #### [UpdateShipmentInput.sender](#)[ShipmentSenderInput](/api/merchant/types/inputs/shipment-sender-input.mdx) #### [UpdateShipmentInput.destination](#)[ShipmentDestinationInput!](/api/merchant/types/inputs/shipment-destination-input.mdx) #### [UpdateShipmentInput.recipient](#)[ShipmentRecipientInput!](/api/merchant/types/inputs/shipment-recipient-input.mdx) #### [UpdateShipmentInput.parcels](#)[[ParcelInput!]](/api/merchant/types/inputs/parcel-input.mdx) #### [UpdateShipmentInput.order](#)[OrderInput](/api/merchant/types/inputs/order-input.mdx) ### Member Of [`updateShipment`](/api/merchant/operations/mutations/update-shipment.mdx) --- ## UpdateThemeInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input UpdateThemeInput { id: ID! handle: ID! isEnabled: Boolean! isDefault: Boolean! options: [ThemeOptionInput!]! } ``` ### Fields #### [UpdateThemeInput.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [UpdateThemeInput.handle](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [UpdateThemeInput.isEnabled](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [UpdateThemeInput.isDefault](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [UpdateThemeInput.options](#)[[ThemeOptionInput!]!](/api/merchant/types/inputs/theme-option-input.mdx) ### Member Of [`updateTheme`](/api/merchant/operations/mutations/update-theme.mdx) --- ## UpdateWebhookInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input UpdateWebhookInput { id: ID! url: String! } ``` ### Fields #### [UpdateWebhookInput.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [UpdateWebhookInput.url](#)[String!](/api/merchant/types/scalars/string.mdx) ### Member Of [`updateWebhook`](/api/merchant/operations/mutations/update-webhook.mdx) --- ## UpdateZoneInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input UpdateZoneInput { id: ID! name: String! countries: [CountryEnum!]! availableHomeDeliveryProviders: [ProviderEnum!]! availablePickupPointProviders: [ProviderEnum!]! } ``` ### Fields #### [UpdateZoneInput.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [UpdateZoneInput.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [UpdateZoneInput.countries](#)[[CountryEnum!]!](/api/merchant/types/enums/country-enum.mdx) #### [UpdateZoneInput.availableHomeDeliveryProviders](#)[[ProviderEnum!]!](/api/merchant/types/scalars/provider-enum.mdx) #### [UpdateZoneInput.availablePickupPointProviders](#)[[ProviderEnum!]!](/api/merchant/types/scalars/provider-enum.mdx) ### Member Of [`updateZone`](/api/merchant/operations/mutations/update-zone.mdx) --- ## UserFilterInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input UserFilterInput { id: [ID!] name: String email: String } ``` ### Fields #### [UserFilterInput.id](#)[[ID!]](/api/merchant/types/scalars/id.mdx) #### [UserFilterInput.name](#)[String](/api/merchant/types/scalars/string.mdx) #### [UserFilterInput.email](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`users`](/api/merchant/operations/queries/users.mdx) --- ## UserSortInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input UserSortInput { field: UserSortEnum! direction: OrderDirectionEnum } ``` ### Fields #### [UserSortInput.field](#)[UserSortEnum!](/api/merchant/types/enums/user-sort-enum.mdx) #### [UserSortInput.direction](#)[OrderDirectionEnum](/api/merchant/types/enums/order-direction-enum.mdx) ### Member Of [`users`](/api/merchant/operations/queries/users.mdx) --- ## WaybillFilterInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input WaybillFilterInput { id: [ID!] provider: [ProviderEnum!] isClosed: Boolean closedAt: DateTimeRangeFilter createdAt: DateTimeRangeFilter } ``` ### Fields #### [WaybillFilterInput.id](#)[[ID!]](/api/merchant/types/scalars/id.mdx) #### [WaybillFilterInput.provider](#)[[ProviderEnum!]](/api/merchant/types/scalars/provider-enum.mdx) #### [WaybillFilterInput.isClosed](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [WaybillFilterInput.closedAt](#)[DateTimeRangeFilter](/api/merchant/types/inputs/date-time-range-filter.mdx) #### [WaybillFilterInput.createdAt](#)[DateTimeRangeFilter](/api/merchant/types/inputs/date-time-range-filter.mdx) ### Member Of [`waybills`](/api/merchant/operations/queries/waybills.mdx) --- ## WaybillSortInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input WaybillSortInput { field: WaybillSortEnum! direction: OrderDirectionEnum } ``` ### Fields #### [WaybillSortInput.field](#)[WaybillSortEnum!](/api/merchant/types/enums/waybill-sort-enum.mdx) #### [WaybillSortInput.direction](#)[OrderDirectionEnum](/api/merchant/types/enums/order-direction-enum.mdx) ### Member Of [`waybills`](/api/merchant/operations/queries/waybills.mdx) --- ## Address export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Address { country: CountryEnum! state: String city: String! postalCode: String! addressLine1: String! addressLine2: String note: String } ``` ### Fields #### [Address.country](#)[CountryEnum!](/api/merchant/types/enums/country-enum.mdx) #### [Address.state](#)[String](/api/merchant/types/scalars/string.mdx) #### [Address.city](#)[String!](/api/merchant/types/scalars/string.mdx) #### [Address.postalCode](#)[String!](/api/merchant/types/scalars/string.mdx) #### [Address.addressLine1](#)[String!](/api/merchant/types/scalars/string.mdx) #### [Address.addressLine2](#)[String](/api/merchant/types/scalars/string.mdx) #### [Address.note](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`OrderBilling`](/api/merchant/types/objects/order-billing.mdx) [`OrderShipping`](/api/merchant/types/objects/order-shipping.mdx) [`PickupPoint`](/api/merchant/types/objects/pickup-point.mdx) [`SessionDestination`](/api/merchant/types/objects/session-destination.mdx) [`ShipmentDestination`](/api/merchant/types/objects/shipment-destination.mdx) [`ShipmentOrigin`](/api/merchant/types/objects/shipment-origin.mdx) --- ## Dimension export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Dimension { width: Float! length: Float! height: Float! } ``` ### Fields #### [Dimension.width](#)[Float!](/api/merchant/types/scalars/float.mdx) #### [Dimension.length](#)[Float!](/api/merchant/types/scalars/float.mdx) #### [Dimension.height](#)[Float!](/api/merchant/types/scalars/float.mdx) ### Member Of [`Packaging`](/api/merchant/types/objects/packaging.mdx) [`Parcel`](/api/merchant/types/objects/parcel.mdx) [`SessionParcel`](/api/merchant/types/objects/session-parcel.mdx) --- ## FloatRange export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type FloatRange { start: Float! end: Float! } ``` ### Fields #### [FloatRange.start](#)[Float!](/api/merchant/types/scalars/float.mdx) #### [FloatRange.end](#)[Float!](/api/merchant/types/scalars/float.mdx) ### Member Of [`MoneyRange`](/api/merchant/types/objects/money-range.mdx) --- ## FulfillmentConfiguration export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type FulfillmentConfiguration { fulfillment: FulfillmentEnum! key: FulfillmentConfigurationEnum! description: String! value: String default: String required: Boolean! group: ConfigurationGroupEnum } ``` ### Fields #### [FulfillmentConfiguration.fulfillment](#)[FulfillmentEnum!](/api/merchant/types/enums/fulfillment-enum.mdx) #### [FulfillmentConfiguration.key](#)[FulfillmentConfigurationEnum!](/api/merchant/types/enums/fulfillment-configuration-enum.mdx) #### [FulfillmentConfiguration.description](#)[String!](/api/merchant/types/scalars/string.mdx) #### [FulfillmentConfiguration.value](#)[String](/api/merchant/types/scalars/string.mdx) #### [FulfillmentConfiguration.default](#)[String](/api/merchant/types/scalars/string.mdx) #### [FulfillmentConfiguration.required](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [FulfillmentConfiguration.group](#)[ConfigurationGroupEnum](/api/merchant/types/enums/configuration-group-enum.mdx) ### Returned By [`updateFulfillmentConfiguration`](/api/merchant/operations/mutations/update-fulfillment-configuration.mdx) [`updateFulfillmentConfigurations`](/api/merchant/operations/mutations/update-fulfillment-configurations.mdx) ### Member Of [`Fulfillment`](/api/merchant/types/objects/fulfillment.mdx) --- ## Fulfillment export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Fulfillment { id: FulfillmentEnum! name: String! icon: String configurations: [FulfillmentConfiguration!]! } ``` ### Fields #### [Fulfillment.id](#)[FulfillmentEnum!](/api/merchant/types/enums/fulfillment-enum.mdx) #### [Fulfillment.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [Fulfillment.icon](#)[String](/api/merchant/types/scalars/string.mdx) #### [Fulfillment.configurations](#)[[FulfillmentConfiguration!]!](/api/merchant/types/objects/fulfillment-configuration.mdx) ### Returned By [`fulfillments`](/api/merchant/operations/queries/fulfillments.mdx) --- ## GlobalIdentifier export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type GlobalIdentifier { id: ID! type: GlobalIdentifierEnum! typeOther: String } ``` ### Fields #### [GlobalIdentifier.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [GlobalIdentifier.type](#)[GlobalIdentifierEnum!](/api/merchant/types/enums/global-identifier-enum.mdx) #### [GlobalIdentifier.typeOther](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`OrderItem`](/api/merchant/types/objects/order-item.mdx) --- ## KeyValue export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type KeyValue { key: String! value: String! } ``` ### Fields #### [KeyValue.key](#)[String!](/api/merchant/types/scalars/string.mdx) #### [KeyValue.value](#)[String!](/api/merchant/types/scalars/string.mdx) ### Member Of [`PickupPoint`](/api/merchant/types/objects/pickup-point.mdx) [`ShipmentEvent`](/api/merchant/types/objects/shipment-event.mdx) --- ## Label export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Label { url: String! } ``` ### Fields #### [Label.url](#)[String!](/api/merchant/types/scalars/string.mdx) ### Member Of [`Parcel`](/api/merchant/types/objects/parcel.mdx) --- ## LocalizedString export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type LocalizedString { language: LanguageEnum! value: String! } ``` ### Fields #### [LocalizedString.language](#)[LanguageEnum!](/api/merchant/types/enums/language-enum.mdx) #### [LocalizedString.value](#)[String!](/api/merchant/types/scalars/string.mdx) ### Member Of [`PickupPointTag`](/api/merchant/types/objects/pickup-point-tag.mdx) --- ## Location export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Location { latitude: Float! longitude: Float! } ``` ### Fields #### [Location.latitude](#)[Float!](/api/merchant/types/scalars/float.mdx) #### [Location.longitude](#)[Float!](/api/merchant/types/scalars/float.mdx) ### Member Of [`PickupPoint`](/api/merchant/types/objects/pickup-point.mdx) [`SessionDestination`](/api/merchant/types/objects/session-destination.mdx) [`ShipmentDestination`](/api/merchant/types/objects/shipment-destination.mdx) [`ShipmentOrigin`](/api/merchant/types/objects/shipment-origin.mdx) --- ## MerchantConfiguration export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type MerchantConfiguration { key: MerchantConfigurationEnum! description: String! value: String default: String required: Boolean! group: ConfigurationGroupEnum } ``` ### Fields #### [MerchantConfiguration.key](#)[MerchantConfigurationEnum!](/api/merchant/types/enums/merchant-configuration-enum.mdx) #### [MerchantConfiguration.description](#)[String!](/api/merchant/types/scalars/string.mdx) #### [MerchantConfiguration.value](#)[String](/api/merchant/types/scalars/string.mdx) #### [MerchantConfiguration.default](#)[String](/api/merchant/types/scalars/string.mdx) #### [MerchantConfiguration.required](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [MerchantConfiguration.group](#)[ConfigurationGroupEnum](/api/merchant/types/enums/configuration-group-enum.mdx) ### Returned By [`updateMerchantConfiguration`](/api/merchant/operations/mutations/update-merchant-configuration.mdx) [`updateMerchantConfigurations`](/api/merchant/operations/mutations/update-merchant-configurations.mdx) ### Member Of [`Merchant`](/api/merchant/types/objects/merchant.mdx) --- ## MerchantSubscriptionComponent export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type MerchantSubscriptionComponent { limit: Int isOveruseEnabled: Boolean overuse: Money } ``` ### Fields #### [MerchantSubscriptionComponent.limit](#)[Int](/api/merchant/types/scalars/int.mdx) #### [MerchantSubscriptionComponent.isOveruseEnabled](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [MerchantSubscriptionComponent.overuse](#)[Money](/api/merchant/types/objects/money.mdx) ### Member Of [`MerchantSubscription`](/api/merchant/types/objects/merchant-subscription.mdx) --- ## MerchantSubscriptionConfirmation export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type MerchantSubscriptionConfirmation { redirectUrl: String } ``` ### Fields #### [MerchantSubscriptionConfirmation.redirectUrl](#)[String](/api/merchant/types/scalars/string.mdx) ### Returned By [`activateSubscription`](/api/merchant/operations/mutations/activate-subscription.mdx) [`subscribe`](/api/merchant/operations/mutations/subscribe.mdx) --- ## MerchantSubscriptionFeatures export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type MerchantSubscriptionFeatures { isCustomerSupportAvailable: Boolean! isPrioritySupportAvailable: Boolean! isKeyAccountManagerAvailable: Boolean! isShopifyPlusFeaturesAvailable: Boolean! } ``` ### Fields #### [MerchantSubscriptionFeatures.isCustomerSupportAvailable](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [MerchantSubscriptionFeatures.isPrioritySupportAvailable](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [MerchantSubscriptionFeatures.isKeyAccountManagerAvailable](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [MerchantSubscriptionFeatures.isShopifyPlusFeaturesAvailable](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) ### Member Of [`MerchantSubscription`](/api/merchant/types/objects/merchant-subscription.mdx) [`MerchantSubscriptionPlan`](/api/merchant/types/objects/merchant-subscription-plan.mdx) --- ## MerchantSubscriptionPaginator export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; A paginated list of MerchantSubscription items. ```graphql type MerchantSubscriptionPaginator { paginatorInfo: PaginatorInfo! data: [MerchantSubscription!]! } ``` ### Fields #### [MerchantSubscriptionPaginator.paginatorInfo](#)[PaginatorInfo!](/api/merchant/types/objects/paginator-info.mdx) Pagination information about the list of items. #### [MerchantSubscriptionPaginator.data](#)[[MerchantSubscription!]!](/api/merchant/types/objects/merchant-subscription.mdx) A list of MerchantSubscription items. ### Returned By [`subscriptions`](/api/merchant/operations/queries/subscriptions.mdx) --- ## MerchantSubscriptionPeriodComponent export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type MerchantSubscriptionPeriodComponent { limit: Int isOveruseEnabled: Boolean overuse: Money usage: Int isLimited: Boolean } ``` ### Fields #### [MerchantSubscriptionPeriodComponent.limit](#)[Int](/api/merchant/types/scalars/int.mdx) #### [MerchantSubscriptionPeriodComponent.isOveruseEnabled](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [MerchantSubscriptionPeriodComponent.overuse](#)[Money](/api/merchant/types/objects/money.mdx) #### [MerchantSubscriptionPeriodComponent.usage](#)[Int](/api/merchant/types/scalars/int.mdx) #### [MerchantSubscriptionPeriodComponent.isLimited](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) ### Member Of [`MerchantSubscriptionPeriod`](/api/merchant/types/objects/merchant-subscription-period.mdx) --- ## MerchantSubscriptionPeriod export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type MerchantSubscriptionPeriod { from: DateTimeTz! to: DateTimeTz! status: MerchantSubscriptionStatusEnum! overuse: Money shipment: MerchantSubscriptionPeriodComponent waybill: MerchantSubscriptionPeriodComponent order: MerchantSubscriptionPeriodComponent request: MerchantSubscriptionPeriodComponent } ``` ### Fields #### [MerchantSubscriptionPeriod.from](#)[DateTimeTz!](/api/merchant/types/scalars/date-time-tz.mdx) #### [MerchantSubscriptionPeriod.to](#)[DateTimeTz!](/api/merchant/types/scalars/date-time-tz.mdx) #### [MerchantSubscriptionPeriod.status](#)[MerchantSubscriptionStatusEnum!](/api/merchant/types/enums/merchant-subscription-status-enum.mdx) #### [MerchantSubscriptionPeriod.overuse](#)[Money](/api/merchant/types/objects/money.mdx) #### [MerchantSubscriptionPeriod.shipment](#)[MerchantSubscriptionPeriodComponent](/api/merchant/types/objects/merchant-subscription-period-component.mdx) #### [MerchantSubscriptionPeriod.waybill](#)[MerchantSubscriptionPeriodComponent](/api/merchant/types/objects/merchant-subscription-period-component.mdx) #### [MerchantSubscriptionPeriod.order](#)[MerchantSubscriptionPeriodComponent](/api/merchant/types/objects/merchant-subscription-period-component.mdx) #### [MerchantSubscriptionPeriod.request](#)[MerchantSubscriptionPeriodComponent](/api/merchant/types/objects/merchant-subscription-period-component.mdx) ### Member Of [`MerchantSubscription`](/api/merchant/types/objects/merchant-subscription.mdx) --- ## MerchantSubscriptionPlanComponentLimit export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type MerchantSubscriptionPlanComponentLimit { monthly: Int yearly: Int } ``` ### Fields #### [MerchantSubscriptionPlanComponentLimit.monthly](#)[Int](/api/merchant/types/scalars/int.mdx) #### [MerchantSubscriptionPlanComponentLimit.yearly](#)[Int](/api/merchant/types/scalars/int.mdx) ### Member Of [`MerchantSubscriptionPlanComponent`](/api/merchant/types/objects/merchant-subscription-plan-component.mdx) --- ## MerchantSubscriptionPlanComponentOveruse export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type MerchantSubscriptionPlanComponentOveruse { monthly: Boolean yearly: Boolean } ``` ### Fields #### [MerchantSubscriptionPlanComponentOveruse.monthly](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [MerchantSubscriptionPlanComponentOveruse.yearly](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) ### Member Of [`MerchantSubscriptionPlanComponent`](/api/merchant/types/objects/merchant-subscription-plan-component.mdx) --- ## MerchantSubscriptionPlanComponent export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type MerchantSubscriptionPlanComponent { limit: MerchantSubscriptionPlanComponentLimit isOveruseEnabled: MerchantSubscriptionPlanComponentOveruse overuse( currency: CurrencyEnum ): [MerchantSubscriptionPlanPricing!] } ``` ### Fields #### [MerchantSubscriptionPlanComponent.limit](#)[MerchantSubscriptionPlanComponentLimit](/api/merchant/types/objects/merchant-subscription-plan-component-limit.mdx) #### [MerchantSubscriptionPlanComponent.isOveruseEnabled](#)[MerchantSubscriptionPlanComponentOveruse](/api/merchant/types/objects/merchant-subscription-plan-component-overuse.mdx) #### [MerchantSubscriptionPlanComponent.overuse](#)[[MerchantSubscriptionPlanPricing!]](/api/merchant/types/objects/merchant-subscription-plan-pricing.mdx) ##### [MerchantSubscriptionPlanComponent.overuse.currency](#)[CurrencyEnum](/api/merchant/types/enums/currency-enum.mdx) ### Member Of [`MerchantSubscriptionPlan`](/api/merchant/types/objects/merchant-subscription-plan.mdx) --- ## MerchantSubscriptionPlanPricing export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type MerchantSubscriptionPlanPricing { monthly: Money! yearly: Money! } ``` ### Fields #### [MerchantSubscriptionPlanPricing.monthly](#)[Money!](/api/merchant/types/objects/money.mdx) #### [MerchantSubscriptionPlanPricing.yearly](#)[Money!](/api/merchant/types/objects/money.mdx) ### Member Of [`MerchantSubscriptionPlan`](/api/merchant/types/objects/merchant-subscription-plan.mdx) [`MerchantSubscriptionPlanComponent`](/api/merchant/types/objects/merchant-subscription-plan-component.mdx) --- ## MerchantSubscriptionPlan export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type MerchantSubscriptionPlan { id: ID! name: String! level: Int! handle: MerchantSubscriptionPlanEnum pricing( currency: CurrencyEnum ): [MerchantSubscriptionPlanPricing!] shipment: MerchantSubscriptionPlanComponent waybill: MerchantSubscriptionPlanComponent order: MerchantSubscriptionPlanComponent features: MerchantSubscriptionFeatures } ``` ### Fields #### [MerchantSubscriptionPlan.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [MerchantSubscriptionPlan.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [MerchantSubscriptionPlan.level](#)[Int!](/api/merchant/types/scalars/int.mdx) #### [MerchantSubscriptionPlan.handle](#)[MerchantSubscriptionPlanEnum](/api/merchant/types/enums/merchant-subscription-plan-enum.mdx) #### [MerchantSubscriptionPlan.pricing](#)[[MerchantSubscriptionPlanPricing!]](/api/merchant/types/objects/merchant-subscription-plan-pricing.mdx) ##### [MerchantSubscriptionPlan.pricing.currency](#)[CurrencyEnum](/api/merchant/types/enums/currency-enum.mdx) #### [MerchantSubscriptionPlan.shipment](#)[MerchantSubscriptionPlanComponent](/api/merchant/types/objects/merchant-subscription-plan-component.mdx) #### [MerchantSubscriptionPlan.waybill](#)[MerchantSubscriptionPlanComponent](/api/merchant/types/objects/merchant-subscription-plan-component.mdx) #### [MerchantSubscriptionPlan.order](#)[MerchantSubscriptionPlanComponent](/api/merchant/types/objects/merchant-subscription-plan-component.mdx) #### [MerchantSubscriptionPlan.features](#)[MerchantSubscriptionFeatures](/api/merchant/types/objects/merchant-subscription-features.mdx) ### Returned By [`subscriptionPlans`](/api/merchant/operations/queries/subscription-plans.mdx) ### Member Of [`MerchantSubscription`](/api/merchant/types/objects/merchant-subscription.mdx) --- ## MerchantSubscription export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type MerchantSubscription { id: ID! plan: MerchantSubscriptionPlan period: PeriodEnum! currency: CurrencyEnum! from: DateTimeTz! to: DateTimeTz status: MerchantSubscriptionStatusEnum! price: Money shipment: MerchantSubscriptionComponent waybill: MerchantSubscriptionComponent order: MerchantSubscriptionComponent request: MerchantSubscriptionComponent features: MerchantSubscriptionFeatures periods( filters: SubscriptionPeriodFilterInput ): [MerchantSubscriptionPeriod!]! } ``` ### Fields #### [MerchantSubscription.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [MerchantSubscription.plan](#)[MerchantSubscriptionPlan](/api/merchant/types/objects/merchant-subscription-plan.mdx) #### [MerchantSubscription.period](#)[PeriodEnum!](/api/merchant/types/enums/period-enum.mdx) #### [MerchantSubscription.currency](#)[CurrencyEnum!](/api/merchant/types/enums/currency-enum.mdx) #### [MerchantSubscription.from](#)[DateTimeTz!](/api/merchant/types/scalars/date-time-tz.mdx) #### [MerchantSubscription.to](#)[DateTimeTz](/api/merchant/types/scalars/date-time-tz.mdx) #### [MerchantSubscription.status](#)[MerchantSubscriptionStatusEnum!](/api/merchant/types/enums/merchant-subscription-status-enum.mdx) #### [MerchantSubscription.price](#)[Money](/api/merchant/types/objects/money.mdx) #### [MerchantSubscription.shipment](#)[MerchantSubscriptionComponent](/api/merchant/types/objects/merchant-subscription-component.mdx) #### [MerchantSubscription.waybill](#)[MerchantSubscriptionComponent](/api/merchant/types/objects/merchant-subscription-component.mdx) #### [MerchantSubscription.order](#)[MerchantSubscriptionComponent](/api/merchant/types/objects/merchant-subscription-component.mdx) #### [MerchantSubscription.request](#)[MerchantSubscriptionComponent](/api/merchant/types/objects/merchant-subscription-component.mdx) #### [MerchantSubscription.features](#)[MerchantSubscriptionFeatures](/api/merchant/types/objects/merchant-subscription-features.mdx) #### [MerchantSubscription.periods](#)[[MerchantSubscriptionPeriod!]!](/api/merchant/types/objects/merchant-subscription-period.mdx) ##### [MerchantSubscription.periods.filters](#)[SubscriptionPeriodFilterInput](/api/merchant/types/inputs/subscription-period-filter-input.mdx) ### Member Of [`Merchant`](/api/merchant/types/objects/merchant.mdx) [`MerchantSubscriptionPaginator`](/api/merchant/types/objects/merchant-subscription-paginator.mdx) --- ## Merchant export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Merchant { id: ID! name: String! icon: String providers: [Provider!]! configurations: [MerchantConfiguration!]! configuration( key: MerchantConfigurationEnum ): MerchantConfiguration webhooks: [Webhook!]! subscription: MerchantSubscription upcomingSubscription: MerchantSubscription themes: [Theme!]! } ``` ### Fields #### [Merchant.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [Merchant.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [Merchant.icon](#)[String](/api/merchant/types/scalars/string.mdx) #### [Merchant.providers](#)[[Provider!]!](/api/merchant/types/objects/provider.mdx) #### [Merchant.configurations](#)[[MerchantConfiguration!]!](/api/merchant/types/objects/merchant-configuration.mdx) #### [Merchant.configuration](#)[MerchantConfiguration](/api/merchant/types/objects/merchant-configuration.mdx) ##### [Merchant.configuration.key](#)[MerchantConfigurationEnum](/api/merchant/types/enums/merchant-configuration-enum.mdx) #### [Merchant.webhooks](#)[[Webhook!]!](/api/merchant/types/objects/webhook.mdx) #### [Merchant.subscription](#)[MerchantSubscription](/api/merchant/types/objects/merchant-subscription.mdx) #### [Merchant.upcomingSubscription](#)[MerchantSubscription](/api/merchant/types/objects/merchant-subscription.mdx) #### [Merchant.themes](#)[[Theme!]!](/api/merchant/types/objects/theme.mdx) ### Returned By [`me`](/api/merchant/operations/queries/me.mdx) [`updateMerchantIcon`](/api/merchant/operations/mutations/update-merchant-icon.mdx) --- ## MoneyRange export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type MoneyRange { amount: FloatRange! currency: CurrencyEnum! } ``` ### Fields #### [MoneyRange.amount](#)[FloatRange!](/api/merchant/types/objects/float-range.mdx) #### [MoneyRange.currency](#)[CurrencyEnum!](/api/merchant/types/enums/currency-enum.mdx) ### Implemented By [`MoneyOrMoneyRange`](/api/merchant/types/unions/money-or-money-range.mdx) --- ## Money export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Money { amount: Float! currency: CurrencyEnum! } ``` ### Fields #### [Money.amount](#)[Float!](/api/merchant/types/scalars/float.mdx) #### [Money.currency](#)[CurrencyEnum!](/api/merchant/types/enums/currency-enum.mdx) ### Member Of [`MerchantSubscription`](/api/merchant/types/objects/merchant-subscription.mdx) [`MerchantSubscriptionComponent`](/api/merchant/types/objects/merchant-subscription-component.mdx) [`MerchantSubscriptionPeriod`](/api/merchant/types/objects/merchant-subscription-period.mdx) [`MerchantSubscriptionPeriodComponent`](/api/merchant/types/objects/merchant-subscription-period-component.mdx) [`MerchantSubscriptionPlanPricing`](/api/merchant/types/objects/merchant-subscription-plan-pricing.mdx) [`Order`](/api/merchant/types/objects/order.mdx) [`OrderItemPrice`](/api/merchant/types/objects/order-item-price.mdx) [`OrderItemTotalPrice`](/api/merchant/types/objects/order-item-total-price.mdx) [`OrderPrice`](/api/merchant/types/objects/order-price.mdx) [`Parcel`](/api/merchant/types/objects/parcel.mdx) [`Pricing`](/api/merchant/types/objects/pricing.mdx) [`Session`](/api/merchant/types/objects/session.mdx) [`SessionParcel`](/api/merchant/types/objects/session-parcel.mdx) ### Implemented By [`MoneyOrMoneyRange`](/api/merchant/types/unions/money-or-money-range.mdx) --- ## OpeningHour export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type OpeningHour { day: DayEnum! start: Time! end: Time! } ``` ### Fields #### [OpeningHour.day](#)[DayEnum!](/api/merchant/types/enums/day-enum.mdx) #### [OpeningHour.start](#)[Time!](/api/merchant/types/objects/time.mdx) #### [OpeningHour.end](#)[Time!](/api/merchant/types/objects/time.mdx) ### Member Of [`PickupPoint`](/api/merchant/types/objects/pickup-point.mdx) --- ## OperatorConfiguration export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type OperatorConfiguration { operator: OperatorEnum! key: OperatorConfigurationEnum! description: String! value: String default: String required: Boolean! group: ConfigurationGroupEnum } ``` ### Fields #### [OperatorConfiguration.operator](#)[OperatorEnum!](/api/merchant/types/enums/operator-enum.mdx) #### [OperatorConfiguration.key](#)[OperatorConfigurationEnum!](/api/merchant/types/enums/operator-configuration-enum.mdx) #### [OperatorConfiguration.description](#)[String!](/api/merchant/types/scalars/string.mdx) #### [OperatorConfiguration.value](#)[String](/api/merchant/types/scalars/string.mdx) #### [OperatorConfiguration.default](#)[String](/api/merchant/types/scalars/string.mdx) #### [OperatorConfiguration.required](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [OperatorConfiguration.group](#)[ConfigurationGroupEnum](/api/merchant/types/enums/configuration-group-enum.mdx) ### Returned By [`updateOperatorConfiguration`](/api/merchant/operations/mutations/update-operator-configuration.mdx) [`updateOperatorConfigurations`](/api/merchant/operations/mutations/update-operator-configurations.mdx) ### Member Of [`Operator`](/api/merchant/types/objects/operator.mdx) --- ## Operator export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Operator { id: OperatorEnum! name: String! configurations: [OperatorConfiguration!]! } ``` ### Fields #### [Operator.id](#)[OperatorEnum!](/api/merchant/types/enums/operator-enum.mdx) #### [Operator.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [Operator.configurations](#)[[OperatorConfiguration!]!](/api/merchant/types/objects/operator-configuration.mdx) ### Returned By [`operators`](/api/merchant/operations/queries/operators.mdx) --- ## OrderBilling export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type OrderBilling { name: String email: String phone: String vatNumber: String isCompany: Boolean address: Address } ``` ### Fields #### [OrderBilling.name](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderBilling.email](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderBilling.phone](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderBilling.vatNumber](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderBilling.isCompany](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [OrderBilling.address](#)[Address](/api/merchant/types/objects/address.mdx) ### Member Of [`Order`](/api/merchant/types/objects/order.mdx) --- ## OrderItemCategory export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type OrderItemCategory { name: String! type: OrderItemCategoryTypeEnum! typeOther: String } ``` ### Fields #### [OrderItemCategory.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [OrderItemCategory.type](#)[OrderItemCategoryTypeEnum!](/api/merchant/types/enums/order-item-category-type-enum.mdx) #### [OrderItemCategory.typeOther](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`OrderItem`](/api/merchant/types/objects/order-item.mdx) --- ## OrderItemPrice export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type OrderItemPrice { net: Money! vat: Float! gross: Money! } ``` ### Fields #### [OrderItemPrice.net](#)[Money!](/api/merchant/types/objects/money.mdx) #### [OrderItemPrice.vat](#)[Float!](/api/merchant/types/scalars/float.mdx) #### [OrderItemPrice.gross](#)[Money!](/api/merchant/types/objects/money.mdx) ### Member Of [`OrderItem`](/api/merchant/types/objects/order-item.mdx) --- ## OrderItemQuantity export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type OrderItemQuantity { count: Float! type: OrderItemQuantityUnitEnum! typeOther: String } ``` ### Fields #### [OrderItemQuantity.count](#)[Float!](/api/merchant/types/scalars/float.mdx) #### [OrderItemQuantity.type](#)[OrderItemQuantityUnitEnum!](/api/merchant/types/enums/order-item-quantity-unit-enum.mdx) #### [OrderItemQuantity.typeOther](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`OrderItem`](/api/merchant/types/objects/order-item.mdx) --- ## OrderItemTotalPrice export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type OrderItemTotalPrice { net: Money! gross: Money! } ``` ### Fields #### [OrderItemTotalPrice.net](#)[Money!](/api/merchant/types/objects/money.mdx) #### [OrderItemTotalPrice.gross](#)[Money!](/api/merchant/types/objects/money.mdx) ### Member Of [`OrderItem`](/api/merchant/types/objects/order-item.mdx) --- ## OrderItem export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type OrderItem { name: String! sku: String referenceId: ID! categories: [OrderItemCategory!] variant: String globalIdentifiers: [GlobalIdentifier!] note: String unit: OrderItemPrice! quantity: OrderItemQuantity! total: OrderItemTotalPrice! isShipping: Boolean! isPayment: Boolean! isDiscount: Boolean! } ``` ### Fields #### [OrderItem.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [OrderItem.sku](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderItem.referenceId](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [OrderItem.categories](#)[[OrderItemCategory!]](/api/merchant/types/objects/order-item-category.mdx) #### [OrderItem.variant](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderItem.globalIdentifiers](#)[[GlobalIdentifier!]](/api/merchant/types/objects/global-identifier.mdx) #### [OrderItem.note](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderItem.unit](#)[OrderItemPrice!](/api/merchant/types/objects/order-item-price.mdx) #### [OrderItem.quantity](#)[OrderItemQuantity!](/api/merchant/types/objects/order-item-quantity.mdx) #### [OrderItem.total](#)[OrderItemTotalPrice!](/api/merchant/types/objects/order-item-total-price.mdx) #### [OrderItem.isShipping](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [OrderItem.isPayment](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [OrderItem.isDiscount](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) ### Member Of [`Order`](/api/merchant/types/objects/order.mdx) --- ## OrderPayment export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type OrderPayment { method: String! status: PaymentStatusEnum! paidAt: DateTimeTz } ``` ### Fields #### [OrderPayment.method](#)[String!](/api/merchant/types/scalars/string.mdx) #### [OrderPayment.status](#)[PaymentStatusEnum!](/api/merchant/types/enums/payment-status-enum.mdx) #### [OrderPayment.paidAt](#)[DateTimeTz](/api/merchant/types/scalars/date-time-tz.mdx) ### Member Of [`Order`](/api/merchant/types/objects/order.mdx) --- ## OrderPrice export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type OrderPrice { net: Money! gross: Money! } ``` ### Fields #### [OrderPrice.net](#)[Money!](/api/merchant/types/objects/money.mdx) #### [OrderPrice.gross](#)[Money!](/api/merchant/types/objects/money.mdx) ### Member Of [`Order`](/api/merchant/types/objects/order.mdx) --- ## OrderShipping export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type OrderShipping { name: String email: String phone: String pickupPointId: ID address: Address method: ShippingMethodEnum provider: String status: ShipmentStatusEnum resolution: ShipmentResolutionEnum } ``` ### Fields #### [OrderShipping.name](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderShipping.email](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderShipping.phone](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderShipping.pickupPointId](#)[ID](/api/merchant/types/scalars/id.mdx) #### [OrderShipping.address](#)[Address](/api/merchant/types/objects/address.mdx) #### [OrderShipping.method](#)[ShippingMethodEnum](/api/merchant/types/enums/shipping-method-enum.mdx) #### [OrderShipping.provider](#)[String](/api/merchant/types/scalars/string.mdx) #### [OrderShipping.status](#)[ShipmentStatusEnum](/api/merchant/types/enums/shipment-status-enum.mdx) #### [OrderShipping.resolution](#)[ShipmentResolutionEnum](/api/merchant/types/enums/shipment-resolution-enum.mdx) ### Member Of [`Order`](/api/merchant/types/objects/order.mdx) --- ## Order export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Order { referenceId: ID! createdAt: DateTimeTz! customerId: ID sessionId: ID billing: OrderBilling shipping: OrderShipping payment: OrderPayment total: OrderPrice! items: [OrderItem!]! cashOnDelivery: Money } ``` ### Fields #### [Order.referenceId](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [Order.createdAt](#)[DateTimeTz!](/api/merchant/types/scalars/date-time-tz.mdx) #### [Order.customerId](#)[ID](/api/merchant/types/scalars/id.mdx) #### [Order.sessionId](#)[ID](/api/merchant/types/scalars/id.mdx) #### [Order.billing](#)[OrderBilling](/api/merchant/types/objects/order-billing.mdx) #### [Order.shipping](#)[OrderShipping](/api/merchant/types/objects/order-shipping.mdx) #### [Order.payment](#)[OrderPayment](/api/merchant/types/objects/order-payment.mdx) #### [Order.total](#)[OrderPrice!](/api/merchant/types/objects/order-price.mdx) #### [Order.items](#)[[OrderItem!]!](/api/merchant/types/objects/order-item.mdx) #### [Order.cashOnDelivery](#)[Money](/api/merchant/types/objects/money.mdx) ### Member Of [`Shipment`](/api/merchant/types/objects/shipment.mdx) --- ## PackagingPaginator export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; A paginated list of Packaging items. ```graphql type PackagingPaginator { paginatorInfo: PaginatorInfo! data: [Packaging!]! } ``` ### Fields #### [PackagingPaginator.paginatorInfo](#)[PaginatorInfo!](/api/merchant/types/objects/paginator-info.mdx) Pagination information about the list of items. #### [PackagingPaginator.data](#)[[Packaging!]!](/api/merchant/types/objects/packaging.mdx) A list of Packaging items. ### Returned By [`packagings`](/api/merchant/operations/queries/packagings.mdx) --- ## Packaging(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Packaging { id: ID! name: String! handle: ID! dimensions: Dimension! isDefault: Boolean! } ``` ### Fields #### [Packaging.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [Packaging.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [Packaging.handle](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [Packaging.dimensions](#)[Dimension!](/api/merchant/types/objects/dimension.mdx) #### [Packaging.isDefault](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) ### Returned By [`createPackaging`](/api/merchant/operations/mutations/create-packaging.mdx) [`packaging`](/api/merchant/operations/queries/packaging.mdx) [`updatePackaging`](/api/merchant/operations/mutations/update-packaging.mdx) ### Member Of [`PackagingPaginator`](/api/merchant/types/objects/packaging-paginator.mdx) --- ## PaginatorInfo export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; Information about pagination using a fully featured paginator. ```graphql type PaginatorInfo { count: Int! currentPage: Int! firstItem: Int hasMorePages: Boolean! lastItem: Int lastPage: Int! perPage: Int! total: Int! } ``` ### Fields #### [PaginatorInfo.count](#)[Int!](/api/merchant/types/scalars/int.mdx) Number of items in the current page. #### [PaginatorInfo.currentPage](#)[Int!](/api/merchant/types/scalars/int.mdx) Index of the current page. #### [PaginatorInfo.firstItem](#)[Int](/api/merchant/types/scalars/int.mdx) Index of the first item in the current page. #### [PaginatorInfo.hasMorePages](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) Are there more pages after this one? #### [PaginatorInfo.lastItem](#)[Int](/api/merchant/types/scalars/int.mdx) Index of the last item in the current page. #### [PaginatorInfo.lastPage](#)[Int!](/api/merchant/types/scalars/int.mdx) Index of the last available page. #### [PaginatorInfo.perPage](#)[Int!](/api/merchant/types/scalars/int.mdx) Number of items per page. #### [PaginatorInfo.total](#)[Int!](/api/merchant/types/scalars/int.mdx) Number of total available items. ### Member Of [`MerchantSubscriptionPaginator`](/api/merchant/types/objects/merchant-subscription-paginator.mdx) [`PackagingPaginator`](/api/merchant/types/objects/packaging-paginator.mdx) [`PickupPointPaginator`](/api/merchant/types/objects/pickup-point-paginator.mdx) [`PricingPaginator`](/api/merchant/types/objects/pricing-paginator.mdx) [`ShipmentPaginator`](/api/merchant/types/objects/shipment-paginator.mdx) [`ThemePaginator`](/api/merchant/types/objects/theme-paginator.mdx) [`TokenPaginator`](/api/merchant/types/objects/token-paginator.mdx) [`UserPaginator`](/api/merchant/types/objects/user-paginator.mdx) [`WaybillPaginator`](/api/merchant/types/objects/waybill-paginator.mdx) [`WebhookPaginator`](/api/merchant/types/objects/webhook-paginator.mdx) [`ZonePaginator`](/api/merchant/types/objects/zone-paginator.mdx) --- ## ParcelRestrictions export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type ParcelRestrictions { isPinRequired: Boolean! ageLimit: Int isIdentityCheckRequired: Boolean! } ``` ### Fields #### [ParcelRestrictions.isPinRequired](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [ParcelRestrictions.ageLimit](#)[Int](/api/merchant/types/scalars/int.mdx) #### [ParcelRestrictions.isIdentityCheckRequired](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) ### Member Of [`Parcel`](/api/merchant/types/objects/parcel.mdx) --- ## Parcel export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Parcel { referenceId: ID! tracking: Tracking label: Label weight: Float! dimensions: Dimension! isReadyForWaybill: Boolean! cashOnDelivery: Money value: Money insurance: Money restrictions: ParcelRestrictions } ``` ### Fields #### [Parcel.referenceId](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [Parcel.tracking](#)[Tracking](/api/merchant/types/objects/tracking.mdx) #### [Parcel.label](#)[Label](/api/merchant/types/objects/label.mdx) #### [Parcel.weight](#)[Float!](/api/merchant/types/scalars/float.mdx) #### [Parcel.dimensions](#)[Dimension!](/api/merchant/types/objects/dimension.mdx) #### [Parcel.isReadyForWaybill](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [Parcel.cashOnDelivery](#)[Money](/api/merchant/types/objects/money.mdx) #### [Parcel.value](#)[Money](/api/merchant/types/objects/money.mdx) #### [Parcel.insurance](#)[Money](/api/merchant/types/objects/money.mdx) #### [Parcel.restrictions](#)[ParcelRestrictions](/api/merchant/types/objects/parcel-restrictions.mdx) ### Member Of [`Shipment`](/api/merchant/types/objects/shipment.mdx) --- ## PartialAddress export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type PartialAddress { country: CountryEnum state: String city: String postalCode: String addressLine1: String addressLine2: String note: String } ``` ### Fields #### [PartialAddress.country](#)[CountryEnum](/api/merchant/types/enums/country-enum.mdx) #### [PartialAddress.state](#)[String](/api/merchant/types/scalars/string.mdx) #### [PartialAddress.city](#)[String](/api/merchant/types/scalars/string.mdx) #### [PartialAddress.postalCode](#)[String](/api/merchant/types/scalars/string.mdx) #### [PartialAddress.addressLine1](#)[String](/api/merchant/types/scalars/string.mdx) #### [PartialAddress.addressLine2](#)[String](/api/merchant/types/scalars/string.mdx) #### [PartialAddress.note](#)[String](/api/merchant/types/scalars/string.mdx) --- ## PickupPointPaginator export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; A paginated list of PickupPoint items. ```graphql type PickupPointPaginator { paginatorInfo: PaginatorInfo! data: [PickupPoint!]! } ``` ### Fields #### [PickupPointPaginator.paginatorInfo](#)[PaginatorInfo!](/api/merchant/types/objects/paginator-info.mdx) Pagination information about the list of items. #### [PickupPointPaginator.data](#)[[PickupPoint!]!](/api/merchant/types/objects/pickup-point.mdx) A list of PickupPoint items. ### Returned By [`pickupPoints`](/api/merchant/operations/queries/pickup-points.mdx) ### Member Of [`Provider`](/api/merchant/types/objects/provider.mdx) --- ## PickupPointProviderReference export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type PickupPointProviderReference { provider: ProviderEnum! referenceId: String! } ``` ### Fields #### [PickupPointProviderReference.provider](#)[ProviderEnum!](/api/merchant/types/scalars/provider-enum.mdx) #### [PickupPointProviderReference.referenceId](#)[String!](/api/merchant/types/scalars/string.mdx) ### Member Of [`PickupPoint`](/api/merchant/types/objects/pickup-point.mdx) --- ## PickupPointTag export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type PickupPointTag { id: ID! name: String! localizations: [LocalizedString!] } ``` ### Fields #### [PickupPointTag.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [PickupPointTag.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [PickupPointTag.localizations](#)[[LocalizedString!]](/api/merchant/types/objects/localized-string.mdx) ### Member Of [`PickupPoint`](/api/merchant/types/objects/pickup-point.mdx) --- ## PickupPoint(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type PickupPoint { isCustom: Boolean! provider: ProviderEnum operator: OperatorEnum type: PickupPointTypeEnum isPickUpAvailable: Boolean! isDropOffAvailable: Boolean! id: ID! name: String! references: [PickupPointProviderReference!]! address: Address! location: Location! phone: String openingHours( timezone: TimezoneEnum ): [OpeningHour!]! isOpen( timestamp: DateTimeTz ): Boolean! distance( location: LocationInput! ): Int! cashOnDelivery: [PaymentMethodEnum!] hasWheelchairAccess: Boolean extra: [KeyValue!] referenceId: ID! tags: [PickupPointTag!] } ``` ### Fields #### [PickupPoint.isCustom](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [PickupPoint.provider](#)[ProviderEnum](/api/merchant/types/scalars/provider-enum.mdx) #### [PickupPoint.operator](#)[OperatorEnum](/api/merchant/types/enums/operator-enum.mdx) #### [PickupPoint.type](#)[PickupPointTypeEnum](/api/merchant/types/enums/pickup-point-type-enum.mdx) #### [PickupPoint.isPickUpAvailable](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [PickupPoint.isDropOffAvailable](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [PickupPoint.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [PickupPoint.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [PickupPoint.references](#)[[PickupPointProviderReference!]!](/api/merchant/types/objects/pickup-point-provider-reference.mdx) #### [PickupPoint.address](#)[Address!](/api/merchant/types/objects/address.mdx) #### [PickupPoint.location](#)[Location!](/api/merchant/types/objects/location.mdx) #### [PickupPoint.phone](#)[String](/api/merchant/types/scalars/string.mdx) #### [PickupPoint.openingHours](#)[[OpeningHour!]!](/api/merchant/types/objects/opening-hour.mdx) ##### [PickupPoint.openingHours.timezone](#)[TimezoneEnum](/api/merchant/types/enums/timezone-enum.mdx) #### [PickupPoint.isOpen](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) ##### [PickupPoint.isOpen.timestamp](#)[DateTimeTz](/api/merchant/types/scalars/date-time-tz.mdx) #### [PickupPoint.distance](#)[Int!](/api/merchant/types/scalars/int.mdx) ##### [PickupPoint.distance.location](#)[LocationInput!](/api/merchant/types/inputs/location-input.mdx) #### [PickupPoint.cashOnDelivery](#)[[PaymentMethodEnum!]](/api/merchant/types/enums/payment-method-enum.mdx) #### [PickupPoint.hasWheelchairAccess](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [PickupPoint.extra](#)[[KeyValue!]](/api/merchant/types/objects/key-value.mdx) #### [PickupPoint.referenceId](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [PickupPoint.tags](#)[[PickupPointTag!]](/api/merchant/types/objects/pickup-point-tag.mdx) ### Returned By [`createPickupPoint`](/api/merchant/operations/mutations/create-pickup-point.mdx) [`inactivatePickupPoint`](/api/merchant/operations/mutations/inactivate-pickup-point.mdx) [`pickupPoint`](/api/merchant/operations/queries/pickup-point.mdx) [`updatePickupPoint`](/api/merchant/operations/mutations/update-pickup-point.mdx) ### Member Of [`PickupPointPaginator`](/api/merchant/types/objects/pickup-point-paginator.mdx) [`SessionDestination`](/api/merchant/types/objects/session-destination.mdx) [`ShipmentDestination`](/api/merchant/types/objects/shipment-destination.mdx) [`ShipmentOrigin`](/api/merchant/types/objects/shipment-origin.mdx) --- ## PricingCondition export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type PricingCondition { isHomeDelivery: Boolean isPickupPoint: Boolean pickupPointTypes: [PickupPointTypeEnum!] providers: [ProviderEnum!] isCustom: Boolean zone: Zone } ``` ### Fields #### [PricingCondition.isHomeDelivery](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [PricingCondition.isPickupPoint](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [PricingCondition.pickupPointTypes](#)[[PickupPointTypeEnum!]](/api/merchant/types/enums/pickup-point-type-enum.mdx) #### [PricingCondition.providers](#)[[ProviderEnum!]](/api/merchant/types/scalars/provider-enum.mdx) #### [PricingCondition.isCustom](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) #### [PricingCondition.zone](#)[Zone](/api/merchant/types/objects/zone.mdx) ### Member Of [`Pricing`](/api/merchant/types/objects/pricing.mdx) --- ## PricingPaginator export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; A paginated list of Pricing items. ```graphql type PricingPaginator { paginatorInfo: PaginatorInfo! data: [Pricing!]! } ``` ### Fields #### [PricingPaginator.paginatorInfo](#)[PaginatorInfo!](/api/merchant/types/objects/paginator-info.mdx) Pagination information about the list of items. #### [PricingPaginator.data](#)[[Pricing!]!](/api/merchant/types/objects/pricing.mdx) A list of Pricing items. ### Returned By [`pricings`](/api/merchant/operations/queries/pricings.mdx) --- ## Pricing(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Pricing { id: ID! name: String! condition: PricingCondition price: Money! priority: Int } ``` ### Fields #### [Pricing.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [Pricing.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [Pricing.condition](#)[PricingCondition](/api/merchant/types/objects/pricing-condition.mdx) #### [Pricing.price](#)[Money!](/api/merchant/types/objects/money.mdx) #### [Pricing.priority](#)[Int](/api/merchant/types/scalars/int.mdx) ### Returned By [`createPricing`](/api/merchant/operations/mutations/create-pricing.mdx) [`pricing`](/api/merchant/operations/queries/pricing.mdx) [`updatePricing`](/api/merchant/operations/mutations/update-pricing.mdx) ### Member Of [`PricingPaginator`](/api/merchant/types/objects/pricing-paginator.mdx) --- ## ProviderConfiguration export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type ProviderConfiguration { provider: ProviderEnum! key: ProviderConfigurationEnum! description: String! value: String default: String required: Boolean! group: ConfigurationGroupEnum } ``` ### Fields #### [ProviderConfiguration.provider](#)[ProviderEnum!](/api/merchant/types/scalars/provider-enum.mdx) #### [ProviderConfiguration.key](#)[ProviderConfigurationEnum!](/api/merchant/types/enums/provider-configuration-enum.mdx) #### [ProviderConfiguration.description](#)[String!](/api/merchant/types/scalars/string.mdx) #### [ProviderConfiguration.value](#)[String](/api/merchant/types/scalars/string.mdx) #### [ProviderConfiguration.default](#)[String](/api/merchant/types/scalars/string.mdx) #### [ProviderConfiguration.required](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [ProviderConfiguration.group](#)[ConfigurationGroupEnum](/api/merchant/types/enums/configuration-group-enum.mdx) ### Returned By [`updateProviderConfiguration`](/api/merchant/operations/mutations/update-provider-configuration.mdx) [`updateProviderConfigurations`](/api/merchant/operations/mutations/update-provider-configurations.mdx) ### Member Of [`Provider`](/api/merchant/types/objects/provider.mdx) --- ## ProviderNetworkEdge export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type ProviderNetworkEdge { from: CountryEnum! to: CountryEnum! homeDelivery: Boolean! pickupPoint: Boolean! } ``` ### Fields #### [ProviderNetworkEdge.from](#)[CountryEnum!](/api/merchant/types/enums/country-enum.mdx) #### [ProviderNetworkEdge.to](#)[CountryEnum!](/api/merchant/types/enums/country-enum.mdx) #### [ProviderNetworkEdge.homeDelivery](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [ProviderNetworkEdge.pickupPoint](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) ### Member Of [`Provider`](/api/merchant/types/objects/provider.mdx) --- ## Provider export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Provider { id: ProviderEnum! name: String! icon: String isEnabled: Boolean! @deprecated isConfigured: Boolean! isAvailable: Boolean! configurations: [ProviderConfiguration!]! network: [ProviderNetworkEdge!]! pickupPoints( filters: PickupPointFilterInput sortBy: PickupPointSortInput first: Int! page: Int ): PickupPointPaginator! } ``` ### Fields #### [Provider.id](#)[ProviderEnum!](/api/merchant/types/scalars/provider-enum.mdx) #### [Provider.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [Provider.icon](#)[String](/api/merchant/types/scalars/string.mdx) #### [Provider.isEnabled](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) :::warning[DEPRECATED] This field is deprecated and will be removed. Use isConfigured instead. ::: #### [Provider.isConfigured](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [Provider.isAvailable](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [Provider.configurations](#)[[ProviderConfiguration!]!](/api/merchant/types/objects/provider-configuration.mdx) #### [Provider.network](#)[[ProviderNetworkEdge!]!](/api/merchant/types/objects/provider-network-edge.mdx) #### [Provider.pickupPoints](#)[PickupPointPaginator!](/api/merchant/types/objects/pickup-point-paginator.mdx) ##### [Provider.pickupPoints.filters](#)[PickupPointFilterInput](/api/merchant/types/inputs/pickup-point-filter-input.mdx) ##### [Provider.pickupPoints.sortBy](#)[PickupPointSortInput](/api/merchant/types/inputs/pickup-point-sort-input.mdx) ##### [Provider.pickupPoints.first](#)[Int!](/api/merchant/types/scalars/int.mdx) Limits number of fetched items. ##### [Provider.pickupPoints.page](#)[Int](/api/merchant/types/scalars/int.mdx) The offset from which items are returned. ### Returned By [`providers`](/api/merchant/operations/queries/providers.mdx) ### Member Of [`Merchant`](/api/merchant/types/objects/merchant.mdx) [`Waybill`](/api/merchant/types/objects/waybill.mdx) --- ## SessionDestination export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type SessionDestination { pickupPoint: PickupPoint address: Address location: Location dropOffAt: DateTimeTz } ``` ### Fields #### [SessionDestination.pickupPoint](#)[PickupPoint](/api/merchant/types/objects/pickup-point.mdx) #### [SessionDestination.address](#)[Address](/api/merchant/types/objects/address.mdx) #### [SessionDestination.location](#)[Location](/api/merchant/types/objects/location.mdx) #### [SessionDestination.dropOffAt](#)[DateTimeTz](/api/merchant/types/scalars/date-time-tz.mdx) ### Member Of [`Session`](/api/merchant/types/objects/session.mdx) --- ## SessionParcel export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type SessionParcel { weight: Float! dimensions: Dimension! cashOnDelivery: Money value: Money insurance: Money } ``` ### Fields #### [SessionParcel.weight](#)[Float!](/api/merchant/types/scalars/float.mdx) #### [SessionParcel.dimensions](#)[Dimension!](/api/merchant/types/objects/dimension.mdx) #### [SessionParcel.cashOnDelivery](#)[Money](/api/merchant/types/objects/money.mdx) #### [SessionParcel.value](#)[Money](/api/merchant/types/objects/money.mdx) #### [SessionParcel.insurance](#)[Money](/api/merchant/types/objects/money.mdx) ### Member Of [`Session`](/api/merchant/types/objects/session.mdx) --- ## SessionRecipient export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type SessionRecipient { firstName: String lastName: String name: String language: LanguageEnum email: String phone: String } ``` ### Fields #### [SessionRecipient.firstName](#)[String](/api/merchant/types/scalars/string.mdx) #### [SessionRecipient.lastName](#)[String](/api/merchant/types/scalars/string.mdx) #### [SessionRecipient.name](#)[String](/api/merchant/types/scalars/string.mdx) #### [SessionRecipient.language](#)[LanguageEnum](/api/merchant/types/enums/language-enum.mdx) #### [SessionRecipient.email](#)[String](/api/merchant/types/scalars/string.mdx) #### [SessionRecipient.phone](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`Session`](/api/merchant/types/objects/session.mdx) --- ## Session(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Session { id: ID! mode: ShipmentModeEnum provider: ProviderEnum destination: SessionDestination recipient: SessionRecipient parcels: [SessionParcel!] isCompleted: Boolean! price: Money sdk: String! } ``` ### Fields #### [Session.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [Session.mode](#)[ShipmentModeEnum](/api/merchant/types/enums/shipment-mode-enum.mdx) #### [Session.provider](#)[ProviderEnum](/api/merchant/types/scalars/provider-enum.mdx) #### [Session.destination](#)[SessionDestination](/api/merchant/types/objects/session-destination.mdx) #### [Session.recipient](#)[SessionRecipient](/api/merchant/types/objects/session-recipient.mdx) #### [Session.parcels](#)[[SessionParcel!]](/api/merchant/types/objects/session-parcel.mdx) #### [Session.isCompleted](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [Session.price](#)[Money](/api/merchant/types/objects/money.mdx) #### [Session.sdk](#)[String!](/api/merchant/types/scalars/string.mdx) ### Returned By [`session`](/api/merchant/operations/mutations/session.mdx) [`session`](/api/merchant/operations/queries/session.mdx) --- ## ShipmentActions export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type ShipmentActions { update: Boolean! delete: Boolean! } ``` ### Fields #### [ShipmentActions.update](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [ShipmentActions.delete](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) ### Member Of [`Shipment`](/api/merchant/types/objects/shipment.mdx) --- ## ShipmentDestination export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type ShipmentDestination { pickupPoint: PickupPoint address: Address location: Location } ``` ### Fields #### [ShipmentDestination.pickupPoint](#)[PickupPoint](/api/merchant/types/objects/pickup-point.mdx) #### [ShipmentDestination.address](#)[Address](/api/merchant/types/objects/address.mdx) #### [ShipmentDestination.location](#)[Location](/api/merchant/types/objects/location.mdx) --- ## ShipmentEvent export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type ShipmentEvent { event: ShipmentEventEnum! actor: ShipmentActorEnum! timestamp: DateTimeTz! hash: String! provider: [KeyValue!] isSimulated: Boolean } ``` ### Fields #### [ShipmentEvent.event](#)[ShipmentEventEnum!](/api/merchant/types/enums/shipment-event-enum.mdx) #### [ShipmentEvent.actor](#)[ShipmentActorEnum!](/api/merchant/types/enums/shipment-actor-enum.mdx) #### [ShipmentEvent.timestamp](#)[DateTimeTz!](/api/merchant/types/scalars/date-time-tz.mdx) #### [ShipmentEvent.hash](#)[String!](/api/merchant/types/scalars/string.mdx) #### [ShipmentEvent.provider](#)[[KeyValue!]](/api/merchant/types/objects/key-value.mdx) #### [ShipmentEvent.isSimulated](#)[Boolean](/api/merchant/types/scalars/boolean.mdx) ### Member Of [`Shipment`](/api/merchant/types/objects/shipment.mdx) --- ## ShipmentOrigin export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type ShipmentOrigin { pickupPoint: PickupPoint address: Address location: Location } ``` ### Fields #### [ShipmentOrigin.pickupPoint](#)[PickupPoint](/api/merchant/types/objects/pickup-point.mdx) #### [ShipmentOrigin.address](#)[Address](/api/merchant/types/objects/address.mdx) #### [ShipmentOrigin.location](#)[Location](/api/merchant/types/objects/location.mdx) ### Member Of [`Shipment`](/api/merchant/types/objects/shipment.mdx) --- ## ShipmentPaginator export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; A paginated list of Shipment items. ```graphql type ShipmentPaginator { paginatorInfo: PaginatorInfo! data: [Shipment!]! } ``` ### Fields #### [ShipmentPaginator.paginatorInfo](#)[PaginatorInfo!](/api/merchant/types/objects/paginator-info.mdx) Pagination information about the list of items. #### [ShipmentPaginator.data](#)[[Shipment!]!](/api/merchant/types/objects/shipment.mdx) A list of Shipment items. ### Returned By [`shipments`](/api/merchant/operations/queries/shipments.mdx) --- ## ShipmentRecipient export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type ShipmentRecipient { firstName: String! lastName: String! name: String! language: LanguageEnum! email: String phone: String } ``` ### Fields #### [ShipmentRecipient.firstName](#)[String!](/api/merchant/types/scalars/string.mdx) #### [ShipmentRecipient.lastName](#)[String!](/api/merchant/types/scalars/string.mdx) #### [ShipmentRecipient.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [ShipmentRecipient.language](#)[LanguageEnum!](/api/merchant/types/enums/language-enum.mdx) #### [ShipmentRecipient.email](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentRecipient.phone](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`Shipment`](/api/merchant/types/objects/shipment.mdx) --- ## ShipmentSender export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type ShipmentSender { name: String! email: String phone: String } ``` ### Fields #### [ShipmentSender.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [ShipmentSender.email](#)[String](/api/merchant/types/scalars/string.mdx) #### [ShipmentSender.phone](#)[String](/api/merchant/types/scalars/string.mdx) ### Member Of [`Shipment`](/api/merchant/types/objects/shipment.mdx) --- ## ShipmentStatus export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type ShipmentStatus { status: ShipmentStatusEnum! resolution: ShipmentResolutionEnum timestamp: DateTimeTz! } ``` ### Fields #### [ShipmentStatus.status](#)[ShipmentStatusEnum!](/api/merchant/types/enums/shipment-status-enum.mdx) #### [ShipmentStatus.resolution](#)[ShipmentResolutionEnum](/api/merchant/types/enums/shipment-resolution-enum.mdx) #### [ShipmentStatus.timestamp](#)[DateTimeTz!](/api/merchant/types/scalars/date-time-tz.mdx) ### Member Of [`Shipment`](/api/merchant/types/objects/shipment.mdx) --- ## Shipment(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Shipment { id: ID! provider: ProviderEnum! sourceId: String waybill: Waybill mode: ShipmentModeEnum! direct: Boolean! origin: ShipmentOrigin! sender: ShipmentSender! destination: ShipmentOrigin! recipient: ShipmentRecipient! parcels: [Parcel!]! tracking: Tracking status: ShipmentStatus events: [ShipmentEvent!]! createdAt: DateTimeTz! order: Order actions: ShipmentActions! } ``` ### Fields #### [Shipment.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [Shipment.provider](#)[ProviderEnum!](/api/merchant/types/scalars/provider-enum.mdx) #### [Shipment.sourceId](#)[String](/api/merchant/types/scalars/string.mdx) #### [Shipment.waybill](#)[Waybill](/api/merchant/types/objects/waybill.mdx) #### [Shipment.mode](#)[ShipmentModeEnum!](/api/merchant/types/enums/shipment-mode-enum.mdx) #### [Shipment.direct](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [Shipment.origin](#)[ShipmentOrigin!](/api/merchant/types/objects/shipment-origin.mdx) #### [Shipment.sender](#)[ShipmentSender!](/api/merchant/types/objects/shipment-sender.mdx) #### [Shipment.destination](#)[ShipmentOrigin!](/api/merchant/types/objects/shipment-origin.mdx) #### [Shipment.recipient](#)[ShipmentRecipient!](/api/merchant/types/objects/shipment-recipient.mdx) #### [Shipment.parcels](#)[[Parcel!]!](/api/merchant/types/objects/parcel.mdx) #### [Shipment.tracking](#)[Tracking](/api/merchant/types/objects/tracking.mdx) #### [Shipment.status](#)[ShipmentStatus](/api/merchant/types/objects/shipment-status.mdx) #### [Shipment.events](#)[[ShipmentEvent!]!](/api/merchant/types/objects/shipment-event.mdx) #### [Shipment.createdAt](#)[DateTimeTz!](/api/merchant/types/scalars/date-time-tz.mdx) #### [Shipment.order](#)[Order](/api/merchant/types/objects/order.mdx) #### [Shipment.actions](#)[ShipmentActions!](/api/merchant/types/objects/shipment-actions.mdx) ### Returned By [`assignShipmentToWaybill`](/api/merchant/operations/mutations/assign-shipment-to-waybill.mdx) [`createShipment`](/api/merchant/operations/mutations/create-shipment.mdx) [`sessionToShipment`](/api/merchant/operations/mutations/session-to-shipment.mdx) [`shipment`](/api/merchant/operations/queries/shipment.mdx) [`unassignShipmentFromWaybill`](/api/merchant/operations/mutations/unassign-shipment-from-waybill.mdx) [`updateShipment`](/api/merchant/operations/mutations/update-shipment.mdx) ### Member Of [`ShipmentPaginator`](/api/merchant/types/objects/shipment-paginator.mdx) [`Waybill`](/api/merchant/types/objects/waybill.mdx) --- ## ThemeOption export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type ThemeOption { key: ThemeConfigurationEnum! value: String default: String description: String! } ``` ### Fields #### [ThemeOption.key](#)[ThemeConfigurationEnum!](/api/merchant/types/enums/theme-configuration-enum.mdx) #### [ThemeOption.value](#)[String](/api/merchant/types/scalars/string.mdx) #### [ThemeOption.default](#)[String](/api/merchant/types/scalars/string.mdx) #### [ThemeOption.description](#)[String!](/api/merchant/types/scalars/string.mdx) ### Member Of [`Theme`](/api/merchant/types/objects/theme.mdx) --- ## ThemePaginator export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; A paginated list of Theme items. ```graphql type ThemePaginator { paginatorInfo: PaginatorInfo! data: [Theme!]! } ``` ### Fields #### [ThemePaginator.paginatorInfo](#)[PaginatorInfo!](/api/merchant/types/objects/paginator-info.mdx) Pagination information about the list of items. #### [ThemePaginator.data](#)[[Theme!]!](/api/merchant/types/objects/theme.mdx) A list of Theme items. ### Returned By [`themes`](/api/merchant/operations/queries/themes.mdx) --- ## Theme(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Theme { id: ID! handle: ID! isEnabled: Boolean! isDefault: Boolean! options: [ThemeOption!]! } ``` ### Fields #### [Theme.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [Theme.handle](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [Theme.isEnabled](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [Theme.isDefault](#)[Boolean!](/api/merchant/types/scalars/boolean.mdx) #### [Theme.options](#)[[ThemeOption!]!](/api/merchant/types/objects/theme-option.mdx) ### Returned By [`createTheme`](/api/merchant/operations/mutations/create-theme.mdx) [`theme`](/api/merchant/operations/queries/theme.mdx) [`updateTheme`](/api/merchant/operations/mutations/update-theme.mdx) ### Member Of [`Merchant`](/api/merchant/types/objects/merchant.mdx) [`ThemePaginator`](/api/merchant/types/objects/theme-paginator.mdx) --- ## Time export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Time { hour: Int! minute: Int! } ``` ### Fields #### [Time.hour](#)[Int!](/api/merchant/types/scalars/int.mdx) #### [Time.minute](#)[Int!](/api/merchant/types/scalars/int.mdx) ### Member Of [`OpeningHour`](/api/merchant/types/objects/opening-hour.mdx) --- ## TokenAllowlist export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type TokenAllowlist { ips: [IP!] referers: [String!] } ``` ### Fields #### [TokenAllowlist.ips](#)[[IP!]](/api/merchant/types/scalars/ip.mdx) #### [TokenAllowlist.referers](#)[[String!]](/api/merchant/types/scalars/string.mdx) ### Member Of [`Token`](/api/merchant/types/objects/token.mdx) --- ## TokenPaginator export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; A paginated list of Token items. ```graphql type TokenPaginator { paginatorInfo: PaginatorInfo! data: [Token!]! } ``` ### Fields #### [TokenPaginator.paginatorInfo](#)[PaginatorInfo!](/api/merchant/types/objects/paginator-info.mdx) Pagination information about the list of items. #### [TokenPaginator.data](#)[[Token!]!](/api/merchant/types/objects/token.mdx) A list of Token items. ### Returned By [`tokens`](/api/merchant/operations/queries/tokens.mdx) --- ## Token(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Token { id: ID! name: String! roles: [RoleEnum!] allowlist: TokenAllowlist } ``` ### Fields #### [Token.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [Token.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [Token.roles](#)[[RoleEnum!]](/api/merchant/types/enums/role-enum.mdx) #### [Token.allowlist](#)[TokenAllowlist](/api/merchant/types/objects/token-allowlist.mdx) ### Returned By [`token`](/api/merchant/operations/queries/token.mdx) ### Member Of [`TokenPaginator`](/api/merchant/types/objects/token-paginator.mdx) --- ## Tracking export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Tracking { code: String! url: String! } ``` ### Fields #### [Tracking.code](#)[String!](/api/merchant/types/scalars/string.mdx) #### [Tracking.url](#)[String!](/api/merchant/types/scalars/string.mdx) ### Member Of [`Parcel`](/api/merchant/types/objects/parcel.mdx) [`Shipment`](/api/merchant/types/objects/shipment.mdx) --- ## UserPaginator export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; A paginated list of User items. ```graphql type UserPaginator { paginatorInfo: PaginatorInfo! data: [User!]! } ``` ### Fields #### [UserPaginator.paginatorInfo](#)[PaginatorInfo!](/api/merchant/types/objects/paginator-info.mdx) Pagination information about the list of items. #### [UserPaginator.data](#)[[User!]!](/api/merchant/types/objects/user.mdx) A list of User items. ### Returned By [`users`](/api/merchant/operations/queries/users.mdx) --- ## User(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type User { id: ID! name: String! email: String! } ``` ### Fields #### [User.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [User.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [User.email](#)[String!](/api/merchant/types/scalars/string.mdx) ### Returned By [`createUser`](/api/merchant/operations/mutations/create-user.mdx) [`user`](/api/merchant/operations/queries/user.mdx) ### Member Of [`UserPaginator`](/api/merchant/types/objects/user-paginator.mdx) --- ## WaybillPaginator export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; A paginated list of Waybill items. ```graphql type WaybillPaginator { paginatorInfo: PaginatorInfo! data: [Waybill!]! } ``` ### Fields #### [WaybillPaginator.paginatorInfo](#)[PaginatorInfo!](/api/merchant/types/objects/paginator-info.mdx) Pagination information about the list of items. #### [WaybillPaginator.data](#)[[Waybill!]!](/api/merchant/types/objects/waybill.mdx) A list of Waybill items. ### Returned By [`waybills`](/api/merchant/operations/queries/waybills.mdx) --- ## Waybill(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Waybill { id: ID! provider: Provider! shipments: [Shipment!]! createdAt: DateTimeTz! closedAt: DateTimeTz } ``` ### Fields #### [Waybill.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [Waybill.provider](#)[Provider!](/api/merchant/types/objects/provider.mdx) #### [Waybill.shipments](#)[[Shipment!]!](/api/merchant/types/objects/shipment.mdx) #### [Waybill.createdAt](#)[DateTimeTz!](/api/merchant/types/scalars/date-time-tz.mdx) #### [Waybill.closedAt](#)[DateTimeTz](/api/merchant/types/scalars/date-time-tz.mdx) ### Returned By [`closeWaybill`](/api/merchant/operations/mutations/close-waybill.mdx) [`createWaybill`](/api/merchant/operations/mutations/create-waybill.mdx) [`deleteWaybill`](/api/merchant/operations/mutations/delete-waybill.mdx) [`waybill`](/api/merchant/operations/queries/waybill.mdx) ### Member Of [`Shipment`](/api/merchant/types/objects/shipment.mdx) [`WaybillPaginator`](/api/merchant/types/objects/waybill-paginator.mdx) --- ## WebhookPaginator export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; A paginated list of Webhook items. ```graphql type WebhookPaginator { paginatorInfo: PaginatorInfo! data: [Webhook!]! } ``` ### Fields #### [WebhookPaginator.paginatorInfo](#)[PaginatorInfo!](/api/merchant/types/objects/paginator-info.mdx) Pagination information about the list of items. #### [WebhookPaginator.data](#)[[Webhook!]!](/api/merchant/types/objects/webhook.mdx) A list of Webhook items. ### Returned By [`webhooks`](/api/merchant/operations/queries/webhooks.mdx) --- ## Webhook(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Webhook { id: ID! webhook: WebhookEnum! transport: TransportEnum! url: String! } ``` ### Fields #### [Webhook.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [Webhook.webhook](#)[WebhookEnum!](/api/merchant/types/enums/webhook-enum.mdx) #### [Webhook.transport](#)[TransportEnum!](/api/merchant/types/enums/transport-enum.mdx) #### [Webhook.url](#)[String!](/api/merchant/types/scalars/string.mdx) ### Returned By [`createWebhook`](/api/merchant/operations/mutations/create-webhook.mdx) [`obtainWebhook`](/api/merchant/operations/mutations/obtain-webhook.mdx) [`updateWebhook`](/api/merchant/operations/mutations/update-webhook.mdx) [`webhook`](/api/merchant/operations/queries/webhook.mdx) ### Member Of [`Merchant`](/api/merchant/types/objects/merchant.mdx) [`WebhookPaginator`](/api/merchant/types/objects/webhook-paginator.mdx) --- ## ZonePaginator export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; A paginated list of Zone items. ```graphql type ZonePaginator { paginatorInfo: PaginatorInfo! data: [Zone!]! } ``` ### Fields #### [ZonePaginator.paginatorInfo](#)[PaginatorInfo!](/api/merchant/types/objects/paginator-info.mdx) Pagination information about the list of items. #### [ZonePaginator.data](#)[[Zone!]!](/api/merchant/types/objects/zone.mdx) A list of Zone items. ### Returned By [`zones`](/api/merchant/operations/queries/zones.mdx) --- ## Zone(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Zone { id: ID! name: String! countries: [CountryEnum!]! availableHomeDeliveryProviders: [ProviderEnum!]! availablePickupPointProviders: [ProviderEnum!]! } ``` ### Fields #### [Zone.id](#)[ID!](/api/merchant/types/scalars/id.mdx) #### [Zone.name](#)[String!](/api/merchant/types/scalars/string.mdx) #### [Zone.countries](#)[[CountryEnum!]!](/api/merchant/types/enums/country-enum.mdx) #### [Zone.availableHomeDeliveryProviders](#)[[ProviderEnum!]!](/api/merchant/types/scalars/provider-enum.mdx) #### [Zone.availablePickupPointProviders](#)[[ProviderEnum!]!](/api/merchant/types/scalars/provider-enum.mdx) ### Returned By [`createZone`](/api/merchant/operations/mutations/create-zone.mdx) [`updateZone`](/api/merchant/operations/mutations/update-zone.mdx) [`zone`](/api/merchant/operations/queries/zone.mdx) ### Member Of [`PricingCondition`](/api/merchant/types/objects/pricing-condition.mdx) [`ZonePaginator`](/api/merchant/types/objects/zone-paginator.mdx) --- ## MoneyOrMoneyRange export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql union MoneyOrMoneyRange = Money | MoneyRange ``` ### Possible types #### [MoneyOrMoneyRange.Money](/api/merchant/types/objects/money.mdx) #### [MoneyOrMoneyRange.MoneyRange](/api/merchant/types/objects/money-range.mdx) --- ## Public API reference Delivery Gateway provides a public GraphQL API for storefront and checkout integrations. You can use it to create and manage delivery sessions, search and select pickup points, set customer addresses, and return delivery options in real time. This API is intended for customer-facing flows where a lightweight, session-based integration is needed. ## Authentication Public API calls are session-based. - Use `merchantId` to create a new session with `createSession`. - Use the returned `session.id` for subsequent queries and mutations in the same checkout flow. Unlike the Merchant API, Public API requests do not require a Merchant Bearer token. Keep Merchant API credentials server-side, and only use the Public API in browser/client checkout flows. ## Endpoints and queries GraphQL queries are executed by sending `POST` HTTP requests to the endpoint: - `https://api.sandbox.deliverygateway.io/graphql/public` in the sandbox environment and - `https://api.deliverygateway.io/graphql/public` in the production environment. You can use cURL or an HTTP client such as [Postman](https://www.postman.com/) or [Insomnia](https://insomnia.rest/) to query the API. ### cURL example ```bash title="Example cURL request" curl -X POST https://api.sandbox.deliverygateway.io/graphql/public \ -H "Content-Type: application/json" \ -d '{"query":"query Session($id: ID!) { session(id: $id) { id mode currency } }","variables":{"id":""}}' ``` ```graphql title="GraphQL query" query Session($id: ID!) { session(id: $id) { id mode currency } } ``` ## Status and error codes Public API follows standard GraphQL response conventions. - A request can return `200 OK` even when business or validation errors exist. - GraphQL-level errors are returned in the `errors` array. - Successful payloads are returned in the `data` object. --- ## createAddress export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql createAddress( input: CreateAddressInput! ): CustomerAddress! ``` ### Arguments #### [createAddress.input](#)[CreateAddressInput!](/api/public/types/inputs/create-address-input.mdx) ### Type #### [CustomerAddress](/api/public/types/objects/customer-address.mdx) --- ## createAndSetAddress export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql createAndSetAddress( input: CreateAndSetAddressInput! ): SessionAddress! ``` ### Arguments #### [createAndSetAddress.input](#)[CreateAndSetAddressInput!](/api/public/types/inputs/create-and-set-address-input.mdx) ### Type #### [SessionAddress](/api/public/types/objects/session-address.mdx) --- ## createSession export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql createSession( merchantId: ID! input: CreateSessionInput! ): Session! ``` ### Arguments #### [createSession.merchantId](#)[ID!](/api/public/types/scalars/id.mdx) #### [createSession.input](#)[CreateSessionInput!](/api/public/types/inputs/create-session-input.mdx) ### Type #### [Session](/api/public/types/objects/session.mdx) --- ## deleteAddress export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql deleteAddress( input: DeleteAddressInput! ): Void ``` ### Arguments #### [deleteAddress.input](#)[DeleteAddressInput!](/api/public/types/inputs/delete-address-input.mdx) ### Type #### [Void](/api/public/types/scalars/void.mdx) A return type for void mutations. --- ## deleteAndUnsetAddress export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql deleteAndUnsetAddress( input: DeleteAddressInput! ): Session! ``` ### Arguments #### [deleteAndUnsetAddress.input](#)[DeleteAddressInput!](/api/public/types/inputs/delete-address-input.mdx) ### Type #### [Session](/api/public/types/objects/session.mdx) --- ## ping(Mutations) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql ping: String! ``` ### Type #### [String](/api/public/types/scalars/string.mdx) The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text. --- ## register export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql register( merchant: RegisterMerchantInput! user: RegisterUserInput! token: String ): Registration! ``` ### Arguments #### [register.merchant](#)[RegisterMerchantInput!](/api/public/types/inputs/register-merchant-input.mdx) #### [register.user](#)[RegisterUserInput!](/api/public/types/inputs/register-user-input.mdx) #### [register.token](#)[String](/api/public/types/scalars/string.mdx) ### Type #### [Registration](/api/public/types/objects/registration.mdx) --- ## setAddress export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql setAddress( input: SetAddressInput! ): Session! ``` ### Arguments #### [setAddress.input](#)[SetAddressInput!](/api/public/types/inputs/set-address-input.mdx) ### Type #### [Session](/api/public/types/objects/session.mdx) --- ## setGuestAddress export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql setGuestAddress( input: SetGuestAddressInput! ): Session! ``` ### Arguments #### [setGuestAddress.input](#)[SetGuestAddressInput!](/api/public/types/inputs/set-guest-address-input.mdx) ### Type #### [Session](/api/public/types/objects/session.mdx) --- ## setHomeDeliveryProvider export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql setHomeDeliveryProvider( input: SetHomeDeliveryProviderInput! ): Session! ``` ### Arguments #### [setHomeDeliveryProvider.input](#)[SetHomeDeliveryProviderInput!](/api/public/types/inputs/set-home-delivery-provider-input.mdx) ### Type #### [Session](/api/public/types/objects/session.mdx) --- ## setPickupPoint export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql setPickupPoint( input: SetPickupPointInput! ): Session! ``` ### Arguments #### [setPickupPoint.input](#)[SetPickupPointInput!](/api/public/types/inputs/set-pickup-point-input.mdx) ### Type #### [Session](/api/public/types/objects/session.mdx) --- ## updateAddress export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql updateAddress( input: UpdateAddressInput! ): CustomerAddress! ``` ### Arguments #### [updateAddress.input](#)[UpdateAddressInput!](/api/public/types/inputs/update-address-input.mdx) ### Type #### [CustomerAddress](/api/public/types/objects/customer-address.mdx) --- ## updateAndSetAddress export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql updateAndSetAddress( input: UpdateAndSetAddressInput! ): SessionAddress! ``` ### Arguments #### [updateAndSetAddress.input](#)[UpdateAndSetAddressInput!](/api/public/types/inputs/update-and-set-address-input.mdx) ### Type #### [SessionAddress](/api/public/types/objects/session-address.mdx) --- ## addresses export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql addresses( sessionId: ID! ): [CustomerAddress!]! ``` ### Arguments #### [addresses.sessionId](#)[ID!](/api/public/types/scalars/id.mdx) ### Type #### [CustomerAddress](/api/public/types/objects/customer-address.mdx) --- ## ping(3) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql ping: String! ``` ### Type #### [String](/api/public/types/scalars/string.mdx) The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text. --- ## session(3) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql session( id: ID! ): Session ``` ### Arguments #### [session.id](#)[ID!](/api/public/types/scalars/id.mdx) ### Type #### [Session](/api/public/types/objects/session.mdx) --- ## what3words export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql what3words( words: String! ): What3WordSquare ``` ### Arguments #### [what3words.words](#)[String!](/api/public/types/scalars/string.mdx) ### Type #### [What3WordSquare](/api/public/types/objects/what-3-word-square.mdx) --- ## AddressFieldEnum(Enums) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum AddressFieldEnum { ADDRESS_LINE1 ADDRESS_LINE2 CITY COUNTRY EMAIL FIRST_NAME LANGUAGE LAST_NAME LOCATION PHONE POSTAL_CODE STATE } ``` ### Values #### [AddressFieldEnum.ADDRESS_LINE1](#) #### [AddressFieldEnum.ADDRESS_LINE2](#) #### [AddressFieldEnum.CITY](#) #### [AddressFieldEnum.COUNTRY](#) #### [AddressFieldEnum.EMAIL](#) #### [AddressFieldEnum.FIRST_NAME](#) #### [AddressFieldEnum.LANGUAGE](#) #### [AddressFieldEnum.LAST_NAME](#) #### [AddressFieldEnum.LOCATION](#) #### [AddressFieldEnum.PHONE](#) #### [AddressFieldEnum.POSTAL_CODE](#) #### [AddressFieldEnum.STATE](#) ### Member Of [`PickupPoint`](/api/public/types/objects/pickup-point.mdx) [`SessionHomeDeliveryAddressProvider`](/api/public/types/objects/session-home-delivery-address-provider.mdx) [`SessionHomeDeliveryProvider`](/api/public/types/objects/session-home-delivery-provider.mdx) --- ## CountryEnum(Enums) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum CountryEnum { AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW } ``` ### Values #### [CountryEnum.AD](#) #### [CountryEnum.AE](#) #### [CountryEnum.AF](#) #### [CountryEnum.AG](#) #### [CountryEnum.AI](#) #### [CountryEnum.AL](#) #### [CountryEnum.AM](#) #### [CountryEnum.AO](#) #### [CountryEnum.AQ](#) #### [CountryEnum.AR](#) #### [CountryEnum.AS](#) #### [CountryEnum.AT](#) #### [CountryEnum.AU](#) #### [CountryEnum.AW](#) #### [CountryEnum.AX](#) #### [CountryEnum.AZ](#) #### [CountryEnum.BA](#) #### [CountryEnum.BB](#) #### [CountryEnum.BD](#) #### [CountryEnum.BE](#) #### [CountryEnum.BF](#) #### [CountryEnum.BG](#) #### [CountryEnum.BH](#) #### [CountryEnum.BI](#) #### [CountryEnum.BJ](#) #### [CountryEnum.BL](#) #### [CountryEnum.BM](#) #### [CountryEnum.BN](#) #### [CountryEnum.BO](#) #### [CountryEnum.BQ](#) #### [CountryEnum.BR](#) #### [CountryEnum.BS](#) #### [CountryEnum.BT](#) #### [CountryEnum.BV](#) #### [CountryEnum.BW](#) #### [CountryEnum.BY](#) #### [CountryEnum.BZ](#) #### [CountryEnum.CA](#) #### [CountryEnum.CC](#) #### [CountryEnum.CD](#) #### [CountryEnum.CF](#) #### [CountryEnum.CG](#) #### [CountryEnum.CH](#) #### [CountryEnum.CI](#) #### [CountryEnum.CK](#) #### [CountryEnum.CL](#) #### [CountryEnum.CM](#) #### [CountryEnum.CN](#) #### [CountryEnum.CO](#) #### [CountryEnum.CR](#) #### [CountryEnum.CU](#) #### [CountryEnum.CV](#) #### [CountryEnum.CW](#) #### [CountryEnum.CX](#) #### [CountryEnum.CY](#) #### [CountryEnum.CZ](#) #### [CountryEnum.DE](#) #### [CountryEnum.DJ](#) #### [CountryEnum.DK](#) #### [CountryEnum.DM](#) #### [CountryEnum.DO](#) #### [CountryEnum.DZ](#) #### [CountryEnum.EC](#) #### [CountryEnum.EE](#) #### [CountryEnum.EG](#) #### [CountryEnum.EH](#) #### [CountryEnum.ER](#) #### [CountryEnum.ES](#) #### [CountryEnum.ET](#) #### [CountryEnum.FI](#) #### [CountryEnum.FJ](#) #### [CountryEnum.FK](#) #### [CountryEnum.FM](#) #### [CountryEnum.FO](#) #### [CountryEnum.FR](#) #### [CountryEnum.GA](#) #### [CountryEnum.GB](#) #### [CountryEnum.GD](#) #### [CountryEnum.GE](#) #### [CountryEnum.GF](#) #### [CountryEnum.GG](#) #### [CountryEnum.GH](#) #### [CountryEnum.GI](#) #### [CountryEnum.GL](#) #### [CountryEnum.GM](#) #### [CountryEnum.GN](#) #### [CountryEnum.GP](#) #### [CountryEnum.GQ](#) #### [CountryEnum.GR](#) #### [CountryEnum.GS](#) #### [CountryEnum.GT](#) #### [CountryEnum.GU](#) #### [CountryEnum.GW](#) #### [CountryEnum.GY](#) #### [CountryEnum.HK](#) #### [CountryEnum.HM](#) #### [CountryEnum.HN](#) #### [CountryEnum.HR](#) #### [CountryEnum.HT](#) #### [CountryEnum.HU](#) #### [CountryEnum.ID](#) #### [CountryEnum.IE](#) #### [CountryEnum.IL](#) #### [CountryEnum.IM](#) #### [CountryEnum.IN](#) #### [CountryEnum.IO](#) #### [CountryEnum.IQ](#) #### [CountryEnum.IR](#) #### [CountryEnum.IS](#) #### [CountryEnum.IT](#) #### [CountryEnum.JE](#) #### [CountryEnum.JM](#) #### [CountryEnum.JO](#) #### [CountryEnum.JP](#) #### [CountryEnum.KE](#) #### [CountryEnum.KG](#) #### [CountryEnum.KH](#) #### [CountryEnum.KI](#) #### [CountryEnum.KM](#) #### [CountryEnum.KN](#) #### [CountryEnum.KP](#) #### [CountryEnum.KR](#) #### [CountryEnum.KW](#) #### [CountryEnum.KY](#) #### [CountryEnum.KZ](#) #### [CountryEnum.LA](#) #### [CountryEnum.LB](#) #### [CountryEnum.LC](#) #### [CountryEnum.LI](#) #### [CountryEnum.LK](#) #### [CountryEnum.LR](#) #### [CountryEnum.LS](#) #### [CountryEnum.LT](#) #### [CountryEnum.LU](#) #### [CountryEnum.LV](#) #### [CountryEnum.LY](#) #### [CountryEnum.MA](#) #### [CountryEnum.MC](#) #### [CountryEnum.MD](#) #### [CountryEnum.ME](#) #### [CountryEnum.MF](#) #### [CountryEnum.MG](#) #### [CountryEnum.MH](#) #### [CountryEnum.MK](#) #### [CountryEnum.ML](#) #### [CountryEnum.MM](#) #### [CountryEnum.MN](#) #### [CountryEnum.MO](#) #### [CountryEnum.MP](#) #### [CountryEnum.MQ](#) #### [CountryEnum.MR](#) #### [CountryEnum.MS](#) #### [CountryEnum.MT](#) #### [CountryEnum.MU](#) #### [CountryEnum.MV](#) #### [CountryEnum.MW](#) #### [CountryEnum.MX](#) #### [CountryEnum.MY](#) #### [CountryEnum.MZ](#) #### [CountryEnum.NA](#) #### [CountryEnum.NC](#) #### [CountryEnum.NE](#) #### [CountryEnum.NF](#) #### [CountryEnum.NG](#) #### [CountryEnum.NI](#) #### [CountryEnum.NL](#) #### [CountryEnum.NO](#) #### [CountryEnum.NP](#) #### [CountryEnum.NR](#) #### [CountryEnum.NU](#) #### [CountryEnum.NZ](#) #### [CountryEnum.OM](#) #### [CountryEnum.PA](#) #### [CountryEnum.PE](#) #### [CountryEnum.PF](#) #### [CountryEnum.PG](#) #### [CountryEnum.PH](#) #### [CountryEnum.PK](#) #### [CountryEnum.PL](#) #### [CountryEnum.PM](#) #### [CountryEnum.PN](#) #### [CountryEnum.PR](#) #### [CountryEnum.PS](#) #### [CountryEnum.PT](#) #### [CountryEnum.PW](#) #### [CountryEnum.PY](#) #### [CountryEnum.QA](#) #### [CountryEnum.RE](#) #### [CountryEnum.RO](#) #### [CountryEnum.RS](#) #### [CountryEnum.RU](#) #### [CountryEnum.RW](#) #### [CountryEnum.SA](#) #### [CountryEnum.SB](#) #### [CountryEnum.SC](#) #### [CountryEnum.SD](#) #### [CountryEnum.SE](#) #### [CountryEnum.SG](#) #### [CountryEnum.SH](#) #### [CountryEnum.SI](#) #### [CountryEnum.SJ](#) #### [CountryEnum.SK](#) #### [CountryEnum.SL](#) #### [CountryEnum.SM](#) #### [CountryEnum.SN](#) #### [CountryEnum.SO](#) #### [CountryEnum.SR](#) #### [CountryEnum.SS](#) #### [CountryEnum.ST](#) #### [CountryEnum.SV](#) #### [CountryEnum.SX](#) #### [CountryEnum.SY](#) #### [CountryEnum.SZ](#) #### [CountryEnum.TC](#) #### [CountryEnum.TD](#) #### [CountryEnum.TF](#) #### [CountryEnum.TG](#) #### [CountryEnum.TH](#) #### [CountryEnum.TJ](#) #### [CountryEnum.TK](#) #### [CountryEnum.TL](#) #### [CountryEnum.TM](#) #### [CountryEnum.TN](#) #### [CountryEnum.TO](#) #### [CountryEnum.TR](#) #### [CountryEnum.TT](#) #### [CountryEnum.TV](#) #### [CountryEnum.TW](#) #### [CountryEnum.TZ](#) #### [CountryEnum.UA](#) #### [CountryEnum.UG](#) #### [CountryEnum.UM](#) #### [CountryEnum.US](#) #### [CountryEnum.UY](#) #### [CountryEnum.UZ](#) #### [CountryEnum.VA](#) #### [CountryEnum.VC](#) #### [CountryEnum.VE](#) #### [CountryEnum.VG](#) #### [CountryEnum.VI](#) #### [CountryEnum.VN](#) #### [CountryEnum.VU](#) #### [CountryEnum.WF](#) #### [CountryEnum.WS](#) #### [CountryEnum.YE](#) #### [CountryEnum.YT](#) #### [CountryEnum.ZA](#) #### [CountryEnum.ZM](#) #### [CountryEnum.ZW](#) ### Member Of [`Address`](/api/public/types/objects/address.mdx) [`AddressInput`](/api/public/types/inputs/address-input.mdx) [`PartialAddress`](/api/public/types/objects/partial-address.mdx) [`PartialAddressInput`](/api/public/types/inputs/partial-address-input.mdx) [`PickupPointFilterInput`](/api/public/types/inputs/pickup-point-filter-input.mdx) [`SessionHomeDeliveryProviderFilterInput`](/api/public/types/inputs/session-home-delivery-provider-filter-input.mdx) [`SessionHomeDeliveryZoneInput`](/api/public/types/inputs/session-home-delivery-zone-input.mdx) [`SessionPickupPointZoneInput`](/api/public/types/inputs/session-pickup-point-zone-input.mdx) [`SessionZoneInput`](/api/public/types/inputs/session-zone-input.mdx) --- ## CurrencyEnum(Enums) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum CurrencyEnum { AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BOV BRL BSD BTN BWP BYN BZD CAD CDF CHE CHF CHW CLF CLP CNY COP COU CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB EUR FJD FKP GBP GEL GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS INR IQD IRR ISK JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LYD MAD MDL MGA MKD MMK MNT MOP MRU MUR MVR MWK MXN MXV MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLE SOS SRD SSP STN SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USD USN UYI UYU UZS VED VEF VND VUV WST XAF XCD XDR XOF XPF XSU XUA YER ZAR ZMW ZWL } ``` ### Values #### [CurrencyEnum.AED](#) #### [CurrencyEnum.AFN](#) #### [CurrencyEnum.ALL](#) #### [CurrencyEnum.AMD](#) #### [CurrencyEnum.ANG](#) #### [CurrencyEnum.AOA](#) #### [CurrencyEnum.ARS](#) #### [CurrencyEnum.AUD](#) #### [CurrencyEnum.AWG](#) #### [CurrencyEnum.AZN](#) #### [CurrencyEnum.BAM](#) #### [CurrencyEnum.BBD](#) #### [CurrencyEnum.BDT](#) #### [CurrencyEnum.BGN](#) #### [CurrencyEnum.BHD](#) #### [CurrencyEnum.BIF](#) #### [CurrencyEnum.BMD](#) #### [CurrencyEnum.BND](#) #### [CurrencyEnum.BOB](#) #### [CurrencyEnum.BOV](#) #### [CurrencyEnum.BRL](#) #### [CurrencyEnum.BSD](#) #### [CurrencyEnum.BTN](#) #### [CurrencyEnum.BWP](#) #### [CurrencyEnum.BYN](#) #### [CurrencyEnum.BZD](#) #### [CurrencyEnum.CAD](#) #### [CurrencyEnum.CDF](#) #### [CurrencyEnum.CHE](#) #### [CurrencyEnum.CHF](#) #### [CurrencyEnum.CHW](#) #### [CurrencyEnum.CLF](#) #### [CurrencyEnum.CLP](#) #### [CurrencyEnum.CNY](#) #### [CurrencyEnum.COP](#) #### [CurrencyEnum.COU](#) #### [CurrencyEnum.CRC](#) #### [CurrencyEnum.CUC](#) #### [CurrencyEnum.CUP](#) #### [CurrencyEnum.CVE](#) #### [CurrencyEnum.CZK](#) #### [CurrencyEnum.DJF](#) #### [CurrencyEnum.DKK](#) #### [CurrencyEnum.DOP](#) #### [CurrencyEnum.DZD](#) #### [CurrencyEnum.EGP](#) #### [CurrencyEnum.ERN](#) #### [CurrencyEnum.ETB](#) #### [CurrencyEnum.EUR](#) #### [CurrencyEnum.FJD](#) #### [CurrencyEnum.FKP](#) #### [CurrencyEnum.GBP](#) #### [CurrencyEnum.GEL](#) #### [CurrencyEnum.GHS](#) #### [CurrencyEnum.GIP](#) #### [CurrencyEnum.GMD](#) #### [CurrencyEnum.GNF](#) #### [CurrencyEnum.GTQ](#) #### [CurrencyEnum.GYD](#) #### [CurrencyEnum.HKD](#) #### [CurrencyEnum.HNL](#) #### [CurrencyEnum.HRK](#) #### [CurrencyEnum.HTG](#) #### [CurrencyEnum.HUF](#) #### [CurrencyEnum.IDR](#) #### [CurrencyEnum.ILS](#) #### [CurrencyEnum.INR](#) #### [CurrencyEnum.IQD](#) #### [CurrencyEnum.IRR](#) #### [CurrencyEnum.ISK](#) #### [CurrencyEnum.JMD](#) #### [CurrencyEnum.JOD](#) #### [CurrencyEnum.JPY](#) #### [CurrencyEnum.KES](#) #### [CurrencyEnum.KGS](#) #### [CurrencyEnum.KHR](#) #### [CurrencyEnum.KMF](#) #### [CurrencyEnum.KPW](#) #### [CurrencyEnum.KRW](#) #### [CurrencyEnum.KWD](#) #### [CurrencyEnum.KYD](#) #### [CurrencyEnum.KZT](#) #### [CurrencyEnum.LAK](#) #### [CurrencyEnum.LBP](#) #### [CurrencyEnum.LKR](#) #### [CurrencyEnum.LRD](#) #### [CurrencyEnum.LSL](#) #### [CurrencyEnum.LYD](#) #### [CurrencyEnum.MAD](#) #### [CurrencyEnum.MDL](#) #### [CurrencyEnum.MGA](#) #### [CurrencyEnum.MKD](#) #### [CurrencyEnum.MMK](#) #### [CurrencyEnum.MNT](#) #### [CurrencyEnum.MOP](#) #### [CurrencyEnum.MRU](#) #### [CurrencyEnum.MUR](#) #### [CurrencyEnum.MVR](#) #### [CurrencyEnum.MWK](#) #### [CurrencyEnum.MXN](#) #### [CurrencyEnum.MXV](#) #### [CurrencyEnum.MYR](#) #### [CurrencyEnum.MZN](#) #### [CurrencyEnum.NAD](#) #### [CurrencyEnum.NGN](#) #### [CurrencyEnum.NIO](#) #### [CurrencyEnum.NOK](#) #### [CurrencyEnum.NPR](#) #### [CurrencyEnum.NZD](#) #### [CurrencyEnum.OMR](#) #### [CurrencyEnum.PAB](#) #### [CurrencyEnum.PEN](#) #### [CurrencyEnum.PGK](#) #### [CurrencyEnum.PHP](#) #### [CurrencyEnum.PKR](#) #### [CurrencyEnum.PLN](#) #### [CurrencyEnum.PYG](#) #### [CurrencyEnum.QAR](#) #### [CurrencyEnum.RON](#) #### [CurrencyEnum.RSD](#) #### [CurrencyEnum.RUB](#) #### [CurrencyEnum.RWF](#) #### [CurrencyEnum.SAR](#) #### [CurrencyEnum.SBD](#) #### [CurrencyEnum.SCR](#) #### [CurrencyEnum.SDG](#) #### [CurrencyEnum.SEK](#) #### [CurrencyEnum.SGD](#) #### [CurrencyEnum.SHP](#) #### [CurrencyEnum.SLE](#) #### [CurrencyEnum.SOS](#) #### [CurrencyEnum.SRD](#) #### [CurrencyEnum.SSP](#) #### [CurrencyEnum.STN](#) #### [CurrencyEnum.SVC](#) #### [CurrencyEnum.SYP](#) #### [CurrencyEnum.SZL](#) #### [CurrencyEnum.THB](#) #### [CurrencyEnum.TJS](#) #### [CurrencyEnum.TMT](#) #### [CurrencyEnum.TND](#) #### [CurrencyEnum.TOP](#) #### [CurrencyEnum.TRY](#) #### [CurrencyEnum.TTD](#) #### [CurrencyEnum.TWD](#) #### [CurrencyEnum.TZS](#) #### [CurrencyEnum.UAH](#) #### [CurrencyEnum.UGX](#) #### [CurrencyEnum.USD](#) #### [CurrencyEnum.USN](#) #### [CurrencyEnum.UYI](#) #### [CurrencyEnum.UYU](#) #### [CurrencyEnum.UZS](#) #### [CurrencyEnum.VED](#) #### [CurrencyEnum.VEF](#) #### [CurrencyEnum.VND](#) #### [CurrencyEnum.VUV](#) #### [CurrencyEnum.WST](#) #### [CurrencyEnum.XAF](#) #### [CurrencyEnum.XCD](#) #### [CurrencyEnum.XDR](#) #### [CurrencyEnum.XOF](#) #### [CurrencyEnum.XPF](#) #### [CurrencyEnum.XSU](#) #### [CurrencyEnum.XUA](#) #### [CurrencyEnum.YER](#) #### [CurrencyEnum.ZAR](#) #### [CurrencyEnum.ZMW](#) #### [CurrencyEnum.ZWL](#) ### Member Of [`CreateSessionInput`](/api/public/types/inputs/create-session-input.mdx) [`Money`](/api/public/types/objects/money.mdx) [`MoneyInput`](/api/public/types/inputs/money-input.mdx) [`MoneyRange`](/api/public/types/objects/money-range.mdx) [`Session`](/api/public/types/objects/session.mdx) --- ## DayEnum(Enums) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum DayEnum { FRIDAY MONDAY SATURDAY SUNDAY THURSDAY TUESDAY WEDNESDAY } ``` ### Values #### [DayEnum.FRIDAY](#) #### [DayEnum.MONDAY](#) #### [DayEnum.SATURDAY](#) #### [DayEnum.SUNDAY](#) #### [DayEnum.THURSDAY](#) #### [DayEnum.TUESDAY](#) #### [DayEnum.WEDNESDAY](#) ### Member Of [`OpeningHour`](/api/public/types/objects/opening-hour.mdx) [`OpeningHourInput`](/api/public/types/inputs/opening-hour-input.mdx) --- ## LanguageEnum(Enums) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum LanguageEnum { AA AB AE AF AK AM AN AR AS AV AY AZ BA BE BG BH BI BM BN BO BR BS CA CE CH CO CR CS CU CV CY DA DE DV DZ EE EL EN EO ES ET EU FA FF FI FJ FO FR FY GA GD GL GN GU GV HA HE HI HO HR HT HU HY HZ IA ID IE IG II IK IO IS IT IU JA JV KA KG KI KJ KK KL KM KN KO KR KS KU KV KW KY LA LB LG LI LN LO LT LU LV MG MH MI MK ML MN MR MS MT MY NA NB ND NE NG NL NN NO NR NV NY OC OJ OM OR OS PA PI PL PS PT QU RM RN RO RU RW SA SC SD SE SG SI SK SL SM SN SO SQ SR SS ST SU SV SW TA TE TG TH TI TK TL TN TO TR TS TT TW TY UG UK UR UZ VE VI VO WA WO XH YI YO ZA ZH ZU } ``` ### Values #### [LanguageEnum.AA](#) #### [LanguageEnum.AB](#) #### [LanguageEnum.AE](#) #### [LanguageEnum.AF](#) #### [LanguageEnum.AK](#) #### [LanguageEnum.AM](#) #### [LanguageEnum.AN](#) #### [LanguageEnum.AR](#) #### [LanguageEnum.AS](#) #### [LanguageEnum.AV](#) #### [LanguageEnum.AY](#) #### [LanguageEnum.AZ](#) #### [LanguageEnum.BA](#) #### [LanguageEnum.BE](#) #### [LanguageEnum.BG](#) #### [LanguageEnum.BH](#) #### [LanguageEnum.BI](#) #### [LanguageEnum.BM](#) #### [LanguageEnum.BN](#) #### [LanguageEnum.BO](#) #### [LanguageEnum.BR](#) #### [LanguageEnum.BS](#) #### [LanguageEnum.CA](#) #### [LanguageEnum.CE](#) #### [LanguageEnum.CH](#) #### [LanguageEnum.CO](#) #### [LanguageEnum.CR](#) #### [LanguageEnum.CS](#) #### [LanguageEnum.CU](#) #### [LanguageEnum.CV](#) #### [LanguageEnum.CY](#) #### [LanguageEnum.DA](#) #### [LanguageEnum.DE](#) #### [LanguageEnum.DV](#) #### [LanguageEnum.DZ](#) #### [LanguageEnum.EE](#) #### [LanguageEnum.EL](#) #### [LanguageEnum.EN](#) #### [LanguageEnum.EO](#) #### [LanguageEnum.ES](#) #### [LanguageEnum.ET](#) #### [LanguageEnum.EU](#) #### [LanguageEnum.FA](#) #### [LanguageEnum.FF](#) #### [LanguageEnum.FI](#) #### [LanguageEnum.FJ](#) #### [LanguageEnum.FO](#) #### [LanguageEnum.FR](#) #### [LanguageEnum.FY](#) #### [LanguageEnum.GA](#) #### [LanguageEnum.GD](#) #### [LanguageEnum.GL](#) #### [LanguageEnum.GN](#) #### [LanguageEnum.GU](#) #### [LanguageEnum.GV](#) #### [LanguageEnum.HA](#) #### [LanguageEnum.HE](#) #### [LanguageEnum.HI](#) #### [LanguageEnum.HO](#) #### [LanguageEnum.HR](#) #### [LanguageEnum.HT](#) #### [LanguageEnum.HU](#) #### [LanguageEnum.HY](#) #### [LanguageEnum.HZ](#) #### [LanguageEnum.IA](#) #### [LanguageEnum.ID](#) #### [LanguageEnum.IE](#) #### [LanguageEnum.IG](#) #### [LanguageEnum.II](#) #### [LanguageEnum.IK](#) #### [LanguageEnum.IO](#) #### [LanguageEnum.IS](#) #### [LanguageEnum.IT](#) #### [LanguageEnum.IU](#) #### [LanguageEnum.JA](#) #### [LanguageEnum.JV](#) #### [LanguageEnum.KA](#) #### [LanguageEnum.KG](#) #### [LanguageEnum.KI](#) #### [LanguageEnum.KJ](#) #### [LanguageEnum.KK](#) #### [LanguageEnum.KL](#) #### [LanguageEnum.KM](#) #### [LanguageEnum.KN](#) #### [LanguageEnum.KO](#) #### [LanguageEnum.KR](#) #### [LanguageEnum.KS](#) #### [LanguageEnum.KU](#) #### [LanguageEnum.KV](#) #### [LanguageEnum.KW](#) #### [LanguageEnum.KY](#) #### [LanguageEnum.LA](#) #### [LanguageEnum.LB](#) #### [LanguageEnum.LG](#) #### [LanguageEnum.LI](#) #### [LanguageEnum.LN](#) #### [LanguageEnum.LO](#) #### [LanguageEnum.LT](#) #### [LanguageEnum.LU](#) #### [LanguageEnum.LV](#) #### [LanguageEnum.MG](#) #### [LanguageEnum.MH](#) #### [LanguageEnum.MI](#) #### [LanguageEnum.MK](#) #### [LanguageEnum.ML](#) #### [LanguageEnum.MN](#) #### [LanguageEnum.MR](#) #### [LanguageEnum.MS](#) #### [LanguageEnum.MT](#) #### [LanguageEnum.MY](#) #### [LanguageEnum.NA](#) #### [LanguageEnum.NB](#) #### [LanguageEnum.ND](#) #### [LanguageEnum.NE](#) #### [LanguageEnum.NG](#) #### [LanguageEnum.NL](#) #### [LanguageEnum.NN](#) #### [LanguageEnum.NO](#) #### [LanguageEnum.NR](#) #### [LanguageEnum.NV](#) #### [LanguageEnum.NY](#) #### [LanguageEnum.OC](#) #### [LanguageEnum.OJ](#) #### [LanguageEnum.OM](#) #### [LanguageEnum.OR](#) #### [LanguageEnum.OS](#) #### [LanguageEnum.PA](#) #### [LanguageEnum.PI](#) #### [LanguageEnum.PL](#) #### [LanguageEnum.PS](#) #### [LanguageEnum.PT](#) #### [LanguageEnum.QU](#) #### [LanguageEnum.RM](#) #### [LanguageEnum.RN](#) #### [LanguageEnum.RO](#) #### [LanguageEnum.RU](#) #### [LanguageEnum.RW](#) #### [LanguageEnum.SA](#) #### [LanguageEnum.SC](#) #### [LanguageEnum.SD](#) #### [LanguageEnum.SE](#) #### [LanguageEnum.SG](#) #### [LanguageEnum.SI](#) #### [LanguageEnum.SK](#) #### [LanguageEnum.SL](#) #### [LanguageEnum.SM](#) #### [LanguageEnum.SN](#) #### [LanguageEnum.SO](#) #### [LanguageEnum.SQ](#) #### [LanguageEnum.SR](#) #### [LanguageEnum.SS](#) #### [LanguageEnum.ST](#) #### [LanguageEnum.SU](#) #### [LanguageEnum.SV](#) #### [LanguageEnum.SW](#) #### [LanguageEnum.TA](#) #### [LanguageEnum.TE](#) #### [LanguageEnum.TG](#) #### [LanguageEnum.TH](#) #### [LanguageEnum.TI](#) #### [LanguageEnum.TK](#) #### [LanguageEnum.TL](#) #### [LanguageEnum.TN](#) #### [LanguageEnum.TO](#) #### [LanguageEnum.TR](#) #### [LanguageEnum.TS](#) #### [LanguageEnum.TT](#) #### [LanguageEnum.TW](#) #### [LanguageEnum.TY](#) #### [LanguageEnum.UG](#) #### [LanguageEnum.UK](#) #### [LanguageEnum.UR](#) #### [LanguageEnum.UZ](#) #### [LanguageEnum.VE](#) #### [LanguageEnum.VI](#) #### [LanguageEnum.VO](#) #### [LanguageEnum.WA](#) #### [LanguageEnum.WO](#) #### [LanguageEnum.XH](#) #### [LanguageEnum.YI](#) #### [LanguageEnum.YO](#) #### [LanguageEnum.ZA](#) #### [LanguageEnum.ZH](#) #### [LanguageEnum.ZU](#) ### Member Of [`CreateSessionInput`](/api/public/types/inputs/create-session-input.mdx) [`CustomerRecipient`](/api/public/types/objects/customer-recipient.mdx) [`CustomerRecipientInput`](/api/public/types/inputs/customer-recipient-input.mdx) [`LocalizedStringInput`](/api/public/types/inputs/localized-string-input.mdx) [`Session`](/api/public/types/objects/session.mdx) --- ## OperatorEnum(Enums) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum OperatorEnum { ALLWYN ALZA_BOX AVANTI AVEC AVIA BILLA BIZ BP BUDNI CESKA_POSTA COOP CORNER CUSTOM CZ_POST DHL DISKA DPD ECONT EURONICS EXPRESS_ONE FED_EX FOX_POST GENIKI GLS HERMES HR_POST INTERSPORT KAUFLAND KKIOSK LIDL MEDIA_MARKT MOL MPL MYFLEXBOX NKD OMV ONE OTHER OX_POINT PACKETA PAGRO PATRONBOLT PLAYERSROOM PLAYMAX POST_NORD PPL RAIFFEISEN REAL RELAY_INMEDIO ROBOT_GURU SAME_DAY SATURN SEUR SHELL SK_POST SPAR SPEEDEX SPORTFACTORY SPRING SPRINTER TAMBURI TNT TRANS_SPED TWO_TWO_ZERO_VOLT UPS WOLT } ``` ### Values #### [OperatorEnum.ALLWYN](#) #### [OperatorEnum.ALZA_BOX](#) #### [OperatorEnum.AVANTI](#) #### [OperatorEnum.AVEC](#) #### [OperatorEnum.AVIA](#) #### [OperatorEnum.BILLA](#) #### [OperatorEnum.BIZ](#) #### [OperatorEnum.BP](#) #### [OperatorEnum.BUDNI](#) #### [OperatorEnum.CESKA_POSTA](#) #### [OperatorEnum.COOP](#) #### [OperatorEnum.CORNER](#) #### [OperatorEnum.CUSTOM](#) #### [OperatorEnum.CZ_POST](#) #### [OperatorEnum.DHL](#) #### [OperatorEnum.DISKA](#) #### [OperatorEnum.DPD](#) #### [OperatorEnum.ECONT](#) #### [OperatorEnum.EURONICS](#) #### [OperatorEnum.EXPRESS_ONE](#) #### [OperatorEnum.FED_EX](#) #### [OperatorEnum.FOX_POST](#) #### [OperatorEnum.GENIKI](#) #### [OperatorEnum.GLS](#) #### [OperatorEnum.HERMES](#) #### [OperatorEnum.HR_POST](#) #### [OperatorEnum.INTERSPORT](#) #### [OperatorEnum.KAUFLAND](#) #### [OperatorEnum.KKIOSK](#) #### [OperatorEnum.LIDL](#) #### [OperatorEnum.MEDIA_MARKT](#) #### [OperatorEnum.MOL](#) #### [OperatorEnum.MPL](#) #### [OperatorEnum.MYFLEXBOX](#) #### [OperatorEnum.NKD](#) #### [OperatorEnum.OMV](#) #### [OperatorEnum.ONE](#) #### [OperatorEnum.OTHER](#) #### [OperatorEnum.OX_POINT](#) #### [OperatorEnum.PACKETA](#) #### [OperatorEnum.PAGRO](#) #### [OperatorEnum.PATRONBOLT](#) #### [OperatorEnum.PLAYERSROOM](#) #### [OperatorEnum.PLAYMAX](#) #### [OperatorEnum.POST_NORD](#) #### [OperatorEnum.PPL](#) #### [OperatorEnum.RAIFFEISEN](#) #### [OperatorEnum.REAL](#) #### [OperatorEnum.RELAY_INMEDIO](#) #### [OperatorEnum.ROBOT_GURU](#) #### [OperatorEnum.SAME_DAY](#) #### [OperatorEnum.SATURN](#) #### [OperatorEnum.SEUR](#) #### [OperatorEnum.SHELL](#) #### [OperatorEnum.SK_POST](#) #### [OperatorEnum.SPAR](#) #### [OperatorEnum.SPEEDEX](#) #### [OperatorEnum.SPORTFACTORY](#) #### [OperatorEnum.SPRING](#) #### [OperatorEnum.SPRINTER](#) #### [OperatorEnum.TAMBURI](#) #### [OperatorEnum.TNT](#) #### [OperatorEnum.TRANS_SPED](#) #### [OperatorEnum.TWO_TWO_ZERO_VOLT](#) #### [OperatorEnum.UPS](#) #### [OperatorEnum.WOLT](#) ### Member Of [`Operator`](/api/public/types/objects/operator.mdx) [`PickupPointOperatorFilterInput`](/api/public/types/inputs/pickup-point-operator-filter-input.mdx) --- ## OrderByRelationAggregateFunction(Enums) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; Aggregate functions when ordering by a relation without specifying a column. ```graphql enum OrderByRelationAggregateFunction { COUNT } ``` ### Values #### [OrderByRelationAggregateFunction.COUNT](#) Amount of items. --- ## OrderByRelationWithColumnAggregateFunction(Enums) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; Aggregate functions when ordering by a relation that may specify a column. ```graphql enum OrderByRelationWithColumnAggregateFunction { AVG MIN MAX SUM COUNT } ``` ### Values #### [OrderByRelationWithColumnAggregateFunction.AVG](#) Average. #### [OrderByRelationWithColumnAggregateFunction.MIN](#) Minimum. #### [OrderByRelationWithColumnAggregateFunction.MAX](#) Maximum. #### [OrderByRelationWithColumnAggregateFunction.SUM](#) Sum. #### [OrderByRelationWithColumnAggregateFunction.COUNT](#) Amount of items. --- ## OrderDirectionEnum(Enums) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum OrderDirectionEnum { ASC DESC } ``` ### Values #### [OrderDirectionEnum.ASC](#) #### [OrderDirectionEnum.DESC](#) ### Member Of [`PickupPointSortInput`](/api/public/types/inputs/pickup-point-sort-input.mdx) --- ## PaymentMethodEnum(Enums) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum PaymentMethodEnum { CARD CASH } ``` ### Values #### [PaymentMethodEnum.CARD](#) #### [PaymentMethodEnum.CASH](#) ### Member Of [`PickupPoint`](/api/public/types/objects/pickup-point.mdx) [`PickupPointFilterInput`](/api/public/types/inputs/pickup-point-filter-input.mdx) --- ## PickupPointSortEnum(Enums) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum PickupPointSortEnum { DISTANCE PRICE } ``` ### Values #### [PickupPointSortEnum.DISTANCE](#) #### [PickupPointSortEnum.PRICE](#) ### Member Of [`PickupPointSortInput`](/api/public/types/inputs/pickup-point-sort-input.mdx) --- ## PickupPointTypeEnum(Enums) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum PickupPointTypeEnum { LOCKER POST_OFFICE SHOP } ``` ### Values #### [PickupPointTypeEnum.LOCKER](#) #### [PickupPointTypeEnum.POST_OFFICE](#) #### [PickupPointTypeEnum.SHOP](#) ### Member Of [`PickupPoint`](/api/public/types/objects/pickup-point.mdx) [`PickupPointFilterInput`](/api/public/types/inputs/pickup-point-filter-input.mdx) [`PickupPointOperatorFilterInput`](/api/public/types/inputs/pickup-point-operator-filter-input.mdx) [`PickupPointProviderFilterInput`](/api/public/types/inputs/pickup-point-provider-filter-input.mdx) [`SessionPickupPointOperator`](/api/public/types/objects/session-pickup-point-operator.mdx) [`SessionPickupPointPriceInput`](/api/public/types/inputs/session-pickup-point-price-input.mdx) [`SessionPickupPointProvider`](/api/public/types/objects/session-pickup-point-provider.mdx) [`SessionPickupPointProviderInput`](/api/public/types/inputs/session-pickup-point-provider-input.mdx) --- ## ShipmentModeEnum(Enums) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum ShipmentModeEnum { RECIPIENT_TO_SENDER SENDER_TO_RECIPIENT THIRD_PARTY_TO_THIRD_PARTY } ``` ### Values #### [ShipmentModeEnum.RECIPIENT_TO_SENDER](#) #### [ShipmentModeEnum.SENDER_TO_RECIPIENT](#) #### [ShipmentModeEnum.THIRD_PARTY_TO_THIRD_PARTY](#) ### Member Of [`CreateSessionInput`](/api/public/types/inputs/create-session-input.mdx) --- ## SortOrder(Enums) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; Directions for ordering a list of records. ```graphql enum SortOrder { ASC DESC } ``` ### Values #### [SortOrder.ASC](#) Sort records in ascending order. #### [SortOrder.DESC](#) Sort records in descending order. ### Member Of [`OrderByClause`](/api/public/types/inputs/order-by-clause.mdx) --- ## SubscriptionPlanEnum export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum SubscriptionPlanEnum { BASIC CUSTOM FREE PREMIUM PROFESSIONAL } ``` ### Values #### [SubscriptionPlanEnum.BASIC](#) #### [SubscriptionPlanEnum.CUSTOM](#) #### [SubscriptionPlanEnum.FREE](#) #### [SubscriptionPlanEnum.PREMIUM](#) #### [SubscriptionPlanEnum.PROFESSIONAL](#) --- ## TimezoneEnum(Enums) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql enum TimezoneEnum { AFRICA_ABIDJAN AFRICA_ALGIERS AFRICA_BISSAU AFRICA_CAIRO AFRICA_CASABLANCA AFRICA_CEUTA AFRICA_EL_AAIUN AFRICA_JOHANNESBURG AFRICA_JUBA AFRICA_KHARTOUM AFRICA_LAGOS AFRICA_MAPUTO AFRICA_MONROVIA AFRICA_NAIROBI AFRICA_NDJAMENA AFRICA_SAO_TOME AFRICA_TRIPOLI AFRICA_TUNIS AFRICA_WINDHOEK AMERICA_ADAK AMERICA_ANCHORAGE AMERICA_ARAGUAINA AMERICA_ARGENTINA_BUENOS_AIRES AMERICA_ARGENTINA_CATAMARCA AMERICA_ARGENTINA_CORDOBA AMERICA_ARGENTINA_JUJUY AMERICA_ARGENTINA_LA_RIOJA AMERICA_ARGENTINA_MENDOZA AMERICA_ARGENTINA_RIO_GALLEGOS AMERICA_ARGENTINA_SALTA AMERICA_ARGENTINA_SAN_JUAN AMERICA_ARGENTINA_SAN_LUIS AMERICA_ARGENTINA_TUCUMAN AMERICA_ARGENTINA_USHUAIA AMERICA_ASUNCION AMERICA_BAHIA AMERICA_BAHIA_BANDERAS AMERICA_BARBADOS AMERICA_BELEM AMERICA_BELIZE AMERICA_BOA_VISTA AMERICA_BOGOTA AMERICA_BOISE AMERICA_CAMBRIDGE_BAY AMERICA_CAMPO_GRANDE AMERICA_CANCUN AMERICA_CARACAS AMERICA_CAYENNE AMERICA_CHICAGO AMERICA_CHIHUAHUA AMERICA_CIUDAD_JUAREZ AMERICA_COSTA_RICA AMERICA_CUIABA AMERICA_DANMARKSHAVN AMERICA_DAWSON AMERICA_DAWSON_CREEK AMERICA_DENVER AMERICA_DETROIT AMERICA_EDMONTON AMERICA_EIRUNEPE AMERICA_EL_SALVADOR AMERICA_FORTALEZA AMERICA_FORT_NELSON AMERICA_GLACE_BAY AMERICA_GOOSE_BAY AMERICA_GRAND_TURK AMERICA_GUATEMALA AMERICA_GUAYAQUIL AMERICA_GUYANA AMERICA_HALIFAX AMERICA_HAVANA AMERICA_HERMOSILLO AMERICA_INDIANA_INDIANAPOLIS AMERICA_INDIANA_KNOX AMERICA_INDIANA_MARENGO AMERICA_INDIANA_PETERSBURG AMERICA_INDIANA_TELL_CITY AMERICA_INDIANA_VEVAY AMERICA_INDIANA_VINCENNES AMERICA_INDIANA_WINAMAC AMERICA_INUVIK AMERICA_IQALUIT AMERICA_JAMAICA AMERICA_JUNEAU AMERICA_KENTUCKY_LOUISVILLE AMERICA_KENTUCKY_MONTICELLO AMERICA_LA_PAZ AMERICA_LIMA AMERICA_LOS_ANGELES AMERICA_MACEIO AMERICA_MANAGUA AMERICA_MANAUS AMERICA_MARTINIQUE AMERICA_MATAMOROS AMERICA_MAZATLAN AMERICA_MENOMINEE AMERICA_MERIDA AMERICA_METLAKATLA AMERICA_MEXICO_CITY AMERICA_MIQUELON AMERICA_MONCTON AMERICA_MONTERREY AMERICA_MONTEVIDEO AMERICA_NEW_YORK AMERICA_NOME AMERICA_NORONHA AMERICA_NORTH_DAKOTA_BEULAH AMERICA_NORTH_DAKOTA_CENTER AMERICA_NORTH_DAKOTA_NEW_SALEM AMERICA_NUUK AMERICA_OJINAGA AMERICA_PANAMA AMERICA_PARAMARIBO AMERICA_PHOENIX AMERICA_PORTAU_PRINCE AMERICA_PORTO_VELHO AMERICA_PUERTO_RICO AMERICA_PUNTA_ARENAS AMERICA_RANKIN_INLET AMERICA_RECIFE AMERICA_REGINA AMERICA_RESOLUTE AMERICA_RIO_BRANCO AMERICA_SANTAREM AMERICA_SANTIAGO AMERICA_SANTO_DOMINGO AMERICA_SAO_PAULO AMERICA_SCORESBYSUND AMERICA_SITKA AMERICA_ST_JOHNS AMERICA_SWIFT_CURRENT AMERICA_TEGUCIGALPA AMERICA_THULE AMERICA_TIJUANA AMERICA_TORONTO AMERICA_VANCOUVER AMERICA_WHITEHORSE AMERICA_WINNIPEG AMERICA_YAKUTAT ANTARCTICA_CASEY ANTARCTICA_DAVIS ANTARCTICA_MACQUARIE ANTARCTICA_MAWSON ANTARCTICA_PALMER ANTARCTICA_ROTHERA ANTARCTICA_TROLL ASIA_ALMATY ASIA_AMMAN ASIA_ANADYR ASIA_AQTAU ASIA_AQTOBE ASIA_ASHGABAT ASIA_ATYRAU ASIA_BAGHDAD ASIA_BAKU ASIA_BANGKOK ASIA_BARNAUL ASIA_BEIRUT ASIA_BISHKEK ASIA_CHITA ASIA_CHOIBALSAN ASIA_COLOMBO ASIA_DAMASCUS ASIA_DHAKA ASIA_DILI ASIA_DUBAI ASIA_DUSHANBE ASIA_FAMAGUSTA ASIA_GAZA ASIA_HEBRON ASIA_HONG_KONG ASIA_HOVD ASIA_HO_CHI_MINH ASIA_IRKUTSK ASIA_JAKARTA ASIA_JAYAPURA ASIA_JERUSALEM ASIA_KABUL ASIA_KAMCHATKA ASIA_KARACHI ASIA_KATHMANDU ASIA_KHANDYGA ASIA_KOLKATA ASIA_KRASNOYARSK ASIA_KUCHING ASIA_MACAU ASIA_MAGADAN ASIA_MAKASSAR ASIA_MANILA ASIA_NICOSIA ASIA_NOVOKUZNETSK ASIA_NOVOSIBIRSK ASIA_OMSK ASIA_ORAL ASIA_PONTIANAK ASIA_PYONGYANG ASIA_QATAR ASIA_QOSTANAY ASIA_QYZYLORDA ASIA_RIYADH ASIA_SAKHALIN ASIA_SAMARKAND ASIA_SEOUL ASIA_SHANGHAI ASIA_SINGAPORE ASIA_SREDNEKOLYMSK ASIA_TAIPEI ASIA_TASHKENT ASIA_TBILISI ASIA_TEHRAN ASIA_THIMPHU ASIA_TOKYO ASIA_TOMSK ASIA_ULAANBAATAR ASIA_URUMQI ASIA_UST_NERA ASIA_VLADIVOSTOK ASIA_YAKUTSK ASIA_YANGON ASIA_YEKATERINBURG ASIA_YEREVAN ATLANTIC_AZORES ATLANTIC_BERMUDA ATLANTIC_CANARY ATLANTIC_CAPE_VERDE ATLANTIC_FAROE ATLANTIC_MADEIRA ATLANTIC_SOUTH_GEORGIA ATLANTIC_STANLEY AUSTRALIA_ADELAIDE AUSTRALIA_BRISBANE AUSTRALIA_BROKEN_HILL AUSTRALIA_DARWIN AUSTRALIA_EUCLA AUSTRALIA_HOBART AUSTRALIA_LINDEMAN AUSTRALIA_LORD_HOWE AUSTRALIA_MELBOURNE AUSTRALIA_PERTH AUSTRALIA_SYDNEY EUROPE_ANDORRA EUROPE_ASTRAKHAN EUROPE_ATHENS EUROPE_BELGRADE EUROPE_BERLIN EUROPE_BRUSSELS EUROPE_BUCHAREST EUROPE_BUDAPEST EUROPE_CHISINAU EUROPE_DUBLIN EUROPE_GIBRALTAR EUROPE_HELSINKI EUROPE_ISTANBUL EUROPE_KALININGRAD EUROPE_KIROV EUROPE_KYIV EUROPE_LISBON EUROPE_LONDON EUROPE_MADRID EUROPE_MALTA EUROPE_MINSK EUROPE_MOSCOW EUROPE_PARIS EUROPE_PRAGUE EUROPE_RIGA EUROPE_ROME EUROPE_SAMARA EUROPE_SARATOV EUROPE_SIMFEROPOL EUROPE_SOFIA EUROPE_TALLINN EUROPE_TIRANE EUROPE_ULYANOVSK EUROPE_VIENNA EUROPE_VILNIUS EUROPE_VOLGOGRAD EUROPE_WARSAW EUROPE_ZURICH INDIAN_CHAGOS INDIAN_MALDIVES INDIAN_MAURITIUS PACIFIC_APIA PACIFIC_AUCKLAND PACIFIC_BOUGAINVILLE PACIFIC_CHATHAM PACIFIC_EASTER PACIFIC_EFATE PACIFIC_FAKAOFO PACIFIC_FIJI PACIFIC_GALAPAGOS PACIFIC_GAMBIER PACIFIC_GUADALCANAL PACIFIC_GUAM PACIFIC_HONOLULU PACIFIC_KANTON PACIFIC_KIRITIMATI PACIFIC_KOSRAE PACIFIC_KWAJALEIN PACIFIC_MARQUESAS PACIFIC_NAURU PACIFIC_NIUE PACIFIC_NORFOLK PACIFIC_NOUMEA PACIFIC_PAGO_PAGO PACIFIC_PALAU PACIFIC_PITCAIRN PACIFIC_PORT_MORESBY PACIFIC_RAROTONGA PACIFIC_TAHITI PACIFIC_TARAWA PACIFIC_TONGATAPU } ``` ### Values #### [TimezoneEnum.AFRICA_ABIDJAN](#) #### [TimezoneEnum.AFRICA_ALGIERS](#) #### [TimezoneEnum.AFRICA_BISSAU](#) #### [TimezoneEnum.AFRICA_CAIRO](#) #### [TimezoneEnum.AFRICA_CASABLANCA](#) #### [TimezoneEnum.AFRICA_CEUTA](#) #### [TimezoneEnum.AFRICA_EL_AAIUN](#) #### [TimezoneEnum.AFRICA_JOHANNESBURG](#) #### [TimezoneEnum.AFRICA_JUBA](#) #### [TimezoneEnum.AFRICA_KHARTOUM](#) #### [TimezoneEnum.AFRICA_LAGOS](#) #### [TimezoneEnum.AFRICA_MAPUTO](#) #### [TimezoneEnum.AFRICA_MONROVIA](#) #### [TimezoneEnum.AFRICA_NAIROBI](#) #### [TimezoneEnum.AFRICA_NDJAMENA](#) #### [TimezoneEnum.AFRICA_SAO_TOME](#) #### [TimezoneEnum.AFRICA_TRIPOLI](#) #### [TimezoneEnum.AFRICA_TUNIS](#) #### [TimezoneEnum.AFRICA_WINDHOEK](#) #### [TimezoneEnum.AMERICA_ADAK](#) #### [TimezoneEnum.AMERICA_ANCHORAGE](#) #### [TimezoneEnum.AMERICA_ARAGUAINA](#) #### [TimezoneEnum.AMERICA_ARGENTINA_BUENOS_AIRES](#) #### [TimezoneEnum.AMERICA_ARGENTINA_CATAMARCA](#) #### [TimezoneEnum.AMERICA_ARGENTINA_CORDOBA](#) #### [TimezoneEnum.AMERICA_ARGENTINA_JUJUY](#) #### [TimezoneEnum.AMERICA_ARGENTINA_LA_RIOJA](#) #### [TimezoneEnum.AMERICA_ARGENTINA_MENDOZA](#) #### [TimezoneEnum.AMERICA_ARGENTINA_RIO_GALLEGOS](#) #### [TimezoneEnum.AMERICA_ARGENTINA_SALTA](#) #### [TimezoneEnum.AMERICA_ARGENTINA_SAN_JUAN](#) #### [TimezoneEnum.AMERICA_ARGENTINA_SAN_LUIS](#) #### [TimezoneEnum.AMERICA_ARGENTINA_TUCUMAN](#) #### [TimezoneEnum.AMERICA_ARGENTINA_USHUAIA](#) #### [TimezoneEnum.AMERICA_ASUNCION](#) #### [TimezoneEnum.AMERICA_BAHIA](#) #### [TimezoneEnum.AMERICA_BAHIA_BANDERAS](#) #### [TimezoneEnum.AMERICA_BARBADOS](#) #### [TimezoneEnum.AMERICA_BELEM](#) #### [TimezoneEnum.AMERICA_BELIZE](#) #### [TimezoneEnum.AMERICA_BOA_VISTA](#) #### [TimezoneEnum.AMERICA_BOGOTA](#) #### [TimezoneEnum.AMERICA_BOISE](#) #### [TimezoneEnum.AMERICA_CAMBRIDGE_BAY](#) #### [TimezoneEnum.AMERICA_CAMPO_GRANDE](#) #### [TimezoneEnum.AMERICA_CANCUN](#) #### [TimezoneEnum.AMERICA_CARACAS](#) #### [TimezoneEnum.AMERICA_CAYENNE](#) #### [TimezoneEnum.AMERICA_CHICAGO](#) #### [TimezoneEnum.AMERICA_CHIHUAHUA](#) #### [TimezoneEnum.AMERICA_CIUDAD_JUAREZ](#) #### [TimezoneEnum.AMERICA_COSTA_RICA](#) #### [TimezoneEnum.AMERICA_CUIABA](#) #### [TimezoneEnum.AMERICA_DANMARKSHAVN](#) #### [TimezoneEnum.AMERICA_DAWSON](#) #### [TimezoneEnum.AMERICA_DAWSON_CREEK](#) #### [TimezoneEnum.AMERICA_DENVER](#) #### [TimezoneEnum.AMERICA_DETROIT](#) #### [TimezoneEnum.AMERICA_EDMONTON](#) #### [TimezoneEnum.AMERICA_EIRUNEPE](#) #### [TimezoneEnum.AMERICA_EL_SALVADOR](#) #### [TimezoneEnum.AMERICA_FORTALEZA](#) #### [TimezoneEnum.AMERICA_FORT_NELSON](#) #### [TimezoneEnum.AMERICA_GLACE_BAY](#) #### [TimezoneEnum.AMERICA_GOOSE_BAY](#) #### [TimezoneEnum.AMERICA_GRAND_TURK](#) #### [TimezoneEnum.AMERICA_GUATEMALA](#) #### [TimezoneEnum.AMERICA_GUAYAQUIL](#) #### [TimezoneEnum.AMERICA_GUYANA](#) #### [TimezoneEnum.AMERICA_HALIFAX](#) #### [TimezoneEnum.AMERICA_HAVANA](#) #### [TimezoneEnum.AMERICA_HERMOSILLO](#) #### [TimezoneEnum.AMERICA_INDIANA_INDIANAPOLIS](#) #### [TimezoneEnum.AMERICA_INDIANA_KNOX](#) #### [TimezoneEnum.AMERICA_INDIANA_MARENGO](#) #### [TimezoneEnum.AMERICA_INDIANA_PETERSBURG](#) #### [TimezoneEnum.AMERICA_INDIANA_TELL_CITY](#) #### [TimezoneEnum.AMERICA_INDIANA_VEVAY](#) #### [TimezoneEnum.AMERICA_INDIANA_VINCENNES](#) #### [TimezoneEnum.AMERICA_INDIANA_WINAMAC](#) #### [TimezoneEnum.AMERICA_INUVIK](#) #### [TimezoneEnum.AMERICA_IQALUIT](#) #### [TimezoneEnum.AMERICA_JAMAICA](#) #### [TimezoneEnum.AMERICA_JUNEAU](#) #### [TimezoneEnum.AMERICA_KENTUCKY_LOUISVILLE](#) #### [TimezoneEnum.AMERICA_KENTUCKY_MONTICELLO](#) #### [TimezoneEnum.AMERICA_LA_PAZ](#) #### [TimezoneEnum.AMERICA_LIMA](#) #### [TimezoneEnum.AMERICA_LOS_ANGELES](#) #### [TimezoneEnum.AMERICA_MACEIO](#) #### [TimezoneEnum.AMERICA_MANAGUA](#) #### [TimezoneEnum.AMERICA_MANAUS](#) #### [TimezoneEnum.AMERICA_MARTINIQUE](#) #### [TimezoneEnum.AMERICA_MATAMOROS](#) #### [TimezoneEnum.AMERICA_MAZATLAN](#) #### [TimezoneEnum.AMERICA_MENOMINEE](#) #### [TimezoneEnum.AMERICA_MERIDA](#) #### [TimezoneEnum.AMERICA_METLAKATLA](#) #### [TimezoneEnum.AMERICA_MEXICO_CITY](#) #### [TimezoneEnum.AMERICA_MIQUELON](#) #### [TimezoneEnum.AMERICA_MONCTON](#) #### [TimezoneEnum.AMERICA_MONTERREY](#) #### [TimezoneEnum.AMERICA_MONTEVIDEO](#) #### [TimezoneEnum.AMERICA_NEW_YORK](#) #### [TimezoneEnum.AMERICA_NOME](#) #### [TimezoneEnum.AMERICA_NORONHA](#) #### [TimezoneEnum.AMERICA_NORTH_DAKOTA_BEULAH](#) #### [TimezoneEnum.AMERICA_NORTH_DAKOTA_CENTER](#) #### [TimezoneEnum.AMERICA_NORTH_DAKOTA_NEW_SALEM](#) #### [TimezoneEnum.AMERICA_NUUK](#) #### [TimezoneEnum.AMERICA_OJINAGA](#) #### [TimezoneEnum.AMERICA_PANAMA](#) #### [TimezoneEnum.AMERICA_PARAMARIBO](#) #### [TimezoneEnum.AMERICA_PHOENIX](#) #### [TimezoneEnum.AMERICA_PORTAU_PRINCE](#) #### [TimezoneEnum.AMERICA_PORTO_VELHO](#) #### [TimezoneEnum.AMERICA_PUERTO_RICO](#) #### [TimezoneEnum.AMERICA_PUNTA_ARENAS](#) #### [TimezoneEnum.AMERICA_RANKIN_INLET](#) #### [TimezoneEnum.AMERICA_RECIFE](#) #### [TimezoneEnum.AMERICA_REGINA](#) #### [TimezoneEnum.AMERICA_RESOLUTE](#) #### [TimezoneEnum.AMERICA_RIO_BRANCO](#) #### [TimezoneEnum.AMERICA_SANTAREM](#) #### [TimezoneEnum.AMERICA_SANTIAGO](#) #### [TimezoneEnum.AMERICA_SANTO_DOMINGO](#) #### [TimezoneEnum.AMERICA_SAO_PAULO](#) #### [TimezoneEnum.AMERICA_SCORESBYSUND](#) #### [TimezoneEnum.AMERICA_SITKA](#) #### [TimezoneEnum.AMERICA_ST_JOHNS](#) #### [TimezoneEnum.AMERICA_SWIFT_CURRENT](#) #### [TimezoneEnum.AMERICA_TEGUCIGALPA](#) #### [TimezoneEnum.AMERICA_THULE](#) #### [TimezoneEnum.AMERICA_TIJUANA](#) #### [TimezoneEnum.AMERICA_TORONTO](#) #### [TimezoneEnum.AMERICA_VANCOUVER](#) #### [TimezoneEnum.AMERICA_WHITEHORSE](#) #### [TimezoneEnum.AMERICA_WINNIPEG](#) #### [TimezoneEnum.AMERICA_YAKUTAT](#) #### [TimezoneEnum.ANTARCTICA_CASEY](#) #### [TimezoneEnum.ANTARCTICA_DAVIS](#) #### [TimezoneEnum.ANTARCTICA_MACQUARIE](#) #### [TimezoneEnum.ANTARCTICA_MAWSON](#) #### [TimezoneEnum.ANTARCTICA_PALMER](#) #### [TimezoneEnum.ANTARCTICA_ROTHERA](#) #### [TimezoneEnum.ANTARCTICA_TROLL](#) #### [TimezoneEnum.ASIA_ALMATY](#) #### [TimezoneEnum.ASIA_AMMAN](#) #### [TimezoneEnum.ASIA_ANADYR](#) #### [TimezoneEnum.ASIA_AQTAU](#) #### [TimezoneEnum.ASIA_AQTOBE](#) #### [TimezoneEnum.ASIA_ASHGABAT](#) #### [TimezoneEnum.ASIA_ATYRAU](#) #### [TimezoneEnum.ASIA_BAGHDAD](#) #### [TimezoneEnum.ASIA_BAKU](#) #### [TimezoneEnum.ASIA_BANGKOK](#) #### [TimezoneEnum.ASIA_BARNAUL](#) #### [TimezoneEnum.ASIA_BEIRUT](#) #### [TimezoneEnum.ASIA_BISHKEK](#) #### [TimezoneEnum.ASIA_CHITA](#) #### [TimezoneEnum.ASIA_CHOIBALSAN](#) #### [TimezoneEnum.ASIA_COLOMBO](#) #### [TimezoneEnum.ASIA_DAMASCUS](#) #### [TimezoneEnum.ASIA_DHAKA](#) #### [TimezoneEnum.ASIA_DILI](#) #### [TimezoneEnum.ASIA_DUBAI](#) #### [TimezoneEnum.ASIA_DUSHANBE](#) #### [TimezoneEnum.ASIA_FAMAGUSTA](#) #### [TimezoneEnum.ASIA_GAZA](#) #### [TimezoneEnum.ASIA_HEBRON](#) #### [TimezoneEnum.ASIA_HONG_KONG](#) #### [TimezoneEnum.ASIA_HOVD](#) #### [TimezoneEnum.ASIA_HO_CHI_MINH](#) #### [TimezoneEnum.ASIA_IRKUTSK](#) #### [TimezoneEnum.ASIA_JAKARTA](#) #### [TimezoneEnum.ASIA_JAYAPURA](#) #### [TimezoneEnum.ASIA_JERUSALEM](#) #### [TimezoneEnum.ASIA_KABUL](#) #### [TimezoneEnum.ASIA_KAMCHATKA](#) #### [TimezoneEnum.ASIA_KARACHI](#) #### [TimezoneEnum.ASIA_KATHMANDU](#) #### [TimezoneEnum.ASIA_KHANDYGA](#) #### [TimezoneEnum.ASIA_KOLKATA](#) #### [TimezoneEnum.ASIA_KRASNOYARSK](#) #### [TimezoneEnum.ASIA_KUCHING](#) #### [TimezoneEnum.ASIA_MACAU](#) #### [TimezoneEnum.ASIA_MAGADAN](#) #### [TimezoneEnum.ASIA_MAKASSAR](#) #### [TimezoneEnum.ASIA_MANILA](#) #### [TimezoneEnum.ASIA_NICOSIA](#) #### [TimezoneEnum.ASIA_NOVOKUZNETSK](#) #### [TimezoneEnum.ASIA_NOVOSIBIRSK](#) #### [TimezoneEnum.ASIA_OMSK](#) #### [TimezoneEnum.ASIA_ORAL](#) #### [TimezoneEnum.ASIA_PONTIANAK](#) #### [TimezoneEnum.ASIA_PYONGYANG](#) #### [TimezoneEnum.ASIA_QATAR](#) #### [TimezoneEnum.ASIA_QOSTANAY](#) #### [TimezoneEnum.ASIA_QYZYLORDA](#) #### [TimezoneEnum.ASIA_RIYADH](#) #### [TimezoneEnum.ASIA_SAKHALIN](#) #### [TimezoneEnum.ASIA_SAMARKAND](#) #### [TimezoneEnum.ASIA_SEOUL](#) #### [TimezoneEnum.ASIA_SHANGHAI](#) #### [TimezoneEnum.ASIA_SINGAPORE](#) #### [TimezoneEnum.ASIA_SREDNEKOLYMSK](#) #### [TimezoneEnum.ASIA_TAIPEI](#) #### [TimezoneEnum.ASIA_TASHKENT](#) #### [TimezoneEnum.ASIA_TBILISI](#) #### [TimezoneEnum.ASIA_TEHRAN](#) #### [TimezoneEnum.ASIA_THIMPHU](#) #### [TimezoneEnum.ASIA_TOKYO](#) #### [TimezoneEnum.ASIA_TOMSK](#) #### [TimezoneEnum.ASIA_ULAANBAATAR](#) #### [TimezoneEnum.ASIA_URUMQI](#) #### [TimezoneEnum.ASIA_UST_NERA](#) #### [TimezoneEnum.ASIA_VLADIVOSTOK](#) #### [TimezoneEnum.ASIA_YAKUTSK](#) #### [TimezoneEnum.ASIA_YANGON](#) #### [TimezoneEnum.ASIA_YEKATERINBURG](#) #### [TimezoneEnum.ASIA_YEREVAN](#) #### [TimezoneEnum.ATLANTIC_AZORES](#) #### [TimezoneEnum.ATLANTIC_BERMUDA](#) #### [TimezoneEnum.ATLANTIC_CANARY](#) #### [TimezoneEnum.ATLANTIC_CAPE_VERDE](#) #### [TimezoneEnum.ATLANTIC_FAROE](#) #### [TimezoneEnum.ATLANTIC_MADEIRA](#) #### [TimezoneEnum.ATLANTIC_SOUTH_GEORGIA](#) #### [TimezoneEnum.ATLANTIC_STANLEY](#) #### [TimezoneEnum.AUSTRALIA_ADELAIDE](#) #### [TimezoneEnum.AUSTRALIA_BRISBANE](#) #### [TimezoneEnum.AUSTRALIA_BROKEN_HILL](#) #### [TimezoneEnum.AUSTRALIA_DARWIN](#) #### [TimezoneEnum.AUSTRALIA_EUCLA](#) #### [TimezoneEnum.AUSTRALIA_HOBART](#) #### [TimezoneEnum.AUSTRALIA_LINDEMAN](#) #### [TimezoneEnum.AUSTRALIA_LORD_HOWE](#) #### [TimezoneEnum.AUSTRALIA_MELBOURNE](#) #### [TimezoneEnum.AUSTRALIA_PERTH](#) #### [TimezoneEnum.AUSTRALIA_SYDNEY](#) #### [TimezoneEnum.EUROPE_ANDORRA](#) #### [TimezoneEnum.EUROPE_ASTRAKHAN](#) #### [TimezoneEnum.EUROPE_ATHENS](#) #### [TimezoneEnum.EUROPE_BELGRADE](#) #### [TimezoneEnum.EUROPE_BERLIN](#) #### [TimezoneEnum.EUROPE_BRUSSELS](#) #### [TimezoneEnum.EUROPE_BUCHAREST](#) #### [TimezoneEnum.EUROPE_BUDAPEST](#) #### [TimezoneEnum.EUROPE_CHISINAU](#) #### [TimezoneEnum.EUROPE_DUBLIN](#) #### [TimezoneEnum.EUROPE_GIBRALTAR](#) #### [TimezoneEnum.EUROPE_HELSINKI](#) #### [TimezoneEnum.EUROPE_ISTANBUL](#) #### [TimezoneEnum.EUROPE_KALININGRAD](#) #### [TimezoneEnum.EUROPE_KIROV](#) #### [TimezoneEnum.EUROPE_KYIV](#) #### [TimezoneEnum.EUROPE_LISBON](#) #### [TimezoneEnum.EUROPE_LONDON](#) #### [TimezoneEnum.EUROPE_MADRID](#) #### [TimezoneEnum.EUROPE_MALTA](#) #### [TimezoneEnum.EUROPE_MINSK](#) #### [TimezoneEnum.EUROPE_MOSCOW](#) #### [TimezoneEnum.EUROPE_PARIS](#) #### [TimezoneEnum.EUROPE_PRAGUE](#) #### [TimezoneEnum.EUROPE_RIGA](#) #### [TimezoneEnum.EUROPE_ROME](#) #### [TimezoneEnum.EUROPE_SAMARA](#) #### [TimezoneEnum.EUROPE_SARATOV](#) #### [TimezoneEnum.EUROPE_SIMFEROPOL](#) #### [TimezoneEnum.EUROPE_SOFIA](#) #### [TimezoneEnum.EUROPE_TALLINN](#) #### [TimezoneEnum.EUROPE_TIRANE](#) #### [TimezoneEnum.EUROPE_ULYANOVSK](#) #### [TimezoneEnum.EUROPE_VIENNA](#) #### [TimezoneEnum.EUROPE_VILNIUS](#) #### [TimezoneEnum.EUROPE_VOLGOGRAD](#) #### [TimezoneEnum.EUROPE_WARSAW](#) #### [TimezoneEnum.EUROPE_ZURICH](#) #### [TimezoneEnum.INDIAN_CHAGOS](#) #### [TimezoneEnum.INDIAN_MALDIVES](#) #### [TimezoneEnum.INDIAN_MAURITIUS](#) #### [TimezoneEnum.PACIFIC_APIA](#) #### [TimezoneEnum.PACIFIC_AUCKLAND](#) #### [TimezoneEnum.PACIFIC_BOUGAINVILLE](#) #### [TimezoneEnum.PACIFIC_CHATHAM](#) #### [TimezoneEnum.PACIFIC_EASTER](#) #### [TimezoneEnum.PACIFIC_EFATE](#) #### [TimezoneEnum.PACIFIC_FAKAOFO](#) #### [TimezoneEnum.PACIFIC_FIJI](#) #### [TimezoneEnum.PACIFIC_GALAPAGOS](#) #### [TimezoneEnum.PACIFIC_GAMBIER](#) #### [TimezoneEnum.PACIFIC_GUADALCANAL](#) #### [TimezoneEnum.PACIFIC_GUAM](#) #### [TimezoneEnum.PACIFIC_HONOLULU](#) #### [TimezoneEnum.PACIFIC_KANTON](#) #### [TimezoneEnum.PACIFIC_KIRITIMATI](#) #### [TimezoneEnum.PACIFIC_KOSRAE](#) #### [TimezoneEnum.PACIFIC_KWAJALEIN](#) #### [TimezoneEnum.PACIFIC_MARQUESAS](#) #### [TimezoneEnum.PACIFIC_NAURU](#) #### [TimezoneEnum.PACIFIC_NIUE](#) #### [TimezoneEnum.PACIFIC_NORFOLK](#) #### [TimezoneEnum.PACIFIC_NOUMEA](#) #### [TimezoneEnum.PACIFIC_PAGO_PAGO](#) #### [TimezoneEnum.PACIFIC_PALAU](#) #### [TimezoneEnum.PACIFIC_PITCAIRN](#) #### [TimezoneEnum.PACIFIC_PORT_MORESBY](#) #### [TimezoneEnum.PACIFIC_RAROTONGA](#) #### [TimezoneEnum.PACIFIC_TAHITI](#) #### [TimezoneEnum.PACIFIC_TARAWA](#) #### [TimezoneEnum.PACIFIC_TONGATAPU](#) --- ## Trashed(Enums) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; Specify if you want to include or exclude trashed results from a query. ```graphql enum Trashed { ONLY WITH WITHOUT } ``` ### Values #### [Trashed.ONLY](#) Only return trashed results. #### [Trashed.WITH](#) Return both trashed and non-trashed results. #### [Trashed.WITHOUT](#) Only return non-trashed results. --- ## AddressInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input AddressInput { country: CountryEnum! state: String city: String! postalCode: String! addressLine1: String! addressLine2: String note: String } ``` ### Fields #### [AddressInput.country](#)[CountryEnum!](/api/public/types/enums/country-enum.mdx) #### [AddressInput.state](#)[String](/api/public/types/scalars/string.mdx) #### [AddressInput.city](#)[String!](/api/public/types/scalars/string.mdx) #### [AddressInput.postalCode](#)[String!](/api/public/types/scalars/string.mdx) #### [AddressInput.addressLine1](#)[String!](/api/public/types/scalars/string.mdx) #### [AddressInput.addressLine2](#)[String](/api/public/types/scalars/string.mdx) #### [AddressInput.note](#)[String](/api/public/types/scalars/string.mdx) ### Member Of [`CustomerAddressInput`](/api/public/types/inputs/customer-address-input.mdx) [`SessionCustomerAddressInput`](/api/public/types/inputs/session-customer-address-input.mdx) [`SessionOriginInput`](/api/public/types/inputs/session-origin-input.mdx) --- ## CreateAddressInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input CreateAddressInput { sessionId: ID! address: CustomerAddressInput! } ``` ### Fields #### [CreateAddressInput.sessionId](#)[ID!](/api/public/types/scalars/id.mdx) #### [CreateAddressInput.address](#)[CustomerAddressInput!](/api/public/types/inputs/customer-address-input.mdx) ### Member Of [`createAddress`](/api/public/operations/mutations/create-address.mdx) [`CreateAndSetAddressInput`](/api/public/types/inputs/create-and-set-address-input.mdx) --- ## CreateAndSetAddressInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input CreateAndSetAddressInput { address: CreateAddressInput! provider: ProviderEnum } ``` ### Fields #### [CreateAndSetAddressInput.address](#)[CreateAddressInput!](/api/public/types/inputs/create-address-input.mdx) #### [CreateAndSetAddressInput.provider](#)[ProviderEnum](/api/public/types/scalars/provider-enum.mdx) ### Member Of [`createAndSetAddress`](/api/public/operations/mutations/create-and-set-address.mdx) --- ## CreateSessionInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input CreateSessionInput { id: ID mode: ShipmentModeEnum currency: CurrencyEnum language: LanguageEnum customer: SessionCustomerInput sender: SessionSenderInput origin: SessionOriginInput parcels: [SessionParcelInput!] price: [SessionPriceInput!] zones: [SessionZoneInput!] pickupPoint: SessionPickupPointInput homeDelivery: SessionHomeDeliveryInput } ``` ### Fields #### [CreateSessionInput.id](#)[ID](/api/public/types/scalars/id.mdx) #### [CreateSessionInput.mode](#)[ShipmentModeEnum](/api/public/types/enums/shipment-mode-enum.mdx) #### [CreateSessionInput.currency](#)[CurrencyEnum](/api/public/types/enums/currency-enum.mdx) #### [CreateSessionInput.language](#)[LanguageEnum](/api/public/types/enums/language-enum.mdx) #### [CreateSessionInput.customer](#)[SessionCustomerInput](/api/public/types/inputs/session-customer-input.mdx) #### [CreateSessionInput.sender](#)[SessionSenderInput](/api/public/types/inputs/session-sender-input.mdx) #### [CreateSessionInput.origin](#)[SessionOriginInput](/api/public/types/inputs/session-origin-input.mdx) #### [CreateSessionInput.parcels](#)[[SessionParcelInput!]](/api/public/types/inputs/session-parcel-input.mdx) #### [CreateSessionInput.price](#)[[SessionPriceInput!]](/api/public/types/inputs/session-price-input.mdx) #### [CreateSessionInput.zones](#)[[SessionZoneInput!]](/api/public/types/inputs/session-zone-input.mdx) #### [CreateSessionInput.pickupPoint](#)[SessionPickupPointInput](/api/public/types/inputs/session-pickup-point-input.mdx) #### [CreateSessionInput.homeDelivery](#)[SessionHomeDeliveryInput](/api/public/types/inputs/session-home-delivery-input.mdx) ### Member Of [`createSession`](/api/public/operations/mutations/create-session.mdx) --- ## CustomerAddressInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input CustomerAddressInput { referenceId: String label: String recipient: CustomerRecipientInput address: AddressInput! location: LocationInput } ``` ### Fields #### [CustomerAddressInput.referenceId](#)[String](/api/public/types/scalars/string.mdx) #### [CustomerAddressInput.label](#)[String](/api/public/types/scalars/string.mdx) #### [CustomerAddressInput.recipient](#)[CustomerRecipientInput](/api/public/types/inputs/customer-recipient-input.mdx) #### [CustomerAddressInput.address](#)[AddressInput!](/api/public/types/inputs/address-input.mdx) #### [CustomerAddressInput.location](#)[LocationInput](/api/public/types/inputs/location-input.mdx) ### Member Of [`CreateAddressInput`](/api/public/types/inputs/create-address-input.mdx) [`SetGuestAddressInput`](/api/public/types/inputs/set-guest-address-input.mdx) [`UpdateAddressInput`](/api/public/types/inputs/update-address-input.mdx) --- ## CustomerRecipientInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input CustomerRecipientInput { firstName: String lastName: String language: LanguageEnum email: String phone: String } ``` ### Fields #### [CustomerRecipientInput.firstName](#)[String](/api/public/types/scalars/string.mdx) #### [CustomerRecipientInput.lastName](#)[String](/api/public/types/scalars/string.mdx) #### [CustomerRecipientInput.language](#)[LanguageEnum](/api/public/types/enums/language-enum.mdx) #### [CustomerRecipientInput.email](#)[String](/api/public/types/scalars/string.mdx) #### [CustomerRecipientInput.phone](#)[String](/api/public/types/scalars/string.mdx) ### Member Of [`CustomerAddressInput`](/api/public/types/inputs/customer-address-input.mdx) [`SessionCustomerAddressInput`](/api/public/types/inputs/session-customer-address-input.mdx) [`SessionHomeDeliveryInput`](/api/public/types/inputs/session-home-delivery-input.mdx) [`SessionPickupPointInput`](/api/public/types/inputs/session-pickup-point-input.mdx) [`SetPickupPointInput`](/api/public/types/inputs/set-pickup-point-input.mdx) --- ## DateRangeFilter(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input DateRangeFilter { start: Date end: Date } ``` ### Fields #### [DateRangeFilter.start](#)[Date](/api/public/types/scalars/date.mdx) #### [DateRangeFilter.end](#)[Date](/api/public/types/scalars/date.mdx) --- ## DateTimeRangeFilter(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input DateTimeRangeFilter { start: DateTimeTz end: DateTimeTz } ``` ### Fields #### [DateTimeRangeFilter.start](#)[DateTimeTz](/api/public/types/scalars/date-time-tz.mdx) #### [DateTimeRangeFilter.end](#)[DateTimeTz](/api/public/types/scalars/date-time-tz.mdx) --- ## DeleteAddressInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input DeleteAddressInput { sessionId: ID! addressId: ID! } ``` ### Fields #### [DeleteAddressInput.sessionId](#)[ID!](/api/public/types/scalars/id.mdx) #### [DeleteAddressInput.addressId](#)[ID!](/api/public/types/scalars/id.mdx) ### Member Of [`deleteAddress`](/api/public/operations/mutations/delete-address.mdx) [`deleteAndUnsetAddress`](/api/public/operations/mutations/delete-and-unset-address.mdx) --- ## DimensionInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input DimensionInput { width: Float! length: Float! height: Float! } ``` ### Fields #### [DimensionInput.width](#)[Float!](/api/public/types/scalars/float.mdx) #### [DimensionInput.length](#)[Float!](/api/public/types/scalars/float.mdx) #### [DimensionInput.height](#)[Float!](/api/public/types/scalars/float.mdx) ### Member Of [`SessionParcelInput`](/api/public/types/inputs/session-parcel-input.mdx) --- ## FloatRangeFilter(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input FloatRangeFilter { start: Float end: Float } ``` ### Fields #### [FloatRangeFilter.start](#)[Float](/api/public/types/scalars/float.mdx) #### [FloatRangeFilter.end](#)[Float](/api/public/types/scalars/float.mdx) --- ## IntRangeFilter(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input IntRangeFilter { start: Int end: Int } ``` ### Fields #### [IntRangeFilter.start](#)[Int](/api/public/types/scalars/int.mdx) #### [IntRangeFilter.end](#)[Int](/api/public/types/scalars/int.mdx) --- ## KeyValueInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input KeyValueInput { key: String! value: String } ``` ### Fields #### [KeyValueInput.key](#)[String!](/api/public/types/scalars/string.mdx) #### [KeyValueInput.value](#)[String](/api/public/types/scalars/string.mdx) --- ## LocalizedStringInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input LocalizedStringInput { language: LanguageEnum! value: String! } ``` ### Fields #### [LocalizedStringInput.language](#)[LanguageEnum!](/api/public/types/enums/language-enum.mdx) #### [LocalizedStringInput.value](#)[String!](/api/public/types/scalars/string.mdx) ### Member Of [`PickupPointTagInput`](/api/public/types/inputs/pickup-point-tag-input.mdx) --- ## LocationInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input LocationInput { latitude: Float! longitude: Float! } ``` ### Fields #### [LocationInput.latitude](#)[Float!](/api/public/types/scalars/float.mdx) #### [LocationInput.longitude](#)[Float!](/api/public/types/scalars/float.mdx) ### Member Of [`CustomerAddressInput`](/api/public/types/inputs/customer-address-input.mdx) [`PickupPointBoundingBoxFilterInput`](/api/public/types/inputs/pickup-point-bounding-box-filter-input.mdx) [`PickupPointDistanceFilterInput`](/api/public/types/inputs/pickup-point-distance-filter-input.mdx) [`PickupPointSortInput`](/api/public/types/inputs/pickup-point-sort-input.mdx) [`SessionCustomerAddressInput`](/api/public/types/inputs/session-customer-address-input.mdx) [`SessionOriginInput`](/api/public/types/inputs/session-origin-input.mdx) --- ## MoneyInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input MoneyInput { amount: Float! currency: CurrencyEnum! } ``` ### Fields #### [MoneyInput.amount](#)[Float!](/api/public/types/scalars/float.mdx) #### [MoneyInput.currency](#)[CurrencyEnum!](/api/public/types/enums/currency-enum.mdx) ### Member Of [`SessionParcelInput`](/api/public/types/inputs/session-parcel-input.mdx) [`SessionPickupPointPriceInput`](/api/public/types/inputs/session-pickup-point-price-input.mdx) [`SessionPriceInput`](/api/public/types/inputs/session-price-input.mdx) --- ## OpeningHourInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input OpeningHourInput { day: DayEnum! start: TimeInput! end: TimeInput! } ``` ### Fields #### [OpeningHourInput.day](#)[DayEnum!](/api/public/types/enums/day-enum.mdx) #### [OpeningHourInput.start](#)[TimeInput!](/api/public/types/inputs/time-input.mdx) #### [OpeningHourInput.end](#)[TimeInput!](/api/public/types/inputs/time-input.mdx) --- ## OrderByClause(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; Allows ordering a list of records. ```graphql input OrderByClause { column: String! order: SortOrder! } ``` ### Fields #### [OrderByClause.column](#)[String!](/api/public/types/scalars/string.mdx) The column that is used for ordering. #### [OrderByClause.order](#)[SortOrder!](/api/public/types/enums/sort-order.mdx) The direction that is used for ordering. --- ## PartialAddressInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PartialAddressInput { country: CountryEnum state: String city: String postalCode: String addressLine1: String addressLine2: String note: String } ``` ### Fields #### [PartialAddressInput.country](#)[CountryEnum](/api/public/types/enums/country-enum.mdx) #### [PartialAddressInput.state](#)[String](/api/public/types/scalars/string.mdx) #### [PartialAddressInput.city](#)[String](/api/public/types/scalars/string.mdx) #### [PartialAddressInput.postalCode](#)[String](/api/public/types/scalars/string.mdx) #### [PartialAddressInput.addressLine1](#)[String](/api/public/types/scalars/string.mdx) #### [PartialAddressInput.addressLine2](#)[String](/api/public/types/scalars/string.mdx) #### [PartialAddressInput.note](#)[String](/api/public/types/scalars/string.mdx) --- ## PickupPointBoundingBoxFilterInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PickupPointBoundingBoxFilterInput { southWest: LocationInput! northEast: LocationInput! } ``` ### Fields #### [PickupPointBoundingBoxFilterInput.southWest](#)[LocationInput!](/api/public/types/inputs/location-input.mdx) #### [PickupPointBoundingBoxFilterInput.northEast](#)[LocationInput!](/api/public/types/inputs/location-input.mdx) ### Member Of [`PickupPointFilterInput`](/api/public/types/inputs/pickup-point-filter-input.mdx) --- ## PickupPointDistanceFilterInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PickupPointDistanceFilterInput { location: LocationInput! distance: Int! } ``` ### Fields #### [PickupPointDistanceFilterInput.location](#)[LocationInput!](/api/public/types/inputs/location-input.mdx) #### [PickupPointDistanceFilterInput.distance](#)[Int!](/api/public/types/scalars/int.mdx) ### Member Of [`PickupPointFilterInput`](/api/public/types/inputs/pickup-point-filter-input.mdx) --- ## PickupPointFilterInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PickupPointFilterInput { isCustom: Boolean providers: [PickupPointProviderFilterInput!] operators: [PickupPointOperatorFilterInput!] boundingBox: PickupPointBoundingBoxFilterInput distance: PickupPointDistanceFilterInput search: String country: CountryEnum postalCode: String cashOnDelivery: [PaymentMethodEnum!] hasWheelchairAccess: Boolean type: [PickupPointTypeEnum!] isOpenTwentyFourSeven: Boolean tags: [[ID!]!] } ``` ### Fields #### [PickupPointFilterInput.isCustom](#)[Boolean](/api/public/types/scalars/boolean.mdx) #### [PickupPointFilterInput.providers](#)[[PickupPointProviderFilterInput!]](/api/public/types/inputs/pickup-point-provider-filter-input.mdx) #### [PickupPointFilterInput.operators](#)[[PickupPointOperatorFilterInput!]](/api/public/types/inputs/pickup-point-operator-filter-input.mdx) #### [PickupPointFilterInput.boundingBox](#)[PickupPointBoundingBoxFilterInput](/api/public/types/inputs/pickup-point-bounding-box-filter-input.mdx) #### [PickupPointFilterInput.distance](#)[PickupPointDistanceFilterInput](/api/public/types/inputs/pickup-point-distance-filter-input.mdx) #### [PickupPointFilterInput.search](#)[String](/api/public/types/scalars/string.mdx) #### [PickupPointFilterInput.country](#)[CountryEnum](/api/public/types/enums/country-enum.mdx) #### [PickupPointFilterInput.postalCode](#)[String](/api/public/types/scalars/string.mdx) #### [PickupPointFilterInput.cashOnDelivery](#)[[PaymentMethodEnum!]](/api/public/types/enums/payment-method-enum.mdx) #### [PickupPointFilterInput.hasWheelchairAccess](#)[Boolean](/api/public/types/scalars/boolean.mdx) #### [PickupPointFilterInput.type](#)[[PickupPointTypeEnum!]](/api/public/types/enums/pickup-point-type-enum.mdx) #### [PickupPointFilterInput.isOpenTwentyFourSeven](#)[Boolean](/api/public/types/scalars/boolean.mdx) #### [PickupPointFilterInput.tags](#)[[[ID!]!]](/api/public/types/scalars/id.mdx) --- ## PickupPointOperatorFilterInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PickupPointOperatorFilterInput { operator: OperatorEnum! type: [PickupPointTypeEnum!] } ``` ### Fields #### [PickupPointOperatorFilterInput.operator](#)[OperatorEnum!](/api/public/types/enums/operator-enum.mdx) #### [PickupPointOperatorFilterInput.type](#)[[PickupPointTypeEnum!]](/api/public/types/enums/pickup-point-type-enum.mdx) ### Member Of [`PickupPointFilterInput`](/api/public/types/inputs/pickup-point-filter-input.mdx) --- ## PickupPointProviderFilterInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PickupPointProviderFilterInput { provider: ProviderEnum! type: [PickupPointTypeEnum!] } ``` ### Fields #### [PickupPointProviderFilterInput.provider](#)[ProviderEnum!](/api/public/types/scalars/provider-enum.mdx) #### [PickupPointProviderFilterInput.type](#)[[PickupPointTypeEnum!]](/api/public/types/enums/pickup-point-type-enum.mdx) ### Member Of [`PickupPointFilterInput`](/api/public/types/inputs/pickup-point-filter-input.mdx) --- ## PickupPointSortInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PickupPointSortInput { field: PickupPointSortEnum! direction: OrderDirectionEnum location: LocationInput } ``` ### Fields #### [PickupPointSortInput.field](#)[PickupPointSortEnum!](/api/public/types/enums/pickup-point-sort-enum.mdx) #### [PickupPointSortInput.direction](#)[OrderDirectionEnum](/api/public/types/enums/order-direction-enum.mdx) #### [PickupPointSortInput.location](#)[LocationInput](/api/public/types/inputs/location-input.mdx) --- ## PickupPointTagInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input PickupPointTagInput { name: String! localizations: [LocalizedStringInput!] } ``` ### Fields #### [PickupPointTagInput.name](#)[String!](/api/public/types/scalars/string.mdx) #### [PickupPointTagInput.localizations](#)[[LocalizedStringInput!]](/api/public/types/inputs/localized-string-input.mdx) ### Member Of [`SessionPickupPointTagInput`](/api/public/types/inputs/session-pickup-point-tag-input.mdx) --- ## RegisterMerchantInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input RegisterMerchantInput { name: String! email: String phone: String } ``` ### Fields #### [RegisterMerchantInput.name](#)[String!](/api/public/types/scalars/string.mdx) #### [RegisterMerchantInput.email](#)[String](/api/public/types/scalars/string.mdx) #### [RegisterMerchantInput.phone](#)[String](/api/public/types/scalars/string.mdx) ### Member Of [`register`](/api/public/operations/mutations/register.mdx) --- ## RegisterUserInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input RegisterUserInput { name: String! email: String! } ``` ### Fields #### [RegisterUserInput.name](#)[String!](/api/public/types/scalars/string.mdx) #### [RegisterUserInput.email](#)[String!](/api/public/types/scalars/string.mdx) ### Member Of [`register`](/api/public/operations/mutations/register.mdx) --- ## SessionCustomerAddressInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionCustomerAddressInput { referenceId: String label: String recipient: CustomerRecipientInput address: AddressInput! location: LocationInput } ``` ### Fields #### [SessionCustomerAddressInput.referenceId](#)[String](/api/public/types/scalars/string.mdx) #### [SessionCustomerAddressInput.label](#)[String](/api/public/types/scalars/string.mdx) #### [SessionCustomerAddressInput.recipient](#)[CustomerRecipientInput](/api/public/types/inputs/customer-recipient-input.mdx) #### [SessionCustomerAddressInput.address](#)[AddressInput!](/api/public/types/inputs/address-input.mdx) #### [SessionCustomerAddressInput.location](#)[LocationInput](/api/public/types/inputs/location-input.mdx) ### Member Of [`SessionCustomerInput`](/api/public/types/inputs/session-customer-input.mdx) --- ## SessionCustomerInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionCustomerInput { referenceId: String addresses: [SessionCustomerAddressInput!] } ``` ### Fields #### [SessionCustomerInput.referenceId](#)[String](/api/public/types/scalars/string.mdx) #### [SessionCustomerInput.addresses](#)[[SessionCustomerAddressInput!]](/api/public/types/inputs/session-customer-address-input.mdx) ### Member Of [`CreateSessionInput`](/api/public/types/inputs/create-session-input.mdx) --- ## SessionHomeDeliveryInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionHomeDeliveryInput { enabled: Boolean! recipient: CustomerRecipientInput location: Boolean providers: [ProviderEnum!] dropOffAt: DateTimeTz price: [SessionPriceInput!] zones: [SessionHomeDeliveryZoneInput!] } ``` ### Fields #### [SessionHomeDeliveryInput.enabled](#)[Boolean!](/api/public/types/scalars/boolean.mdx) #### [SessionHomeDeliveryInput.recipient](#)[CustomerRecipientInput](/api/public/types/inputs/customer-recipient-input.mdx) #### [SessionHomeDeliveryInput.location](#)[Boolean](/api/public/types/scalars/boolean.mdx) #### [SessionHomeDeliveryInput.providers](#)[[ProviderEnum!]](/api/public/types/scalars/provider-enum.mdx) #### [SessionHomeDeliveryInput.dropOffAt](#)[DateTimeTz](/api/public/types/scalars/date-time-tz.mdx) #### [SessionHomeDeliveryInput.price](#)[[SessionPriceInput!]](/api/public/types/inputs/session-price-input.mdx) #### [SessionHomeDeliveryInput.zones](#)[[SessionHomeDeliveryZoneInput!]](/api/public/types/inputs/session-home-delivery-zone-input.mdx) ### Member Of [`CreateSessionInput`](/api/public/types/inputs/create-session-input.mdx) --- ## SessionHomeDeliveryProviderFilterInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionHomeDeliveryProviderFilterInput { country: CountryEnum! postalCode: String! provider: ProviderEnum } ``` ### Fields #### [SessionHomeDeliveryProviderFilterInput.country](#)[CountryEnum!](/api/public/types/enums/country-enum.mdx) #### [SessionHomeDeliveryProviderFilterInput.postalCode](#)[String!](/api/public/types/scalars/string.mdx) #### [SessionHomeDeliveryProviderFilterInput.provider](#)[ProviderEnum](/api/public/types/scalars/provider-enum.mdx) --- ## SessionHomeDeliveryZoneInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionHomeDeliveryZoneInput { countries: [CountryEnum!]! providers: [ProviderEnum!]! } ``` ### Fields #### [SessionHomeDeliveryZoneInput.countries](#)[[CountryEnum!]!](/api/public/types/enums/country-enum.mdx) #### [SessionHomeDeliveryZoneInput.providers](#)[[ProviderEnum!]!](/api/public/types/scalars/provider-enum.mdx) ### Member Of [`SessionHomeDeliveryInput`](/api/public/types/inputs/session-home-delivery-input.mdx) --- ## SessionOriginInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionOriginInput { pickupPointId: ID address: AddressInput location: LocationInput } ``` ### Fields #### [SessionOriginInput.pickupPointId](#)[ID](/api/public/types/scalars/id.mdx) #### [SessionOriginInput.address](#)[AddressInput](/api/public/types/inputs/address-input.mdx) #### [SessionOriginInput.location](#)[LocationInput](/api/public/types/inputs/location-input.mdx) ### Member Of [`CreateSessionInput`](/api/public/types/inputs/create-session-input.mdx) --- ## SessionParcelInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionParcelInput { weight: Float! dimensions: DimensionInput! cashOnDelivery: MoneyInput value: MoneyInput insurance: MoneyInput } ``` ### Fields #### [SessionParcelInput.weight](#)[Float!](/api/public/types/scalars/float.mdx) #### [SessionParcelInput.dimensions](#)[DimensionInput!](/api/public/types/inputs/dimension-input.mdx) #### [SessionParcelInput.cashOnDelivery](#)[MoneyInput](/api/public/types/inputs/money-input.mdx) #### [SessionParcelInput.value](#)[MoneyInput](/api/public/types/inputs/money-input.mdx) #### [SessionParcelInput.insurance](#)[MoneyInput](/api/public/types/inputs/money-input.mdx) ### Member Of [`CreateSessionInput`](/api/public/types/inputs/create-session-input.mdx) --- ## SessionPickupPointCustomAllowInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionPickupPointCustomAllowInput { id: ID referenceId: ID } ``` ### Fields #### [SessionPickupPointCustomAllowInput.id](#)[ID](/api/public/types/scalars/id.mdx) #### [SessionPickupPointCustomAllowInput.referenceId](#)[ID](/api/public/types/scalars/id.mdx) ### Member Of [`SessionPickupPointCustomInput`](/api/public/types/inputs/session-pickup-point-custom-input.mdx) --- ## SessionPickupPointCustomInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionPickupPointCustomInput { enabled: Boolean! allowlist: [SessionPickupPointCustomAllowInput!] } ``` ### Fields #### [SessionPickupPointCustomInput.enabled](#)[Boolean!](/api/public/types/scalars/boolean.mdx) #### [SessionPickupPointCustomInput.allowlist](#)[[SessionPickupPointCustomAllowInput!]](/api/public/types/inputs/session-pickup-point-custom-allow-input.mdx) ### Member Of [`SessionPickupPointInput`](/api/public/types/inputs/session-pickup-point-input.mdx) --- ## SessionPickupPointDisallowInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionPickupPointDisallowInput { id: ID referenceId: ID hide: Boolean } ``` ### Fields #### [SessionPickupPointDisallowInput.id](#)[ID](/api/public/types/scalars/id.mdx) #### [SessionPickupPointDisallowInput.referenceId](#)[ID](/api/public/types/scalars/id.mdx) #### [SessionPickupPointDisallowInput.hide](#)[Boolean](/api/public/types/scalars/boolean.mdx) ### Member Of [`SessionPickupPointInput`](/api/public/types/inputs/session-pickup-point-input.mdx) --- ## SessionPickupPointInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionPickupPointInput { enabled: Boolean! recipient: CustomerRecipientInput providers: [SessionPickupPointProviderInput!] price: [SessionPickupPointPriceInput!] disallow: [SessionPickupPointDisallowInput!] tags: [SessionPickupPointTagInput!] custom: SessionPickupPointCustomInput zones: [SessionPickupPointZoneInput!] } ``` ### Fields #### [SessionPickupPointInput.enabled](#)[Boolean!](/api/public/types/scalars/boolean.mdx) #### [SessionPickupPointInput.recipient](#)[CustomerRecipientInput](/api/public/types/inputs/customer-recipient-input.mdx) #### [SessionPickupPointInput.providers](#)[[SessionPickupPointProviderInput!]](/api/public/types/inputs/session-pickup-point-provider-input.mdx) #### [SessionPickupPointInput.price](#)[[SessionPickupPointPriceInput!]](/api/public/types/inputs/session-pickup-point-price-input.mdx) #### [SessionPickupPointInput.disallow](#)[[SessionPickupPointDisallowInput!]](/api/public/types/inputs/session-pickup-point-disallow-input.mdx) #### [SessionPickupPointInput.tags](#)[[SessionPickupPointTagInput!]](/api/public/types/inputs/session-pickup-point-tag-input.mdx) #### [SessionPickupPointInput.custom](#)[SessionPickupPointCustomInput](/api/public/types/inputs/session-pickup-point-custom-input.mdx) #### [SessionPickupPointInput.zones](#)[[SessionPickupPointZoneInput!]](/api/public/types/inputs/session-pickup-point-zone-input.mdx) ### Member Of [`CreateSessionInput`](/api/public/types/inputs/create-session-input.mdx) --- ## SessionPickupPointPriceInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionPickupPointPriceInput { provider: ProviderEnum pickupPointType: PickupPointTypeEnum price: MoneyInput! } ``` ### Fields #### [SessionPickupPointPriceInput.provider](#)[ProviderEnum](/api/public/types/scalars/provider-enum.mdx) #### [SessionPickupPointPriceInput.pickupPointType](#)[PickupPointTypeEnum](/api/public/types/enums/pickup-point-type-enum.mdx) #### [SessionPickupPointPriceInput.price](#)[MoneyInput!](/api/public/types/inputs/money-input.mdx) ### Member Of [`SessionPickupPointInput`](/api/public/types/inputs/session-pickup-point-input.mdx) --- ## SessionPickupPointProviderInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionPickupPointProviderInput { provider: ProviderEnum! pickupPointTypes: [PickupPointTypeEnum!] } ``` ### Fields #### [SessionPickupPointProviderInput.provider](#)[ProviderEnum!](/api/public/types/scalars/provider-enum.mdx) #### [SessionPickupPointProviderInput.pickupPointTypes](#)[[PickupPointTypeEnum!]](/api/public/types/enums/pickup-point-type-enum.mdx) ### Member Of [`SessionPickupPointInput`](/api/public/types/inputs/session-pickup-point-input.mdx) --- ## SessionPickupPointTagInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionPickupPointTagInput { id: ID referenceId: ID tags: [PickupPointTagInput!] hide: Boolean } ``` ### Fields #### [SessionPickupPointTagInput.id](#)[ID](/api/public/types/scalars/id.mdx) #### [SessionPickupPointTagInput.referenceId](#)[ID](/api/public/types/scalars/id.mdx) #### [SessionPickupPointTagInput.tags](#)[[PickupPointTagInput!]](/api/public/types/inputs/pickup-point-tag-input.mdx) #### [SessionPickupPointTagInput.hide](#)[Boolean](/api/public/types/scalars/boolean.mdx) ### Member Of [`SessionPickupPointInput`](/api/public/types/inputs/session-pickup-point-input.mdx) --- ## SessionPickupPointZoneInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionPickupPointZoneInput { countries: [CountryEnum!]! providers: [ProviderEnum!]! } ``` ### Fields #### [SessionPickupPointZoneInput.countries](#)[[CountryEnum!]!](/api/public/types/enums/country-enum.mdx) #### [SessionPickupPointZoneInput.providers](#)[[ProviderEnum!]!](/api/public/types/scalars/provider-enum.mdx) ### Member Of [`SessionPickupPointInput`](/api/public/types/inputs/session-pickup-point-input.mdx) --- ## SessionPriceInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionPriceInput { provider: ProviderEnum price: MoneyInput! } ``` ### Fields #### [SessionPriceInput.provider](#)[ProviderEnum](/api/public/types/scalars/provider-enum.mdx) #### [SessionPriceInput.price](#)[MoneyInput!](/api/public/types/inputs/money-input.mdx) ### Member Of [`CreateSessionInput`](/api/public/types/inputs/create-session-input.mdx) [`SessionHomeDeliveryInput`](/api/public/types/inputs/session-home-delivery-input.mdx) --- ## SessionSenderInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionSenderInput { name: String! email: String phone: String bankAccountNumber: String } ``` ### Fields #### [SessionSenderInput.name](#)[String!](/api/public/types/scalars/string.mdx) #### [SessionSenderInput.email](#)[String](/api/public/types/scalars/string.mdx) #### [SessionSenderInput.phone](#)[String](/api/public/types/scalars/string.mdx) #### [SessionSenderInput.bankAccountNumber](#)[String](/api/public/types/scalars/string.mdx) ### Member Of [`CreateSessionInput`](/api/public/types/inputs/create-session-input.mdx) --- ## SessionZoneInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SessionZoneInput { countries: [CountryEnum!]! providers: [ProviderEnum!]! } ``` ### Fields #### [SessionZoneInput.countries](#)[[CountryEnum!]!](/api/public/types/enums/country-enum.mdx) #### [SessionZoneInput.providers](#)[[ProviderEnum!]!](/api/public/types/scalars/provider-enum.mdx) ### Member Of [`CreateSessionInput`](/api/public/types/inputs/create-session-input.mdx) --- ## SetAddressInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SetAddressInput { sessionId: ID! addressId: ID! provider: ProviderEnum } ``` ### Fields #### [SetAddressInput.sessionId](#)[ID!](/api/public/types/scalars/id.mdx) #### [SetAddressInput.addressId](#)[ID!](/api/public/types/scalars/id.mdx) #### [SetAddressInput.provider](#)[ProviderEnum](/api/public/types/scalars/provider-enum.mdx) ### Member Of [`setAddress`](/api/public/operations/mutations/set-address.mdx) --- ## SetGuestAddressInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SetGuestAddressInput { sessionId: ID! address: CustomerAddressInput! provider: ProviderEnum } ``` ### Fields #### [SetGuestAddressInput.sessionId](#)[ID!](/api/public/types/scalars/id.mdx) #### [SetGuestAddressInput.address](#)[CustomerAddressInput!](/api/public/types/inputs/customer-address-input.mdx) #### [SetGuestAddressInput.provider](#)[ProviderEnum](/api/public/types/scalars/provider-enum.mdx) ### Member Of [`setGuestAddress`](/api/public/operations/mutations/set-guest-address.mdx) --- ## SetHomeDeliveryProviderInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SetHomeDeliveryProviderInput { sessionId: ID! provider: ProviderEnum! } ``` ### Fields #### [SetHomeDeliveryProviderInput.sessionId](#)[ID!](/api/public/types/scalars/id.mdx) #### [SetHomeDeliveryProviderInput.provider](#)[ProviderEnum!](/api/public/types/scalars/provider-enum.mdx) ### Member Of [`setHomeDeliveryProvider`](/api/public/operations/mutations/set-home-delivery-provider.mdx) --- ## SetPickupPointInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input SetPickupPointInput { sessionId: ID! pickupPointId: ID! recipient: CustomerRecipientInput } ``` ### Fields #### [SetPickupPointInput.sessionId](#)[ID!](/api/public/types/scalars/id.mdx) #### [SetPickupPointInput.pickupPointId](#)[ID!](/api/public/types/scalars/id.mdx) #### [SetPickupPointInput.recipient](#)[CustomerRecipientInput](/api/public/types/inputs/customer-recipient-input.mdx) ### Member Of [`setPickupPoint`](/api/public/operations/mutations/set-pickup-point.mdx) --- ## TimeInput(Inputs) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input TimeInput { hour: Int! minute: Int! } ``` ### Fields #### [TimeInput.hour](#)[Int!](/api/public/types/scalars/int.mdx) #### [TimeInput.minute](#)[Int!](/api/public/types/scalars/int.mdx) ### Member Of [`OpeningHourInput`](/api/public/types/inputs/opening-hour-input.mdx) --- ## UpdateAddressInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input UpdateAddressInput { sessionId: ID! addressId: ID! address: CustomerAddressInput! } ``` ### Fields #### [UpdateAddressInput.sessionId](#)[ID!](/api/public/types/scalars/id.mdx) #### [UpdateAddressInput.addressId](#)[ID!](/api/public/types/scalars/id.mdx) #### [UpdateAddressInput.address](#)[CustomerAddressInput!](/api/public/types/inputs/customer-address-input.mdx) ### Member Of [`updateAddress`](/api/public/operations/mutations/update-address.mdx) [`UpdateAndSetAddressInput`](/api/public/types/inputs/update-and-set-address-input.mdx) --- ## UpdateAndSetAddressInput export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql input UpdateAndSetAddressInput { address: UpdateAddressInput! provider: ProviderEnum } ``` ### Fields #### [UpdateAndSetAddressInput.address](#)[UpdateAddressInput!](/api/public/types/inputs/update-address-input.mdx) #### [UpdateAndSetAddressInput.provider](#)[ProviderEnum](/api/public/types/scalars/provider-enum.mdx) ### Member Of [`updateAndSetAddress`](/api/public/operations/mutations/update-and-set-address.mdx) --- ## Address(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Address { country: CountryEnum! state: String city: String! postalCode: String! addressLine1: String! addressLine2: String note: String } ``` ### Fields #### [Address.country](#)[CountryEnum!](/api/public/types/enums/country-enum.mdx) #### [Address.state](#)[String](/api/public/types/scalars/string.mdx) #### [Address.city](#)[String!](/api/public/types/scalars/string.mdx) #### [Address.postalCode](#)[String!](/api/public/types/scalars/string.mdx) #### [Address.addressLine1](#)[String!](/api/public/types/scalars/string.mdx) #### [Address.addressLine2](#)[String](/api/public/types/scalars/string.mdx) #### [Address.note](#)[String](/api/public/types/scalars/string.mdx) ### Member Of [`CustomerAddress`](/api/public/types/objects/customer-address.mdx) [`PickupPoint`](/api/public/types/objects/pickup-point.mdx) [`What3WordSquare`](/api/public/types/objects/what-3-word-square.mdx) --- ## CustomerAddress export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type CustomerAddress { id: ID referenceId: String label: String recipient: CustomerRecipient address: Address! location: Location } ``` ### Fields #### [CustomerAddress.id](#)[ID](/api/public/types/scalars/id.mdx) #### [CustomerAddress.referenceId](#)[String](/api/public/types/scalars/string.mdx) #### [CustomerAddress.label](#)[String](/api/public/types/scalars/string.mdx) #### [CustomerAddress.recipient](#)[CustomerRecipient](/api/public/types/objects/customer-recipient.mdx) #### [CustomerAddress.address](#)[Address!](/api/public/types/objects/address.mdx) #### [CustomerAddress.location](#)[Location](/api/public/types/objects/location.mdx) ### Returned By [`addresses`](/api/public/operations/queries/addresses.mdx) [`createAddress`](/api/public/operations/mutations/create-address.mdx) [`updateAddress`](/api/public/operations/mutations/update-address.mdx) ### Member Of [`Customer`](/api/public/types/objects/customer.mdx) [`SessionAddress`](/api/public/types/objects/session-address.mdx) [`SessionHomeDeliveryAddress`](/api/public/types/objects/session-home-delivery-address.mdx) --- ## CustomerRecipient export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type CustomerRecipient { firstName: String lastName: String name: String language: LanguageEnum email: String phone: String } ``` ### Fields #### [CustomerRecipient.firstName](#)[String](/api/public/types/scalars/string.mdx) #### [CustomerRecipient.lastName](#)[String](/api/public/types/scalars/string.mdx) #### [CustomerRecipient.name](#)[String](/api/public/types/scalars/string.mdx) #### [CustomerRecipient.language](#)[LanguageEnum](/api/public/types/enums/language-enum.mdx) #### [CustomerRecipient.email](#)[String](/api/public/types/scalars/string.mdx) #### [CustomerRecipient.phone](#)[String](/api/public/types/scalars/string.mdx) ### Member Of [`CustomerAddress`](/api/public/types/objects/customer-address.mdx) [`SessionHomeDelivery`](/api/public/types/objects/session-home-delivery.mdx) [`SessionPickupPoint`](/api/public/types/objects/session-pickup-point.mdx) --- ## Customer export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Customer { addresses: [CustomerAddress!] } ``` ### Fields #### [Customer.addresses](#)[[CustomerAddress!]](/api/public/types/objects/customer-address.mdx) ### Member Of [`SessionHomeDelivery`](/api/public/types/objects/session-home-delivery.mdx) [`SessionPickupPoint`](/api/public/types/objects/session-pickup-point.mdx) --- ## Dimension(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Dimension { width: Float! length: Float! height: Float! } ``` ### Fields #### [Dimension.width](#)[Float!](/api/public/types/scalars/float.mdx) #### [Dimension.length](#)[Float!](/api/public/types/scalars/float.mdx) #### [Dimension.height](#)[Float!](/api/public/types/scalars/float.mdx) --- ## FloatRange(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type FloatRange { start: Float! end: Float! } ``` ### Fields #### [FloatRange.start](#)[Float!](/api/public/types/scalars/float.mdx) #### [FloatRange.end](#)[Float!](/api/public/types/scalars/float.mdx) ### Member Of [`MoneyRange`](/api/public/types/objects/money-range.mdx) --- ## KeyValue(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type KeyValue { key: String! value: String! } ``` ### Fields #### [KeyValue.key](#)[String!](/api/public/types/scalars/string.mdx) #### [KeyValue.value](#)[String!](/api/public/types/scalars/string.mdx) ### Member Of [`PickupPoint`](/api/public/types/objects/pickup-point.mdx) --- ## Location(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Location { latitude: Float! longitude: Float! } ``` ### Fields #### [Location.latitude](#)[Float!](/api/public/types/scalars/float.mdx) #### [Location.longitude](#)[Float!](/api/public/types/scalars/float.mdx) ### Member Of [`CustomerAddress`](/api/public/types/objects/customer-address.mdx) [`PickupPoint`](/api/public/types/objects/pickup-point.mdx) [`What3WordSquare`](/api/public/types/objects/what-3-word-square.mdx) --- ## Merchant(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Merchant { id: ID! name: String! icon: String } ``` ### Fields #### [Merchant.id](#)[ID!](/api/public/types/scalars/id.mdx) #### [Merchant.name](#)[String!](/api/public/types/scalars/string.mdx) #### [Merchant.icon](#)[String](/api/public/types/scalars/string.mdx) ### Member Of [`Registration`](/api/public/types/objects/registration.mdx) [`SessionPickupPoint`](/api/public/types/objects/session-pickup-point.mdx) --- ## MoneyRange(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type MoneyRange { amount: FloatRange! currency: CurrencyEnum! } ``` ### Fields #### [MoneyRange.amount](#)[FloatRange!](/api/public/types/objects/float-range.mdx) #### [MoneyRange.currency](#)[CurrencyEnum!](/api/public/types/enums/currency-enum.mdx) ### Member Of [`SessionPickupPointCustom`](/api/public/types/objects/session-pickup-point-custom.mdx) [`SessionPickupPointOperator`](/api/public/types/objects/session-pickup-point-operator.mdx) [`SessionPickupPointProvider`](/api/public/types/objects/session-pickup-point-provider.mdx) ### Implemented By [`MoneyOrMoneyRange`](/api/public/types/unions/money-or-money-range.mdx) --- ## Money(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Money { amount: Float! currency: CurrencyEnum! } ``` ### Fields #### [Money.amount](#)[Float!](/api/public/types/scalars/float.mdx) #### [Money.currency](#)[CurrencyEnum!](/api/public/types/enums/currency-enum.mdx) ### Member Of [`PickupPoint`](/api/public/types/objects/pickup-point.mdx) [`SessionHomeDeliveryAddressProvider`](/api/public/types/objects/session-home-delivery-address-provider.mdx) ### Implemented By [`MoneyOrMoneyRange`](/api/public/types/unions/money-or-money-range.mdx) --- ## OpeningHour(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type OpeningHour { day: DayEnum! start: Time! end: Time! } ``` ### Fields #### [OpeningHour.day](#)[DayEnum!](/api/public/types/enums/day-enum.mdx) #### [OpeningHour.start](#)[Time!](/api/public/types/objects/time.mdx) #### [OpeningHour.end](#)[Time!](/api/public/types/objects/time.mdx) ### Member Of [`PickupPoint`](/api/public/types/objects/pickup-point.mdx) --- ## Operator(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Operator { operator: OperatorEnum! name: String! icon: String } ``` ### Fields #### [Operator.operator](#)[OperatorEnum!](/api/public/types/enums/operator-enum.mdx) #### [Operator.name](#)[String!](/api/public/types/scalars/string.mdx) #### [Operator.icon](#)[String](/api/public/types/scalars/string.mdx) ### Member Of [`PickupPoint`](/api/public/types/objects/pickup-point.mdx) [`SessionPickupPointOperator`](/api/public/types/objects/session-pickup-point-operator.mdx) --- ## PaginatorInfo(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; Information about pagination using a fully featured paginator. ```graphql type PaginatorInfo { count: Int! currentPage: Int! firstItem: Int hasMorePages: Boolean! lastItem: Int lastPage: Int! perPage: Int! total: Int! } ``` ### Fields #### [PaginatorInfo.count](#)[Int!](/api/public/types/scalars/int.mdx) Number of items in the current page. #### [PaginatorInfo.currentPage](#)[Int!](/api/public/types/scalars/int.mdx) Index of the current page. #### [PaginatorInfo.firstItem](#)[Int](/api/public/types/scalars/int.mdx) Index of the first item in the current page. #### [PaginatorInfo.hasMorePages](#)[Boolean!](/api/public/types/scalars/boolean.mdx) Are there more pages after this one? #### [PaginatorInfo.lastItem](#)[Int](/api/public/types/scalars/int.mdx) Index of the last item in the current page. #### [PaginatorInfo.lastPage](#)[Int!](/api/public/types/scalars/int.mdx) Index of the last available page. #### [PaginatorInfo.perPage](#)[Int!](/api/public/types/scalars/int.mdx) Number of items per page. #### [PaginatorInfo.total](#)[Int!](/api/public/types/scalars/int.mdx) Number of total available items. ### Member Of [`PickupPointPaginator`](/api/public/types/objects/pickup-point-paginator.mdx) --- ## PartialAddress(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type PartialAddress { country: CountryEnum state: String city: String postalCode: String addressLine1: String addressLine2: String note: String } ``` ### Fields #### [PartialAddress.country](#)[CountryEnum](/api/public/types/enums/country-enum.mdx) #### [PartialAddress.state](#)[String](/api/public/types/scalars/string.mdx) #### [PartialAddress.city](#)[String](/api/public/types/scalars/string.mdx) #### [PartialAddress.postalCode](#)[String](/api/public/types/scalars/string.mdx) #### [PartialAddress.addressLine1](#)[String](/api/public/types/scalars/string.mdx) #### [PartialAddress.addressLine2](#)[String](/api/public/types/scalars/string.mdx) #### [PartialAddress.note](#)[String](/api/public/types/scalars/string.mdx) --- ## PickupPointPaginator(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; A paginated list of PickupPoint items. ```graphql type PickupPointPaginator { paginatorInfo: PaginatorInfo! data: [PickupPoint!]! } ``` ### Fields #### [PickupPointPaginator.paginatorInfo](#)[PaginatorInfo!](/api/public/types/objects/paginator-info.mdx) Pagination information about the list of items. #### [PickupPointPaginator.data](#)[[PickupPoint!]!](/api/public/types/objects/pickup-point.mdx) A list of PickupPoint items. ### Member Of [`SessionPickupPointList`](/api/public/types/objects/session-pickup-point-list.mdx) --- ## PickupPointTag(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type PickupPointTag { id: ID! name: String! } ``` ### Fields #### [PickupPointTag.id](#)[ID!](/api/public/types/scalars/id.mdx) #### [PickupPointTag.name](#)[String!](/api/public/types/scalars/string.mdx) ### Member Of [`PickupPoint`](/api/public/types/objects/pickup-point.mdx) [`SessionPickupPoint`](/api/public/types/objects/session-pickup-point.mdx) --- ## PickupPoint(3) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type PickupPoint { isCustom: Boolean! icon: String provider: Provider operator: Operator type: PickupPointTypeEnum id: ID! pid: Int! name: String! address: Address! location: Location! phone: String openingHours( timezone: TimezoneEnum ): [OpeningHour!]! isOpen( timestamp: DateTimeTz ): Boolean! isOpenTwentyFourSeven: Boolean! distance( location: LocationInput! ): Int! requiredAddressFields: [AddressFieldEnum!] price: Money cashOnDelivery: [PaymentMethodEnum!] hasWheelchairAccess: Boolean load: Float images: [String!] extra: [KeyValue!] referenceId: ID! isAvailable: Boolean! tags: [PickupPointTag!] } ``` ### Fields #### [PickupPoint.isCustom](#)[Boolean!](/api/public/types/scalars/boolean.mdx) #### [PickupPoint.icon](#)[String](/api/public/types/scalars/string.mdx) #### [PickupPoint.provider](#)[Provider](/api/public/types/objects/provider.mdx) #### [PickupPoint.operator](#)[Operator](/api/public/types/objects/operator.mdx) #### [PickupPoint.type](#)[PickupPointTypeEnum](/api/public/types/enums/pickup-point-type-enum.mdx) #### [PickupPoint.id](#)[ID!](/api/public/types/scalars/id.mdx) #### [PickupPoint.pid](#)[Int!](/api/public/types/scalars/int.mdx) #### [PickupPoint.name](#)[String!](/api/public/types/scalars/string.mdx) #### [PickupPoint.address](#)[Address!](/api/public/types/objects/address.mdx) #### [PickupPoint.location](#)[Location!](/api/public/types/objects/location.mdx) #### [PickupPoint.phone](#)[String](/api/public/types/scalars/string.mdx) #### [PickupPoint.openingHours](#)[[OpeningHour!]!](/api/public/types/objects/opening-hour.mdx) ##### [PickupPoint.openingHours.timezone](#)[TimezoneEnum](/api/public/types/enums/timezone-enum.mdx) #### [PickupPoint.isOpen](#)[Boolean!](/api/public/types/scalars/boolean.mdx) ##### [PickupPoint.isOpen.timestamp](#)[DateTimeTz](/api/public/types/scalars/date-time-tz.mdx) #### [PickupPoint.isOpenTwentyFourSeven](#)[Boolean!](/api/public/types/scalars/boolean.mdx) #### [PickupPoint.distance](#)[Int!](/api/public/types/scalars/int.mdx) ##### [PickupPoint.distance.location](#)[LocationInput!](/api/public/types/inputs/location-input.mdx) #### [PickupPoint.requiredAddressFields](#)[[AddressFieldEnum!]](/api/public/types/enums/address-field-enum.mdx) #### [PickupPoint.price](#)[Money](/api/public/types/objects/money.mdx) #### [PickupPoint.cashOnDelivery](#)[[PaymentMethodEnum!]](/api/public/types/enums/payment-method-enum.mdx) #### [PickupPoint.hasWheelchairAccess](#)[Boolean](/api/public/types/scalars/boolean.mdx) #### [PickupPoint.load](#)[Float](/api/public/types/scalars/float.mdx) #### [PickupPoint.images](#)[[String!]](/api/public/types/scalars/string.mdx) #### [PickupPoint.extra](#)[[KeyValue!]](/api/public/types/objects/key-value.mdx) #### [PickupPoint.referenceId](#)[ID!](/api/public/types/scalars/id.mdx) #### [PickupPoint.isAvailable](#)[Boolean!](/api/public/types/scalars/boolean.mdx) #### [PickupPoint.tags](#)[[PickupPointTag!]](/api/public/types/objects/pickup-point-tag.mdx) ### Member Of [`PickupPointPaginator`](/api/public/types/objects/pickup-point-paginator.mdx) [`SessionPickupPoint`](/api/public/types/objects/session-pickup-point.mdx) [`SessionPickupPointList`](/api/public/types/objects/session-pickup-point-list.mdx) --- ## Provider(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Provider { provider: ProviderEnum! name: String! icon: String information: String } ``` ### Fields #### [Provider.provider](#)[ProviderEnum!](/api/public/types/scalars/provider-enum.mdx) #### [Provider.name](#)[String!](/api/public/types/scalars/string.mdx) #### [Provider.icon](#)[String](/api/public/types/scalars/string.mdx) #### [Provider.information](#)[String](/api/public/types/scalars/string.mdx) ### Member Of [`PickupPoint`](/api/public/types/objects/pickup-point.mdx) [`SessionHomeDeliveryAddressProvider`](/api/public/types/objects/session-home-delivery-address-provider.mdx) [`SessionHomeDeliveryProvider`](/api/public/types/objects/session-home-delivery-provider.mdx) [`SessionPickupPointProvider`](/api/public/types/objects/session-pickup-point-provider.mdx) --- ## Registration export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Registration { merchant: Merchant! user: User! token: Token! } ``` ### Fields #### [Registration.merchant](#)[Merchant!](/api/public/types/objects/merchant.mdx) #### [Registration.user](#)[User!](/api/public/types/objects/user.mdx) #### [Registration.token](#)[Token!](/api/public/types/objects/token.mdx) ### Returned By [`register`](/api/public/operations/mutations/register.mdx) --- ## SessionAddress export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type SessionAddress { session: Session! address: CustomerAddress! } ``` ### Fields #### [SessionAddress.session](#)[Session!](/api/public/types/objects/session.mdx) #### [SessionAddress.address](#)[CustomerAddress!](/api/public/types/objects/customer-address.mdx) ### Returned By [`createAndSetAddress`](/api/public/operations/mutations/create-and-set-address.mdx) [`updateAndSetAddress`](/api/public/operations/mutations/update-and-set-address.mdx) --- ## SessionAnalytics export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type SessionAnalytics { userId: ID anonymousId: ID merchantId: ID! } ``` ### Fields #### [SessionAnalytics.userId](#)[ID](/api/public/types/scalars/id.mdx) #### [SessionAnalytics.anonymousId](#)[ID](/api/public/types/scalars/id.mdx) #### [SessionAnalytics.merchantId](#)[ID!](/api/public/types/scalars/id.mdx) ### Member Of [`Session`](/api/public/types/objects/session.mdx) --- ## SessionHomeDeliveryAddressProvider export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type SessionHomeDeliveryAddressProvider { provider: Provider! selected: Boolean! price: Money requiredAddressFields: [AddressFieldEnum!] } ``` ### Fields #### [SessionHomeDeliveryAddressProvider.provider](#)[Provider!](/api/public/types/objects/provider.mdx) #### [SessionHomeDeliveryAddressProvider.selected](#)[Boolean!](/api/public/types/scalars/boolean.mdx) #### [SessionHomeDeliveryAddressProvider.price](#)[Money](/api/public/types/objects/money.mdx) #### [SessionHomeDeliveryAddressProvider.requiredAddressFields](#)[[AddressFieldEnum!]](/api/public/types/enums/address-field-enum.mdx) ### Member Of [`SessionHomeDeliveryAddress`](/api/public/types/objects/session-home-delivery-address.mdx) --- ## SessionHomeDeliveryAddress export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type SessionHomeDeliveryAddress { address: CustomerAddress! providers: [SessionHomeDeliveryAddressProvider!] selected: SessionHomeDeliveryAddressProvider } ``` ### Fields #### [SessionHomeDeliveryAddress.address](#)[CustomerAddress!](/api/public/types/objects/customer-address.mdx) #### [SessionHomeDeliveryAddress.providers](#)[[SessionHomeDeliveryAddressProvider!]](/api/public/types/objects/session-home-delivery-address-provider.mdx) #### [SessionHomeDeliveryAddress.selected](#)[SessionHomeDeliveryAddressProvider](/api/public/types/objects/session-home-delivery-address-provider.mdx) ### Member Of [`SessionHomeDelivery`](/api/public/types/objects/session-home-delivery.mdx) --- ## SessionHomeDeliveryProvider export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type SessionHomeDeliveryProvider { provider: Provider! price: MoneyOrMoneyRange requiredAddressFields: [AddressFieldEnum!] } ``` ### Fields #### [SessionHomeDeliveryProvider.provider](#)[Provider!](/api/public/types/objects/provider.mdx) #### [SessionHomeDeliveryProvider.price](#)[MoneyOrMoneyRange](/api/public/types/unions/money-or-money-range.mdx) #### [SessionHomeDeliveryProvider.requiredAddressFields](#)[[AddressFieldEnum!]](/api/public/types/enums/address-field-enum.mdx) ### Member Of [`SessionHomeDelivery`](/api/public/types/objects/session-home-delivery.mdx) --- ## SessionHomeDelivery export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type SessionHomeDelivery { enabled: Boolean! customer: Customer providers( filter: SessionHomeDeliveryProviderFilterInput ): [SessionHomeDeliveryProvider!] location: Boolean recipient: CustomerRecipient alwaysConfirmRecipient: Boolean selected: SessionHomeDeliveryAddress title: String information: String } ``` ### Fields #### [SessionHomeDelivery.enabled](#)[Boolean!](/api/public/types/scalars/boolean.mdx) #### [SessionHomeDelivery.customer](#)[Customer](/api/public/types/objects/customer.mdx) #### [SessionHomeDelivery.providers](#)[[SessionHomeDeliveryProvider!]](/api/public/types/objects/session-home-delivery-provider.mdx) ##### [SessionHomeDelivery.providers.filter](#)[SessionHomeDeliveryProviderFilterInput](/api/public/types/inputs/session-home-delivery-provider-filter-input.mdx) #### [SessionHomeDelivery.location](#)[Boolean](/api/public/types/scalars/boolean.mdx) #### [SessionHomeDelivery.recipient](#)[CustomerRecipient](/api/public/types/objects/customer-recipient.mdx) #### [SessionHomeDelivery.alwaysConfirmRecipient](#)[Boolean](/api/public/types/scalars/boolean.mdx) #### [SessionHomeDelivery.selected](#)[SessionHomeDeliveryAddress](/api/public/types/objects/session-home-delivery-address.mdx) #### [SessionHomeDelivery.title](#)[String](/api/public/types/scalars/string.mdx) #### [SessionHomeDelivery.information](#)[String](/api/public/types/scalars/string.mdx) ### Member Of [`Session`](/api/public/types/objects/session.mdx) --- ## SessionPickupPointCustom export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type SessionPickupPointCustom { enabled: Boolean! title: String information: String price: MoneyRange } ``` ### Fields #### [SessionPickupPointCustom.enabled](#)[Boolean!](/api/public/types/scalars/boolean.mdx) #### [SessionPickupPointCustom.title](#)[String](/api/public/types/scalars/string.mdx) #### [SessionPickupPointCustom.information](#)[String](/api/public/types/scalars/string.mdx) #### [SessionPickupPointCustom.price](#)[MoneyRange](/api/public/types/objects/money-range.mdx) ### Member Of [`SessionPickupPoint`](/api/public/types/objects/session-pickup-point.mdx) --- ## SessionPickupPointListMapCustom export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type SessionPickupPointListMapCustom { pid: Int! lat: Float! lng: Float! icn: String } ``` ### Fields #### [SessionPickupPointListMapCustom.pid](#)[Int!](/api/public/types/scalars/int.mdx) #### [SessionPickupPointListMapCustom.lat](#)[Float!](/api/public/types/scalars/float.mdx) #### [SessionPickupPointListMapCustom.lng](#)[Float!](/api/public/types/scalars/float.mdx) #### [SessionPickupPointListMapCustom.icn](#)[String](/api/public/types/scalars/string.mdx) ### Member Of [`SessionPickupPointListMap`](/api/public/types/objects/session-pickup-point-list-map.mdx) --- ## SessionPickupPointListMap export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type SessionPickupPointListMap { custom: [SessionPickupPointListMapCustom!]! common: [Int!]! disallowed: [Int!]! } ``` ### Fields #### [SessionPickupPointListMap.custom](#)[[SessionPickupPointListMapCustom!]!](/api/public/types/objects/session-pickup-point-list-map-custom.mdx) #### [SessionPickupPointListMap.common](#)[[Int!]!](/api/public/types/scalars/int.mdx) #### [SessionPickupPointListMap.disallowed](#)[[Int!]!](/api/public/types/scalars/int.mdx) ### Member Of [`SessionPickupPointList`](/api/public/types/objects/session-pickup-point-list.mdx) --- ## SessionPickupPointList export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type SessionPickupPointList { recommended: [PickupPoint!] map: SessionPickupPointListMap! points( first: Int! page: Int ): PickupPointPaginator! } ``` ### Fields #### [SessionPickupPointList.recommended](#)[[PickupPoint!]](/api/public/types/objects/pickup-point.mdx) #### [SessionPickupPointList.map](#)[SessionPickupPointListMap!](/api/public/types/objects/session-pickup-point-list-map.mdx) #### [SessionPickupPointList.points](#)[PickupPointPaginator!](/api/public/types/objects/pickup-point-paginator.mdx) ##### [SessionPickupPointList.points.first](#)[Int!](/api/public/types/scalars/int.mdx) Limits number of fetched items. ##### [SessionPickupPointList.points.page](#)[Int](/api/public/types/scalars/int.mdx) The offset from which items are returned. ### Member Of [`SessionPickupPoint`](/api/public/types/objects/session-pickup-point.mdx) --- ## SessionPickupPointOperator export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type SessionPickupPointOperator { operator: Operator! pickupPointTypes: [PickupPointTypeEnum!] price: MoneyRange } ``` ### Fields #### [SessionPickupPointOperator.operator](#)[Operator!](/api/public/types/objects/operator.mdx) #### [SessionPickupPointOperator.pickupPointTypes](#)[[PickupPointTypeEnum!]](/api/public/types/enums/pickup-point-type-enum.mdx) #### [SessionPickupPointOperator.price](#)[MoneyRange](/api/public/types/objects/money-range.mdx) ### Member Of [`SessionPickupPoint`](/api/public/types/objects/session-pickup-point.mdx) --- ## SessionPickupPointProvider export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type SessionPickupPointProvider { provider: Provider! pickupPointTypes: [PickupPointTypeEnum!] price: MoneyRange } ``` ### Fields #### [SessionPickupPointProvider.provider](#)[Provider!](/api/public/types/objects/provider.mdx) #### [SessionPickupPointProvider.pickupPointTypes](#)[[PickupPointTypeEnum!]](/api/public/types/enums/pickup-point-type-enum.mdx) #### [SessionPickupPointProvider.price](#)[MoneyRange](/api/public/types/objects/money-range.mdx) ### Member Of [`SessionPickupPoint`](/api/public/types/objects/session-pickup-point.mdx) --- ## SessionPickupPoint export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type SessionPickupPoint { enabled: Boolean! customer: Customer merchant: Merchant! custom: SessionPickupPointCustom! providers: [SessionPickupPointProvider!] operators: [SessionPickupPointOperator!] pickupPoints( filters: PickupPointFilterInput sortBy: PickupPointSortInput ): SessionPickupPointList! pickupPoint( id: ID! ): PickupPoint pickupPointByPid( id: Int! ): PickupPoint recipient: CustomerRecipient alwaysConfirmRecipient: Boolean selected: PickupPoint title: String information: String tags: [[PickupPointTag!]!] } ``` ### Fields #### [SessionPickupPoint.enabled](#)[Boolean!](/api/public/types/scalars/boolean.mdx) #### [SessionPickupPoint.customer](#)[Customer](/api/public/types/objects/customer.mdx) #### [SessionPickupPoint.merchant](#)[Merchant!](/api/public/types/objects/merchant.mdx) #### [SessionPickupPoint.custom](#)[SessionPickupPointCustom!](/api/public/types/objects/session-pickup-point-custom.mdx) #### [SessionPickupPoint.providers](#)[[SessionPickupPointProvider!]](/api/public/types/objects/session-pickup-point-provider.mdx) #### [SessionPickupPoint.operators](#)[[SessionPickupPointOperator!]](/api/public/types/objects/session-pickup-point-operator.mdx) #### [SessionPickupPoint.pickupPoints](#)[SessionPickupPointList!](/api/public/types/objects/session-pickup-point-list.mdx) ##### [SessionPickupPoint.pickupPoints.filters](#)[PickupPointFilterInput](/api/public/types/inputs/pickup-point-filter-input.mdx) ##### [SessionPickupPoint.pickupPoints.sortBy](#)[PickupPointSortInput](/api/public/types/inputs/pickup-point-sort-input.mdx) #### [SessionPickupPoint.pickupPoint](#)[PickupPoint](/api/public/types/objects/pickup-point.mdx) ##### [SessionPickupPoint.pickupPoint.id](#)[ID!](/api/public/types/scalars/id.mdx) #### [SessionPickupPoint.pickupPointByPid](#)[PickupPoint](/api/public/types/objects/pickup-point.mdx) ##### [SessionPickupPoint.pickupPointByPid.id](#)[Int!](/api/public/types/scalars/int.mdx) #### [SessionPickupPoint.recipient](#)[CustomerRecipient](/api/public/types/objects/customer-recipient.mdx) #### [SessionPickupPoint.alwaysConfirmRecipient](#)[Boolean](/api/public/types/scalars/boolean.mdx) #### [SessionPickupPoint.selected](#)[PickupPoint](/api/public/types/objects/pickup-point.mdx) #### [SessionPickupPoint.title](#)[String](/api/public/types/scalars/string.mdx) #### [SessionPickupPoint.information](#)[String](/api/public/types/scalars/string.mdx) #### [SessionPickupPoint.tags](#)[[[PickupPointTag!]!]](/api/public/types/objects/pickup-point-tag.mdx) ### Member Of [`Session`](/api/public/types/objects/session.mdx) --- ## Session(4) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Session { id: ID! currency: CurrencyEnum language: LanguageEnum isGuest: Boolean! homeDelivery: SessionHomeDelivery! pickupPoint: SessionPickupPoint! analytics: SessionAnalytics! themes: [Theme!]! sdk: String! } ``` ### Fields #### [Session.id](#)[ID!](/api/public/types/scalars/id.mdx) #### [Session.currency](#)[CurrencyEnum](/api/public/types/enums/currency-enum.mdx) #### [Session.language](#)[LanguageEnum](/api/public/types/enums/language-enum.mdx) #### [Session.isGuest](#)[Boolean!](/api/public/types/scalars/boolean.mdx) #### [Session.homeDelivery](#)[SessionHomeDelivery!](/api/public/types/objects/session-home-delivery.mdx) #### [Session.pickupPoint](#)[SessionPickupPoint!](/api/public/types/objects/session-pickup-point.mdx) #### [Session.analytics](#)[SessionAnalytics!](/api/public/types/objects/session-analytics.mdx) #### [Session.themes](#)[[Theme!]!](/api/public/types/objects/theme.mdx) #### [Session.sdk](#)[String!](/api/public/types/scalars/string.mdx) ### Returned By [`createSession`](/api/public/operations/mutations/create-session.mdx) [`deleteAndUnsetAddress`](/api/public/operations/mutations/delete-and-unset-address.mdx) [`session`](/api/public/operations/queries/session.mdx) [`setAddress`](/api/public/operations/mutations/set-address.mdx) [`setGuestAddress`](/api/public/operations/mutations/set-guest-address.mdx) [`setHomeDeliveryProvider`](/api/public/operations/mutations/set-home-delivery-provider.mdx) [`setPickupPoint`](/api/public/operations/mutations/set-pickup-point.mdx) ### Member Of [`SessionAddress`](/api/public/types/objects/session-address.mdx) --- ## Theme(3) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Theme { handle: ID! url: String! isDefault: Boolean! } ``` ### Fields #### [Theme.handle](#)[ID!](/api/public/types/scalars/id.mdx) #### [Theme.url](#)[String!](/api/public/types/scalars/string.mdx) #### [Theme.isDefault](#)[Boolean!](/api/public/types/scalars/boolean.mdx) ### Member Of [`Session`](/api/public/types/objects/session.mdx) --- ## Time(Objects) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Time { hour: Int! minute: Int! } ``` ### Fields #### [Time.hour](#)[Int!](/api/public/types/scalars/int.mdx) #### [Time.minute](#)[Int!](/api/public/types/scalars/int.mdx) ### Member Of [`OpeningHour`](/api/public/types/objects/opening-hour.mdx) --- ## Token(3) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type Token { id: ID! name: String! } ``` ### Fields #### [Token.id](#)[ID!](/api/public/types/scalars/id.mdx) #### [Token.name](#)[String!](/api/public/types/scalars/string.mdx) ### Member Of [`Registration`](/api/public/types/objects/registration.mdx) --- ## User(3) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type User { id: ID! name: String! email: String! } ``` ### Fields #### [User.id](#)[ID!](/api/public/types/scalars/id.mdx) #### [User.name](#)[String!](/api/public/types/scalars/string.mdx) #### [User.email](#)[String!](/api/public/types/scalars/string.mdx) ### Member Of [`Registration`](/api/public/types/objects/registration.mdx) --- ## What3WordSquare export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql type What3WordSquare { address: Address! location: Location! } ``` ### Fields #### [What3WordSquare.address](#)[Address!](/api/public/types/objects/address.mdx) #### [What3WordSquare.location](#)[Location!](/api/public/types/objects/location.mdx) ### Returned By [`what3words`](/api/public/operations/queries/what-3-words.mdx) --- ## MoneyOrMoneyRange(Unions) export const Bullet = () => <> ●  export const SpecifiedBy = (props) => <>Specification⎘ export const Badge = (props) => <>{props.text} export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => { const [open, setOpen] = useState(startOpen); return (
{ e.preventDefault(); setOpen((open) => !open); }} style={{ listStyle:'none' }} > {open ? dataOpen : dataClose} {open && children}
); }; No description ```graphql union MoneyOrMoneyRange = Money | MoneyRange ``` ### Possible types #### [MoneyOrMoneyRange.Money](/api/public/types/objects/money.mdx) #### [MoneyOrMoneyRange.MoneyRange](/api/public/types/objects/money-range.mdx) ### Member Of [`SessionHomeDeliveryProvider`](/api/public/types/objects/session-home-delivery-provider.mdx) --- ## Merchant(Concepts) In the Delivery Gateway system, the merchant is your e-commerce platform or platforms. That is to say, the merchant is the entity that accepts orders from customers and contracts with logistics providers to deliver those orders. The merchant configuration provides a set of default settings for a number of Delivery Gateway features. It allows you to provide information that can be reused for any delivery. ## The merchant ID The merchant ID is your merchant's unique identifier. It is automatically generated when you register a new merchant, and it is used to identify the merchant to the Web Plugin and the Merchant API. The easiest, most convenient way of accessing Delivery Gateway features is to use a lightweight frontend integration, utilizing our embedded UI: you can use the merchant ID to connect your merchant to the integration. For more information, check out [Frontend integration](/dev/how-tos/frontend-integration). For backend integration, the Merchant API also uses the ID to identify your merchant. You can query it in the `id` field of the `Merchant` object type. :::important You can't change your merchant ID. ::: ## Merchant configuration :::note This section is about merchant configuration via the Merchant API. For information on how to configure your merchant in the Admin dashboard, see [Merchant configuration](/admin/how-tos/merchant-config). ::: With the Merchant API, you can create and update your merchant configuration via the `Merchant` object type. Merchant configuration queries and mutations both have two required fields for each configuration object: - `key`: The enumerator for a given configuration option: [MerchantConfigurationEnum](/api/merchant/types/enums/merchant-configuration-enum). - `value`: The value of that configuration option. For example, you can configure a default currency for your merchant. The `key` field in the configuration is `CURRENCY`. The `value` field will contain the currency code of your preferred currency. To query the `Merchant` object type, you can use the `me` keyword. Let's query the currency with the `configuration` field that takes a `key` argument: ```graphql title="GraphQL query" query { me { configuration(key: CURRENCY) { key value } } } ``` ```json title="JSON response" { "data": { "me": { "configuration": { "key": "CURRENCY", "value": "EUR" } } } } ``` You can also query multiple or even all merchant configurations with the `configurations` field. Both `configuration` and `configurations` has, in addition to `key` and `value`, subfields for the default value and the description of the configuration option. Let's list all the options: ```graphql title="GraphQL query" query { me { configurations { key description value default } } } ``` ```json title="JSON response" { "data": { "me": { "configurations": [ { "key": "UI_ALLOWED_REFERRERS", "description": "Allowed HTTP referrers for embedded UI", "value": "", "default": null }, { "key": "SENDER_NAME", "description": "Default sender name for shipments", "value": "Ny Shop's Name", "default": null }, { "key": "FORCE_DEFAULT_SENDER", "description": "Always send shipment with the default sender", "value": "true", "default": "false" }, { "key": "SENDER_EMAIL", "description": "Default sender email for shipments", "value": "example@email.com", "default": null }, ] } } } ``` You can update the merchant configuration at any time with the `updateMerchantConfiguration` mutation. It allows you to update one setting at a time. Let's change the currency to USD: ```graphql title="GraphQL mutation" mutation { updateMerchantConfiguration( input: { key: CURRENCY, value: "USD", } ) { key value } } ``` ```json title="JSON response" { "data": { "updateMerchantConfiguration": { "key": "CURRENCY", "value": "USD" } } } ``` --- ## Providers(Concepts) A provider is a logistics provider: a company that provides shipping and delivery, including home delivery and pickup point delivery. Delivery Gateway connects e-commerce platforms - called merchants in our system - with providers, allowing a seamless connection to all your partners via a single platform. ## Providers vs operators Providers and operators both play an important part in the Delivery Gateway ecosystem but they are quite different. Providers are the companies that ship your products: they deliver to the customer's address or to a pickup location. Operators, on the other hand, manage delivery pickup location such as parcel lockers or physical stores. A company can be a provider and an operator at the same time: for example, several providers have their own parcel locker system. ## Provider configuration :::note This section is about provider configuration via the Merchant API. For information on how to configure your merchant in the Admin dashboard, see [Provider configuration](/admin/how-tos/provider-config). ::: Delivery Gateway offers a large number of providers. After providing the right credentials, you can enable any of them to use for deliveries. You can also add custom providers. With the Merchant API, you can create and update your provider configuration via the `Provider` object type. Each provider can be configured separately, based on their `id`: ```graphql title="GraphQL query" query { providers { id name icon isEnabled isAvailable } } ``` ```json title="JSON response" { "data": { "providers": [ { "id": "Best Prov Inc" }, { "id": "Second Best Prov Inc" }, ] } } ``` Provider configuration works similarly to the merchant configuration: the `configurations` field takes a `ProviderConfiguration` object type with two required subfields: - `key`: The enumerator for a given configuration option, for example, `PICKUP_POINT_INFORMATION`. Check the available options here: [ProviderConfigurationEnum](/api/merchant/types/enums/provider-configuration-enum). - `value`: The value of that configuration option. For example, the text of the pickup point information. You can query the configuration of every provider: ```graphql title="GraphQL query" query { providers { id configurations { key value } } } ``` ```json title="JSON response" { "data": { "providers": [ { "id": "BEST_PROV", "configurations": [ { "key": "TITLE", "value": "Best Provider Inc" }, { "key": "AVAILABLE", "value": "false" }, { "key": "FORCE_AVAILABLE", "value": "false" }, { "key": "HOME_DELIVERY_AVAILABLE", "value": "true" }, { "key": "PICKUP_POINT_AVAILABLE", "value": "true" }, ] }, ] } } ``` You can also update the provider configuration using these key-value pairs with the `updateProviderConfiguration` and the `updateProviderConfigurations` types, depending on whether you want to update multiple settings. For example, here's how you can use `updateProviderConfigurations` to update two settings at the same time. The `input` field needs: - A `provider` subfield, in addition to `key` and `value`, to identify the provider. It takes an `id` value from the `Provider` object type. - An array with all the configuration options you wish to update. ```graphql title="GraphQL mutation" mutation { updateProviderConfigurations( input: [{ provider: BEST_PROV, key: AVAILABLE, value: "true", }, { provider: BEST_PROV, key: PICKUP_POINT_INFORMATION, value: "0-24 parcel locker service" }] ) { key value } } ``` ```json title="JSON response" { "data": { "updateProviderConfigurations": [ { "key": "AVAILABLE", "value": "true" }, { "key": "PICKUP_POINT_INFORMATION", "value": "0-24 parcel locker service" } ] } } ``` --- ## Sessions ## About sessions When a user tells Delivery Gateway they need a delivery, DGW creates a session. A session is the process of setting up a delivery, from selecting the delivery method to providing the user details and then confirming the delivery. - Lightweight frontend integration: When only the Delivery Gateway frontend is integrated to your e-commerce platform, our Web Plugin creates and manages sessions. - Full backend integration: Your e-commerce platform's backend is connected to the Delivery Gateway backend and uses the Merchant API to handle sessions. The full integration sequence looks like this: ```mermaid sequenceDiagram participant U as User participant FM as Frontend (merchant) participant DF as Delivery Gateway (frontend) participant BM as Backend (merchant) participant DB as Delivery Gateway (backend) U ->> FM: I need a delivery FM ->> BM: Clickreate Delivery Gateway session for user BM ->> DB: Create session DB -->> BM: Session id BM -->> FM: Session id FM ->> DF: Initialize DF ->> BM: Get delivery options BM -->> DF: U ->> FM: Set delivery details FM ->> BM: Save delivery details BM -->> FM: U ->> FM: User is ready FM ->> BM: Submit BM ->> DB: Get delivery details DB -->> BM: BM -->> FM: Save ``` ## Session ID The session ID is the main identifying information of a session. It is automatically generated whenever you create a new session. To update an existing session, you always need the session ID. ## Session details During a full session, the session is updated with the necessary information regarding one or more deliveries. It can receive default settings from the merchant configuration and provider configuration, but you can individually override each and every one of these settings during the process. For example, the currency of the session determines which currency is shown to display prices during the session. The default currency is the one specified in the merchant configuration. Similarly, you can configure the language of the session: the default value is that of the browser or OS locale. You can also update pricing for a session, overriding any of the pre-configured pricing rules. For example, you can create special promotions or offer free shipping by updating the pricing value. ### Authenticated customers A Delivery Gateway session doesn't require customer authentication: a session can be executed in a full with an anonymous user. However, authenticating a customer has several potential benefits, such as saving and reusing addresses, or offering previously selected pickup points. An authenticated customer is referred to by its reference ID. This is generated and assigned to the customer by your system. During a session, an authenticated customer can create, update, and delete their address information, including email address and phone number. ### Delivery options By default, the merchant configuration and the provider configurations determine what delivery methods and which providers are available for a session. However, you can always override these settings during a session: for example, you can enable home delivery even if it's disabled by default, or disable a provider that is otherwise available.