commerce/orders/billinginfo

Use the Billing Info subresource to manage the billing information stored for an order.

JSON Example

BillingInfo Properties

Property Description
auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

billingContact

type: contact

The cardholder's billing contact information, including addresses.

contact.address

type: address

Address information to supply for a contact.

contact.address.address1

type: string

Physical or mailing address line one. Usually includes the street number and street name or it could be a P.O. Box. Max length: 200.

contact.address.address2

type: string

Physical or mailing address line two. Usually supplements the main street address with apartment, floor, suite, building, or unit information. Max length: 200.

contact.address.address3

type: string

Physical or mailing address line three. Max length: 200.

contact.address.address4

type: string

Physical or mailing address line four. Max length: 200.

contact.address.addressType

type: string

The type of address, which is commercial or residential.

contact.address.cityOrTown

type: string

The entered city or town for the address.

contact.address.countryCode

type: string

The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US.

contact.address.isValidated

type: bool

Indicates if the address has been validated. If true, the address has been verified by an address validation service.

contact.address.postalOrZipCode

type: string

The entered zip or postal code for an address.

contact.address.stateOrProvince

type: string

The entered state or province for an address.

contact.companyOrOrganization

type: string

The entered company or organization name entered for a customer account.

contact.email

type: string

The email address for the customer account and contact. This email may be used for login to the storefront, receiving in-stock product notifications, and subscription mailing lists.

contact.firstName

type: string

The full first name of a customer or contact name.

contact.id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

contact.lastNameOrSurname

type: string

The full last name or surname of a customer or contact name.

contact.middleNameOrInitial

type: string

Character string of the middle name or initial for the customer.

contact.phoneNumbers

type: phone

List of phone numbers associated with the customer account contact. The phone numbers include area codes.

contact.phone.home

type: string

Home phone number.

contact.phone.mobile

type: string

Mobile phone number.

contact.phone.work

type: string

Work phone number.

card

type: paymentCard

Properties of a credit card used to submit payment for an order.

paymentCard.bin

type: string

The bin number of a branded credit card.

paymentCard.cardNumberPartOrMask

type: string

The masked credit card number part returned from the payment gateway.

paymentCard.expireMonth

type: short

The two-digit month a credit card expires for a payment method.

paymentCard.expireYear

type: short

The four-digit year the credit card expires for a payment method.

paymentCard.isCardInfoSaved

type: bool

If true, the credit card information is saved to the customer account for future use.

paymentCard.isUsedRecurring

type: bool

If true, the credit card is used for a recurring order payment.

paymentCard.nameOnCard

type: string

The full name printed on a credit card. The name should match what is printed on the card exactly, used in validation during a payment.

paymentCard.paymentOrCardType

type: string

The type of credit card, such as Visa or Amex.

paymentCard.paymentServiceCardId

type: string

Unique identifier of the credit card from the payment service.

check

type: checkPayment

Information about the check used in the billing information, if it exists.

checkPayment.checkNumber

type: string

If applicable, the check number associated with the payment action or interaction.

customCreditType

type: string

Indicates a custom reward type.

data

type: Mozu.Core.Api.Contracts.Json

Custom data originated by the billing service.

externalTransactionId

type: string

Holds the transaction ID for an external payment type service.

isSameBillingShippingAddress

type: bool

If true, the system overrides the customer's billing address information with the supplied fulfillment information.

paymentType

type: string

The type of payment, such as credit card, check, or PayPal Express. Additional payment types will be supported in future releases.

paymentWorkflow

type: string

Identifies a specific workflow the payment goes through. This is used to define a workflow for external payment services.

purchaseOrder

type: purchaseOrderPayment

The purchase order payment details.

purchaseOrderPayment.customFields

type: list of purchaseOrderCustomField

Details of the custom text fields associated with the purchase order.

Refer to Custom Text Fields in the Purchase Order guides topic for more information.

purchaseOrderPayment.purchaseOrderCustomField.code

type: string

The unique identifier of the object.

purchaseOrderPayment.purchaseOrderCustomField.label

type: string

Descriptive text used as a label for objects, such as field names, facets, date ranges, contact information, and package information.

purchaseOrderPayment.purchaseOrderCustomField.value

type: string

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

purchaseOrderPayment.paymentTerm

type: purchaseOrderPaymentTerm

The details of the payment terms. The payment terms are made up of a code and a description.

Refer to Payment Terms in the Purchase Order guides topic for more information.

purchaseOrderPayment.purchaseOrderPaymentTerm.code

type: string

The unique identifier of the object.

purchaseOrderPayment.purchaseOrderPaymentTerm.description

type: string

The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types.

purchaseOrderPayment.purchaseOrderNumber

type: string

The purchase order number.

Note:  Kibo eCommerce does not validate the purchase order number by default; however, you can add validation functionality using Arc.js. Refer to Validate Purchase Orders During the Checkout Process in the Arc.js Guides for more information and examples.

storeCreditCode

type: string

The code that identifies the store credit to apply to the order.

storeCreditType

type: string

A payment referring to a store credit or gift card.

  • StoreCredit
  • GiftCard
  • Custom

StoreCredit and GiftCard are internally managed by Kibo eComm. Use Custom for externally managed gift cards or reward systems. If Custom is used, provide the name for the custom type in the CustomCreditType field.

token

type: paymentToken

The token to access billing information.

paymentToken.paymentServiceTokenId

type: string

The identifier of the payment service token.

paymentToken.type

type: string

The type of scope, which is a developer account or production tenant.

Operations

Operation Name Request URI Description
GetBillingInfo GET %7borderId%7d%2fbillinginfo%3fdraft%3d%7bdraft%7d%26responseFields%3d%7bresponseFields%7d

Retrieves the billing information associated with an order.

SetBillingInfo PUT %7borderId%7d%2fbillinginfo%3fupdatemode%3d%7bupdateMode%7d%26version%3d%7bversion%7d%26responseFields%3d%7bresponseFields%7d

Updates the billing information supplied for an order.