order_ob.json

{
  "api_environment": "production",
  "vendor_id": "45",
  "vendor_order_id": "11223344",
  "internal_comment": "Any internal comment here",
  "customer_comment": "Any customer comment here",
  "payments": [
    {
      "via": "33",
      "payer_name": "Erika Mustermann"
    }
  ],
  "articles": [
    {
      "tariff_sku_id": "123456",
      "tax_rate": "19",
      "quantity": "1"
    }
  ],
  "addresses": [
    {
      "firstname": "Erika",
      "lastname": "Mustermann",
      "street": "wiesenmuehle straße 3",
      "city": "Fulda",
      "zipcode": "36037",
      "email": "erika@mustermann.de",
      "address_type": "1",
      "addition": "Zimmer 123",
      "country_iso": "DE"
    },
    {
      "full_name": "John Doe",
      "gender": "2",
      "street": "wiesenmuehle straße 9",
      "city": "Fulda",
      "zipcode": "36039",
      "email": "john@doe.de",
      "address_type": "2",
      "addition": "Zimmer 321",
      "country_iso": "DE"
    }
  ],
   "contract_data": {
    "id_type": "1",
    "id_place": "Fulda",
    "date_of_birth": "26.02.1993",
    "place_of_birth": "Fulda",
    "nationality": "de",
    "valid_till": "22.10.2022",
    "id_number": "123456789",
    "account_name": "Erika Musthamann",
    "account_iban": "DE08506521240001125566"
  }
}

"api_environment"
use "production" for production version and use "development" for testing.

"vendor_id": "45"
This is your Vendor ID in our company. Do not change.

"vendor_order_id": "11223344" (sample value)
Your Vtex Order ID. This is a Unique ID for every order.

"internal_comment": "Any internal comment here",
"customer_comment": "Any customer comment here",
Customer comments or your internal comments.

"payments": [
{
"via": "33", (This is Payment ID for your company in our system. Do not change.
"payer_name": "Erika Mustermann" (Customer name)
}
]

"articles": [
{
"tariff_sku_id": "123456", (This is the Contract ID we send to you in our "get_all_tariffs" endpoint. We need to talk about this)
"tax_rate": "19", (tax rate based on the country)
"quantity": "1" (this is usually 1 always)
}
],

Address information are pretty basic and I think no need to explain.
"address_type": "1" (Invoice address)
"address_type": "2" (Shipping address)

"contract_data": {
"id_type": "2", ( 2: Neuer Personalausweis, 3:Deutscher Reisepass, 4:Ausländischer Reisepass, 5:Personalausweis-EU )
"id_place": "Fulda", (ID issued location)
"date_of_birth": "26.02.1993",
"place_of_birth": "Fulda",
"nationality": "de",
"valid_till": "22.10.2022", (ID valid till date / when ID is expired)
"id_number": "123456789", (Number of the ID card)
"account_name": "Erika Musthamann", (Bank account name of customer)
"account_iban": "DE08506521240001125566" (Bank account number of the customer)
}