86045399-88541296(021)

ساعت کاری 08:00-18:00 + پشتیبانی 24 ساعته از طریق تیکت

اتصال به سامانه زاگما با وب سرویس(ورژن 1.2.8)

به طور کلی روال کار با API به دو بخش ارسال اطلاعات خریدار و فروشگاه دار (عضویت فروشگاه دار در سامانه الزامی می باشد) به سامانه زاگما و دریافت و نمایش اطلاعات مورد نیاز به فروشگاه دار و خریدار تقسیم می شود.

تغییرات جدید در 1.2.5 : دریافت فاکتور و تائید سفارشات از طریق وب سرویس
تغییرات جدید در 1.2.6 : مشاهده اعتبار پنل و مشاهده مشخصات فروشگاه
تغییرات جدید در 1.2.7 : استفاده از توکن برای اتصال به زاگما، تایید گروهی سفارشات
تغییرات جدید در 1.2.8 : ثبت فروشگاه جدید(کسر از اعتبار حساب)، آپلود مدرک، بررسی وضعیت فروشگاه، لیست فروشگاههای ثبت شده
تغییرات جدید در 1.2.9 : استعلام سفارشات آماده ارسال در 7 روز اخیر، ترکینگ مرسولات با توکن، پارامتر noehazine با مقدار 5 برای حالت پرداخت شده

ورژن 1.2

پارامترشرح
usernameنام کاربری (نام کاربری نمونه test)
passwordرمز ورود به سامانه (رمز برای نام کاربری نمونه 654321)
shopkodکد فروشگاه (در پنل سامانه زاگما، مدیریت فروشگاه » مشخصات فروشگاه » کد قرمز رنگ با نام کد فروشگاه)

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

 

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

http://api.zagma.ir/orderstatus

 

پارامترمقداروضعیت
codeبارکد مرسوله مورد نظرالزامی
shopkodکد فروشگاه(می تواند با توکن جایگزین شود، نمونه در فایل پست من)الزامی
kind
نوع کد ارسالی

  1. اگر خالی باشد بارکد زاگما در نظر گرفتته می شود
  2. اگر برابر barcodepost باشد بارکد پستی در نظر گرفته می شود
  3. اگر برابر orderid مقدار شماره یونیک سبد خرید که فروشگاه در زمان ثبت با وب سرویس ارسال کرده در نظر گرفته می شود
اختیاری
"barcod":null,
"timeit":0,
"vazit":0,
"vaz":"false

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

در خروجی perpage نشان دهنده محدودیت هر صفحه (110 عدد) می باشد، countit تعداد کل دریافتی، inthispange تعداد در این صفحه، currentpage صفحه کنونی، lastpage آخرین صفحه ، barcode بارکد زاگمای مرسوله، barcodepost بارکد پستی مرسوله ، orderid مقدار شماره یونیک سبد خرید که فروشگاه در زمان ثبت با وب سرویس ارسال کرده است، tarikh زمان آخرین تغییرات

پارامتر (پارامتر خروجی در صورت موفق بودن درخواست)شرح
barcodeبارکد ارسالی مرسوله در زاگما
barcodepostبارکد پستی مرسوله در شرکت حمل نقل (برای پیگیری)
vaziatشرح وضعیت مرسوله به صورت فارسی
zagmaکد وضعیت مرسوله در زاگما
postکد وضعیت مرسوله در شرکت حمل
tarikhتاریخ آخرین وضعیت مرسوله
vazبررسی درست یا نادرست بودن نتیجه استعلام
  • استعلام هزینه خدمات، ارسال دیتا به صورت جیسون

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

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

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

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

پارامترمقداروضعیت
shopkodکد فروشگاه ثبت شده در زاگماالزامی
weightوزن کالا به گرمالزامی
ostanکد استان (طبق لیست پیوست STATE_CODE )الزامی
cityکد شهرستان (طبق لیست پیوست CODE )الزامی
noehazineنوع محاسبه هزینه :

  1. ثابت [ارسال رایگان] (از خریدار تنها مبلغ کالا دریافت میگردد)
  2. شناور (از خریدار قیمت کالا+هزینه خدمات+هزینه پستی دریافت میگردد)
  3. مشمول (از خریدار قیمت کالا + هزینه پستی دریافت میگردد)
  4. کرایه ثابت [هزینه ارسال دلخواه] (از خریدار قیمت کالا + کرایه وارد شده دریافت میگردد)
  5. برای پرداخت شده به صورت آنلاین(پیش کرایه/پرداخت شده)
