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.

order_number

integer

0..1

Order number of Speed4Trade CONNECT. Can be used for matching.

order_number_prefix

string

0..1

Prefix for the order number of Speed4Trade CONNECT. Can be used for order matching.

external_order_number_1

string

0..1

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

external_order_number_2

string

0..1

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

transaction_id_1

string

0..1

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

transaction_id_2

string

0..1

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

marketplace_order_id_1

string

0..1

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

marketplace_order_id_2

string

0..1

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

Identifier of the dispatch provider.

dispatch_provider_external_id

string

0..1

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

Customer number of Speed4Trade CONNECT.

customer_external_id_1

string

0..1

First external customer id.

customer_external_id_2

string

0..1

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

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

Company name in invoice address.

invoice_first_name

string

0..1

First name in invoice address.

invoice_last_name

string

0..1

Last name in invoice address.

invoice_street

string

0..1

Street in invoice address.

invoice_house_number

string

0..1

House number in invoice address.

invoice_street_addition

string

0..1

Additional street field in invoice address.

invoice_postal_code

string

0..1

Postal code in invoice address.

invoice_city

string

0..1

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

Phone number in invoice address.

invoice_email_address

string

0..1

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

Company name in alternative delivery address.

delivery_first_name

string

0..1

First name in alternative delivery address.

delivery_last_name

string

0..1

Last name in alternative delivery address.

delivery_street

string

0..1

Street in alternative delivery address.

delivery_house_number

string

0..1

House number in alternative delivery address.

delivery_street_addition

string

0..1

Additional street field in alternative delivery address.

delivery_postal_code

string

0..1

Postal code in alternative delivery address.

delivery_city

string

0..1

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

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

Name of the individually managed dispatch types in Speed4Trade CONNECT.

dispatch_type_external_id

string

0..1

External id of dispatch type.

dispatch_handling_identifier

string

0..1

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

VAT ID.

coupon_value

decimal

0..1

The amount of the coupon. No percentage.

exported_at

datetime

0..1

Timestamp of the export to an ERP system.

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

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

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

item_internal_number

string

0..1

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

item_match_code

string

0..1

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

item_ean_code

string

0..1

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

item_upc_code

string

0..1

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

item_isbn

string

0..1

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

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

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

A free field for reference number.

coupon_percent

decimal

0..1

Coupon percentage value.

expected_delivery_date

datetime

0..1

The expected delivery date.

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

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

External ID of the payment.

recipient

string

0..1

The recipient of the payment.

iban

string

0..1

IBAN of the payment.

bic

string

0..1

BIC of the payment.

bank_name

string

0..1

Name of the Bank.

payment_reason

string

0..1

The purpose of the payment.

note_to_buyer

string

0..1

A note for the buyer.

url

string

0..1

URL for payment.

transaction_number

string

0..1

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

The URL for downloading the SEPA mandate.

sepa_mandate_reference

string

0..1

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

The tracking number of the packet.

dispatch_provider_identifier

string

0..1

Name of the individually managed dispatch providers in Speed4Trade CONNECT.

dispatch_provider_external_id

string

0..1

External ID of dispatch provider.

dispatch_type_identifier

string

0..1

Name of the individually managed dispatch types in Speed4Trade CONNECT.

dispatch_type_external_id

string

0..1

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.

return_number

string

0..1

The RMA number of the return.

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

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

item_internal_number

string

0..1

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

item_match_code

string

0..1

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

item_ean_code

string

0..1

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

item_upc_code

string

0..1

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

item_isbn

string

0..1

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

tracking_number

string

0..1

The tracking number of the packet.

quantity

integer

0..1

Quantity of the item within the packet.

export_flags

Element

0..1

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

export_flag

Element

1..N

Element that contains all data of the export flag.

export_identifier

string

0..1

Identifier of the export flag.

export_time

datetime

0..1

The date and time of the export.

additional_order_data

Element

0..1

Element that combines the data of additional order data. It can contain several 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.

order_documents

Element

0..1

Element that combines the data of order documents. It can contain several order_document-nodes. Hint: the section order documents only exists if an invoice export type is set in job options.

order_document

Element

1..N

Element that contains all data of the order document.

type

string

1

Type of the order document, e.g. "INVOICE". See table of values below for further description.

pos

decimal

0..1

Position of the order document to separate order documents with the same type.

external_id

string

0..1

The external ID of the order document.

filename

string

0..1

The file name of the order document.

base64

string

0..1

The BASE64 encoded file content.

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.

Fulfillment by Amazon

The fulfillment is made by Amazon.

Fulfillment by Amazon failed

The fulfillment by Amazon has failed.

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.

