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": "[email protected]",
        "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	UAE Dirham
BGN	Bulgarian Lev
BHD	Bahraini Dinar
CZK	Czech Crown
EGP	Egyptian Pound
EUR	Euro
GBP	The British Pound
HUF	Hungarian Forint
INR	Indian Rupee
IQD	Iraqi Dinar
KWD	Kuwaiti Dinar
MAD	Moroccan Dirham
NGN	Nigerian Naira
OMR	Omani Rial
PLN	Polish Zloty
QAR	Qatari Riyal
RON	Romanian Leu
RUB	Russian Ruble
SAR	Suudi Arabistan Riyal
TRY	Turkish Lira
UAH	Ukrayna Grivnası
USD	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:

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

The response means that the order has been successfully migrated.