• مشخصات پروفایل

*وزن و قیمت استفاده شده به عنوان ورودی و همچنین پارامترهای خروجی مرتبط با آنها، به ترتیب بر حسب گرم و تومان می باشد.

• استعلام وضعیت سفارشات ثبت شده به صورت جیسون

http://api.zagma.ir/orderstatus

http://api.zagma.org/orderstatus (لینک کمکی)

"barcod":null,
"timeit":0,
"vazit":0,
"vaz":"false

میباشد، در این حالت مقدار vaz که نشان دهنده وضعیت عملکرد میباشد برابر false است. در صورت درست اجرا شدن، مقدار vaz برابر true شده و پارامترهای زیر ایجاد میشوند: ( در فایل نمونه checkvaziat )

• استعلام هزینه خدمات، ارسال دیتا به صورت جیسون

http://api.zagma.ir/requestpricepostnew  (استعلام قیمت برای ثبت در پست)

http://api.zagma.org/requestpricepostnew (لینک کمکی)

http://api.zagma.ir/requestpricenedexnew  (استعلام قیمت برای ثبت در ندکس)

http://api.zagma.org/requestpricenedexnew (لینک کمکی)

http://api.zagma.ir/requestpricetipaxnew (استعلام قیمت برای ثبت در تیپاکس)

http://api.zagma.org/requestpricetipaxnew (لینک کمکی)

http://api.zagma.ir/requestpricemotornew(استعلام قیمت برای ثبت در پیک موتوری)

http://api.zagma.org/requestpricemotornew(لینک کمکی)

خروجی این متد در صورت نادرست بودن به صورت جیسون :

"code":12,
"vaz":"false,
"dalil": "فروشگاه انتخابی غیر مجاز میباشد"

میباشد، در این حالت مقدار vaz که نشان دهنده وضعیت عملکرد میباشد برابر false است. در صورت درست اجرا شدن، مقدار vaz برابر true شده و پارامترهای زیر ایجاد میشوند: ( در فایل نمونه reqprice )

*فروشگاه هایی که به صورت مارکت پلیس(market place) یا چند فروشگاهی فعالیت می کنند و چندین فروشگاه در سراسر ایران دارند، می توانند با ارسال تنها کد استان فروشگاه ارسال کننده در پارامتر ostansender به علاوه پارامترهای ذکر شده در جدول استعلام هزینه خدمات (بدون ارسال کد هر فروشگاه) هزینه ارسال را دریافت نمایند، لطفا توجه داشته باشید که این قابلیت تنها برای استعلام هزینه خدمات بوده و برای ثبت سفارش حتما می بایست کد فروشگاه درست ارسال گردد.*مقدار این پارامترها در صورت درست بودن، به صورت یک عدد (برای مثال 7134.4) خواهد بود، در غیر این صورت مقدار آنها برابر با ‘نامعتبر‘ می باشد. (برای مثال استان هرمزگان»کیش که تنها به صورت ارسال پیشتاز آنلاین {پرداخت شده} قابل ارسال است، همچنین در صورتی که نوع هزینه گزینه یک {ثابت} قرار داده شود، خروجی پارامترها کلمه ‘رایگان‘ می باشد.)

*در صورتی که پارامترهای ارسالی درست باشد ولی به دلیل بروز اشکال فنی در ارتباط با شرکت های حمل و نقل، سیستم نتواند هزینه پستی را تخمین بزند، هزینه آنلاین به صورت “نامعتبر” اعلام می گردد ولی هزینه پرداخت در محل به صورت “بعد از ارسال” اعلام می گردد.

• ثبت سفارش (به صورت سبد خرید) ارتباط از طریق جیسون با لینک

http://api.zagma.ir/orderwitharray

http://api.zagma.org/orderwitharray (لینک کمکی)

خروجی این متد در صورت نادرست بودن به صورت جیسون :

"code":11,
"vaz":"false",
"dalil": "نام کاربری یا رمز عبور نادرست میباشد"

میباشد، در این حالت مقدار vaz که نشان دهنده وضعیت عملکرد میباشد برابر false است.  در صورت درست اجرا شدن، مقدار vaz برابر true شده و پارامترهای زیر ایجاد میشوند: ( در فایل نمونه sabsefaresharray )

