Objects

CheckoutOrderType

No description

No description

type CheckoutOrderType {
  orderId: String
  transactionId: String
  secondaryTransactionId: String @deprecated
  billingAddress: AddressType
  shippingAddress: AddressType
  company: String @deprecated
  firstName: String @deprecated
  lastName: String @deprecated
  zip: String @deprecated
  email: String @deprecated
  phone: String @deprecated
  address1: String @deprecated
  address2: String @deprecated
  city: String @deprecated
  country: String @deprecated
  message: String
  currency: String
  campaignIds: [String]
  campaignNames: [String]
  discountExVat: Decimal!
  discountIncVat: Decimal!
  itemValueExVat: Decimal!
  itemValueIncVat: Decimal!
  orderValueExVat: Decimal!
  orderValueIncVat: Decimal!
  paymentFeeExVat: Decimal!
  paymentFeeIncVat: Decimal!
  shippingFeeExVat: Decimal!
  shippingFeeIncVat: Decimal!
  sum: Decimal!
  balance: Decimal!
  rows: [CheckoutOrderRowType]
  marketId: String!
  externalOrderId: String
  status: String
  ipAddress: String
  languageId: String
  promoCode: String
  customerId: Int!
  customerTypeId: Int!
  gender: GenderType!
  personalId: String
  userAgent: String
  metaData: String
  customerGroupId: Int!
  paymentId: Int!
  organizationNumber: String
  shippingId: Int!
  pickupPoint: String
  desiredDeliveryDate: DateTime
  goodsLabel: String
  customerOrderNumber: String
}

Fields

orderId ● String scalar

Order ID

transactionId ● String scalar

Payment Provider Transaction ID

secondaryTransactionId ● String deprecated scalar

Deprecated: Not used any more.

Secondary transaction ID

billingAddress ● AddressType object

Billing address

shippingAddress ● AddressType object

Shipping address

company ● String deprecated scalar

Deprecated: Use Billing Address instead.

Company

firstName ● String deprecated scalar

Deprecated: Use Billing Address instead.

First name

lastName ● String deprecated scalar

Deprecated: Use Billing Address instead.

Last name

zip ● String deprecated scalar

Deprecated: Use Billing Address instead.

Zip code

email ● String deprecated scalar

Deprecated: Use Billing Address instead.

E-mail

phone ● String deprecated scalar

Deprecated: Use Billing Address instead.

Phone number

address1 ● String deprecated scalar

Deprecated: Use Billing Address instead.

Address Line 1

address2 ● String deprecated scalar

Deprecated: Use Billing Address instead.

Address Line 2

city ● String deprecated scalar

Deprecated: Use Billing Address instead.

City

country ● String deprecated scalar

Deprecated: Use Billing Address instead.

Country

message ● String scalar

Order message

currency ● String scalar

Currency

campaignIds ● [String] list scalar

Campaign IDs

campaignNames ● [String] list scalar

Campaign names

discountExVat ● Decimal! non-null scalar required

Discount excl. VAT

discountIncVat ● Decimal! non-null scalar required

Discount incl. VAT

itemValueExVat ● Decimal! non-null scalar required

Represents the total sum of the prices for all order rows, excluding VAT

itemValueIncVat ● Decimal! non-null scalar required

Represents the total sum of the prices for all order rows

orderValueExVat ● Decimal! non-null scalar required

Order value excluding VAT (item value + fees - balance)

orderValueIncVat ● Decimal! non-null scalar required

Order value including VAT (item value + fees - balance)

paymentFeeExVat ● Decimal! non-null scalar required

Payment fee excl. VAT

paymentFeeIncVat ● Decimal! non-null scalar required

Payment fee incl. VAT

shippingFeeExVat ● Decimal! non-null scalar required

Shipping fee excl. VAT

shippingFeeIncVat ● Decimal! non-null scalar required

Shipping fee incl. VAT

sum ● Decimal! non-null scalar required

Order sum. Amount to pay.

balance ● Decimal! non-null scalar required

Amount used from Balance

rows ● [CheckoutOrderRowType] list object

Order rows

marketId ● String! non-null scalar required

Market ID.

externalOrderId ● String scalar

External Order ID

status ● String scalar

Order Status

ipAddress ● String scalar

IP Address

languageId ● String scalar

Locale

promoCode ● String scalar

Promo Code

customerId ● Int! non-null scalar required

Customer ID

customerTypeId ● Int! non-null scalar required

Customer Type ID

gender ● GenderType! non-null enum required

Gender

personalId ● String scalar

Personal ID

userAgent ● String scalar

User Agent

metaData ● String scalar

Meta Data

customerGroupId ● Int! non-null scalar required

CustomerGroup ID

paymentId ● Int! non-null scalar required

Payment ID

organizationNumber ● String scalar

Organization Number

shippingId ● Int! non-null scalar required

Shipping ID

pickupPoint ● String scalar

Pickup Point

desiredDeliveryDate ● DateTime scalar

Desired Delivery Date

goodsLabel ● String scalar

An optional text usually used to mark the goods. The value may be included on the shipment so it can be printed on packaging, labels, or other markings that follow the goods.

customerOrderNumber ● String scalar

An optional customer-supplied reference number for the order. Use this field to include your own internal order number, PO number, or tracking identifier. The value is not validated or required to be unique.

Member Of

CheckoutAndOrderType object ● CheckoutDataType object

CheckoutOrderRowType

No description

CheckoutType

Represents the current state of a checkout session.