الزامی
pricepostقیمت برای کرایه ثابت [کرایه وارد شده] پستی(تومان)الزامی در صورتی که
noehazine برابر 4 باشد
priceقیمت کل سبد خرید به تومانالزامی
cart*سبد خرید آرایه ای به صورت جیسون ارسال میگردد، در صورتی که تمام کالای سبد خرید در زاگما در قسمت انبارداری و یا در فراگما ثبت شده اند، به منظور انبارداری و مدیریت کالاهایتان لطفا قیمت و وزن و کد موجود در زاگما را ارسال نمایید.

(*کد کالاهای انبار در قسمت مدیریت انبار»لیست کالاهای موجود در انبار به صورت رنگ قرمز مشخص شده است)

(*کد کالاهای فراگما در قسمت مدیریت کالاهای فروشگاه»لیست کالاهای ثبت شده به صورت رنگ قرمز مشخص شده است)

نام کالاname
قیمت هر کالا (تومان)price
کد کالاcode
تعداد سفارش داده شدهquantity
وزن هر کالا(گرم)vazn
اختیاری
kalajaبرای انبارداری a  و برای فراگما fاختیاری
defaultاگر برابر no باشد برای ثبت سفارش وزن و قیمت و نام ارسالی در نظر گرفته می شود (برای کالاهای موجود در انبار همواره وزن از انبار خوانده شده )، در غیر این صورت وزن و قیمت و نام موجود در انبار/فراگما در نظر گرفته می شوداختیاری

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

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

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

پارامتر (پارامتر خروجی در صورت موفق بودن درخواست)شرح
sefareshipmahalهزینه خدمات برای ارسال سفارشی پرداخت در محل
pishtazpmahalهزینه خدمات برای ارسال پیشتاز پرداخت در محل
sefareshionlineهزینه خدمات برای ارسال سفارشی پرداخت شده
pishtazonlineهزینه خدمات برای ارسال پیشتاز پرداخت شده
posttipaxcodهزینه خدمات برای تیپاکس پرداخت در محل
posttipaxonlineهزینه خدمات برای تیپاکس پرداخت شده
posttipaxpaskeraieهزینه خدمات برای تیپاکس پس کرایه
postnedexcodهزینه خدمات برای ندکس پرداخت در محل
postnedexonlineهزینه خدمات برای ندکس پرداخت شده
peikecodهزینه خدمات برای پیک موتوری پرداخت در محل
peikeonlineهزینه خدمات برای پیک موتوری پرداخت شده


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

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

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

http://api.zagma.ir/orderwitharray

پارامترمقداروضعیت
usernameنام کاربری صاحب فروشگاه در زاگماالزامی
passwordرمز عبور اکانت زاگماالزامی
shopkodکد فروشگاه ثبت شده در زاگماالزامی
mobileشماره تماس خریدارالزامی
phoneشماره ثابت خریدارمیتواند خالی باشد
weight*وزن کل سبد خرید به گرم

(*این وزن با جمع وزن سبد ارسالی مقایسه شده و بیشترین وزن اعمال می گردد)

الزامی
payنوع پرداخت هزینه :

  1. پرداخت در محل
  2. پرداخت شده(قبلا از مشتری مبلغ کل دریافت شده است)
  3. *پس کرایه(قبلا از مشتری مبلغ کالا دریافت شده است و تنها مبلغ هزینه پستی دریافت می شود)

(*حالت پس کرایه برای پست سفارشی و پیشتاز قابل قبول نمی باشد)

الزامی
noersal*نوع ارسال :

  1. سفارشی
  2. پیشتاز
  3. ندکس
  4. پیک موتوری
  5. تیپاکس

