محصولات فروشگاه آنلاین خود را به صورت رایگان در پاساژ نمایش دهید!

وب سرویس پاساژ به شما امکان می دهد فروشگاه آنلاین خود را به صورت رایگان به پاساژ متصل نموده و به سرعت آمار بازدید و فروش محصولات خود را افزایش دهید. به وسیله این سرویس می توانید همواره محصولات خود را در پاساژ به روز نگه دارید. دسترسی به وب سرویس تنها برای فروشگاه هایی با سطح کیفی مطلوب امکان پذیر است. قبل از استفاده از وب سرویس می بایست در پاساژ فروشگاه داشته باشید. اگر هنوز فروشگاه نساخته اید به مرکز فروشندگان پاساژ رجوع کنید.

مستندات وب سرویس

در این قسمت می توانید توابع وب سرویس و پارامتر های ورودی و خروجی هر کدام را مشاهده نمایید.

ثبت درخواست وب سرویس

جهت دریافت API_KEY وب سرویس درخواست خود را ثبت نمایید.

مستندات وب سرویس

متد ها

    • ساخت محصول

      POST https://api.epasazh.com/web/v1/add-product

      با ارسال پارامتر های جدول زیر در قالب یک درخواست json به آدرس مشخص شده می توانید یک محصول در فروشگاه خود ایجاد نمایید. توجه داشته باشید که ارسال پارامتر pasazh-api-key در Header درخواست ارسالی اجباری است و برای دریافت مقدار آن می بایست فرم "ثبت درخواست وب سرویس" را تکمیل نمایید.

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

      نام نوع نام فارسی توضیحات
      id integer کد محصول کد محصول در سیستم شما - حداقل 0 و حداکثر 999999999 - این پارامتر همواره باید یکتا باشد.
      name string نام محصول حداقل 3 کاراکتر و حداکثر 80 کاراکتر
      description string توضیحات محصول حداقل 30 کاراکتر و حداکثر 512 کاراکتر
      images json array تصاویر محصول یک json array حاوی url کامل تصاویر محصول - حداقل یک تصویر حداکثر 5 تصویر
      group_id integer کد گروه کد گروه محصول در سیستم شما - حداقل 0 و حداکثر 999999999
      group_name string نام گروه نام گروه محصول در سیستم شما - حداقل 0 کاراکتر و حداکثر 100 کاراکتر
      price integer قیمت قیمت محصول به تومان - حداقل 100 و حداکثر 999999999
      technical_description string توضیحات فنی محصول حداکثر 512 کاراکتر
      percent_discount integer تخفیف تخفیف محصول به درصد - حداقل 0 و حداکثر 99 - پیشفرض 0
      bargain_status integer چانه زنی فعال و یا غیر فعال بودن امکان چانه روی محصول - غیرفعال 0 و فعال 1 - پیشفرض 1
      in_town_transmission_status integer وضعیت ارسال درون شهری نوع محاسبه هزینه ارسال درون شهری محصول - رایگان 0 - هزینه ثابت 1 - اتوماتیک 2 - پیشفرض 0
      out_town_transmission_status integer وضعیت ارسال برون شهری نوع محاسبه هزینه ارسال درون شهری محصول - رایگان 0 - هزینه ثابت 1 - اتوماتیک 2 - پیشفرض 0
      in_town_transmission_fix_price integer هزینه ثابت ارسال درون شهری در صورتی که in_town_transmission_status را 1 انتخاب نمایید این پارامتر اجباری می شود - حداقل 1000 تومان و حداکثر 99000 تومان
      out_town_transmission_fix_price integer هزینه ثابت ارسال برون شهری در صورتی که out_town_transmission_status را 1 انتخاب نمایید این پارامتر اجباری می شود - حداقل 1000 تومان و حداکثر 99000 تومان
      weight integer وزن مرسوله در صورتی که out_town_transmission_status یا in_town_transmission_status را 1 انتخاب نمایید این پارامتر اجباری می شود - حداقل 100 گرم و حداکثر 30000 گرم
      visibility_status integer وضعیت نمایش محصول به عموم نمایش محصول 1 - عدم نمایش 0 - پیشفرض 1
      quantity integer موجودی موجودی محصول حداقل 0 و حداکثر 100 - پیشفرض 1
      gift string هدیه هدیه محصول - حداقل 3 کاراکتر و حداکثر 100
      transmission_duration integer مدت زمان ارسال کالا مدت زمان مورد نیاز فروشنده برای ارسال کالا - حداقل 1 روز و حداکثر 15 روز

      نمونه کد ارسال درخواست ساخت محصول

      نمونه کد ارسال درخواست POST با کتابخانه Guzzle در زبان PHP در زیر آورده شده است. اگر از سیستم دیگری جهت ارسال درخواست استفاده می نمایید می بایست یک درخواست JSON با محتویات مشابه زیر ارسال نمایید.

      
      $headers = [
          'pasazh-api-key' => 'YOUR_API_KEY',
          'Accept' => 'application/json',
      ];
      
      $client = new Client();
      
      $json_arr = [
          'json' => [
              'id' => 1,
              'name' => 'نام کالا',
              'description' => 'توضیحات کالا',
              'technical_description' => 'مشخصات فنی کالا',
              'group_id' => 10,
              'group_name' => 'مانتو',
              'price' => '100000',
              'percent_discount' => 10,
              'bargain_status' => 1,
              'in_town_transmission_status' => 1,
              'out_town_transmission_status' => 2,
              'in_town_transmission_fix_price' => 12000,
              'out_town_transmission_fix_price' => 0,
              'visibility_status' => 1,
              'quantity' => 8,
              'weight' => 700,
              'gift' => 1,
              'transmission_duration' => 2,
              'images' => [
                  'https://sample.com/image1.jpg',
                  'https://sample.com/image2.jpg',
                  'https://sample.com/image3.jpg',
              ],
          ],
          'headers' => $headers,
      ];
      
      $response = $client->post('https://api.epasazh.com/web/v1/add-product', $json_arr);
      $result = $response->getBody()->getContents();
      
      

      نمونه پاسخ دریافتی موفق

      در صورت موفقیت آمیز بودن عملیات پاسخی مشابه زیر دریافت می نمایید. توجه داشته باشید که تنها در صورتی که result_code برابر 0 باشد عملیات موفقیت آمیز بوده است.

      
      {
          "result_code": 0,
          "result_message": "product added successfully"
      }
      
      

      نمونه پاسخ دریافتی خطا

      در صورتی که خطایی در عملیات ویرایش محصول رخ دهد پاسخی مشابه زیر دریافت می نمایید. که در آن result_code نمایش دهنده کد خطا و result_message نمایش دهنده دلیل خطاست همچنین در صورتی که خطای رخ داده شده دارای توضیحات بیشتری باشد توضیحات در detail نمایش داده می شود

      
      {
          "result_code": "2",
          "result_message": "validation error",
          "detail": {
              "id": [
                  "فیلد آی دی الزامی است"
              ],
              "name": [
                  "فیلد نام الزامی است"
              ],
              "description": [
                  "فیلد توضیحات الزامی است"
              ],
              "group_id": [
                  "فیلد کد گروه الزامی است"
              ],
              "group_name": [
                  "فیلد نام گروه الزامی است"
              ],
              "price": [
                  "فیلد قیمت الزامی است"
              ],
              "quantity": [
                  "فیلد موجودی الزامی است"
              ],
              "images": [
                  "فیلد تصاویر الزامی است"
              ]
          }
      }
      
      
    • ویرایش محصول

      POST https://api.epasazh.com/web/v1/edit-product

      جهت ویرایش محصولاتی که قبلا ایجاد نموده اید، می بایست یک درخواست به آدرس فوق ارسال نمایید. نمونه کد ارسال و پاسخ های دریافتی در زیر آورده شده است. تنها محصولاتی قابل ویرایش هستند که قبلا توسط شما ایجاد شده باشند. توجه داشته باشید که ویرایش فیلد هایی شامل نام، توضیحات، مشخصات فنی که به صورت متنی هستند محصول شما را مجددا به حالت در انتظار تایید می برد و پس از تایید آن توسط اوپراتور مجددا در سایت نمایش داده می شودند.

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

      نام نوع نام فارسی توضیحات
      id integer کد محصول کد محصول در سیستم شما - حداقل 0 و حداکثر 999999999 - این پارامتر همواره باید یکتا باشد.
      name string نام محصول حداقل 3 کاراکتر و حداکثر 80 کاراکتر
      description string توضیحات محصول حداقل 30 کاراکتر و حداکثر 512 کاراکتر
      images json array تصاویر محصول یک json array حاوی url کامل تصاویر محصول - حداقل یک تصویر حداکثر 5 تصویر
      price integer قیمت قیمت محصول به تومان - حداقل 100 و حداکثر 999999999
      technical_description string توضیحات فنی محصول حداکثر 512 کاراکتر
      percent_discount integer تخفیف تخفیف محصول به درصد - حداقل 0 و حداکثر 99 - پیشفرض 0
      bargain_status integer چانه زنی فعال و یا غیر فعال بودن امکان چانه روی محصول - غیرفعال 0 و فعال 1 - پیشفرض 1
      in_town_transmission_status integer وضعیت ارسال درون شهری نوع محاسبه هزینه ارسال درون شهری محصول - رایگان 0 - هزینه ثابت 1 - اتوماتیک 2 - پیشفرض 0
      out_town_transmission_status integer وضعیت ارسال برون شهری نوع محاسبه هزینه ارسال درون شهری محصول - رایگان 0 - هزینه ثابت 1 - اتوماتیک 2 - پیشفرض 0
      in_town_transmission_fix_price integer هزینه ثابت ارسال درون شهری در صورتی که in_town_transmission_status را 1 انتخاب نمایید این پارامتر اجباری می شود - حداقل 1000 تومان و حداکثر 99000 تومان
      out_town_transmission_fix_price integer هزینه ثابت ارسال برون شهری در صورتی که out_town_transmission_status را 1 انتخاب نمایید این پارامتر اجباری می شود - حداقل 1000 تومان و حداکثر 99000 تومان
      weight integer وزن مرسوله در صورتی که out_town_transmission_status یا in_town_transmission_status را 1 انتخاب نمایید این پارامتر اجباری می شود - حداقل 100 گرم و حداکثر 30000 گرم
      visibility_status integer وضعیت نمایش محصول به عموم نمایش محصول 1 - عدم نمایش 0 - پیشفرض 1
      quantity integer موجودی موجودی محصول حداقل 0 و حداکثر 100 - پیشفرض 1
      gift string هدیه هدیه محصول - حداقل 3 کاراکتر و حداکثر 100
      transmission_duration integer مدت زمان ارسال کالا مدت زمان مورد نیاز فروشنده برای ارسال کالا - حداقل 1 روز و حداکثر 15 روز

      نمونه کد ارسال درخواست ساخت محصول

      نمونه کد ارسال درخواست POST با کتابخانه Guzzle در زبان PHP در زیر آورده شده است. اگر از سیستم دیگری جهت ارسال درخواست استفاده می نمایید می بایست یک درخواست JSON با محتویات مشابه زیر ارسال نمایید.

      
      $headers = [
          'pasazh-api-key' => 'YOUR_API_KEY',
          'Accept' => 'application/json',
      ];
      
      $client = new Client();
      
      $json_arr = [
          'json' => [
              'id' => 1,
              'name' => 'نام کالا',
              'description' => 'توضیحات کالا',
              'technical_description' => 'مشخصات فنی کالا',
              'price' => '100000',
              'percent_discount' => 10,
              'bargain_status' => 1,
              'in_town_transmission_status' => 1,
              'out_town_transmission_status' => 2,
              'in_town_transmission_fix_price' => 12000,
              'out_town_transmission_fix_price' => 0,
              'visibility_status' => 1,
              'quantity' => 8,
              'weight' => 700,
              'gift' => 1,
              'transmission_duration' => 2,
              'images' => [
                  'https://sample.com/image1.jpg',
                  'https://sample.com/image2.jpg',
                  'https://sample.com/image3.jpg',
              ],
          ],
          'headers' => $headers,
      ];
      
      $response = $client->post('https://api.epasazh.com/web/v1/edit-product', $json_arr);
      $result = $response->getBody()->getContents();
      
      

      نمونه پاسخ دریافتی موفق

      در صورت موفقیت آمیز بودن عملیات پاسخی مشابه زیر دریافت می نمایید. توجه داشته باشید که تنها در صورتی که result_code برابر 0 باشد عملیات موفقیت آمیز بوده است.

      
      {
          "result_code": 0,
          "result_message": "product edited successfully"
      }
      
      

      نمونه پاسخ دریافتی خطا

      در صورتی که خطایی در عملیات ساخت محصول رخ دهد پاسخی مشابه زیر دریافت می نمایید. که در آن result_code نمایش دهنده کد خطا و result_message نمایش دهنده دلیل خطاست همچنین در صورتی که خطای رخ داده شده دارای توضیحات بیشتری باشد توضیحات در detail نمایش داده می شود

      
      {
          "result_code": "2",
          "result_message": "validation error",
          "detail": {
              "id": [
                  "فیلد آی دی الزامی است"
              ],
              "name": [
                  "فیلد نام الزامی است"
              ],
              "description": [
                  "فیلد توضیحات الزامی است"
              ],
              "group_id": [
                  "فیلد کد گروه الزامی است"
              ],
              "group_name": [
                  "فیلد نام گروه الزامی است"
              ],
              "price": [
                  "فیلد قیمت الزامی است"
              ],
              "quantity": [
                  "فیلد موجودی الزامی است"
              ],
              "images": [
                  "فیلد تصاویر الزامی است"
              ]
          }
      }
      
      
    • حذف محصول

      POST https://api.epasazh.com/web/v1/delete-product

      جهت حذف محصول می بایست یک درخواست به آدرس فوق ارسال نمایید. نمونه کد ارسال و پاسخ های دریافتی در زیر آورده شده است.

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

      نام نوع نام فارسی توضیحات
      id integer کد محصول کد محصول در سیستم شما - حداقل 0 و حداکثر 999999999 - این پارامتر همواره باید یکتا باشد.

      نمونه کد ارسال درخواست ساخت محصول

      نمونه کد ارسال درخواست POST با کتابخانه Guzzle در زبان PHP در زیر آورده شده است. اگر از سیستم دیگری جهت ارسال درخواست استفاده می نمایید می بایست یک درخواست JSON با محتویات مشابه زیر ارسال نمایید.

      
      $headers = [
          'pasazh-api-key' => 'YOUR_API_KEY',
          'Accept' => 'application/json',
      ];
      
      $client = new Client();
      
      $json_arr = [
          'json' => [
              'id' => 1
          ],
          'headers' => $headers,
      ];
      
      $response = $client->post('https://api.epasazh.com/web/v1/delete-product', $json_arr);
      $result = $response->getBody()->getContents();
      
      

      نمونه پاسخ دریافتی موفق

      در صورت موفقیت آمیز بودن عملیات پاسخی مشابه زیر دریافت می نمایید. توجه داشته باشید که تنها در صورتی که result_code برابر 0 باشد عملیات موفقیت آمیز بوده است.

      
      {
          "result_code": 0,
          "result_message": "product deleted successfully"
      }
      
      

      نمونه پاسخ دریافتی خطا

      در صورتی که خطایی در عملیات ساخت محصول رخ دهد پاسخی مشابه زیر دریافت می نمایید. که در آن result_code نمایش دهنده کد خطا و result_message نمایش دهنده دلیل خطاست همچنین در صورتی که خطای رخ داده شده دارای توضیحات بیشتری باشد توضیحات در detail نمایش داده می شود

      
      {
          "result_code": "9",
          "result_message": "product not found"
      }
      
      

ثبت درخواست وب سرویس

برای دریافت API_KEY وب سرویس لازم است ابتدا درخواست خود را ثبت نمایید. پس از ثبت، پاساژ وب سایت و محصولات شما را بررسی نموده و کد دسترسی به وب سرویس را برای شما ارسال می نماید.