Speed4Trade CONNECT API 2.0

orders

Element

1

Wrapper element that combines the data of an order. It can contain several order-nodes.

order

Element

1..N

Wrapper element that contains all the data of one order.

external_order_number_1

string

0..1

100

First external order number, e.g. ERP order number. Can be used for order matching.

external_order_number_2

string

0..1

100

Second external order number, e.g. ERP order number. Can be used for order matching.

transaction_id_1

string

0..1

70

First payment transaction id. Can be used for order matching.

transaction_id_2

string

0..1

70

Second payment transaction id. Can be used for order matching.

marketplace_order_id_1

string

0..1

50

First marketplace order id. Can be used for order matching.

marketplace_order_id_2

string

0..1

50

Second marketplace order id. Can be used for order matching.

order_date

datetime

0..1

Timestamp when the order was placed on the trading platform.

dispatch_provider_identifier

string

0..1

100

Identifier of the dispatch provider.

dispatch_provider_external_id

string

0..1

100

External ID of the dispatch provider.

currency_code_iso

string

0..1

Current currency of the order in ISO 4217.

payment_method_charge

decimal

0..1

A fee for the payment method.

payment_method_identifier

string

0..1

Identifier of the payment method

cash_on_delivery_charge

decimal

0..1

An extra fee for cash on delivery.

customer_type_identifier

string

0..1

Identifier of the customer type. See table of values below for further description.

customer_number

integer

0..1

10

Customer number of Speed4Trade CONNECT.

customer_external_id_1

string

0..1

50

First external customer id.

customer_external_id_2

string

0..1

50

Second external customer id.

customer_country_code_iso

string

0..1

Country code of the customer in ISO 3166-1 alpha-2.

invoice_number

integer

0..1

10

Invoice number of Speed4Trade CONNECT.

invoice_salutation_identifier

string

0..1

Identifier of salutation in invoice address. See table of values below for further description

invoice_title

string

0..1

Title in invoice address.

invoice_company_name

string

0..1

200

Company name in invoice address.

invoice_first_name

string

0..1

200

First name in invoice address.

invoice_last_name

string

0..1

400

Last name in invoice address.

invoice_street

string

0..1

400

Street in invoice address.

invoice_house_number

string

0..1

100

House number in invoice address.

invoice_street_addition

string

0..1

400

Additional street field in invoice address.

invoice_postal_code

string

0..1

100

Postal code in invoice address.

invoice_city

string

0..1

400

City in invoice address.

invoice_country_code_iso

string

0..1

Country code in invoice address in ISO 3166-1 alpha-2.

invoice_phone_number

string

0..1

50

Phone number in invoice address.

invoice_email_address

string

0..1

100

Email address in invoice address.

delivery_salutation_identifier

string

0..1

Identifier of salutation in alternative delivery address. See table of values below for further description

delivery_title

string

0..1

Title in alternative delivery address.

delivery_company_name

string

0..1

200

Company name in alternative delivery address.

delivery_first_name

string

0..1

200

First name in alternative delivery address.

delivery_last_name

string

0..1

400

Last name in alternative delivery address.

delivery_street

string

0..1

400

Street in alternative delivery address.

delivery_house_number

string

0..1

100

House number in alternative delivery address.

delivery_street_addition

string

0..1

400

Additional street field in alternative delivery address.

delivery_postal_code

string

0..1

100

Postal code in alternative delivery address.

delivery_city

string

0..1

400

City in alternative delivery address.

delivery_country_code_iso

string

0..1

Country code in alternative delivery address in ISO 3166-1 alpha-2.

delivery_phone_number

string

0..1

50

Phone number in alternative delivery address.

on_hold_reason_note

string

0..1

Note to the on hold reason.

on_hold_reason_identifier

string

0..1

Identifier of the on hold reason. This can be one out of the table of values below or an individual reason.

dispatch_type_identifier

string

0..1

100

Name of the individually managed dispatch types in Speed4Trade CONNECT.

dispatch_type_external_id

string

0..1

100

External id of dispatch type.

dispatch_handling_identifier

string

0..1

100

price_type_identifier

string

0..1

Identifier of the price type. See table of values below for further description.

