# Address Migration

Address migrations will result in an error if user migrations have not been performed beforehand.

### Example Request

```
curl --location --request POST 'https://{{omnitron_url}}/api/v1/remote/{{channel_id}}/migrations/start/address/' \
--header 'Authorization: Token {{token}}' \
--form 'file=@"/path/to/test_address.json"'
```

#### **Test Address File Format (test\_address.json)**

```
[
    {
        "title": “test”,
        "phone_number": "9999999999",
        "customer_code": "1",
        "first_name": "Lorem",
        "last_name": "Ipsum",
        "township": "ÜSKÜDAR",
        "tax_no": null,
        "country": "Türkiye",
        "company_name": null,
        "city": "İSTANBUL",
        "tax_office": null,
        "line": "A Mh., B Caddesi, C Apt., No 1/2 34000 Üsküdar/İstanbul",
        "email": "lorem.ipsum@mail.com",
        "district": null
    }
]
```

**Description:**

The data format requirements for each field in the context of address migration are as follows:

* **"number"**: Should be in String format, mandatory, and limited to 255 characters.
* **"customer\_code"**: Should be in String format, mandatory. Must match the customer\_code from user migration. This matching is how users and orders are correlated in Omnitron.
* **"user\_email"**: Should be in Email format, mandatory.
* **"status"**: Should be in String format, mandatory, limited to 64 characters.
* **"created\_date"**: Should be in the format detailed in the datetime\_format of user migration.
* **"amount"**: Should be in Float format, maximum of 12 digits, accepting 2 digits after the decimal point. Mandatory.
* **"discount\_amount"**: Should be in Float format, maximum of 12 digits, accepting 2 digits after the decimal point. Can be null.
* **"currency"**: Should be in String format, mandatory. Allowable values for the currency field are detailed elsewhere.
* **"payment\_type"**: Should be in String format, limited to 64 characters. Can be null or an empty string.
* **"bank"**: Should be in String format, limited to 64 characters. Can be null or an empty string.
* **"installment\_count"**: Should be in Integer format, with a minimum value of 1.
* **"tracking\_number"**: Should be in String format, mandatory, limited to 64 characters. Can be null or an empty string.
* **"shipping\_company"**: Should be in String format. Allowable values for the shipping\_company field are detailed elsewhere. Can be null.
* **"shipping\_address"**: Should be in String format, mandatory, limited to 512 characters.
* **"billing\_address"**: Should be in String format, mandatory, limited to 512 characters.
* **"extra\_field"**: Should be in Dictionary format. If empty, it should be provided as {}.

#### **Currency Format:**

The following values are accepted for the currency field:

| Code | Description                                                                                                                                                  |
| ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| AED  | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/c/cb/Flag_of_the_United_Arab_Emirates.svg/23px-Flag_of_the_United_Arab_Emirates.svg.png) UAE Dirham |
| BGN  | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/9/9a/Flag_of_Bulgaria.svg/23px-Flag_of_Bulgaria.svg.png) Bulgarian Lev                              |
| BHD  | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/2/2c/Flag_of_Bahrain.svg/23px-Flag_of_Bahrain.svg.png) Bahraini Dinar                               |
| CZK  | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/c/cb/Flag_of_the_Czech_Republic.svg/23px-Flag_of_the_Czech_Republic.svg.png) Czech Crown            |
| EGP  | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/f/fe/Flag_of_Egypt.svg/23px-Flag_of_Egypt.svg.png) Egyptian Pound                                   |
| EUR  | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/b/b7/Flag_of_Europe.svg/23px-Flag_of_Europe.svg.png) Euro                                           |
| GBP  | ![](https://upload.wikimedia.org/wikipedia/en/thumb/a/ae/Flag_of_the_United_Kingdom.svg/23px-Flag_of_the_United_Kingdom.svg.png) The British Pound           |
| HUF  | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/c/c1/Flag_of_Hungary.svg/23px-Flag_of_Hungary.svg.png) Hungarian Forint                             |
| INR  | ![](https://upload.wikimedia.org/wikipedia/en/thumb/4/41/Flag_of_India.svg/23px-Flag_of_India.svg.png) Indian Rupee                                          |
| IQD  | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/f/f6/Flag_of_Iraq.svg/23px-Flag_of_Iraq.svg.png) Iraqi Dinar                                        |
| KWD  | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/a/aa/Flag_of_Kuwait.svg/23px-Flag_of_Kuwait.svg.png) Kuwaiti Dinar                                  |
| MAD  | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/2/2c/Flag_of_Morocco.svg/23px-Flag_of_Morocco.svg.png) Moroccan Dirham                              |
| NGN  | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/7/79/Flag_of_Nigeria.svg/23px-Flag_of_Nigeria.svg.png) Nigerian Naira                               |
| OMR  | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Flag_of_Oman.svg/23px-Flag_of_Oman.svg.png) Omani Rial                                         |
| PLN  | ![](https://upload.wikimedia.org/wikipedia/en/thumb/1/12/Flag_of_Poland.svg/23px-Flag_of_Poland.svg.png) Polish Zloty                                        |
| QAR  | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/6/65/Flag_of_Qatar.svg/23px-Flag_of_Qatar.svg.png) Qatari Riyal                                     |
| RON  | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/7/73/Flag_of_Romania.svg/23px-Flag_of_Romania.svg.png) Romanian Leu                                 |
| RUB  | ![](https://upload.wikimedia.org/wikipedia/en/thumb/f/f3/Flag_of_Russia.svg/23px-Flag_of_Russia.svg.png) Russian Ruble                                       |
| SAR  | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/0/0d/Flag_of_Saudi_Arabia.svg/23px-Flag_of_Saudi_Arabia.svg.png) Suudi Arabistan Riyal              |
| TRY  | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/b/b4/Flag_of_Turkey.svg/23px-Flag_of_Turkey.svg.png) Turkish Lira                                   |
| UAH  | ![](https://upload.wikimedia.org/wikipedia/commons/thumb/4/49/Flag_of_Ukraine.svg/23px-Flag_of_Ukraine.svg.png) Ukrayna Grivnası                             |
| USD  | ![](https://upload.wikimedia.org/wikipedia/en/thumb/a/a4/Flag_of_the_United_States.svg/20px-Flag_of_the_United_States.svg.png) United States Dollar          |

#### **Shipping Company Format:**

The following values are accepted for the shipping\_company field:

(format: "shipping company": "accepted value")

Example: "ACS Kargo": "acs",

### Example Response

When a request is made, the response received will be as follows:

```
{"migration_id": "2740e84efe2e4bea91615f46f567aa3c"}
```

#### **Control**

For verification, the following request is sent:

```
curl --location --request GET 'https://{{omnitron_url}}/api/v1/remote/{{channel_id}}/migrations/{{migration_id}}/progress/' \  
--header 'Authorization: Token {{token}}'
```

If the response received is as follows:

```json
{
    "total_count": 1,
    "error_count": 0,
    "processed_count": 1
}
```

The response means that the order has been successfully migrated.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidocs.akinon.com/omnitron/integration/migration/address-migration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