(*برای روشهای دیگر عدد یک را انتخاب نمایید)

الزامی
ostanکد استان (طبق لیست پیوست STATE_CODE )الزامی
cityکد شهرستان (طبق لیست پیوست CODE )الزامی
price*قیمت کل سبد خرید به تومان

(*این قیمت با جمع قیمت سبد ارسالی مقایسه شده و بیشترین قیمت اعمال می گردد)

الزامی
buyerنام خریدارالزامی
adressآدرس خریدارالزامی
codeposکد پستی خریدارالزامی
emailآدرس ایمیل خریدارمیتواند خالی باشد
cart*سبد خرید آرایه ای به صورت جیسون ارسال میگردد، در صورتی که تمام کالای سبد خرید در زاگما در قسمت انبارداری و یا در فراگما ثبت شده اند، به منظور انبارداری و مدیریت کالاهایتان لطفا قیمت و وزن و کد موجود در زاگما را ارسال نمایید.

(*کد کالاهای انبار در قسمت مدیریت انبار»لیست کالاهای موجود در انبار به صورت رنگ قرمز مشخص شده است)

(*کد کالاهای فراگما در قسمت مدیریت کالاهای فروشگاه»لیست کالاهای ثبت شده به صورت رنگ قرمز مشخص شده است)

نام کالاname
قیمت هر کالا (تومان)price
کد کالاcode
تعداد سفارش داده شدهquantity
وزن هر کالا(گرم)vazn
الزامی
noehazineنوع محاسبه هزینه :

  1. ثابت [ارسال رایگان] (از خریدار تنها مبلغ کالا دریافت میگردد)
  2. شناور (از خریدار قیمت کالا+هزینه خدمات+هزینه پستی دریافت میگردد)
  3. مشمول (از خریدار قیمت کالا + هزینه پستی دریافت میگردد)
  4. کرایه ثابت [هزینه ارسال دلخواه] (از خریدار قیمت کالا + کرایه وارد شده دریافت میگردد)
  5. برای پرداخت شده به صورت آنلاین(پیش کرایه/پرداخت شده)
الزامی
pricepostقیمت برای کرایه ثابت [هزینه ارسال دلخواه] پستی(تومان)الزامی در صورتی که
noehazine برابر 4 باشد
idکد سبد خرید ثبت شده در فروشگاه مربوطهمیتواند ارسال نشود

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

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

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

پارامتر (پارامتر خروجی در صورت موفق بودن درخواست)شرح
barcodبارکد سفارش ثبت شده
vazبررسی درست یا نادرست بودن نتیجه استعلام

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

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

kalajaبرای انبارداری a  و برای فراگما fالزامی در صورتی که کالا در انبار زاگما و یا فراگما موجود باشد
defaultاگر برابر no باشد برای ثبت سفارش وزن و قیمت و نام ارسالی در نظر گرفته می شود (برای کالاهای موجود در انبار همواره وزن از انبار خوانده شده )، در غیر این صورت وزن و قیمت و نام موجود در انبار/فراگما در نظر گرفته می شود             اختیاری
  • اعمال هزینه بسته بندی بر روی مرسولات ارسالی :

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

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

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

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

کد وضعیتشرح کد
1معلق در فروشگاه
2آماده قبول
3اشتباه در اعلام آماده ارسال
4عدم حضور مدیر فروشگاه
5قبول شده
6غیرقابل توزیع
7توزیع شده
8باجه معطله
9غیرقابل توزیع
10پیش برگشتی مرسوله
11ثبت نهایی برگشتی
12مرسوله خسارتی
13مرسوله غرامتی
70تایید شده مدیر مالی
71تسویه شده مدیر مالی

 

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