order_status_identifier

string

0..1

Identifier for order status. See table of values below for further description.

payment_status_identifier

string

0..1

Identifier for payment status. See table of values below for further description.

shipping_charge

decimal

0..1

Extra fee for shipping method.

weight

decimal

0..1

Weight of the order.

tax_id_number

string

0..1

50

VAT ID.

coupon_value

decimal

0..1

The amount of the coupon. No percentage.

discount_amount

decimal

0..1

The amount of the monetary discount.

marketplace_actualisation_deactivated_at

datetime

0..1

Timestamp when the synchronization with the trading platform was deactivated at.

marketplace_username

string

0..1

100

Username on the trading platform.

ready_for_collection_date

datetime

0..1

Timestamp when to order can be collected in a branch.

packstation

boolean

0..1

Flag, if the delivery address is a Packstation.

tags

Element

0..1

Element that combines the data of order tags. It can contain several tag-nodes.

tag

string

1..N

Name of an order tag. This can be one out of the table of values below or an individual one.

order_items

Element

0..1

Element that combines the data of order items. It can contain several order_item-nodes.

order_item

Element

1..N

Element that contains all data of one order item.

item_identifier

string

0..1

200

Identifier of the item. Can be used for order matching.

item_internal_number

string

0..1

50

Internal number of the item. Can be used for order matching.

item_match_code

string

0..1

100

Matchcode of the item. Can be used for order matching.

item_ean_code

string

0..1

30

EAN number of the item. Can be used for order matching.

item_upc_code

string

0..1

12

UPC number of the item. Can be used for order matching.

item_isbn

string

0..1

13

ISBN number of the item. Can be used for order matching.

position_number

integer

0..1

Sequential number of the item.

order_date

datetime

0..1

The date when the position was added to the order. Mandatory for new order items.

quantity

integer

0..1

Quantity of the ordered item.

price

decimal

0..1

Price of one ordered item.

purchase_price

decimal

0..1

Purchase price of the item.

tax_rate

decimal

0..1

Tax rate in percent.

note

string

0..1

Note for this order item.

serial_number

string

0..1

50

Serial number of the item.

type_identifier

string

0..1

Type of the order item. See table of values below for further description.

reference_number

string

0..1

400

A free field for reference number.

channel_item_number

string

0..1

The item number of the trading platform.

coupon_percent

decimal

0..1

Coupon percentage value.

expected_delivery_date

datetime

0..1

The expected delivery date.

cancel_date

datetime

0..1

The timestamp when the entire order was canceled.

discount_value

decimal

0..1

The discount value (no percentage) of one ordered item.

additional_order_item_data

Element

0..1

Element that combines the data of additional order item data. It can contain several order_item_data-nodes.

order_item_data

Element

1.N

Element that contains all additional data for one order item.

key

string

0..1

The key of the additional data.

value

string

0..1

The value of the additional data.

order_notices

Element

0..1

Element that combines all order notices. It can contain several order_note-nodes.

order_note

Element

1..N

Element that contains all data of one order note.

text

string

0..1

1000

The content of the order note.

type

string

0..1

The type of the order note. See table of values below for further description.

payment_instructions

Element

0..1

Element that combines the data of payment instructions. It can contain several payment_instruction-nodes.

payment_instruction

Element

0..N

Element that contains all data for one payment instruction.

external _id

string

0..1

50

External ID of the payment.

recipient

string

0..1

150

The recipient of the payment.

iban

string

0..1

34

IBAN of the payment.

bic

string

0..1

11

BIC of the payment.

bank_name

string

0..1

150

Name of the Bank.

payment_reason

string

0..1

140

The purpose of the payment.

note_to_buyer

string

0..1

300

A note for the buyer.

url

string

0..1

300

URL for payment.

transaction_number

string

0..1

50

The payment transaction number.

receipt_printing

boolean

0..1

This flag controls whether the payment information is printed in the receipt.

amount

decimal

0..1

The amount of the payment instruction.

currency_code_iso

string

0..1

Current currency of the order in ISO 4217.

due_date

datetime

0..1

The due date of the payment.

sepa_mandate_url

string

0..1

2083

The URL for downloading the SEPA mandate.

