type Query {
ping: String!
fulfillments: [Fulfillment!]!
me: Merchant!
operators: [Operator!]!
packaging(id: ID!): Packaging
pickupPoint(id: ID!): PickupPoint
pricing(id: ID!): Pricing
providers: [Provider!]!
session(id: ID!): Session
shipment(id: ID!): Shipment
theme(id: ID!): Theme
token: Token!
waybill(id: ID!): Waybill
webhook(id: ID!): Webhook
zone(id: ID!): Zone
packagings(
first: Int!
page: Int
): PackagingPaginator!
pickupPoints(
filters: PickupPointFilterInput
sortBy: PickupPointSortInput
first: Int!
page: Int
): PickupPointPaginator!
pricings(
first: Int!
page: Int
): PricingPaginator!
shipments(
filters: ShipmentFilterInput
sortBy: ShipmentSortInput
first: Int!
page: Int
): ShipmentPaginator!
themes(
first: Int!
page: Int
): ThemePaginator!
tokens(
first: Int!
page: Int
): TokenPaginator!
waybills(
filters: WaybillFilterInput
sortBy: WaybillSortInput
first: Int!
page: Int
): WaybillPaginator!
webhooks(
first: Int!
page: Int
): WebhookPaginator!
zones(
first: Int!
page: Int
): ZonePaginator!
}
type Mutation {
ping: String!
updateFulfillmentConfiguration(input: UpdateFulfillmentConfigurationInput!): FulfillmentConfiguration!
updateMerchantConfiguration(input: UpdateMerchantConfigurationInput!): MerchantConfiguration!
updateOperatorConfiguration(input: UpdateOperatorConfigurationInput!): OperatorConfiguration!
upsertOrder(input: OrderInput!): Void
createPackaging(input: CreatePackagingInput!): Packaging!
updatePackaging(input: UpdatePackagingInput!): Packaging!
deletePackaging(id: ID!): Void
createPickupPoint(input: CreatePickupPointInput!): PickupPoint!
updatePickupPoint(input: UpdatePickupPointInput!): PickupPoint!
createPricing(input: CreatePricingInput!): Pricing!
updatePricing(input: UpdatePricingInput!): Pricing!
deletePricing(id: ID!): Void
updateProviderConfiguration(input: UpdateProviderConfigurationInput!): ProviderConfiguration!
session(input: SessionInput): Session!
createShipment(input: CreateShipmentInput!): Shipment!
sessionToShipment(input: SessionToShipmentInput!): Shipment!
updateShipment(input: UpdateShipmentInput!): Shipment!
deleteShipment(id: ID!): Void
createTheme(input: CreateThemeInput!): Theme!
updateTheme(input: UpdateThemeInput!): Theme!
deleteTheme(id: ID!): Void
createToken(input: CreateTokenInput!): String!
deleteToken(id: ID!): Void
createWaybill(input: CreateWaybillInput!): Waybill!
deleteWaybill(id: ID!): Waybill!
assignShipmentToWaybill(input: AssignShipmentToWaybillInput!): Shipment!
unassignShipmentFromWaybill(id: ID!): Shipment!
closeWaybill(id: ID!): Waybill!
createWebhook(input: CreateWebhookInput!): Webhook!
obtainWebhook(input: ObtainWebhookInput!): Webhook!
updateWebhook(input: UpdateWebhookInput!): Webhook!
deleteWebhook(id: ID!): Void
createZone(input: CreateZoneInput!): Zone!
updateZone(input: UpdateZoneInput!): Zone!
deleteZone(id: ID!): Void
}
input DimensionInput {
width: Float!
length: Float!
height: Float!
}
type Dimension {
width: Float!
length: Float!
height: Float!
}
input AddressInput {
country: CountryEnum!
state: String
city: String!
postalCode: String!
addressLine1: String!
addressLine2: String
note: String
}
type Address {
country: CountryEnum!
state: String
city: String!
postalCode: String!
addressLine1: String!
addressLine2: String
note: String
}
type Location {
latitude: Float!
longitude: Float!
}
input LocationInput {
latitude: Float!
longitude: Float!
}
type Money {
amount: Float!
currency: CurrencyEnum!
}
input MoneyInput {
amount: Float!
currency: CurrencyEnum!
}
type MoneyRange {
amount: FloatRange!
currency: CurrencyEnum!
}
union MoneyOrMoneyRange = Money | MoneyRange
type FloatRange {
start: Float!
end: Float!
}
scalar IP
"""
_no description_
## Values
### custom(id)
The custom providers can be used as string.
### MPL
The MPL can be used as enumeration or string.
### GLS
The GLS can be used as enumeration or string.
### FOX_POST
The FOX_POST can be used as enumeration or string.
### PACKETA
The PACKETA can be used as enumeration or string.
### SAME_DAY
The SAME_DAY can be used as enumeration or string.
### DPD
The DPD can be used as enumeration or string.
### SPRINTER
The SPRINTER can be used as enumeration or string.
### EXPRESS_ONE
The EXPRESS_ONE can be used as enumeration or string.
### DHL
The DHL can be used as enumeration or string.
### TNT
The TNT can be used as enumeration or string.
### FED_EX
The FED_EX can be used as enumeration or string.
### UPS
The UPS can be used as enumeration or string.
### TRANS_SPED
The TRANS_SPED can be used as enumeration or string.
"""
scalar ProviderEnum
type Time {
hour: Int!
minute: Int!
}
input TimeInput {
hour: Int!
minute: Int!
}
type OpeningHour {
day: DayEnum!
start: Time!
end: Time!
}
input OpeningHourInput {
day: DayEnum!
start: TimeInput!
end: TimeInput!
}
type KeyValue {
key: String!
value: String!
}
input KeyValueInput {
key: String!
value: String
}
enum OrderDirectionEnum {
ASC
DESC
}
input IntRangeFilter {
start: Int
end: Int
}
input FloatRangeFilter {
start: Float
end: Float
}
input DateRangeFilter {
start: Date
end: Date
}
input DateTimeRangeFilter {
start: DateTimeTz
end: DateTimeTz
}
"A date string with format `Y-m-d`."
scalar Date
"A datetime string with format `Y-m-d\\TH:i:sP`."
scalar DateTimeTz
scalar Void
scalar Upload
input CustomerInput {
referenceId: String
addresses: [CustomerAddressInput!]
}
input CustomerRecipientInput {
firstName: String
lastName: String
language: LanguageEnum
email: String
phone: String
}
input CustomerAddressInput {
referenceId: String
label: String
recipient: CustomerRecipientInput
address: AddressInput!
location: LocationInput
}
type Fulfillment {
id: FulfillmentEnum!
name: String!
configurations: [FulfillmentConfiguration!]!
}
type FulfillmentConfiguration {
fulfillment: FulfillmentEnum!
key: FulfillmentConfigurationEnum!
description: String!
value: String
default: String
}
input UpdateFulfillmentConfigurationInput {
fulfillment: FulfillmentEnum!
key: FulfillmentConfigurationEnum!
value: String
}
type Label {
url: String!
}
type Merchant {
id: ID!
name: String!
providers: [Provider!]!
configurations: [MerchantConfiguration!]!
configuration(key: MerchantConfigurationEnum): MerchantConfiguration
webhooks: [Webhook!]!
themes: [Theme!]!
}
type MerchantConfiguration {
key: MerchantConfigurationEnum!
description: String!
value: String
default: String
}
input UpdateMerchantConfigurationInput {
key: MerchantConfigurationEnum!
value: String
}
type Operator {
id: OperatorEnum!
name: String!
configurations: [OperatorConfiguration!]!
}
type OperatorConfiguration {
operator: OperatorEnum!
key: OperatorConfigurationEnum!
description: String!
value: String
default: String
}
input UpdateOperatorConfigurationInput {
operator: OperatorEnum!
key: OperatorConfigurationEnum!
value: String
}
input OrderBillingInput {
name: String
email: String
phone: String
vatNumber: String
isCompany: Boolean
address: AddressInput
}
input OrderShippingInput {
name: String
email: String
phone: String
pickupPointId: ID
address: AddressInput
method: ShippingMethodEnum
provider: String
status: ShipmentStatusEnum
resolution: ShipmentResolutionEnum
}
input OrderPaymentInput {
method: String!
status: PaymentStatusEnum!
paidAt: DateTimeTz
}
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!
}
input OrderItemCategoryInput {
name: String!
type: OrderItemCategoryTypeEnum!
typeOther: String
}
input GlobalIdentifierInput {
id: ID!
type: GlobalIdentifierEnum!
typeOther: String
}
input OrderUnitPriceInput {
net: MoneyInput!
vat: Float!
gross: MoneyInput!
}
input OrderItemQuantityInput {
count: Float!
type: OrderItemQuantityUnitEnum!
typeOther: String
}
input OrderTotalPriceInput {
net: MoneyInput!
gross: MoneyInput!
}
input OrderInput {
referenceId: ID!
createdAt: DateTimeTz!
customerId: ID
sessionId: ID
billing: OrderBillingInput
shipping: OrderShippingInput
payment: OrderPaymentInput
total: OrderTotalPriceInput!
items: [OrderItemInput!]!
cashOnDelivery: MoneyInput
}
type Order {
referenceId: ID!
createdAt: DateTimeTz!
customerId: ID
sessionId: ID
billing: OrderBilling
shipping: OrderShipping
payment: OrderPayment
total: OrderPrice!
items: [OrderItem!]!
cashOnDelivery: Money
}
type OrderBilling {
name: String
email: String
phone: String
vatNumber: String
isCompany: Boolean
address: Address
}
type OrderShipping {
name: String
email: String
phone: String
pickupPointId: ID
address: Address
method: ShippingMethodEnum
provider: String
status: ShipmentStatusEnum
resolution: ShipmentResolutionEnum
}
type OrderPayment {
method: String!
status: PaymentStatusEnum!
paidAt: DateTimeTz
}
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!
}
type OrderItemCategory {
name: String!
type: OrderItemCategoryTypeEnum!
typeOther: String
}
type GlobalIdentifier {
id: ID!
type: GlobalIdentifierEnum!
typeOther: String
}
type OrderItemPrice {
net: Money!
vat: Float!
gross: Money!
}
type OrderItemTotalPrice {
net: Money!
gross: Money!
}
type OrderItemQuantity {
count: Float!
type: OrderItemQuantityUnitEnum!
typeOther: String
}
type OrderPrice {
net: Money!
gross: Money!
}
type Packaging {
id: ID!
name: String!
handle: ID!
dimensions: Dimension!
isDefault: Boolean!
}
input CreatePackagingInput {
name: String!
handle: ID!
dimensions: DimensionInput!
isDefault: Boolean!
}
input UpdatePackagingInput {
id: ID!
name: String!
handle: ID!
dimensions: DimensionInput!
isDefault: Boolean!
}
input ParcelInput {
referenceId: String!
weight: Float!
dimensions: DimensionInput!
isReadyForWaybill: Boolean!
cashOnDelivery: MoneyInput
value: MoneyInput
insurance: MoneyInput
}
type Parcel {
referenceId: ID!
tracking: Tracking
label: Label
weight: Float!
dimensions: Dimension!
isReadyForWaybill: Boolean!
cashOnDelivery: Money
value: Money
insurance: Money
}
type PickupPoint {
isCustom: Boolean!
provider: ProviderEnum
operator: OperatorEnum
type: PickupPointTypeEnum
isPickUpAvailable: Boolean!
isDropOffAvailable: Boolean!
id: ID!
name: String!
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!
}
input CreatePickupPointInput {
referenceId: String!
name: String!
phone: String!
cashOnDelivery: [PaymentMethodEnum!]
hasWheelchairAccess: Boolean
address: AddressInput!
location: LocationInput!
openingHours: PickupPointOpeningHoursInput
isActive: Boolean!
}
input UpdatePickupPointInput {
id: ID!
referenceId: String!
name: String!
phone: String!
cashOnDelivery: [PaymentMethodEnum!]
hasWheelchairAccess: Boolean
address: AddressInput!
location: LocationInput!
openingHours: PickupPointOpeningHoursInput
isActive: Boolean!
}
input PickupPointOpeningHoursInput {
timezone: TimezoneEnum!
openingHours: [OpeningHourInput!]!
}
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
}
input PickupPointProviderFilterInput {
provider: ProviderEnum!
type: [PickupPointTypeEnum!]
}
input PickupPointOperatorFilterInput {
operator: OperatorEnum!
type: [PickupPointTypeEnum!]
}
input PickupPointDistanceFilterInput {
location: LocationInput!
distance: Int!
}
input PickupPointBoundingBoxFilterInput {
southWest: LocationInput!
northEast: LocationInput!
}
enum PickupPointSortEnum {
NAME
DISTANCE
}
input PickupPointSortInput {
field: PickupPointSortEnum!
direction: OrderDirectionEnum
location: LocationInput
}
type Pricing {
id: ID!
name: String!
condition: PricingCondition
price: Money!
priority: Int
}
type PricingCondition {
isHomeDelivery: Boolean
isPickupPoint: Boolean
pickupPointTypes: [PickupPointTypeEnum!]
providers: [ProviderEnum!]
isCustom: Boolean
zone: Zone
}
input CreatePricingInput {
name: String!
condition: PricingConditionInput
price: MoneyInput!
priority: Int
}
input UpdatePricingInput {
id: ID!
name: String!
condition: PricingConditionInput
price: MoneyInput!
priority: Int
}
input PricingConditionInput {
isHomeDelivery: Boolean
isPickupPoint: Boolean
pickupPointTypes: [PickupPointTypeEnum!]
providers: [ProviderEnum!]
isCustom: Boolean
zoneId: ID
}
type Provider {
id: ProviderEnum!
name: String!
icon: String
isEnabled: Boolean!
isAvailable: Boolean!
configurations: [ProviderConfiguration!]!
pickupPoints(
filters: PickupPointFilterInput
sortBy: PickupPointSortInput
first: Int!
page: Int
): PickupPointPaginator!
}
type ProviderConfiguration {
provider: ProviderEnum!
key: ProviderConfigurationEnum!
description: String!
value: String
default: String
}
input UpdateProviderConfigurationInput {
provider: ProviderEnum!
key: ProviderConfigurationEnum!
value: String
}
input SessionInput {
id: ID
mode: ShipmentModeEnum
currency: CurrencyEnum
language: LanguageEnum
customer: CustomerInput
parcels: [SessionParcelInput!]
price: [SessionPriceInput!]
pickupPoint: SessionPickupPointInput
homeDelivery: SessionHomeDeliveryInput
}
input SessionPickupPointInput {
enabled: Boolean!
recipient: CustomerRecipientInput
providers: [SessionPickupPointProviderInput!]
price: [SessionPickupPointPriceInput!]
disallow: [SessionPickupPointDisallowInput!]
}
input SessionHomeDeliveryInput {
enabled: Boolean!
recipient: CustomerRecipientInput
location: Boolean
providers: [ProviderEnum!]
price: [SessionPriceInput!]
}
input SessionPriceInput {
provider: ProviderEnum
price: MoneyInput!
}
input SessionPickupPointProviderInput {
provider: ProviderEnum!
pickupPointTypes: [PickupPointTypeEnum!]
}
input SessionPickupPointPriceInput {
provider: ProviderEnum
pickupPointType: PickupPointTypeEnum
price: MoneyInput!
}
input SessionPickupPointDisallowInput {
id: ID
referenceId: ID
}
input SessionParcelInput {
weight: Float!
dimensions: DimensionInput!
cashOnDelivery: MoneyInput
value: MoneyInput
insurance: MoneyInput
}
type Session {
id: ID!
mode: ShipmentModeEnum
provider: ProviderEnum
destination: SessionDestination
recipient: SessionRecipient
parcels: [SessionParcel!]
isCompleted: Boolean!
price: Money
}
type SessionDestination {
pickupPoint: PickupPoint
address: Address
location: Location
}
type SessionRecipient {
firstName: String
lastName: String
name: String
language: LanguageEnum
email: String
phone: String
}
type SessionParcel {
weight: Float!
dimensions: Dimension!
cashOnDelivery: Money
value: Money
insurance: Money
}
input CreateShipmentInput {
provider: ProviderEnum!
referenceId: String!
sourceId: String
waybillId: ID
mode: ShipmentModeEnum
direct: Boolean! = false
origin: ShipmentOriginInput
sender: ShipmentSenderInput
destination: ShipmentDestinationInput!
recipient: ShipmentRecipientInput!
parcels: [ParcelInput!]
order: OrderInput
}
input SessionToShipmentInput {
sessionId: ID!
referenceId: String!
sourceId: String
waybillId: ID
mode: ShipmentModeEnum
direct: Boolean! = false
origin: ShipmentOriginInput
sender: ShipmentSenderInput
parcels: [ParcelInput!]
order: OrderInput
}
input UpdateShipmentInput {
id: ID!
referenceId: String!
sourceId: String
waybillId: ID
mode: ShipmentModeEnum!
direct: Boolean! = false
origin: ShipmentOriginInput
sender: ShipmentSenderInput
destination: ShipmentDestinationInput!
recipient: ShipmentRecipientInput!
parcels: [ParcelInput!]
order: OrderInput
}
input ShipmentOriginInput {
pickupPointId: ID
address: AddressInput
location: LocationInput
}
input ShipmentSenderInput {
name: String!
email: String
phone: String
bankAccountNumber: String
}
input ShipmentDestinationInput {
pickupPointId: ID
address: AddressInput
location: LocationInput
}
input ShipmentRecipientInput {
firstName: String!
lastName: String!
language: LanguageEnum!
email: String
phone: String
}
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
}
type ShipmentOrigin {
pickupPoint: PickupPoint
address: Address
location: Location
}
type ShipmentSender {
name: String!
email: String
phone: String
}
type ShipmentDestination {
pickupPoint: PickupPoint
address: Address
location: Location
}
type ShipmentRecipient {
firstName: String!
lastName: String!
name: String!
language: LanguageEnum!
email: String
phone: String
}
type ShipmentStatus {
status: ShipmentStatusEnum!
resolution: ShipmentResolutionEnum
timestamp: DateTimeTz!
}
type ShipmentEvent {
event: ShipmentEventEnum!
actor: ShipmentActorEnum!
timestamp: DateTimeTz!
hash: String!
provider: [KeyValue!]
isSimulated: Boolean
}
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!]
}
enum ShipmentSortEnum {
CREATED_AT
}
input ShipmentSortInput {
field: ShipmentSortEnum!
direction: OrderDirectionEnum
}
type Theme {
id: ID!
handle: ID!
isEnabled: Boolean!
isDefault: Boolean!
options: [ThemeOption!]!
}
type ThemeOption {
key: ThemeConfigurationEnum!
value: String
default: String
description: String!
}
input CreateThemeInput {
handle: ID!
isEnabled: Boolean!
isDefault: Boolean!
options: [ThemeOptionInput!]!
}
input UpdateThemeInput {
id: ID!
handle: ID!
isEnabled: Boolean!
isDefault: Boolean!
options: [ThemeOptionInput!]!
}
input ThemeOptionInput {
key: ThemeConfigurationEnum!
value: String
}
input CreateTokenInput {
name: String!
roles: [RoleEnum!]
allowlist: TokenAllowlistInput
}
input TokenAllowlistInput {
ips: [IP!]
referers: [String!]
}
type Token {
id: ID!
name: String!
roles: [RoleEnum!]
allowlist: TokenAllowlist
}
type TokenAllowlist {
ips: [IP!]
referers: [String!]
}
type Tracking {
code: String!
url: String!
}
type Waybill {
id: ID!
provider: Provider!
shipments: [Shipment!]!
createdAt: DateTimeTz!
closedAt: DateTimeTz
}
input CreateWaybillInput {
provider: ProviderEnum!
referenceId: String!
shipments: [ID!]
}
input AssignShipmentToWaybillInput {
waybillId: ID!
shipmentId: ID!
}
input WaybillFilterInput {
id: [ID!]
provider: [ProviderEnum!]
isClosed: Boolean
closedAt: DateTimeRangeFilter
createdAt: DateTimeRangeFilter
}
enum WaybillSortEnum {
CLOSED_AT
CREATED_AT
}
input WaybillSortInput {
field: WaybillSortEnum!
direction: OrderDirectionEnum
}
type Webhook {
id: ID!
webhook: WebhookEnum!
transport: TransportEnum!
url: String!
}
input CreateWebhookInput {
webhook: WebhookEnum!
transport: TransportEnum!
url: String!
}
input ObtainWebhookInput {
webhook: WebhookEnum!
transport: TransportEnum!
url: String!
}
input UpdateWebhookInput {
id: ID!
url: String!
}
type Zone {
id: ID!
name: String!
countries: [CountryEnum!]!
}
input CreateZoneInput {
name: String!
countries: [CountryEnum!]!
}
input UpdateZoneInput {
id: ID!
name: String!
countries: [CountryEnum!]!
}
type PaginatorInfo {
count: Int!
currentPage: Int!
firstItem: Int
hasMorePages: Boolean!
lastItem: Int
lastPage: Int!
perPage: Int!
total: Int!
}
type PackagingPaginator {
paginatorInfo: PaginatorInfo!
data: [Packaging!]!
}
type PickupPointPaginator {
paginatorInfo: PaginatorInfo!
data: [PickupPoint!]!
}
type PricingPaginator {
paginatorInfo: PaginatorInfo!
data: [Pricing!]!
}
type ShipmentPaginator {
paginatorInfo: PaginatorInfo!
data: [Shipment!]!
}
type ThemePaginator {
paginatorInfo: PaginatorInfo!
data: [Theme!]!
}
type TokenPaginator {
paginatorInfo: PaginatorInfo!
data: [Token!]!
}
type WaybillPaginator {
paginatorInfo: PaginatorInfo!
data: [Waybill!]!
}
type WebhookPaginator {
paginatorInfo: PaginatorInfo!
data: [Webhook!]!
}
type ZonePaginator {
paginatorInfo: PaginatorInfo!
data: [Zone!]!
}
enum SortOrder {
ASC
DESC
}
enum OrderByRelationAggregateFunction {
COUNT
}
enum OrderByRelationWithColumnAggregateFunction {
AVG
MIN
MAX
SUM
COUNT
}
input OrderByClause {
column: String!
order: SortOrder!
}
enum Trashed {
ONLY
WITH
WITHOUT
}
enum RoleEnum {
MERCHANT_CONFIGURATION
MERCHANT_OPERATOR
MERCHANT_PACKAGING
MERCHANT_PRICING
MERCHANT_PROVIDER
MERCHANT_SESSION
MERCHANT_SHIPMENT
MERCHANT_THEME
MERCHANT_TOKEN
MERCHANT_WAYBILL
MERCHANT_WEBHOOK
MERCHANT_ZONE
}
enum MerchantConfigurationEnum {
ALWAYS_CONFIRM_RECIPIENT
CURRENCY
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_ENABLED
HOME_DELIVERY_INFORMATION
HOME_DELIVERY_PROVIDER
HOME_DELIVERY_TITLE
MODE
PICKUP_POINT_ENABLED
PICKUP_POINT_INFORMATION
PICKUP_POINT_TITLE
REQUIRE_ADDRESS_LOCATION
SENDER_ADDRESS_LINE1
SENDER_ADDRESS_LINE2
SENDER_CITY
SENDER_COUNTRY
SENDER_EMAIL
SENDER_NAME
SENDER_PHONE
SENDER_POSTAL_CODE
SENDER_STATE
UI_ALLOWED_REFERRERS
WEBHOOK_SIGNATURE
}
enum ProviderConfigurationEnum {
ACCOUNTING_CODE
ACCOUNT_NUMBER
ADDRESS_ID
AGREEMENT
API_KEY
AVAILABLE
BU_CODE
CLIENT_ID
CLIENT_NUMBER
CLIENT_SECRET
CUSTOMER_ID
FORCE_AVAILABLE
FULFILLMENT
HOME_DELIVERY_AVAILABLE
HOME_DELIVERY_INFORMATION
LABEL_SIZE
PASSWORD
PICKUP_POINT_AVAILABLE
PICKUP_POINT_INFORMATION
PRIORITY
REQUIRED_ADDRESS_FIELDS_FOR_HOME_DELIVERY
REQUIRED_ADDRESS_FIELDS_FOR_PICKUP_POINT_DELIVERY
SPEDITOR_NAME
TITLE
TRACKING_API_KEY
USERNAME
}
enum OperatorConfigurationEnum {
PRIORITY
TITLE
}
enum FulfillmentConfigurationEnum {
API_KEY
AVAILABLE
}
enum WebhookEnum {
ADDRESS_CREATED
ADDRESS_DELETED
ADDRESS_UPDATED
CONFIGURATION_UPDATED
SHIPMENT_CREATED
SHIPMENT_DELETED
SHIPMENT_UPDATED
}
enum ThemeConfigurationEnum {
BRAND_COLOR
BUTTON_ROUNDING
FONT_FAMILY
SURFACE_ROUNDING
}
enum TransportEnum {
REST
}
enum OperatorEnum {
ALZA_BOX
AVANTI
AVIA
COOP
CORNER
DHL
DPD
EXPRESS_ONE
FED_EX
FOX_POST
GLS
MEDIA_MARKT
MOL
MPL
OMV
OTHER
PACKETA
PATRONBOLT
PLAYERSROOM
PLAYMAX
REAL
RELAY_INMEDIO
ROBOT_GURU
SAME_DAY
SPORTFACTORY
SPRINTER
TNT
TRANS_SPED
TWO_TWO_ZERO_VOLT
UPS
}
enum FulfillmentEnum {
WEBSHIPPY
}
enum PickupPointTypeEnum {
LOCKER
POST_OFFICE
SHOP
}
enum PaymentMethodEnum {
CARD
CASH
}
enum ShipmentEventEnum {
CANCELED
COLLECTED
COLLECTING
CREATED
DELIVERED
DELIVERING
FAILED
IN_PROGRESS
RECEIVABLE
RETURNED
RETURNING
SUSPENDED
UNKNOWN
}
enum ShipmentActorEnum {
PROVIDER
RECIPIENT
SENDER
UNKNOWN
}
enum ShipmentStatusEnum {
DELIVERED
DELIVERING
FAILED
FAILING
IN_PROGRESS
RECEIVABLE
WAITING_FOR_COLLECTION
}
enum ShipmentResolutionEnum {
CANCELED_BY_RECIPIENT
CANCELED_BY_SENDER
OBLITERATED
RECEIVED
UNDELIVERABLE
}
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
}
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
}
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
}
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
}
enum DayEnum {
FRIDAY
MONDAY
SATURDAY
SUNDAY
THURSDAY
TUESDAY
WEDNESDAY
}
enum AddressFieldEnum {
ADDRESS_LINE1
ADDRESS_LINE2
CITY
COUNTRY
EMAIL
FIRST_NAME
LANGUAGE
LAST_NAME
LOCATION
PHONE
POSTAL_CODE
STATE
}
enum ShipmentModeEnum {
RECIPIENT_TO_SENDER
SENDER_TO_RECIPIENT
THIRD_PARTY_TO_THIRD_PARTY
}
enum PaymentStatusEnum {
AUTHORIZED
PAID
PARTIALLY_RAID
PARTIALLY_REFUNDED
PENDING
REFUNDED
VOIDED
}
enum OrderItemCategoryTypeEnum {
GOOGLE
OTHER
}
enum GlobalIdentifierEnum {
EAN
GTIN
ISBN
JAN
MPN
NIQ
OTHER
UPC
}
enum OrderItemQuantityUnitEnum {
KILOGRAM
LITER
OTHER
PIECE
}
enum ShippingMethodEnum {
HOME_DELIVERY
ONLINE
PICKUP_POINT
STORE
}