در حالت عادی قیمت کل سبد خرید به عنوان قیمت نهایی مرسوله در نظر گرفته می شود، ولی با ارسال پارامتر exceptions جمع قیمت مرسولات موجود در سبد خرید به عنوان قیمت نهایی در نظر گرفته می شود.

در صورتی که کالاهای موجود در انبارهای زاگما و یا در فراگما ثبت شده بودند، لطفا در کنار اطلاعات بالا عبارت زیر را هم برای انبارداری kalaja را برابر a و برای کالاهای موجود در فراگما kalaja را برابر f قرار دهید.

• اعمال هزینه بسته بندی بر روی مرسولات ارسالی :

1. در پنل مدیریت زاگما وارد قسمت مدیرت فراگما » تنظیمات فراگما شده و هزینه بسته بندی مورد نظرتان را برای تمام مرسولات ثبتی اعمال نمایید.
2. در وب سرویس هنگام ثبت سفارش مقدار هزینه بسته بندی را به تومان توسط پارامتر packaging اعمال نمایید.

همچنین میتوانید در قسمت مدیرت فراگما » تنظیمات فراگما عبارت “هزینه بسته‌بندی” که بر روی فاکتورهای پرینت شده، نمایش داده می شود را تغییر دهید.

•  پنهان کردن نام مرسولات ارسالی (افزایش امنیت مرسولات ارسالی) :

1. در پنل مدیریت زاگما وارد قسمت مدیریت فراگما » تنظیمات فراگما شده و نام جدید را برای تمام مرسولات ثبتی وارد نمایید.
2. در وب سرویس هنگام ثبت سفارش نام جدید کالا را توسط پارامتر newkalaname اعمال نمایید.

• کد وضعیت در شرکت حمل (به تفضیل) :

• کد وضعیت در زاگما (به تفضیل) :

باجه معطله : در این حالت در صورتی که خریدار مرسوله در مقصد مورد نظر نباشد و مرسوله 2-3 روز در شعبه شرکت حمل و نقل در شهر مقصد می ماند در این حالت پستچی 1-2 بار دیگر به مقصد مورد نظر برای تحویل کالا مراجعت می کند و در صورت عدم پاسخگویی مجدد مرسوله برگشت می خورد.(خریدار مرسوله با مراجعه به شعبه شرکت حمل و نقل می تواند به صورت دستی مرسوله را دریافت کند.)

انصراف خریدار/تائید شده توسط خریدار : در این حالت در هنگامی که از خریدار تائید پیامکی برای ارسال مرسوله گرفته می شود، خریدار درخواست خود را اعلام می کند.

معلق : در این حالت فروشگاه دار مرسوله رو به صورت معلق در آورده و آن را اسال نکرده است.

تائید شده در انتظار مامور پست : در این حالت مرسوله توسط فروشگاه دار اماده تحویل به پستچی می باشد.

تائید وجه دریافتی توسط پست/تائید شده درانتظار مأمور پست/بررسی برای پرداخت توسط پست : در این حالتها شرکت حمل و نقل مربوطه در حال بررسی پرداخت پول به زاگما می باشد.

قابل پرداخت : در این حالت پست به زاگما مبلغ مرسوله مورد نظر را پرداخت کرده است و زاگما می تواند با فروشگاه دار تسویه کند.

• کد وضعیت در زاگما (به صورت خلاصه دسته بندی شده یک) :

• کد وضعیت در زاگما (به صورت خلاصه دسته بندی شده دو) :

توجه : لطفا توجه داشته باشید که محدودیت برای ثبت سفارشات با کمک API  هر 25 ثانیه می باشد، برای رفع این محدودیت می توانید در قسمت مدیریت فروشگاه، مشخصات فروشگاه آی پی فروشگاهتان را در قسمت IP خاص برای استفاده از وب سرویس وارد نمایید، تا دیگر این محدودیت برای شما ایجاد نشود.

