E-Commerce Service (1.0.0)

The array of orders you wish to update the settlement date for

The DivideBuy order ID for this order

The retailer’s order ID supplied at the time of order creation

The retailer’s order reference supplied at the time of order creation.

Accepts Mr, Mrs, Miss, Ms, Mx, Dr, Prof, Rev

Allows both upper and lower case alphabets with spaces, apostrophes, and hyphens up to 50 characters.

Allows both upper and lower case alphabets with spaces, apostrophes, and hyphens between 2 to 50 characters.

Accepts valid date of birth in YYYY-MM-DD format not younger than 18 years nor older than 100 years

Accepts valid UK mobile number - should be 11 digits long and begin with 07

Accepts any string value up to 12 characters.

Accepts any string value up to 50 characters.

Accepts any string value up to 50 characters.

Accepts any string value up to 50 characters.

Accepts any string value up to 50 characters.

Accepts any string value up to 25 characters.

Accepts any string value up to 100 characters.

Accepts any string value.

Must be in the format “YY-MM” where YY is the number of years, and MM is the number of months, that the customer has lived at this address. Either this field, or the following move_in_date field, are required for the current address.

Accepts a string value representing the date that the customer moved in to this address, in the format YYYY-MM-DD. Either this field, or the previous time_at_address field, are required for the current address.

Accepts any string value up to 12 characters.

Accepts any string value up to 50 characters.

Accepts any string value up to 50 characters.

Accepts any string value up to 50 characters.

Accepts any string value up to 50 characters.

Accepts any string value up to 50 characters.

Accepts any string value up to 100 characters.

Accepts any string value

Must be in the format “YY-MM” where YY is the number of years, and MM is the number of months, that the customer has lived at this address. This field is required, if the time_at_address is set on the customer’s current address.

Accepts a string value representing the date that the customer moved in to this address, in the format YYYY-MM-DD. This field is required, if the move_in_date is set on the customer’s current address.

Accepts one of the following values. "Employed full-time, "Employed part-time", "Self employed", "Pension", "Other", "Director of a limited company", Unemployed" or "Retired, not working"

Accepts onr of the following values. "Yes, outright owner", "Yes, with mortgage", "No, renting", "No, other"

The customer’s IP address - a single IP address of either IPv4 or IPv6 format, multiple IPs not supported.

Accepts integer value in pounds. The rent field is required if the residential status is not selected as “Yes, outright owner”, or “No, other” option.

Must be a string and match an existing nationality found in this list https://www.gov.uk/government/publications/nationalities/list-of-nationalities

The internal ID for the related order

The internal reference for the related order (if not available, the ID can be sent again)

The number of months the customer is requesting to spread the cost of their order over. This must be equal to one of the agreed terms you have enabled by us, other values will return an error.

The date of each month that the customer would like to make their payments. Accepts integer values between 1 to 31.

Subtotal of order in pounds

The VAT rate as a percentage (i.e. 20 for 20% VAT). If the VAT rate is not provided, we will use the rate we have configured for your account internally. We recommend providing this value where possible to ensure you are in control of the specific details of your orders.

Subtotal of order in pounds

Shipping total in pounds

Shipping method - typically an identifier for the shipping method such as ‘free_shipping’ or ‘express’ etc.

A more detailed description of the shipping method, i.e. “Free Shipping” or “Next-Day Delivery” etc.

Total amount of discount on the order, in pounds

When the discount is calculated within the order total. For more cases this will be beforeVat, with VAT only being applicable to the amount paid by the customer. Accepts beforeVat or afterVat.

Order total in pounds

Boolean value to state if the shipping address is the customer’s default shipping address - accepts 1 or 0

Boolean value to state if the billing address is the customer’s default billing address - accepts 1 or 0

The total the customer has paid upfront, in pounds. Please note - any upfront payments must be collected by yourselves before redirecting your customer to us to complete their application for the remainder of the amount.

The amount of credit being requested, in pounds. This is the order total, minus any upfront payment.

A representation of the sales channel used to generate this quote. For e-commerce/web orders, this field is not required, however for other channels - due to regulatory requirements - we are required to know the source or sales channel of the quote. For any of the following sales channels, the following value should be supplied here "Web orders (ecommerce/app) → not required", "Orders sold in store → in-store", "Orders created over the phone (telesales) → telephony" or "Orders created via a home visit → in-home"

An array of the line items that the order contains. Providing a line item breakdown of the order is not required, but to aid you and us to cross reference the details of orders for any queries, it is advised where possible to provide this information.

The name of the line item.

The SKU of the item.

The quantity of this item in the order

order.line_items.*.quantity

The price of the item, including any VAT. At least one of these parameters

The percentage of VAT applied to this item. If not provided, the value configured on your retailer account will be used.

The total cost for this item, excluding VAT. Equates to the unit cost excluding VAT, multiplied by the quantity. If not provided, the value will be calculated using the details configured on your retailer account.

The total cost for this item, including VAT. Equates to the unit cost including VAT, multiplied by the quantity. If not provided, the value will be calculated using the details configured on your retailer account.

The amount of discount applied directly to this line item, in pounds. If not provided, the value will be set to 0.

Accepts a valid URL that can be used to redirect the customer from our checkout, in the instance any unexpected errors occur. This value is optional, but if provided will allow us to redirect the customer to a URL specified by you in order for you to continue to manage the customer journey. The URL must be a valid URL, but you are free to add query parameters as you like, which will be preserved at the time of redirection.

An optional object describing the intended payment details.

Describes the payment method for the order. Currently the only acceptable value for this is direct_debit. Only accounts with explicit permission to pay via Direct Debit will be able to supply payment details here

The sort code of the account to be used for a Direct Debit payment. Must be an 6 character long string, and contain only digits (0-9). Please remove any hyphens or spaces before requesting a quote. Required if payment.method is direct_debit.

The account number of the account to be used for a Direct Debit payment. Must be an 8 character long string, and contain only digits (0-9). Please remove any hyphens or spaces before requesting a quote. Required if payment.method is direct_debit.