کد وضعیتشرح کد
1تسویه با بازاریاب
2تسویه با فروشگاه
3*قابل پرداخت
4مردود
5نیازمند تائید سفارش توسط فروشگاه دار
6نیازمند تائید سفارش  توسط منشی
7نیازمند تائید سفارش توسط همکار
8نیازمند تائید سفارش توسط همکار کامل
9نیازمند تائید سفارش توسط بازاریاب
10نیازمند تائید سفارش توسط فروشگاه دار به عنوان بازاریاب
11نیازمند تائید انباردار برای ارسال
12تائید سفارش توسط خریدار
13نیازمند تائید فروشنده برای ارسال
14نیازمند تائید فروشگاه دار برای ارسال
15نیازمند تائید تأمین‌کننده برای ارسال
16*معلق در فروشگاه
17آماده قبول
18اشتباه در اعلام آماده ارسال
19عدم حضور مدیر فروشگاه
20دریافت شده آماده توزیع
21در حال توزیع*(توقیف شده)
22در حال توزیع با پیک موتوری
23توزیع شده
24توزیع شده باپیک موتوری
25*باجه معطله
26غیرقابل توزیع
27پیش برگشتی مرسوله
28ثبت نهایی برگشتی
29ثبت نهایی برگشتی بازگشت کالا به فروشگاه
30مرسوله خسارتی
31مرسوله غرامتی
32*تائید وجه دریافتی توسط پست
33*بررسی برای پرداخت توسط پست
34*تائید شده درانتظار مأمور پست
35*تائید شده توسط خریدار
36*انصراف خریدار

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

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

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

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

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

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

 

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

گروه کد وضعیتشرح خلاصه کد
17-20-22درحال توزیع
1-2-3-23-24-32-33توزیع شده
27-28-29برگشتی
18-19-21-26-30-31مرسولات غیر قابل توزیع
25باجه معطله
4-36انصرافی
5 تا 16 – 35معلق
34تایید شده در انتظار مامور پست

 

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

گروه کد وضعیتشرح خلاصه کد
1-2-3-23-24-32-33قبول شده
27-28-29رد شده
17-20-22درحال توزیع
25باجه معطله
18-19-21-26-30-31غیر قابل پذیرش
4 تا 16 – 36 – 35نیازمند تائید فروشگاه دار
34تایید شده در انتظار مامور پست

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

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

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

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

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

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

برای قرار دادن پیگیری مرسوله کد زیر را کپی(COPY) نمایید و در صفحه مورد نظر به صورت کد HTML قرار دهید(PAST)، از این پس خریداران با وارد کردن کد رهگیری که دارند می توانند وضعیت مرسوله را مشاهده نمایید.
لینک مستقیم :

لینک مستقیم با کمک کد جاواسکریپت :

<div><script type=”text/JavaScript” src=”https://www.zagma.ir/zagma-tracking.js”></script></div>

https://www.zagma.ir/order-tracking-iframe.html?id=بارکد مرسوله
https://www.zagma.ir/order-tracking-iframe.php?id=بارکد مرسوله
https://www.zagma.ir/order-tracking/?id=بارکد مرسوله

<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

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

 

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

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

http://api.zagma.ir/cityfull

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

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

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

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

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

ورژن 1.2.5

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

http://api.zagma.ir/changestatusorder

پارامترمقداروضعیت
usernameنام کاربری صاحب فروشگاه در زاگماالزامی
passwordرمز عبور اکانت زاگماالزامی
shopkodکد فروشگاه ثبت شده در زاگماالزامی
codeبارکد مرسوله مورد نظرالزامی
functionعملیات مورد نظر بر روی مرسوله

 r = معلق کردن سفارش

 s = آماده ارسال

الزامی

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

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

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

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

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

[barcodeposti] => 19379069311926681394

 

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

در وب سرویس جدید با ارسال بارکد مرسوله (بارکد پستی/بارکد زاگما) میتوانید

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

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

ورژن 1.2.6

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

http://api.zagma.ir/showcredit

پارامترمقداروضعیت
usernameنام کاربری صاحب فروشگاه در زاگماالزامی
passwordرمز عبور اکانت زاگماالزامی


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

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

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

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

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

http://api.zagma.ir/shopdetiles

پارامترمقداروضعیت
usernameنام کاربری صاحب فروشگاه در زاگماالزامی
passwordرمز عبور اکانت زاگماالزامی
shopcodeکد فروشگاه (در پنل سامانه زاگما، مدیریت فروشگاه » مشخصات فروشگاه » کد قرمز رنگ با نام کد فروشگاه)الزامی

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

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

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

 