Shopgate-Auftrag schwebend

Shopgate order pending.

Otto-Auftrags-Avisierung

Otto order notification.

eBay pending

On hold because the order is still being checked by eBay.

OXID pending

On hold because the order is still being checked by OXID.

Magento pending

On hold because the order is still being checked by Magento.

Outdated

Order date too old.

COMMERCE pending

On hold because the order is still being checked by COMMERCE.

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.

ISPU

In-store-pick-up for eBay Click and Collect.

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.

CANCELLATION INVOICE

Cancelled invoice

DELIVERY NOTE

Delivery note

INVOICE

Invoice

OFFER

Offer

ORDER

Order

PARCEL LABEL 1

Parcel label 1

PARCEL LABEL 2

Parcel label 2

RETURN TICKET

Return ticket

SEPA DEBIT AGREEMENT

Sepa debit agreement

SHIPPING LABEL

Shipping label

<?xml version="1.0" encoding="UTF-8"?>
<orders>
  <order>
    <order_number>29000</order_number>
    <order_number_prefix>G2</order_number_prefix>
    <external_order_number_1>EXT1</external_order_number_1>
    <external_order_number_2>EXT2</external_order_number_2>
    <transaction_id_1>TRN-12321</transaction_id_1>
    <transaction_id_2>ACT-23409</transaction_id_2>
    <marketplace_order_id_1>MPO-0001</marketplace_order_id_1>
    <marketplace_order_id_2>ORD-0002</marketplace_order_id_2>
    <order_date>2018-01-01T01:00:00.000+02:00</order_date>
    <dispatch_provider_identifier>Big Standard Delivery</dispatch_provider_identifier>
    <dispatch_provider_external_id>BigDeliv</dispatch_provider_external_id>
    <currency_code_iso>EUR</currency_code_iso>
    <payment_method_charge>2.0000</payment_method_charge>
    <payment_method_identifier>cash on delivery</payment_method_identifier>  
    <cash_on_delivery_charge>1.5000</cash_on_delivery_charge>
    <customer_number>130041</customer_number>
    <customer_type_identifier>private</customer_type_identifier>
    <customer_external_id_1>1234677</customer_external_id_1>
    <customer_external_id_2>9788797</customer_external_id_2>
    <customer_country_code_iso>DE</customer_country_code_iso>
    <invoice_number>5887</invoice_number>
    <invoice_salutation_identifier>mr</invoice_salutation_identifier>
    <invoice_title>Dipl.-Ing.</invoice_title>
    <invoice_company_name>Speed4Trade</invoice_company_name>
    <invoice_first_name>John</invoice_first_name>
    <invoice_last_name>Doe</invoice_last_name>
    <invoice_street>Alington</invoice_street>
    <invoice_house_number>0</invoice_house_number>
    <invoice_street_addition/>
    <invoice_postal_code>00123</invoice_postal_code>
    <invoice_city>Washington</invoice_city>
    <invoice_country_code_iso>COM</invoice_country_code_iso>
    <invoice_phone_number>00 000 - 000</invoice_phone_number>
    <invoice_email_address>mail@example.com</invoice_email_address>
    <delivery_salutation_identifier>ms</delivery_salutation_identifier>
    <delivery_title>Prof.</delivery_title>
    <delivery_company_name>Company</delivery_company_name>
    <delivery_first_name>Tina</delivery_first_name>
    <delivery_last_name>Miller</delivery_last_name>
    <delivery_street>Lombard Street</delivery_street>
    <delivery_house_number>13</delivery_house_number>
    <delivery_street_addition>a</delivery_street_addition>
    <delivery_postal_code>94177</delivery_postal_code>
    <delivery_city>San Francisco</delivery_city>
    <delivery_country_code_iso>COM</delivery_country_code_iso>
    <delivery_phone_number>10 101 - 010</delivery_phone_number>
    <on_hold_reason_note>checking by marketplace</on_hold_reason_note>
    <on_hold_reason_identifier>5% quote</on_hold_reason_identifier>
    <dispatch_type_external_id>BigStd</dispatch_type_external_id>
    <dispatch_type_identifier>BigStandard</dispatch_type_identifier>
    <dispatch_handling_identifier>Standard</dispatch_handling_identifier>
    <price_type_identifier>big</price_type_identifier>
    <order_status_identifier>outstanding payment</order_status_identifier>
    <payment_status_identifier>unpaid</payment_status_identifier>
    <shipping_charge>5.0000</shipping_charge>
    <weight>10.0000</weight>
    <tax_id_number>COM1203123</tax_id_number>
    <coupon_value>4.5000</coupon_value>
    <exported_at>2016-01-16T19:00:00</exported_at>
    <discount_amount>1.4500</discount_amount>
    <marketplace_actualisation_deactivated_at>2016-01-16T19:00:00</marketplace_actualisation_deactivated_at>
    <marketplace_username>sanfranco123</marketplace_username>
    <ready_for_collection_date>2016-01-23T19:00:00</ready_for_collection_date>
    <packstation>false</packstation>
    <tags>
      <tag>Checked</tag>
      <tag>VIP-Order</tag>
      <tag>Stamm B</tag>
    </tags>
    <order_items>
      <order_item>
        <item_identifier>Test Item</item_identifier>
        <item_internal_number>Test-0001</item_internal_number>
        <item_match_code>Match-001</item_match_code>
        <item_ean_code>0X1</item_ean_code>
        <item_upc_code>0Y1</item_upc_code>
        <item_isbn>0Z1</item_isbn>
        <order_date>2016-01-16T19:00:00</order_date>
        <quantity>1</quantity>
        <price>5.50</price>
        <purchase_price>2.49</purchase_price>
        <tax_rate>19.0000</tax_rate>
        <note>This is a test item</note>
        <serial_number>X12312-Y8349534</serial_number>
        <type_identifier>default</type_identifier>
        <reference_number>BBB-12343</reference_number>    
        <coupon_percent>0</coupon_percent>
        <expected_delivery_date>2017-05-05T00:00:00.000+02:00</expected_delivery_date>
        <discount_value>3.95</discount_value>
        <additional_order_item_data>
          <order_item_data>
            <key>KEY</key>
            <value>VAL</value>
          </order_item_data>
        </additional_order_item_data>
      </order_item>
    </order_items>
    <order_notices>
      <order_note>
        <text>Note1</text>
        <type>internal</type>
      </order_note>
      <order_note>
        <text>Note2</text>
        <type>external</type>
      </order_note>
    </order_notices>
    <payment_instructions>
      <payment_instruction>
        <external_id>xsz0001</external_id>
        <recipient>Speed4Trade Shopping</recipient>
        <iban>ag4ae4g</iban>
        <bic>34g34g</bic>
        <bank_name>Bank</bank_name>
        <payment_reason>Order-00000-$</payment_reason>
        <note_to_buyer>Please pay the amount in 9 days.</note_to_buyer>
        <url>www.speed4trade.com</url>
        <transaction_number>3522-6278-ABCD</transaction_number>
        <receipt_printing>true</receipt_printing>
        <amount>42.50</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/>
      </payment_instruction>
    </payment_instructions>
    <packets>
      <packet>
        <tracking_number>23718784519384180</tracking_number>
        <dispatch_provider_identifier>Big Standard Delivery</dispatch_provider_identifier>
        <dispatch_provider_external_id>BigDeliv</dispatch_provider_external_id>
        <dispatch_type_identifier>BigStandard</dispatch_type_identifier>
        <dispatch_type_external_id>BigStd</dispatch_type_external_id>
        <shipping_date>2017-06-14T09:52:16.000+02:00</shipping_date>
        <estimated_arrival_date>2017-06-16T16:00:00.000+02:00</estimated_arrival_date>

        <return_number>132654</return_number>

        <packet_content>
          <content>
            <item_identifier>Test Item - Variante</item_identifier>
            <item_internal_number>Test-0001</item_internal_number>
            <item_match_code>Match-001</item_match_code>
            <item_ean_code>0X1</item_ean_code>
            <item_upc_code>0Y1</item_upc_code>
            <item_isbn>0Z1</item_isbn>
            <tracking_number>23718784519384180</tracking_number>
            <quantity>1</quantity>
          </content>
        </packet_content>
      </packet>
    </packets>
    <export_flags>
      <export_flag>
        <export_identifier>Order exported to ERP</export_identifier>
        <export_time>2019-03-22T17:14:00.000+01:00</export_time>
      </export_flag>
    </export_flags>
    <additional_order_data>
      <order_data>
        <key>KEY</key>
        <value>VAL</value>
      </order_data>
    </additional_order_data>
    <!-- the section order documents only exists if an invoice export type is set in job options -->
    <order_documents>
      <order_document type="INVOICE" pos="0" external_id="R836238">
        <filename>invoice.pdf</filename>
        <base64>JVBERi0xLjQKJaqrrK0KNCAwIG9iago8PAovUHJvZH--BASE64-ENCODED-FILE-CONTENT--jk4MkI+XQo+PgpzdGFydHhyZWYKNzQzMwolJUVPRgo=</base64>
      </order_document>
    </order_documents>
  </order>
</orders>