StreamlineExpressRequest Data Type

Defines a request to the Streamline Express service. This information contains the page to use together with optional overrides (such as payment method to use) in addition to the customer information that should be used when creating the purchase.

Properties
name data type description
page string The Streamline Express page to use.
countryCode string The country of the customer, in ISO alpha-2 format, for example SE.
invoiceAddress string The invoice address.
invoiceAddressDescription string The description of the invoice address.
invoiceZipcode string The zipcode of the invoice address.
invoiceCity string The city of the invoice address.
deliveryMethodCode string Deprecated in favor of deliveryMethodName
deliveryMethodName string The name of the delivery method.
paymentMethodCode string Deprecated in favor of paymentMethodName
paymentMethodName string The name of the payment method.
termsOfDeliveryCode string The code of the terms of delivery.
termsOfPaymentCode string The code of the terms of payment.
sellerNumber string The number of the seller to use.
methodOfArrivalNumber string The number of the method of arrival (or "channel").
campaignCode string The campaign to use for the purchase.
applicableIntegrities array of string Defines integrities that the consumer has accepted.
socialSecurityNumber string The social security number of the customer. Mutually exclusive with companyName and organizationNumber.
deniedIntegrities array of string Defines integrities that the consumer has opted out from.
firstName string The first name of the customer. Mutually exclusive with 'companyName'.
startDate string
lastName string The last name of the customer. Mutually exclusive with 'companyName'.
organizationNumber string The organization number of the customer. Mutually exclusive with firstName, lastName and socialSecurityNumber.
invoiceAdministrativeDivision string The administrative division of the address, such as province, state, municipality or county
companyName string The company name of the customer. Mutually exclusive with firstName, lastName and socialSecurityNumber.
email string The email address of the customer.
customerNumber string The customer number of an existing customer. The order/subscription will be connected to the specified customer. Name, address and contact details will be updated.
alternativeEmailAddress string The alternative email address of the customer.
landline string The landline phone number of the customer.
cellphone string The cellphone number of the customer.
gender Sex The gender of the customer.
additionalOrderText string The Additional order text on the purchase.
sellerDepartment string For sales handled by third parties, typically TM call centers - the department that the seller belongs to. The order/subscription's createdBy field will be updated with the department (and sellerPerson)
sellerPerson string For sales handled by third parties, typically TM call centers - the name/identifier of the seller person. The order/subscription's createdBy field will be updated with the seller (and sellerDepartment)
notes string A free text that will be stored in the order's/subscription's list of notes.
nextDeliveryDate string For orders: earliest delivery date. For subscriptions: suggested next delivery date. Defaulted to today's date.
orderDate string For orders: the order date. For subscription: the starting date. Defaulted to nextDeliveryDate if specified, otherwise today's date
languageCode Language Language code.
dateOfBirth string Date of birth of the customer.
interval number The interval of the subscription.
customFields array of CustomField Custom fields.
remoteAddress string The remote client address.

Example

{
  "page" : "...",
  "countryCode" : "SE",
  "invoiceAddress" : "...",
  "invoiceAddressDescription" : "...",
  "invoiceZipcode" : "...",
  "invoiceCity" : "...",
  "deliveryMethodName" : "...",
  "paymentMethodName" : "...",
  "termsOfDeliveryCode" : "...",
  "termsOfPaymentCode" : "...",
  "sellerNumber" : "...",
  "methodOfArrivalNumber" : "...",
  "campaignCode" : "...",
  "applicableIntegrities" : [ "...", "..." ],
  "socialSecurityNumber" : "...",
  "deniedIntegrities" : [ "...", "..." ],
  "firstName" : "...",
  "lastName" : "...",
  "organizationNumber" : "...",
  "invoiceAdministrativeDivision" : "...",
  "companyName" : "...",
  "email" : "...",
  "customerNumber" : "...",
  "alternativeEmailAddress" : "...",
  "landline" : "...",
  "cellphone" : "...",
  "gender" : "WOMAN",
  "additionalOrderText" : "...",
  "sellerDepartment" : "...",
  "sellerPerson" : "...",
  "notes" : "...",
  "nextDeliveryDate" : "...",
  "orderDate" : "...",
  "languageCode" : "pl",
  "dateOfBirth" : "...",
  "interval" : 12345,
  "customFields" : [ {
    "code" : "...",
    "value" : "..."
  }, {
    "code" : "...",
    "value" : "..."
  } ],
  "remoteAddress" : "..."
}