توجه : در ارسال کالا از طریق وب سرویس(API) مرسولات از طریق id (کد سبد خرید ثبت شده در فروشگاه مربوطه) تفکیک می شوند، از این رو لطفا در نظر داشته باشید که برای مرسولات کد id متمایز انتخاب نمایید(و یا این پارامتر را خالی بگذارید)، در غیر این صورت مرسولات تکراری در نظر گرفته می شوند.

توجه : لطفا توجه داشته باشید که برای حذف محدودیت وزن مرسولات سفارشی/پیشتاز بیشتر از 30 کیلوگرم که توسط پست ایجاد شده است(به منظور ارسال بدون محدودیت وزنی)، حتما در قسمت مدیریت فروشگاه»تنظیمات فروشگاه تیک تفکیک مرسولات سنگین به مرسولات سبک‌تر را بزنید.

توجه : همچنین برای رند کردن هزینه فاکتور تیک گرد کردن (رند کردن) مبلغ نهایی را در قسمت مدیریت فروشگاه»تنظیمات فروشگاه تیک را فعال نمایید.

توجه : لازم به ذکر است برای تعیین هزینه بسته بندی تیک اعمال هزینه بسته‌بندی را در قسمت مدیریت فروشگاه»تنظیمات فروشگاه را فعال نمایید.

اسکریپت نمایش وضعیت مرسوله ارسالی/پیگیری سفارش ارسالی :

<style>.h_iframe-zagma_embed_frame{position:relative;}.h_iframe-zagma_embed_frame .ratio{display:block;width:100%;height:auto;}.h_iframe-zagma_embed_frame iframe{position:absolute;top:0;left:0;width:100%;height:100%;}</style><div class=”h_iframe-zagma_embed_frame”><span style=”display: block;padding-top: 57%”></span><iframe src=”https://www.zagma.ir/order-tracking-iframe.html” allowFullScreen=”true” webkitallowfullscreen=”true” mozallowfullscreen=”true”></iframe></div>

پیش نمایش :

• دریافت لیست شهر بر اساس استان :

لیست شهرهای تحت پوشش زاگما هر چند وقت آپدیت شده و وسعت بیشتری میگیرد، به این منظور میتوانید لیست شهرها را در هر لجظه بر حسب استان ارسالی دریافت نمایید.

در این حالت مقدار state که کد استان مورد نظر می باشد به لینک :

http://api.zagma.ir/cityfromstate

http://api.zagma.org/cityfromstate(لینک کمکی)

ارسال می گردد و در پاسخ شهرهای آن استان (name) به همراه کد آن شهر (code) دریافت می گردد.

• دریافت لیست تمام شهر به صورت جیسون :

لیست تمام شهرهای تحت پوشش زاگما به صورت جیسون :

http://api.zagma.ir/cityfull

http://api.zagma.org/cityfull(لینک کمکی)

قابل مشاهده می باشد، که در این لیست مقدار vaz برابر true می باشد که نشان دهنده لود شدن درست این لیست می باشد، همچنین آرایه entries حاوی لیست شهرها در قسمت cities مربوطه به همراه استان title و کد استان ها code می باشد، لازم به ذکر است لیست شهرها را به صورت جیسون می توانید از لینک زیر دانلود نمایید :

http://api.zagma.org/cityfulldownload?format=json

http://api.zagma.org/cityfulldownload?format=json(لینک کمکی)

http://api.zagma.org/cityfulldownload?format=array

http://api.zagma.org/cityfulldownload?format=array(لینک کمکی)

تائید سفارشات :

http://api.zagma.ir/changestatusorder

http://api.zagma.org/changestatusorder(لینک کمکی)

خروجی این متد در صورت نادرست بودن به صورت جیسون :

"code":12,
"vaz":"false,
"dalil": "فروشگاه انتخابی غیر مجاز میباشد"

میباشد، در این حالت مقدار vaz که نشان دهنده وضعیت عملکرد میباشد برابر false است. در صورت درست اجرا شدن، مقدار vaz برابر true شده و سیستم بر حسب اینکه مرسوله را فعال یا غیر فعال کرده باشید پیغام :

[dalil] => سفارش مورد نظر به درستی معلق شد [vaz] => true