sepa_mandate_reference

string

0..1

35

The reference number of the SEPA mandate.

packets

Element

0..1

Element that combines the data of packets. It can contain several packet-nodes.

packet

Element

1..N

Element that contains all data of one packet.

tracking_number

string

0..1

200

The tracking number of the packet.

dispatch_provider_identifier

string

0..1

100

Name of the individually managed dispatch providers in Speed4Trade CONNECT.

dispatch_provider_external_id

string

0..1

100

External ID of dispatch provider.

dispatch_type_identifier

string

0..1

100

Name of the individually managed dispatch types in Speed4Trade CONNECT.

dispatch_type_external_id

string

0..1

100

External ID of dispatch type.

shipping_date

datetime

0..1

The shipping date of the packet.

estimated_arrival_date

datetime

0..1

The estimated date of arrival of the packet.

packet_content

Element

0..1

Element that combines the data of packet content. It can contain several content-nodes.

content

Element

1..N

Element that contains all data of the packet content.

item_identifier

string

0..1

200

Identifier of the item. Can be used for order matching.

item_internal_number

string

0..1

50

Internal number of the item. Can be used for order matching.

item_match_code

string

0..1

100

Matchcode of the item. Can be used for order matching.

item_ean_code

string

0..1

30

EAN number of the item. Can be used for order matching.

item_upc_code

string

0..1

12

UPC number of the item. Can be used for order matching.

item_isbn

string

0..1

13

ISBN number of the item. Can be used for order matching.

quantity

integer

0..1

Quantity of the item within the packet.

additional_order_data

Element

0..1

Element that combines the data of additional order data. It can contain severeal order_data-nodes.

order_data

Element

1..N

Element that contains all additional data for one order.

key

string

0..1

The key of the additional data.

value

string

0..1

The value of the additional data.

10

new

New order.

120

outstanding payment

The order is confirmed but the payment is outstanding.

130

paid shipping

The order is paid and can be shipped.

140

shipped complete

The order is shipped and completed.

220

confirmed shipping

The order is confirmed and can be shipped.

230

shipped outstanding

The order is shipped but the payment is outstanding.

240

paid complete

The order is paid and completed.

320

confirmed pickup

The order is confirmed and can be picked up.

330

pickedup completed

The order is picked up and completed.

985

regrouped

The order items are regrouped to another order.

990

canceled

The order is canceled.

995

back order

The order is parked in back order, e.g. until the confirmation of the trading platform receives.

0

default

The default type for order items.

1

coupon fixvalue

The order item is a coupon position with a fix value.

2

coupon percentvalue

The order item is a coupon position with a percentual value.

3

additional service

The order item is a service for another order item.

4

reversal item

The order item is a reversal item.

business

The customer is a business client.

private

The customer is a private client.

mr

Salutation for male clients.

ms

Salutation for female clients.

business

Salutation for companies.

Set shipment status failed

Setting the shipment status failed.

Manuelle Rückstellung

The order was set on hold manually.

Klarna-Auftrag schwebend

Klarna order pending.

Klarna-Auftrag verweigert

Klarna order denied.

Outdated

Order date too old.

gross

All prices of the order are incl. VAT.

net

All prices of the order are excl. VAT.

unpaid

There exists no payment for this order.

underpaid

This order is not fully paid.

paid

This order is full paid.

overpaid

The customer paid too much for this order.

PRIORITY

Priority shipping required.

EXTERNAL_INVOICING

Indicator for external invoice creation.

B2B

Indicator for B2B orders.

internal

Internal order note.

external

External order note. This will be used for document print-out.

amazon pay

200

Pay by Amazon payment.

billsafe

200

Pay by Billsafe.

cash

300

Pay cash on pickup.

cash on delivery

100

Pay by cash on delivery.

credit card

100

Pay by Creditcard.

debit

100

Pay by debit.

finance

100

Pay by finance.

giropay

200

Pay by Giropay.

invoice

200

Pay by invoice.

klarna account

200

Pay by rate to Klarna.

klarna invoice

200

Pay by invoice to Klarna.

marketplace payment

200

Pay by method which is defined from marketplace.

paypal

100

Pay by PayPal.

