به برنج شهر خوش آمدید.😍
به برنج شهر خوش آمدید.😍
Authorization: Api-Key {API_KEY} "
version: "1.0.0"
title: Mixin Management API
tags:
- name: "customer"
- name: "category"
- name: "brand"
- name: "product"
- name: "product comment"
- name: "tag"
- name: "product image"
- name: "product attributes"
servers:
- url: 'https://site-url.ir'
paths:
/api/management/v1/customers/:
get:
tags:
- customer
summary: لیست مشتریان
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: 'cURL'
label: 'CLI'
source: |
curl --location --request GET 'https://www.site-url.ir/api/management/v1/customers/?page=1' \
--header 'Authorization: Api-Key توضیحات/p> analysis: type: string example: '' english_name: type: string example: X10 main_category: type: integer example: 1 other_categories: type: array example: [2,3] brand: type: integer example: 1 is_digital: type: boolean example: false price: type: integer example: 700000 compare_at_price: type: integer example: 800000 special_offer: type: boolean example: true special_offer_end: type: string example: '2021-03-10T16:22:19+03:30' length: type: integer example: null width: type: integer example: null height: type: integer example: null barcode: type: string example: null show_price: type: boolean example: true stock: type: integer example: 5 stock_type: type: string example: limited max_order_quantity: type: integer example: 5 guarantee: type: string example: null product_identifier: type: string example: null old_path: type: string example: null old_slug: type: string example: null has_variants: type: boolean example: true available: type: boolean example: true draft: type: boolean example: false seo_title: type: string example: موبایل X10 seo_description: type: string example: توضیحات extra_fields: type: array description: extra fields list items: type: object additionalProperties: type: string productData: type: object properties: name: type: string description: name of product main_category: type: integer description: main category id description: type: string description: description for product analysis: type: string description: analysis english_name: type: string description: product name in english other_categories: type: array items: type: integer description: other categories id in list brand: type: integer description: brand id is_digital: type: boolean description: is product digital ro not default: false price: type: integer description: product price in tomans compare_at_price: type: integer description: product price before sale in tomans special_offer: type: boolean default: false description: is product in special offer or not special_offer_end: type: string example: '2021-03-10T16:22:19+03:30' description: end date of product special offer length: type: integer description: length in centimeters width: type: integer description: width in centimeters height: type: integer description: height in centimeters weight: type: integer description: weight in grams barcode: type: string description: barcode stock_type: type: string default: 'unlimited' enum: ['limited', 'unlimited', 'call', 'out_of_stock'] description: stock type of product (one of this items ['limited', 'unlimited', 'call', 'out_of_stock']) stock: type: integer default: 0 description: product stock max_order_quantity: type: integer default: 0 description: maximum quantity of product in cart guarantee: type: string description: product guarantee product_identifier: type: string description: product identifier old_path: type: string description: old product url in case you moved it from another platform to mixin old_slug: type: string description: old product slug in case you moved it from another platform to mixin has_variants: type: boolean default: false description: product has variants or not available: type: boolean default: true description: is product available or not seo_title: type: string description: seo title seo_description: type: string description: seo title extra_fields: type: array description: extra fields list items: type: string required: - name - main_category productEditData: type: object properties: name: type: string description: name of product main_category: type: integer description: main category id description: type: string description: description for product analysis: type: string description: analysis english_name: type: string description: product name in english other_categories: type: array items: type: integer description: other categories id in list brand: type: integer description: brand id is_digital: type: boolean description: is product digital ro not price: type: integer description: product price in tomans. if product has variants all variants price will be update with new price compare_at_price: type: integer description: product price before sale in tomans. if product has variants all variants compare_at_price will be update with new price special_offer: type: boolean description: is product in special offer or not special_offer_end: type: string example: '2021-03-10T16:22:19+03:30' description: end date of product special offer length: type: integer description: length in centimeters width: type: integer description: width in centimeters height: type: integer description: height in centimeters weight: type: integer description: weight in grams barcode: type: string description: barcode stock_type: type: string enum: ['limited', 'unlimited', 'call', 'out_of_stock'] description: stock type of product (one of this items ['limited', 'unlimited', 'call', 'out_of_stock']) stock: type: integer description: product stock max_order_quantity: type: integer description: maximum quantity of product in cart guarantee: type: string description: product guarantee product_identifier: type: string description: product identifier old_path: type: string description: old product url in case you moved it from another platform to mixin old_slug: type: string description: old product slug in case you moved it from another platform to mixin has_variants: type: boolean description: product has variants or not available: type: boolean description: is product available or not seo_title: type: string description: seo title seo_description: type: string description: seo title tagItem: properties: id: type: integer example: 1 value: type: string example: 'برچسب' tagData: type: object properties: value: type: string description: tag value required: - value imageItem: properties: id: type: integer example: 1 image: type: string example: "/media/product-images/123.jpg" image_alt: type: string example: '' default: type: boolean example: true imageData: type: object properties: image: type: string format: binary description: image file image_url: type: string description: image url (if sent, 'image' parameter can be ignored) image_alt: type: string description: alternative text for image default: type: boolean default: false description: set image as default image for product required: - image imageEditData: type: object properties: image_alt: type: string description: alternative text for image default: type: boolean description: set image as default image for product required: - default secondaryAttributeItem: properties: id: type: integer example: 1 attribute: type: string example: attribute name value: type: string example: attribue value order: type: integer example: 0 secondaryAttributeData: type: object properties: attribute: type: string description: attribute name value: type: string description: attribue value order: type: integer description: attribute order in Ascending order default: 0 required: - attribute - value secondaryAttributeEditData: type: object properties: attribute: type: string description: attribute name value: type: string description: attribue value order: type: integer description: attribute order in Ascending order required: - attribute - value mainAttributeItem: properties: attribute: type: string example: 'مشخصه' values: type: array items: $ref: '#/components/schemas/mainAttributeValues' mainAttributeValues: properties: id: type: integer example: 1 value: type: string example: attribue value mainAttributeData: type: object properties: attribute: type: string description: attribute value: type: array items: type: string description: attribute values required: - attribute - value productVariantItem: properties: id: type: integer example: 1 attributes: type: array items: $ref: '#/components/schemas/mainAttributeValues' price: type: integer example: 800000 compare_at_price: type: integer example: 900000 show_price: type: boolean example: true is_default: type: boolean example: true stock: type: integer example: 10 length: type: integer example: null width: type: integer example: null height: type: integer example: null weight: type: integer example: null barcode: type: string example: null product_identifier: type: string example: null image: type: object $ref: '#/components/schemas/imageItem' productVariantData: type: object properties: price: type: integer description: product price in tomans compare_at_price: type: integer description: product price before sale in tomans is_default: type: boolean description: select variant as default stock: type: integer description: product variant stock length: type: integer description: length in centimeters width: type: integer description: width in centimeters height: type: integer description: height in centimeters weight: type: integer description: weight in grams barcode: type: string description: barcode product_identifier: type: string description: product variant identifier image: type: integer description: product image id for this variant order: properties: id: type: integer example: 1 first_name: type: string example: user first name last_name: type: string example: user last name phone_number: type: string example: '09123456789' status: type: string example: 'pending' payment_method: type: string example: 'online' payment_status: type: string example: 'paid' creation_date: type: string example: "2021-06-07T13:16:33.383644+04:30" shipping_method_name: type: string example: 'پست' final_price: type: integer example: 580000 orderEvent: properties: id: type: integer example: 1 creation_date: type: string example: "2021-06-07T13:16:33.383644+04:30" text: type: string example: "وضعیت سفارش به «در انتظار تایید» تغییر پیدا کرد." orderItem: properties: id: type: integer example: 104 name: type: string example: 'موبایل ال جی' quantity: type: integer example: 1 compare_at_price: type: integer example: 2500000 price: type: integer example: 2300000 total_price: type: integer example: 2300000 image: type: string example: 'media/product-images/323232354.jpg' url: type: string example: 'product/1/موبایل-ال-جی' orderDetail: properties: id: type: integer example: 1 creation_date: type: string example: "2021-06-07T13:16:33.383644+04:30" status: type: string example: 'pending' first_name: type: string example: user first name last_name: type: string example: user last name phone_number: type: string example: '09123456789' customer_note: type: string example: '' payment_method: type: string example: 'online' payment_status: type: string example: 'paid' shipping_method_name: type: string example: 'پست' shipping_date: type: string example: null shipping_start_time: type: string example: null shipping_end_time: type: string example: null shipping_province: type: string example: 'تهران' shipping_city: type: string example: 'تهران' shipping_address: type: string example: 'خیابان آزادی شرق به غرب، بعد از دانشگاه شریف کوچه صادقی، پلاک 29،پارک علم و فناوری دانشگاه شریف، طبقه دوم، واحد 3' shipping_zip_code: type: string example: '1458883499' shipping_first_name: type: string example: user first name shipping_last_name: type: string example: user last name shipping_phone_number: type: string example: '09123456789' shipping_tracking_code: type: string example: null coupon_discount_amount: type: string example: null discount_amount: type: integer example: 200000 cart_price: type: integer example: 2500000 tax_amount: type: integer example: 0 shipping_price: type: integer example: 0 final_price: type: integer example: 2300000 items: type: array items: $ref: "#/components/schemas/orderItem" events: type: array items: $ref: "#/components/schemas/orderEvent" orderPayment: properties: id: type: integer example: 1 creation_date: type: string example: "2021-06-07T13:16:33.383644+04:30" price: type: integer example: 2300000 method: type: string example: 'online' status: type: string example: 'initiated' psp: type: string example: 'sadad' transaction_number: type: string example: null
به برنج شهر خوش آمدید.😍
به برنج شهر خوش آمدید.😍