[dalil] => سفارش مورد نظر به درستی به آمده ارسال تغییر وضعیت داد [vaz] => true

دریافت فاکتور :

در وب سرویس جدید با ارسال بارکد مرسوله میتوانید

http://api.zagma.ir/showinvoice?code=barcode

http://api.zagma.org/showinvoice?code=barcode(لینک کمکی)

فاکتور مرسوله مورد نظر را دریافت نمایید. در صورتی که می خواهید فاکتور مورد نظر با راهنمای پرینت قابل دسترس باشد کافیست عبارت &help=yes در انتهای لینک مربوطه قرار دهید.

مشاهده اعتبار پنل :

http://api.zagma.ir/showcredit

http://api.zagma.org/showcredit(لینک کمکی)

خروجی این متد در صورت نادرست بودن به صورت جیسون :

 [dalil] => نام کاربری یا رمز عبور نادرست می باشد
 [code] => 11
 [vaz] => false

میباشد، در این حالت مقدار vaz که نشان دهنده وضعیت عملکرد میباشد برابر false است. در صورت درست اجرا شدن، مقدار vaz برابر true شده و سیستم شارژ پنل کاربری شما را به صورت تومان نمایش می دهد. پیغام :

[credit] => 8142630
[usable_credit] => 8136030
[vaz] => true

مشاهده مشخصات فروشگاه

http://api.zagma.ir/shopdetiles

http://api.zagma.org/shopdetiles(لینک کمکی)

خروجی این متد در صورت نادرست بودن به صورت جیسون :

 [dalil] => نام کاربری یا رمز عبور نادرست می باشد
 [code] => 11
 [vaz] => false

می باشد، در این حالت مقدار vaz که نشان دهنده وضعیت عملکرد میباشد برابر false است. در صورت درست اجرا شدن، مقدار vaz برابر true شده و سیستم مشخصات فروشگاه را نمایش می دهد. برای توضیحات بیشتر و ویرایش هر قسمت به پنل کاربری زاگما مراجعه نمایید. (در مقدار پارامتر 2 به معنی غیر فعال و 1 به معنی فعال می باشد)

استفاده از توکن :

در تمام وب سرویس های مورد بحث می توانید توکن دریافتی را به صورت زیر به جای نام کاربری، رمز عبور و کد فروشگاه استفاده نمایید:

توکن را می توانید از قسمت مدیریت فروشگاه»مشخصات فروشگاه»تنظیمات فروشگاه(وب سرویس) مشاهده نمایید و یا توکن جدید بسازید، توکن های ایجاد شده بدون محدودیت می باشند و می توانید از توکن به صورت نامحدود استفاده نمایید، لطفا توجه داشته باشید که با ایجاد توکن جدید ، توکن قدیمی غیر فعال می شود.

تائید سفارشات به صورت گروهی :

http://api.zagma.ir/changestatusordersbyarray

http://api.zagma.org/changestatusordersbyarray(لینک کمکی)

خروجی این متد در صورت نادرست بودن به صورت جیسون :

"code":12,
"vaz":"false,
"dalil": "فروشگاه انتخابی غیر مجاز میباشد"

میباشد، در این حالت مقدار vaz که نشان دهنده وضعیت عملکرد میباشد برابر false است. در صورت درست اجرا شدن، مقدار vaz برابر true شده و سیستم بر حسب اینکه مرسوله را فعال یا غیر فعال کرده باشید پیغام :

[dalil] => سفارش مورد نظر به درستی معلق شد [vaz] => true

[dalil] => سفارش مورد نظر به درستی به آمده ارسال تغییر وضعیت داد [vaz] => true

لطفا برای وارد کردن نمونه کد پست من (Postman) از روش زیر استفاده نمایید:

1. فایل پست من فشرده شده را دانلود نمایید.
2. فایل پست من با فرمت .json موجود در فایل فشرده را استخراج نمایید.
3. پست من را اجرا نموده و در قسمت بالا سمت چپ گزینه import را انتخاب نمایید.
4. در پنجره باز شده گزینه file را انتخاب نموده و فایل گفته شده در قسمت یک را انتخاب نمایید.