پارامترتوضیحات
shopnameنام فروشگاه
shopinfoمشخصات فروشگاه که در پنل زاگما وارد شده است
registerزمان ثبت نام فروشگاه
adressآدرس فروشگاه
larginfoمشخصات تکمیلی فروشگاه که در پنل زاگما وارد شده است
cityfaنام شهری که فروشگاه در آن ثبت شده است
cityکد شهری که فروشگاه در آن ثبت شده است
statefaنام استانی که فروشگاه در آن ثبت شده است
stateکد استانی که فروشگاه در آن ثبت شده است
discountonlineshoppingتخفیف در خرید آنلاین
taidpishsefareshتائید خودکار پیش سفارشات
ersalatomatتغییر خودکار به آماده ارسال
onlinefreeخرید آنلاین رایگان
maxcartcodحداکثر سبد خرید برای پرداخت در محل(تومان)
tafkikوزن تفکیک مرسوله(گرم)
ronditkonگرد کردن (رند کردن) مبلغ نهایی
sendsmsevenapiارسال پیامک ثبت سفارشات در زمان استفاده از وب سرویس
forceapibarasicodecartاجبار وب سرویس به بررسی کد کالای ارسالی در سبد خرید
donotspamorderجلوگیری از ثبت اسپم سفارشات
monthsتعداد ماه فعالیت
latitudeمختصات جغرافیایی
longitudeمختصات جغرافیایی
timeopenساعت کاری

ورژن 1.2.7

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

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

پارامترمقداروضعیت
tokenتوکن دریافتی از پنل زاگماالزامی

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

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

http://api.zagma.ir/changestatusordersbyarray

پارامترمقداروضعیت
tokenتوکن دریافتی از پنل زاگماالزامی
orders
پارامترمقدار

 

وضعیت
codeبارکد مرسوله مورد نظرالزامی
functionعملیات مورد نظر بر روی مرسولهr = معلق کردن سفارش

s = آماده ارسال

الزامی
الزامی

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

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

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

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

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

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

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

ورژن 1.2.8

به علت ارسال مستقیم مشخصات به حساب کاربریتان، لطفا حتما در پنل کاربریتان در سامانه زاگما، تنظیمات» تنظیم IP کلی ، آی پی های سرور/هاست خود را وارد نمایید.

آپلود مدرک :

با کمک این گزینه میتوانید، مدارک مورد نظرتان را به صورت سیستمی بدون آنکه وارد زاگما شوید برای کارشناسان مربوطه ارسال نمایید.(برای مثال مدارک ثبت فروشگاه)

http://api.zagma.ir/uploadocument

پارامترمقداروضعیت
usernameنام کاربری زاگماالزامی
passwordرمز عبور زاگماالزامی
urlآدرس لینک فایلی که قرار است آپلود گرددالزامی
informationتوضیح کوتاهی در مورد مدرک آپلود شدهاختیاری

در صورتی که مدرک مورد نظر به درستی آپلود گردد، در خروجی مقدار vaz برابر true میگردد.

 

لیست فروشگاهها :

با کمک این گزینه میتوانید، لیست تمام فروشگاههای ثبت شده و وضغیت در پنل کاربریتان را مشاهده نمایید، لیست به صورت صفحه هاتی می باشد که در هر صفحه 80 فروشگاه لیست میگردد، شما میتوانید با ارسال شماره صفحه مورد نظر، آن لیست را مشاهده نمایید.

http://api.zagma.ir/storeslist

پارامترمقداروضعیت
usernameنام کاربری زاگماالزامی
passwordرمز عبور زاگماالزامی
isactive
  • اگر صفر یا خالی باشد، تمام فروشگاهها لیست میشوند
  • اگر برابر یک باشد، تنها فروشگاههای فعال نمایش داده میشوند
الزامی
pagenumberشماره صفحه مورد نظر برای نمایش لیست فروشگاههااختیاری

در خروجی perpage نشان دهنده تعداد دیتا در هر صفحه و thispage شماره صفحه کنونی ، allpages تعداد کل صفحات موجود، vaz که در صورت true بودن نشان دهنده این است که استعلام به درستی صورت پذیرفته است.

 

