پرش به محتویات

سفارشات

سفارش جدید

برای ایجاد سفارش جدید در آمادست می‌توانید از طریق اندپوینت زیر اقدام نمایید

اندپوینت

https://api.amadast.com/external-api/v1.0/pre-orders

پارامترهای ارسالی

در جدول زیر موارد ارسالی در body به صورت کامل توضیح داده شده اند:

ردیف فیلد توضیحات
۱ store_id * شناسه فروشگاه
۲ order_id * شناسه سفارش در سایت شما
۳ sender_name * نام ونام خانوادگی فرستنده
۴ sender_mobile* شماره همراه فرستنده
۵ recipient_name* نام ونام خانوادگی گیرنده
۶ recipient_mobile* شماره همراه گیرنده
۷ recipient_city_id* شناسه شهر گیرنده
۸ recipient_address* آدرس گیرنده
۹ recipient_postal_code* کدپستی گیرنده
۱۰ weight* وزن(به گرم)
۱۱ value* ارزش(به ریال)
۱۲ product_type* نوع محصول
۱۳ package_type* نوع مرسوله
۱۴ description توضیحات
۱۵ is_big* بزرگ
۱۶ is_breakable* شکستنی
۱۷ is_liquid* مایعات

نکته: موارد ستاره دار بایستی پر شوند.

نمونه کد

نحوه درخواست برای ایجاد سفارش جدید به صورت زیر می‌باشد:

<?php
$client = new Client();

$headers = [
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9....'
];

$body = '{
  "store_id": 20608,
  "order_id": 4456567,
  "sender_name": "علوی زاده",
  "sender_mobile": "09011487821",
  "recipient_name": "سید احمد مرتضوی",
  "recipient_mobile": "09012345678",
  "recipient_city_id": 170,
  "postal_code": "6831743715",
  "recipient_address": "اصفهان.نجف آباد.امیراباد.خ طالقانی.کوی موگویی.پلاک ۱۵",
  "recipient_postal_code": "6831743715",
  "weight": "1150",
  "value": 830900000,
  "product_type": "1",
  "package_type": "3",
  "description": "توضیحات سفارش",
  "is_big": false,
  "is_breakable": true,
  "is_liquid": false
}';


$request = new Request('POST', 'https://api.amadast.com/external-api/v1.0/pre-orders', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

در صورت موفقیت آمیز بودن عملیات مقدار بازگشتی به صورت زیر می‌باشد:


{
    "result": true,
    "code": 201,
    "message": [
        "سفارش با موفقیت ثبت شد"
    ],
    "data": {
        "id": 1999522,
        "hash_id": "lXAR3",
        "user_id": 1155,
        "store": 25207,
        "order_id": 4456567,
        "sender_name": "علوی زاده",
        "sender_mobile": "09011487821",
        "recipient_name": "سید احمد مرتضوی",
        "recipient_mobile": "09012345678",
        "recipient_address": "اصفهان.نجف آباد.امیراباد.خ طالقانی.کوی موگویی.پلاک ۱۵",
        "recipient_postal_code": "6831743715",
        "recipient_city": {
            "id": 170,
            "title": "اصفهان",
            "province": {
                "id": 4,
                "title": "اصفهان",
                "location": null
            },
            "location": "32,51"
        },
        "weight": "1150",
        "value": 830900000,
        "paid_at": null,
        "payable": null,
        "product_type": {
            "id": "1",
            "title": "پوشاک"
        },
        "package_type": {
            "id": "3",
            "title": "کارتن سایز 3 (200 × 200 × 150 میلیمتر)"
        },
        "description": "توضیحات سفارش",
        "created_at": "2024-06-12T12:58:27.000000Z"
    }
}

در صورت نامعتبر بودن شناسه‌ی فروشگاه مقدار بازگشتی به صورت زیر می‌باشد:


{
    "result": false,
    "data": null,
    "message": {
        "store_id": [
            "فروشگاه مورد نظر یافت نشد."
        ]
    }
}

در صورت تکراری بودن شناسه‌ی سفارش در یک فروشگاه مقدار بازگشتی به صورت زیر می‌باشد:


{
    "result": false,
    "data": null,
    "message": {
        "order_id": [
            "سفارش وارد شده در این فروشگاه تکراری است."
        ]
    }
}

درصورت وجود خطای سیستمی مقدار بازگشتی به صورت زیر می‌باشد:


{
    "result": false,
    "code": 500,
    "message": [
        "خطای سیستمی"
    ],
    "data": null
}