Deliverer
Represents a shipping provider, including its contact and address information.
Type Definition
type Deliverer {
name: String
address: String
zipcode: String
city: String
country: String
state: String
phone: String
email: String
url: String
currency: String
language: String
}
Fields
Field | Type | Nullable | Description | Related Types |
---|---|---|---|---|
name | String | Yes | The name of the shipping provider. | — |
address | String | Yes | The address of the shipping provider. | — |
zipcode | String | Yes | The postal code of the shipping provider’s address. | — |
city | String | Yes | The city where the shipping provider is located. | — |
country | String | Yes | The country of the shipping provider. | — |
state | String | Yes | The state or region of the shipping provider. | — |
phone | String | Yes | The contact phone number for the shipping provider. | — |
String | Yes | The contact email address for the shipping provider. | — | |
url | String | Yes | The website URL of the shipping provider. | — |
currency | String | Yes | The currency used by the shipping provider. | — |
language | String | Yes | The language preference of the shipping provider. | — |
Relationships
- Product.deliverer: The
Deliverer
type is referenced by thedeliverer
field on theProduct
object type, linking products to their shipping providers.
Usage Examples
Basic Query
{
product(id: 12345) {
deliverer {
name
address
city
country
}
}
}
Field Selection
{
product(id: 12345) {
deliverer {
name
phone
email
url
currency
language
}
}
}
Nested Queries
{
product(id: 12345) {
id
title
deliverer {
name
address
zipcode
city
state
country
phone
email
url
}
}
}
Filtering and Sorting
The Deliverer
object itself does not support direct filtering, sorting, or pagination. However, you can filter or sort products by their deliverer-related fields by querying the Product
type with appropriate arguments and then selecting the deliverer
fields.
Example: Fetch products shipped by a deliverer in a specific country, sorted by product title:
{
products(filter: { delivererCountry: "USA" }, sort: TITLE_ASC, first: 10) {
edges {
node {
id
title
deliverer {
name
country
}
}
}
}
}
Note: The above filtering and sorting capabilities depend on the Product
type’s schema and available arguments.
Implements
The Deliverer
type does not implement any interfaces.
Connections
The Deliverer
type is used as a nested object within other types, such as Product
. It does not have standalone connections or pagination fields.
Related Types
- Product: Contains a
deliverer
field of typeDeliverer
, linking products to their shipping providers.
Best Practices
- When querying deliverer information, select only the fields you need to optimize query performance.
- Use nested queries to retrieve deliverer details alongside product data to reduce the number of API calls.
- Since all fields on
Deliverer
are optional, always implement null checks in your client code. - For filtering or sorting by deliverer attributes, perform these operations on the parent object (e.g.,
Product
) if supported. - Cache deliverer information where appropriate to minimize repeated network requests, especially for frequently accessed products.
Notes
- All fields on the
Deliverer
type are optional and may returnnull
if the information is not available. - The API currently requires no authentication; however, this may change in future versions. Plan your integration accordingly.
- There are no computed or derived fields on the
Deliverer
type. - No fields on
Deliverer
accept arguments. - The
Deliverer
type is designed for straightforward data retrieval and does not support mutations directly. - Consider the impact of including large nested deliverer objects in queries on response size and performance. Select only necessary fields to optimize.
Last updated on