نمایش وضعیت فروشگاه :

این قسمت برای نمایش وضعیت یک فروشگاه خاص میباشد.

http://api.zagma.ir/storeinformation

پارامترمقداروضعیت
usernameنام کاربری زاگماالزامی
passwordرمز عبور زاگماالزامی
shopcodeکد فروشگاه مورد نظرالزامی

در صورتی که استعلام به درستی صورت پذیرد، در خروجی مقدار vaz برابر true میگردد، در این حالت isactive نشان دهنده وضعیت فروشگاه میباشد،

 “isactive”: “false” = فروشگاه مورد نظر فعال نمیباشد
 “isactive”: “true” = فروشگاه فعال است

ثبت فروشگاه جدید :

http://api.zagma.ir/registernewstore

پارامترمقداروضعیت
usernameنام کاربری زاگماالزامی
password رمز عبور زاگماالزامی
shopnameنام فروشگاه مورد نظرالزامی
fieldofactivityزمینه کاری :

11 = کالای دیجیتالی
12 = لوازم خانگی
13 = زیبایی و سلامتی
14 = فرهنگ و هنر
15 = ورزش و سرگرمی
16 = مادر و کودک
17 = خدمات اینترنت
18 = طراحی و تبلیغات
19 = اجتماعی
20 = کسب و کار و امور مالی
21 = خدمات علمی و آموزشی
22 = خدمات توریسم و حمل و نقل
23 = کالا و خدمات
24 = ابزار آلات
25 = خودرو و لوازم
26 = مد و لباس

الزامی
stateاستان فروشگاهالزامی
cityشهر فروشگاه

*لطفا توجه داشته باشید که برای شهر تهران منطقه بندی بر اساس 2 رقم اول کد پستی به شرح زیر است :

1011 = منطقه 11 پستی تهران
1013 = منطقه 13 پستی تهران
1014 = منطقه 14 پستی تهران
1015 = منطقه 15 پستی تهران
1016 = منطقه 16 پستی تهران
1017 = منطقه 17 پستی تهران
1018 = منطقه 18 پستی تهران
1019 = منطقه 19 پستی تهران

الزامی
contracttypeنوع قرارداد فروشگاه :

قرارداد با پست(فروشگاهی/فروشنده) = 1
انبارداری = 2

الزامی
shopinformationتوضیح کوتاهی در مورد فروشگاهالزامی
shopadressآدرس فروشگاهالزامی
latitudeعرض جغرافیایی فروشگاهاختیاری
longitudeطول جغرافیایی فروشگاهاختیاری
discountcodeکد تخفیفاختیاری

در صورتی که فروشگاه به درستی ثبت گردد، مقدار vaz برابر true میگردد و سیستم به شما کد فروشگاه ثبت شده را در پارامتر storecode نمایش میدهد.

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

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

ورژن 1.2.9

لیست مرسولات آماده ارسال 7 روز اخیر :

با کمک این گزینه میتوانید، لیست تمامی کالاهای آماده ارسال کالاهای فروشگاه مورد نظر (کد فروشگاه/توکن فروشگاه) مشاهده نمایید :

http://api.zagma.ir/orderstatusreadyforsend

پارامترمقداروضعیت
username
نام کاربریالزامی
password
رمز عبورالزامی
shopkod
کد فروشگاه مورد نظرالزامی
pagenumberشماره صفحه مورد نظر برای نمایش لیست فروشگاههااختیاری

در خروجی perpage نشان دهنده محدودیت هر صفحه (110 عدد) می باشد، countit تعداد کل دریافتی، inthispange تعداد در این صفحه، currentpage صفحه کنونی، lastpage آخرین صفحه ، barcode بارکد زاگمای مرسوله، barcodepost بارکد پستی مرسوله ، orderid مقدار شماره یونیک سبد خرید که فروشگاه در زمان ثبت با وب سرویس ارسال کرده است، tarikh زمان آخرین تغییرات

دانلود همه فایلهای پست من(Postman) به صورت یکجا

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

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