prepay

100

Pay by prepay.

RatePAY

200

Pay by rate to RatePAY.

sofortueberweisung

100

Pay by Sofortueberweisung.

<?xml version="1.0" encoding="UTF-8"?>
<orders>
  <order>
    <order_number>290</order_number>
    <order_number_prefix>M</order_number_prefix>
    <external_order_number_1>Order O1001</external_order_number_1>
    <external_order_number_2>ERPA1001</external_order_number_2>
    <transaction_id_1>O8376262537</transaction_id_1>
    <transaction_id_2>A845464515</transaction_id_2>
    <marketplace_order_id_1>MPO5822</marketplace_order_id_1>
    <marketplace_order_id_2/>
    <order_date>2017-01-01T15:00:00.000+01:00</order_date>
    <dispatch_provider_identifier>DHL</dispatch_provider_identifier>
    <dispatch_provider_external_id>DHL</dispatch_provider_external_id>
    <currency_code_iso>EUR</currency_code_iso>
    <payment_method_charge>2.00</payment_method_charge>
    <payment_method_identifier>cash on delivery</payment_method_identifier>
    <cash_on_delivery_charge>1.50</cash_on_delivery_charge>
    <customer_type_identifier>private</customer_type_identifier>
    <customer_number>1744541</customer_number>
    <customer_external_id_1>KU9704</customer_external_id_1>
    <customer_external_id_2/>
    <customer_country_code_iso>DE</customer_country_code_iso>
    <invoice_number>10006545</invoice_number>
    <invoice_salutation_identifier>mr</invoice_salutation_identifier>
    <invoice_title>Dr.</invoice_title>
    <invoice_company_name>Speed4Trade GmbH</invoice_company_name>
    <invoice_first_name>Firstname</invoice_first_name>
    <invoice_last_name>Lastname</invoice_last_name>
    <invoice_street>An den Gärten</invoice_street>
    <invoice_house_number>8-10</invoice_house_number>
    <invoice_street_addition>Hauptgebäude</invoice_street_addition>
    <invoice_postal_code>92655</invoice_postal_code>
    <invoice_city>Altenstadt</invoice_city>
    <invoice_country_code_iso>DE</invoice_country_code_iso>
    <invoice_phone_number>+499602/9444-0</invoice_phone_number>
    <invoice_email_address>info@speed4trade.com</invoice_email_address>
    <delivery_salutation_identifier>ms</delivery_salutation_identifier>
    <delivery_title/>
    <delivery_company_name>Speed4Trade GmbH</delivery_company_name>
    <delivery_first_name>Tina</delivery_first_name>
    <delivery_last_name>Target</delivery_last_name>
    <delivery_street>An den Gärten</delivery_street>
    <delivery_house_number>8-10</delivery_house_number>
    <delivery_street_addition/>
    <delivery_postal_code>92665</delivery_postal_code>
    <delivery_city>Altenstadt</delivery_city>
    <delivery_country_code_iso>DE</delivery_country_code_iso>
    <delivery_phone_number>09602/94440</delivery_phone_number>
    <on_hold_reason_note/>
    <on_hold_reason_identifier>5% Prüfungsquote</on_hold_reason_identifier>
    <dispatch_type_identifier>Standard</dispatch_type_identifier>
    <dispatch_type_external_id>Normalversand</dispatch_type_external_id>
    <dispatch_handling_identifier>Standard</dispatch_handling_identifier>
    <price_type_identifier>gross</price_type_identifier>
    <order_status_identifier>outstanding payment</order_status_identifier>
    <payment_status_identifier>unpaid</payment_status_identifier>
    <shipping_charge>5.00</shipping_charge>
    <weight>10.00</weight>
    <tax_id_number>DE999999999</tax_id_number>
    <coupon_value>4.50</coupon_value>
    <exported_at>2017-01-01T15:00:00.000+01:00</exported_at>
    <discount_amount>1.45</discount_amount>
    <marketplace_actualisation_deactivated_at>2017-01-01T15:00:00.000+01:00</marketplace_actualisation_deactivated_at>
    <marketplace_username>mp_username_2017</marketplace_username>
    <ready_for_collection_date>2017-01-01T15:00:00.000+01:00</ready_for_collection_date>
    <packstation>false</packstation>
    <tags>
      <tag>Priority</tag>
    </tags>
    <order_items>
      <order_item>
        <item_identifier>Item title</item_identifier>
        <item_internal_number>II-7222</item_internal_number>
        <item_match_code>MC_872364</item_match_code>
        <item_ean_code>5901234123457</item_ean_code>
        <item_upc_code>036000291452</item_upc_code>
        <item_isbn>9783161484100</item_isbn>
        <position_number>1</position_number>
        <order_date>2017-01-01T15:00:00.000+01:00</order_date>
        <quantity>1</quantity>
        <price>9.99</price>
        <purchase_price>7.52</purchase_price>
        <tax_rate>19.00</tax_rate>
        <note>Please pack as gift</note>
        <serial_number>SN-Z18743287</serial_number>
        <type_identifier>default</type_identifier>
        <reference_number>ABC-9227273</reference_number>
        <channel_item_number>3937464383145</channel_item_number>
        <coupon_percent>10</coupon_percent>
        <expected_delivery_date>2017-01-01T15:00:00.000+01:00</expected_delivery_date>
        <cancel_date>2017-01-01T15:00:00.000+01:00</cancel_date>
        <discount_value>3.95</discount_value>
        <additional_order_item_data>
          <order_item_data>
            <key>Key</key>
            <value>Value</value>
          </order_item_data>
        </additional_order_item_data>
      </order_item>
    </order_items>
    <order_notices>
      <order_note>
        <text>Note 1</text>
        <type>internal</type>
      </order_note>
      <order_note>
        <text>Note 2</text>
        <type>external</type>
      </order_note>
    </order_notices>
    <payment_instructions>
      <payment_instruction>
        <external_id>960127695P2891V</external_id>
        <recipient>Speed4Trade GmbH</recipient>
        <iban>DE00753900001234567890</iban>
        <bic>GENODEF1WEV</bic>
        <bank_name>Volksbank Raiffeisenbank Nordoberpfalz eG</bank_name>
        <payment_reason/>

        <note_to_buyer>Bitte Ã¼berweisen Sie EUR 10,00 bis 2017-01-01 auf das Bankkonto von PayPal. Empfänger: "PayPal Europe". IBAN: "DE281207008880011197". BIC: "DEUTDEDBPAL". Name der Bank: "Deutsche Bank". Referenznummer: "7GH234816E0900S4T".</note_to_buyer>
        <url>https://www.speed4trade.com</url>
        <transaction_number>74C66483WS123F</transaction_number>
        <receipt_printing>true</receipt_printing>
        <amount>15.99</amount>

        <currency_code_iso>EUR</currency_code_iso>
        <due_date>2019-03-22T17:14:00.000+01:00</due_date>
        <sepa_mandate_url/>
        <sepa_mandate_reference>131516181920</sepa_mandate_reference>

      </payment_instruction>
    </payment_instructions>
    <packets>
      <packet>
        <tracking_number>123456789012</tracking_number>
        <dispatch_provider_identifier>DHL</dispatch_provider_identifier>
        <dispatch_provider_external_id>DHL</dispatch_provider_external_id>
        <dispatch_type_identifier>Standard</dispatch_type_identifier>
        <dispatch_type_external_id>Normalversand</dispatch_type_external_id>
        <shipping_date>2017-01-01T15:00:00.000+01:00</shipping_date>
        <estimated_arrival_date>2017-01-01T15:00:00.000+01:00</estimated_arrival_date>
        <packet_content>
          <content>
            <item_identifier>Item identifier</item_identifier>
            <item_internal_number>II-7222</item_internal_number>
            <item_match_code>MC_872364</item_match_code>
            <item_ean_code>5901234123457</item_ean_code>
            <item_upc_code>036000291452</item_upc_code>
            <item_isbn>9783161484100</item_isbn>
            <quantity>1</quantity>
          </content>
        </packet_content>
      </packet>
    </packets>
    <additional_order_data>
      <order_data>
        <key>Key</key>
        <value>Value</value>
      </order_data>
    </additional_order_data>
  </order>
</orders>