{ "source": "https://seller.digikala.com/open-api/v1/doc/specification.yml", "retrieved_at": "2026-09-27", "sha256": "314c94c5099e3b8d4028dcc69dc91620d37336c3c0e2ba11b1ee0c4656493a15", "operations": { "get /open-api/v1/": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/auth/scopes": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/auth/scopes/{client_code}": { "parameters": [ { "name": "client_code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/auth/token": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "authorization_code" ], "properties": { "authorization_code": { "type": "string" } } } } }, "post /open-api/v1/auth/refresh-token": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "access_token", "refresh_token" ], "properties": { "access_token": { "type": "string" }, "refresh_token": { "type": "string" } } } } }, "post /open-api/v1/auth/revoke": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/categories/tree": { "parameters": [ { "name": "search[parent_id]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/product-creation/search/v2": { "parameters": [ { "name": "search[keyword]", "in": "query", "required": "true", "schema": { "type": "string" } }, { "name": "search[categories]", "in": "query", "required": false, "schema": { "type": "option" } }, { "name": "search[brands]", "in": "query", "required": false, "schema": { "type": "option" } }, { "name": "search[types]", "in": "query", "required": false, "schema": { "type": "option" } }, { "name": "search[colorPalettes]", "in": "query", "required": false, "schema": { "type": "option" } }, { "name": "search[statuses]", "in": "query", "required": false, "schema": { "type": "option", "enum": [ "marketable", "coming_soon", "stop_production" ] } }, { "name": "search[fake]", "in": "query", "required": false, "schema": { "type": "bool" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/product-creation/search/suggestion/v2": { "parameters": [ { "name": "search[keyword]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/product-creation/be-seller/{product_id}": { "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/product-creation/search/category/v2/{keyword}": { "parameters": [ { "name": "keyword", "in": "path", "required": true, "schema": { "type": "string, integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/product-creation/category/{category_id}/validation": { "parameters": [ { "name": "category_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/product-creation/product/detail/validation": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "category_id", "brand_id", "is_iranian" ], "properties": { "category_id": { "type": "integer" }, "division_id": { "type": "integer" }, "model": { "type": "string" }, "brand_id": { "type": "integer" }, "product_type_ids": { "type": "array", "required": false, "items": { "type": "integer" } }, "color_id": { "type": "integer" }, "is_iranian": { "type": "boolean" }, "product_classes": { "type": "array", "required": false, "items": { "type": "integer" } }, "fake": { "type": "boolean" }, "fake_reasons": { "type": "array", "required": false, "items": { "type": "integer" } }, "general_mefa_id": { "type": "string" }, "exclusive_mefa_id": { "type": "string" }, "package_width": { "type": "integer" }, "package_height": { "type": "integer" }, "package_length": { "type": "integer" }, "package_weight": { "type": "integer" }, "description": { "type": "string" }, "disadvantages": { "type": "array", "required": false, "items": { "type": "string" } }, "advantages": { "type": "array", "required": false, "items": { "type": "string" } }, "draft_product_id": { "type": "integer" } } } } }, "get /open-api/v1/product-creation/draft-product/count": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/product-creation/draft-product/{draft_product_id}": { "parameters": [ { "name": "draft_product_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/product-creation/{draft_product_id}/auto-title": { "parameters": [ { "name": "draft_product_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/product-creation/auto-title/save": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "draft_product_id", "title_fa" ], "properties": { "draft_product_id": { "type": "integer" }, "title_fa": { "type": "string" }, "title_en": { "type": "string" }, "description": { "type": "string" }, "advantages": { "type": "array", "required": false, "items": { "type": "string" } }, "disadvantages": { "type": "array", "required": false, "items": { "type": "string" } } } } } }, "get /open-api/v1/product-creation/attributes/{category_id}": { "parameters": [ { "name": "category_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/product-creation/attributes": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "draft_product_id" ], "properties": { "draft_product_id": { "type": "integer" }, "length": { "type": "double" }, "width": { "type": "double" }, "height": { "type": "double" }, "weight": { "type": "double" }, "attributes": { "type": "array", "required": false, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "value": { "type": [ "integer", "string", "boolean", "array", "object" ] } } } } } } } } }, "post /open-api/v1/product-creation/images/requests/brand-logo/upload": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "multipart/form-data": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary" } } } } }, "post /open-api/v1/product-creation/images/requests/upload": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "multipart/form-data": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary" } } } } }, "post /open-api/v1/product-creation/images/upload": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "multipart/form-data": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary" } } } } }, "post /open-api/v1/product-creation/images/ai": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "image_id", "is_main" ], "properties": { "image_id": { "type": "string" }, "is_main": { "type": "boolean" } } } } }, "post /open-api/v1/product-creation/save": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "category_id": { "type": "integer" }, "draft_product_id": { "type": "integer" }, "use_temp_images": { "type": "boolean" }, "only_b2b": { "type": "boolean" }, "photos_detail": { "type": "object", "required": [], "properties": { "main_image": { "type": "string" }, "order": { "type": "string" }, "images": { "type": "array", "required": [], "items": { "type": "object", "properties": { "encrypted_id": { "type": "string" }, "active": { "type": "boolean" } } } } } } } } } }, "post /open-api/v1/product-creation/assign": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "productId" ], "properties": { "productId": { "type": "integer" } } } } }, "post /open-api/v1/product-creation/brand/request": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "brand_origin", "description", "logo_id", "name_en", "name_fa", "category_id" ], "properties": { "brand_origin": { "type": "string" }, "description": { "type": "string" }, "logo_id": { "type": "string" }, "name_en": { "type": "string" }, "name_fa": { "type": "string" }, "iranian_registration_url": { "type": "string" }, "category_id": { "type": "string" } } } } }, "get /open-api/v1/product-creation/brand": { "parameters": [ { "name": "search[title_fa]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[title_en]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/draft-products/seller": { "parameters": [ { "name": "search[brand_ids]", "in": "query", "required": false, "schema": { "type": "array" } }, { "name": "search[category_ids]", "in": "query", "required": false, "schema": { "type": "array" } }, { "name": "search[near_expiration]", "in": "query", "required": false, "schema": { "type": "bool" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "delete /open-api/v1/draft-products/{draft_product_id}": { "parameters": [ { "name": "draft_product_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/products/seller": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[multi_search]", "in": "query", "required": false, "schema": { "type": "search box" } }, { "name": "search[category_id]", "in": "query", "required": false, "schema": { "type": "option" } }, { "name": "search[brand_id]", "in": "query", "required": false, "schema": { "type": "option" } }, { "name": "search[moderation_status]", "in": "query", "required": false, "schema": { "type": "option", "enum": [ "draft", "in_review", "waiting_for_confirm", "edit_after_approved", "approved", "in_review_after_approved", "removed", "duplicate" ] } }, { "name": "search[fake_status]", "in": "query", "required": false, "schema": { "type": "radio", "enum": [ "fake", "real" ] } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/products/{product_id}/score": { "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/product-edit/{product_id}/publish": { "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "force_marketplace_seller_id": { "type": "integer" } } } } }, "get /open-api/v1/product-edit/{product_id}": { "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "put /open-api/v1/product-edit/{product_id}": { "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "category_id", "brand_id", "is_iranian" ], "properties": { "category_id": { "type": "integer" }, "division_id": { "type": "integer" }, "model": { "type": "string" }, "brand_id": { "type": "integer" }, "product_type_ids": { "type": "array", "required": false, "items": { "type": "integer" } }, "color_id": { "type": "integer" }, "is_iranian": { "type": "boolean" }, "product_classes": { "type": "array", "required": false, "items": { "type": "integer" } }, "fake": { "type": "boolean" }, "general_mefa_id": { "type": "string" }, "exclusive_mefa_id": { "type": "string" }, "package_width": { "type": "integer" }, "package_height": { "type": "integer" }, "package_length": { "type": "integer" }, "package_weight": { "type": "integer" }, "description": { "type": "string" }, "disadvantages": { "type": "array", "required": false, "items": { "type": "string" } }, "advantages": { "type": "array", "required": false, "items": { "type": "string" } }, "width": { "type": "integer" }, "height": { "type": "integer" }, "length": { "type": "integer" }, "weight": { "type": "integer" }, "attributes": { "type": "object", "required": [], "properties": { "123": { "type": "object", "required": [], "properties": { "id": { "type": "integer" }, "value": { "type": "mixed" } } } } }, "title_fa": { "type": "string" }, "title_en": { "type": "string" }, "use_temp_images": { "type": "boolean" }, "photos_detail": { "type": "object", "required": [], "properties": { "main_image": { "type": "string" }, "order": { "type": "string" }, "images": { "type": "array", "required": [], "items": { "type": "object", "properties": { "encrypted_id": { "type": "string" }, "active": { "type": "boolean" } } } } } }, "video_ids": { "type": "array", "required": false, "items": { "required": false, "type": "string" } } } } } }, "post /open-api/v1/product-edit/{category_id}/auto-title": { "parameters": [ { "name": "category_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "brand_id" ], "properties": { "division_id": { "type": "integer" }, "model": { "type": "string" }, "brand_id": { "type": "integer" }, "product_type_ids": { "type": "array", "required": false, "items": { "type": "integer" } }, "attributes": { "type": "object", "required": [], "properties": { "123": { "type": "object", "required": [], "properties": { "id": { "type": "integer" }, "value": { "type": "mixed" } } } } } } } } }, "get /open-api/v1/variants": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id", "product_variant_id", "selling_stock", "selling_price", "marketplace_seller_stock", "warehouse_stock", "created_at" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[id]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search[ids]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[shipping_type]", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "seller", "digikala", "both" ] } }, { "name": "search[active]", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "search[moderation_status]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[category_ids]", "in": "query", "required": false, "schema": { "type": "string,integer" } }, { "name": "search[buy_box_winner]", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "product", "no_winner", "sku", "suppressed" ] } }, { "name": "search[in_competition]", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "search[search_term]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[price_terms]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[out_of_stock]", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "search[archived]", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "search[selling_channel]", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "digikala", "digistyle", "digikala_digistyle", "b2b", "digikala_b2b", "digistyle_b2b", "all" ] } }, { "name": "search[creation_time_from]", "in": "query", "required": false, "schema": { "type": "datetime" } }, { "name": "search[creation_time_to]", "in": "query", "required": false, "schema": { "type": "datetime" } }, { "name": "search[seller_product_tags]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[nearby_seller_shipment]", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/variants/{variant_id}": { "parameters": [ { "name": "variant_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "put /open-api/v1/variants/{variant_id}": { "parameters": [ { "name": "variant_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "seller_stock": { "type": "integer" }, "maximum_per_order": { "type": "integer" }, "selling_price": { "type": "integer" }, "price_limit": { "type": "integer" }, "credit_increase_percentage": { "type": "number" }, "shipping_type": { "type": "string" }, "lead_time": { "type": "integer" }, "seller_lead_time": { "type": "integer" }, "activation": { "type": "boolean" }, "three_hour_delivery": { "type": "boolean" } } } } }, "put /open-api/v1/variants/b2b-activation": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "variant_ids" ], "properties": { "variant_ids": { "type": "array" } } } } }, "post /open-api/v1/variants/export": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "id": { "type": "integer" }, "shipping_type": { "type": "string" }, "active": { "type": "boolean" }, "moderation_status": { "type": "string" }, "category_ids": { "type": "string" }, "buy_box_winner": { "type": "boolean" }, "in_competition": { "type": "boolean" }, "search_term": { "type": "string" }, "price_terms": { "type": "string" }, "out_of_stock": { "type": "boolean" }, "archived": { "type": "boolean" }, "selling_channel": { "type": "string" } } } } }, "get /open-api/v1/variants/{variant_id}/gold": { "parameters": [ { "name": "variant_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "put /open-api/v1/variants/{variant_id}/gold": { "parameters": [ { "name": "variant_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "gold_wage", "gold_profit", "order_limit" ], "properties": { "gold_wage": { "type": "double" }, "gold_profit": { "type": "double" }, "none_gold_wage": { "type": "double" }, "none_gold_cost": { "type": "double" }, "order_limit": { "type": "integer" } } } } }, "get /open-api/v1/variants/{variant_id}/price-calculator": { "parameters": [ { "name": "variant_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "gold_wage", "in": "query", "required": true, "schema": { "type": "double" } }, { "name": "gold_profit", "in": "query", "required": true, "schema": { "type": "double" } }, { "name": "none_gold_wage", "in": "query", "required": true, "schema": { "type": "double" } }, { "name": "none_gold_cost", "in": "query", "required": true, "schema": { "type": "double" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "put /open-api/v1/variants/{variant_id}/activation": { "parameters": [ { "name": "variant_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "activation" ], "properties": { "activation": { "type": "boolean" } } } } }, "get /open-api/v1/variants/{variant_id}/b2b-prices": { "parameters": [ { "name": "variant_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "put /open-api/v1/variants/{variant_id}/b2b-prices": { "parameters": [ { "name": "variant_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "active", "b2b_prices" ], "properties": { "active": { "type": "boolean" }, "b2b_prices": { "type": "array", "required": [ "min", "max", "selling_price" ], "items": { "type": "object", "properties": { "min": { "type": "integer" }, "max": { "type": "integer" }, "selling_price": { "type": "integer" } } } } } } } }, "put /open-api/v1/variants/{variant_id}/archive": { "parameters": [ { "name": "variant_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "archive" ], "properties": { "archive": { "type": "boolean" } } } } }, "get /open-api/v1/variants/{variant_id}/seller-stock": { "parameters": [ { "name": "variant_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "patch /open-api/v1/variants/{variant_id}/seller-stock": { "parameters": [ { "name": "variant_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "seller_stock" ], "properties": { "seller_stock": { "type": "integer" } } } } }, "patch /open-api/v1/variants/selling-price": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "variant_id", "selling_price", "credit_increase_percentage" ], "properties": { "variant_id": { "type": "integer" }, "selling_price": { "type": "integer" }, "credit_increase_percentage": { "type": "integer" } } } } }, "get /open-api/v1/variants/creation/{product_id}": { "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/variants/creation/{product_id}": { "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "is_active", "order_limit", "marketplace_seller_stock", "warranty_id", "site", "shipping_type" ], "properties": { "is_active": { "type": "boolean" }, "order_limit": { "type": "integer" }, "marketplace_seller_stock": { "type": "integer" }, "supplier_code": { "type": "string" }, "price": { "type": "integer" }, "warranty_id": { "type": "integer" }, "site": { "type": "string" }, "shipping_type": { "type": "string" }, "lead_time": { "type": "integer" }, "fbs_lead_time": { "type": "integer" }, "three_hour_delivery": { "type": "boolean" }, "color_id": { "type": "integer" }, "size_id": { "type": "integer" }, "package_width": { "type": "integer" }, "package_height": { "type": "integer" }, "package_length": { "type": "integer" }, "package_weight": { "type": "integer" }, "gold_price_parameters": { "type": "object", "required": [], "properties": { "gold_wage": { "type": "number" }, "gold_profit": { "type": "number" }, "non_gold_parts_wage": { "type": "integer" }, "non_gold_parts_cost": { "type": "integer" } } }, "sizes": { "type": "array", "required": [], "items": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "integer" } } } }, "photos_detail": { "type": "array", "required": [], "items": { "type": "object", "properties": { "id": { "type": "string" }, "is_main": { "type": "boolean" } } } }, "theme_values": { "type": "array", "required": [], "items": { "type": "object", "properties": { "theme_id": { "type": "integer" }, "theme_value_id": { "type": "integer" } } } } } } } }, "put /open-api/v1/variants/creation/{product_id}/{variant_id}": { "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "variant_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "force_marketplace_seller_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "is_active", "order_limit", "marketplace_seller_stock", "site", "shipping_type" ], "properties": { "is_active": { "type": "boolean" }, "order_limit": { "type": "integer" }, "marketplace_seller_stock": { "type": "integer" }, "supplier_code": { "type": "string" }, "price": { "type": "integer" }, "site": { "type": "string" }, "shipping_type": { "type": "string" }, "lead_time": { "type": "integer" }, "fbs_lead_time": { "type": "integer" }, "package_width": { "type": "integer" }, "package_height": { "type": "integer" }, "package_length": { "type": "integer" }, "package_weight": { "type": "integer" }, "gold_price_parameters": { "type": "object", "required": [], "properties": { "gold_wage": { "type": "number" }, "gold_profit": { "type": "number" }, "non_gold_parts_wage": { "type": "number" }, "non_gold_parts_cost": { "type": "number" } } }, "auto_pricing_parameters": { "type": "object", "required": [], "properties": { "non_parts_wage": { "type": "integer" }, "non_parts_cost": { "type": "integer" }, "wage": { "type": "integer" }, "wage_pct": { "type": "number" }, "profit": { "type": "number" } } }, "sizes": { "type": "array", "required": [], "items": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "integer" } } } }, "photos_detail": { "type": "array", "required": [], "items": { "type": "object", "properties": { "id": { "type": "string" }, "is_main": { "type": "boolean" } } } }, "three_hour_delivery": { "type": "boolean" } } } } }, "get /open-api/v1/variants/creation/size/types": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/variants/creation/size/request": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "product_id": { "type": "integer" }, "title": { "type": "string" }, "theme_id": { "type": "integer" } } } } }, "post /open-api/v1/variants/creation/color/request": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "product_id": { "type": "integer" }, "title": { "type": "string" }, "product_image_id": { "type": "string" }, "hex_code": { "type": "string" }, "theme_id": { "type": "integer" } } } } }, "post /open-api/v1/variants/creation/warranty/request": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "warranty_title", "warranty_period", "warranty_image_id_1", "has_insurance" ], "properties": { "product_id": { "type": "integer" }, "warranty_title": { "type": "string" }, "warranty_period": { "type": "integer" }, "warranty_image_id_1": { "type": "string" }, "warranty_image_id_2": { "type": "string" }, "has_insurance": { "type": "boolean" }, "insurance_title": { "type": "string" }, "insurance_period": { "type": "integer" }, "insurance_image_id_1": { "type": "string" }, "insurance_image_id_2": { "type": "string" } } } } }, "get /open-api/v1/variants/creation/themes/{theme_id}/theme-values": { "parameters": [ { "name": "theme_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "product_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "category_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "brand_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/orders": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "order_created_at" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[search_term]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[created_today]", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/orders/statistics": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/orders/history": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "processed", "returned", "canceled" ] } }, { "name": "category_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "order_created_at_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order_created_at_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exit_from_warehouse_date_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exit_from_warehouse_date_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "returned_to_warehouse_date_to", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "returned_to_warehouse_date_from", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "shipping_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "seller", "digikala", "nearby" ] } }, { "name": "search_text_all", "in": "query", "required": false, "schema": { "type": "string,integer" } }, { "name": "b2b_active", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "delete /open-api/v1/orders/{order_item_id}": { "parameters": [ { "name": "order_item_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "cancellation_reason_id" ], "properties": { "cancellation_reason_id": { "type": "integer" }, "count": { "type": "integer" } } } } }, "get /open-api/v1/inventories": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[stock_status]", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "has_warehouse_stock", "has_not_warehouse_stock", "has_marketplace_seller_stock", "has_not_marketplace_seller_stock", "soon_out_of_stock" ] } }, { "name": "search[selling_stock]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search[active]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search[category_ids]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search[search_field]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[product_filter]", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "has_dead_stock", "active", "inactive" ] } }, { "name": "search[warehouse_filter]", "in": "query", "required": false, "schema": { "type": "string", "enum": [ 1, 50, 28, 48, "others" ] } }, { "name": "search[calculate_available_stock]", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "search[over_30_days]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/inventories/{product_variant_id}": { "parameters": [ { "name": "product_variant_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "search serial", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/inventories/{product_variant_id}/export": { "parameters": [ { "name": "product_variant_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "search[product_variant_id]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search[serial]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/inventories/export": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "stock_status": { "type": "string" }, "selling_stock": { "type": "boolean" }, "active": { "type": "boolean" }, "category_id": { "type": "integer" }, "search_field": { "type": "mixed" }, "product_filter": { "type": "string" }, "warehouse_filter": { "type": "integer" } } } } }, "get /open-api/v1/packages": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id", "created_at" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[multi_search]", "in": "query", "required": false, "schema": { "type": "string,integer" } }, { "name": "search[type]", "in": "query", "required": false, "schema": { "type": "string,enum", "enum": [ "order_fulfilment", "consignment" ] } }, { "name": "search[status]", "in": "query", "required": false, "schema": { "type": "string,enum", "enum": [ "new", "received", "partially_received", "rejected", "error", "deleted" ] } }, { "name": "search[delivery_type]", "in": "query", "required": false, "schema": { "type": "string,enum", "enum": [ "seller", "digikala", "mobile_hub", "post", "compensation", "retail_consignment" ] } }, { "name": "search[package_created_at_from]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[package_created_at_to]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[package_received_at_from]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[package_received_at_to]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/packages": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "packages", "package_type" ], "properties": { "packages": { "type": "object" }, "package_type": { "type": "string" } } } } }, "get /open-api/v1/packages/warehouses": { "parameters": [ { "name": "delivery_type", "in": "query", "required": false, "schema": { "type": "string,enum", "enum": [ "seller", "digikala", "mobile_hub", "post", "compensation", "retail_consignment" ] } }, { "name": "shipping_nature_id", "in": "query", "required": false, "schema": { "type": "integer,enum", "enum": [ 1, 2 ] } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/packages/warehouses/{warehouse_id}/capacities": { "parameters": [ { "name": "warehouse_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "delivery_type", "in": "query", "required": true, "schema": { "type": "string,enum", "enum": [ "digikala", "mobile_hub", "seller" ] } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string,date" } }, { "name": "package_type", "in": "query", "required": true, "schema": { "type": "string,enum", "enum": [ "order_fulfilment", "consignment" ] } }, { "name": "shipping_nature_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "variants", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "counts", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/packages/warehouses/{warehouse_id}/capacities": { "parameters": [ { "name": "warehouse_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "delivery_type": { "type": "string" }, "date": { "type": "string" }, "package_type": { "type": "string" }, "shipping_nature_id": { "type": "integer" }, "variants": { "type": "array", "required": false, "items": { "type": "integer" } }, "counts": { "type": "array", "required": false, "items": { "type": "integer" } } } } } }, "get /open-api/v1/packages/{package_id}": { "parameters": [ { "name": "package_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "search[multi_search]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[status]", "in": "query", "required": false, "schema": { "type": "string,enum", "enum": [ "new", "received", "partially_received", "rejected", "deleted" ] } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "delete /open-api/v1/packages/{package_id}": { "parameters": [ { "name": "package_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/packages/{package_id}/excel/export": { "parameters": [ { "name": "package_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "search[multi_search]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[status]", "in": "query", "required": false, "schema": { "type": "string,enum", "enum": [ "new", "received", "partially_received", "rejected", "deleted" ] } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/packages/consignment/variants": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "variant_ids", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/packages/order-fulfilment/variants": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "commitment_date" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "[order_item_ids]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "[order_commitment_type]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search[commitment_to]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/packages/order-fulfilment/variants": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "order_item_ids": { "type": "array", "required": false, "items": { "type": "integer" } } } } } }, "get /open-api/v1/variants/packages/consignment": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "_id", "sale_quantity" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[multi_search]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[shipping_nature_id]", "in": "query", "required": false, "schema": { "type": "integer,enum", "enum": [ 1, 3, 2 ] } }, { "name": "search[selected_variant_ids]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/shipments/dk": { "parameters": [ { "name": "search[created_at_end]", "in": "query", "required": false, "schema": { "type": "Y-m-d\\TH:i:s.uP" } }, { "name": "search[shipment_receive_at_start]", "in": "query", "required": false, "schema": { "type": "Y-m-d\\TH:i:s.uP" } }, { "name": "search[shipment_receive_at_end]", "in": "query", "required": false, "schema": { "type": "Y-m-d\\TH:i:s.uP" } }, { "name": "search[shipment_status]", "in": "query", "required": false, "schema": { "type": "string,enum", "enum": [ "new", "received", "partially_received", "rejected", "error" ] } }, { "name": "search[multi_search]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/shipments/dk": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "package_ids": { "type": "array", "required": false, "items": { "type": "integer" } }, "warehouse_id": { "type": "integer" }, "pickup_date": { "type": "string" }, "time_scope": { "type": "string" } } } } }, "get /open-api/v1/shipments/dk/packages": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "package_ids", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[warehouse_id]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/shipments/dk/{shipment_id}": { "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "delete /open-api/v1/shipments/dk/{shipment_id}": { "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/profile": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/profile/business": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "patch /open-api/v1/profile/business": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "national_id": { "type": "string" }, "company_name": { "type": "string" }, "company_type": { "type": "string" }, "company_registration_number": { "type": "string" }, "company_national_id_number": { "type": "string" }, "company_economic_number": { "type": "string" }, "company_authorized_representative": { "type": "string" } } } } }, "get /open-api/v1/profile/store": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/profile/address": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/profile/warehouse": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/profile/document": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/profile/training": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/profile/performance": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/questions": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id", "most_viewed", "best_selling", "newest_product", "most-answers", "least-answers" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[answer-status]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[question-date-from]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[question-date-to]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/questions/{question_id}": { "parameters": [ { "name": "question_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/questions/answer": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "question_id", "answer" ], "properties": { "question_id": { "type": "integer" }, "answer": { "type": "string" }, "file_ids": { "type": "array", "required": false, "items": { "type": "integer" } } } } } }, "get /open-api/v1/insight/overview": { "parameters": [ { "name": "range", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "last_7_days", "last_14_days", "last_30_days", "before_last_14_days" ] } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/insight/top-deactivated": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/insight/trend-sales-reports": { "parameters": [ { "name": "range", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "last_7_days", "last_14_days", "last_30_days", "before_last_14_days" ] } }, { "name": "category_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/insight/sales-reports": { "parameters": [ { "name": "range", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "last_7_days", "last_14_days", "last_30_days", "before_last_14_days" ] } }, { "name": "category_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "net_item_sold_from", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "net_item_sold_to", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "net_sales_amount_from", "in": "query", "required": false, "schema": { "type": "float" } }, { "name": "net_sales_amount_to", "in": "query", "required": false, "schema": { "type": "float" } }, { "name": "search_field", "in": "query", "required": false, "schema": { "type": "string,integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/insight/overview/export": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/lightening-deal/products": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "enum" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[q]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/lightening-deal/products/{product_id}": { "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/lightening-deal/promotions": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/lightening-deal/promotions/{productId}": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/lightening-deal/bids": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "bidsData" ], "properties": { "bidsData": { "type": "array", "required": [ "productVariantId", "productId", "source", "promotions" ], "items": { "type": "object", "properties": { "productVariantId": { "type": "integer" }, "productId": { "type": "integer" }, "source": { "type": "string" }, "promotions": { "type": "array", "required": [ "promotionId", "promotionPrice", "numberOfVariantsInPromotion", "minBid", "autoRaise", "upperBound", "paymentMethod" ], "items": { "type": "object", "properties": { "promotionId": { "type": "integer" }, "promotionPrice": { "type": "integer" }, "numberOfVariantsInPromotion": { "type": "integer" }, "minBid": { "type": "integer" }, "autoRaise": { "type": "integer" }, "upperBound": { "type": "integer" }, "paymentMethod": { "type": "string" } } } } } } } } } } }, "get /open-api/v1/lightening-deal/bids": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[status]", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "pending", "payment", "productSupply", "approvedWinner", "live", "ended", "lost" ] } }, { "name": "search[startDate]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search[endDate]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search[q]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/lightening-deal/bidsSummary": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/lightening-deal/check-duplicate-dkp-in-promotion/{promotionId}/{productId}": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "promotionId", "productId" ], "properties": { "promotionId": { "type": "integer" }, "productId": { "type": "integer" } } } } }, "post /open-api/v1/lightening-deal/bids/{bidId}/payment-method": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "paymentMethod" ], "properties": { "paymentMethod": { "type": "string" } } } } }, "get /open-api/v1/pricing/buybox/price-suggestion/winning-price": { "parameters": [ { "name": "product_variant_id", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/buybox/price-suggestion/nth-rank-winning-price": { "parameters": [ { "name": "product_variant_id", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "target_rank", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/smart-discount/variants/eligible": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "latest", "price_low", "price_high", "earliest" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[query]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[onlyBuyBoxWinner]", "in": "query", "required": false, "schema": { "type": "bool" } }, { "name": "search[isOutlet]", "in": "query", "required": false, "schema": { "type": "bool" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/smart-discount/variants/{active_status}": { "parameters": [ { "name": "active_status", "in": "path", "required": true, "schema": { "type": null } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[query]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[status]", "in": "query", "required": false, "schema": { "type": "array", "enum": [ [ "approved", "active" ], [ "rejected", "ended" ] ] } }, { "name": "search[startedAt]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[endAt]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/pricing/smart-discount/variants/batch": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array" } } } } }, "put /open-api/v1/pricing/smart-discount/variants/batch": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "promotionVariantIds" ], "properties": { "promotionVariantIds": { "type": "array" }, "discount": { "type": "integer" }, "limit": { "type": "integer" }, "orderLimit": { "type": "integer" }, "startedAt": { "type": "string" }, "endAt": { "type": "string" } } } } }, "post /open-api/v1/pricing/smart-discount/variants": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array" } } } } }, "put /open-api/v1/pricing/smart-discount/variants": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "promotionVariantId" ], "properties": { "promotionVariantId": { "type": "integer" }, "promotionPrice": { "type": "integer" }, "discount": { "type": "integer" }, "limit": { "type": "integer" }, "orderLimit": { "type": "integer" }, "startedAt": { "type": "string" }, "endAt": { "type": "string" } } } } }, "delete /open-api/v1/pricing/smart-discount/variants": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "variant_ids" ], "properties": { "variant_ids": { "type": "array" } } } } }, "delete /open-api/v1/pricing/smart-discount/variants/all": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "variant_ids" ], "properties": { "variant_ids": { "type": "array" } } } } }, "get /open-api/v1/pricing/smart-discount/variants/eligible/excel": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/smart-discount/variants/excel/sample": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/smart-discount/variants/excel/async-export": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/pricing/smart-discount/variants/excel": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "file_id": { "type": "integer" }, "file_ids": { "type": "array" } } } } }, "post /open-api/v1/pricing/smart-discount/variants/excel/delete-all-async": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "file_id" ], "properties": { "file_id": { "type": "integer" } } } } }, "get /open-api/v1/pricing/smart-discount/auto-joined/{campaign_name}": { "parameters": [ { "name": "campaign_name", "in": "path", "required": true, "schema": { "type": null } }, { "name": "promotionVariantId", "in": "query", "required": true, "schema": { "type": "int" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/promotions": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "promotion_id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[nature]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[status]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[searchKeyword]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[startAt]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[endAt]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/promotions/configs": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/promotions/recommended": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/promotions/eligible": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id", "start_at", "end_at", "join_deadline" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[nature]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[label_ids]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[excludeJoined]", "in": "query", "required": false, "schema": { "type": "bool" } }, { "name": "search[title]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[startAt]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[endAt]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[lastSeconds]", "in": "query", "required": false, "schema": { "type": "bool" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/pricing/promotions/eligible/min-discounts": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "variant_ids", "promotion_nature" ], "properties": { "variant_ids": { "type": "array" }, "promotion_nature": { "type": "string" } } } } }, "get /open-api/v1/pricing/promotions/unjoined": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[nature]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/promotions/variant-current-promotions/{product_variant_id}": { "parameters": [ { "name": "product_variant_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "promotion_id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/promotions/variants": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[promotionStatus]", "in": "query", "required": false, "schema": { "type": "string", "enum": "draft,pending,approved,rejected,active,ended" } }, { "name": "search[promotionVariantStatus]", "in": "query", "required": false, "schema": { "type": "string", "enum": "draft,rejected,approved,partially_approved,partially_rejected" } }, { "name": "search[query]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/promotions/variants/{variant_id}": { "parameters": [ { "name": "variant_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/promotions/variants/rejection-reason/{promotion_variant_id}": { "parameters": [ { "name": "promotion_variant_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[promotion_variant_id]", "in": "query", "required": false, "schema": { "type": "int" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/promotions/{promotion_id}": { "parameters": [ { "name": "promotion_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/promotions/{promotion_id}/variants": { "parameters": [ { "name": "promotion_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[selectedIds]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[searchKeyword]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[status]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[onlyAutoJoined]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/pricing/promotions/{promotion_id}/variants": { "parameters": [ { "name": "promotion_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array" } } } } }, "patch /open-api/v1/pricing/promotions/{promotion_id}/variants": { "parameters": [ { "name": "promotion_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array" } } } } }, "delete /open-api/v1/pricing/promotions/{promotion_id}/variants": { "parameters": [ { "name": "promotion_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "ids" ], "properties": { "ids": { "type": "array" } } } } }, "get /open-api/v1/pricing/promotions/{promotion_id}/variants/rejected": { "parameters": [ { "name": "promotion_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/pricing/promotions/{promotion_id}/variants/batch": { "parameters": [ { "name": "promotion_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array" } } } } }, "patch /open-api/v1/pricing/promotions/{promotion_id}/variants/batch": { "parameters": [ { "name": "promotion_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "ids" ], "properties": { "ids": { "type": "array" }, "discount": { "type": "integer" }, "order_limit": { "type": "integer" }, "price_limit": { "type": "integer" } } } } }, "get /open-api/v1/pricing/promotions/{promotion_id}/variants/eligible": { "parameters": [ { "name": "promotion_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[query]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[onlyBuyBoxWinner]", "in": "query", "required": false, "schema": { "type": "bool" } }, { "name": "search[categories]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[highlyDemanded]", "in": "query", "required": false, "schema": { "type": "bool" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/promotions/{promotion_id}/variants/eligible_v2": { "parameters": [ { "name": "promotion_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[query]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[onlyBuyBoxWinner]", "in": "query", "required": false, "schema": { "type": "bool" } }, { "name": "search[categories]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[highlyDemanded]", "in": "query", "required": false, "schema": { "type": "bool" } }, { "name": "search[isHero]", "in": "query", "required": false, "schema": { "type": "bool" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/promotions/{promotion_id}/variants/to-join": { "parameters": [ { "name": "promotion_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[variant_ids]", "in": "query", "required": false, "schema": { "type": "array" } }, { "name": "search[promotion_id]", "in": "query", "required": false, "schema": { "type": "int" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/promotions/{promotion_id}/variants/{variant_id}/commission-discount": { "parameters": [ { "name": "promotion_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "variant_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/promotions/{promotion_id}/variants/eligible/excel": { "parameters": [ { "name": "promotion_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/promotions/{promotion_id}/variants/excel/sample": { "parameters": [ { "name": "promotion_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/pricing/promotions/{promotion_id}/variants/excel": { "parameters": [ { "name": "promotion_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "file_id" ], "properties": { "file_id": { "type": "integer" } } } } }, "get /open-api/v1/pricing/plp": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[idOrTitle]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[statuses]", "in": "query", "required": false, "schema": { "type": "array", "enum": [ "approved", "active", "ended" ] } }, { "name": "search[startAt]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[endAt]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[isAdPLP]", "in": "query", "required": false, "schema": { "type": "bool" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "delete /open-api/v1/pricing/plp": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "promotion_id" ], "properties": { "promotion_id": { "type": "integer" } } } } }, "post /open-api/v1/pricing/plp": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "title", "platform", "startAt", "endAt", "isAdPLP" ], "properties": { "title": { "type": "string" }, "platform": { "type": "string" }, "startAt": { "type": "int" }, "endAt": { "type": "int" }, "isAdPLP": { "type": "bool" } } } } }, "put /open-api/v1/pricing/plp": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "promotion_id", "title", "platform", "startAt", "endAt", "isAdPLP" ], "properties": { "promotion_id": { "type": "integer" }, "title": { "type": "string" }, "platform": { "type": "string" }, "startAt": { "type": "int" }, "endAt": { "type": "int" }, "isAdPLP": { "type": "bool" } } } } }, "get /open-api/v1/pricing/plp/{promotion_id}": { "parameters": [ { "name": "promotion_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "productOrVariantId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "delete /open-api/v1/pricing/plp/variants": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "promotion_id", "variant_ids" ], "properties": { "promotion_id": { "type": "integer" }, "variant_ids": { "type": "array" } } } } }, "get /open-api/v1/pricing/plp/variants/eligible": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "latest", "price_low", "price_high", "earliest" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[onlyBuyBoxWinner]", "in": "query", "required": false, "schema": { "type": "bool" } }, { "name": "search[idOrTitle]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/plp/excel/import/sample": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/plp/excel/{promotion_id}": { "parameters": [ { "name": "promotion_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/pricing/plp/excel": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "title", "platform", "startAt", "endAt", "isAdPLP", "fileId" ], "properties": { "title": { "type": "string" }, "platform": { "type": "Undefined!" }, "startAt": { "type": "int" }, "endAt": { "type": "int" }, "isAdPLP": { "type": "bool" }, "promotionId": { "type": "int" }, "fileId": { "type": "int" } } } } }, "get /open-api/v1/pricing/vouchers": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[title]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[status]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[startAt]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[endAt]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[isPrivate]", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/pricing/vouchers": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "productIds", "title", "limit", "startAt", "endAt", "isPrivate" ], "properties": { "productIds": { "type": "array" }, "title": { "type": "string" }, "limit": { "type": "int" }, "voucherTypeId": { "type": "int" }, "type": { "type": "string" }, "percentage": { "type": "int" }, "max_discount": { "type": "int" }, "discount": { "type": "int" }, "min_price_discount_activation": { "type": "int" }, "startAt": { "type": "string" }, "endAt": { "type": "string" }, "isPrivate": { "type": "bool" } } } } }, "put /open-api/v1/pricing/vouchers": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "newProductIds", "deletedProductIds", "title", "limit", "voucherTypeId", "voucherId", "startAt", "endAt", "isVisible", "isPrivate" ], "properties": { "newProductIds": { "type": "array" }, "deletedProductIds": { "type": "array" }, "title": { "type": "string" }, "limit": { "type": "int" }, "voucherTypeId": { "type": "int" }, "voucherId": { "type": "int" }, "startAt": { "type": "string" }, "endAt": { "type": "string" }, "isVisible": { "type": "bool" }, "isPrivate": { "type": "bool" } } } } }, "get /open-api/v1/pricing/vouchers/types": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[type]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/vouchers/{voucher_id}": { "parameters": [ { "name": "voucher_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/vouchers/variants/eligible": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "latest", "price_low", "price_high", "earliest" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[query]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[categories]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[onlyBuyBoxWinner]", "in": "query", "required": false, "schema": { "type": "bool" } }, { "name": "search[type]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/price-stats/{variant_id}/boundary": { "parameters": [ { "name": "variant_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "promotion_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/pricing/multi-pricing/estimate": { "parameters": [ { "name": "variant_id", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "selling_price", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "rrp_price", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/batch/inquiry": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "batch_id" ], "properties": { "batch_id": { "type": "integer" } } } } }, "post /open-api/v1/batch/variant/update": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "items" ], "properties": { "deadline": { "type": "integer" }, "items": { "type": "array", "required": [ "variant_id" ], "items": { "type": "object", "properties": { "variant_id": { "type": "integer" }, "payload": { "type": "object", "required": [], "properties": { "seller_stock": { "type": "integer" }, "maximum_per_order": { "type": "integer" }, "selling_price": { "type": "integer" }, "shipping_type": { "type": "string" }, "lead_time": { "type": "integer" }, "seller_lead_time": { "type": "integer" }, "three_hour_delivery": { "type": "boolean" } } } } } } } } } }, "post /open-api/v1/batch/variant/activation/update": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "items" ], "properties": { "deadline": { "type": "integer" }, "items": { "type": "array", "required": [ "variant_id" ], "items": { "type": "object", "properties": { "variant_id": { "type": "integer" }, "payload": { "type": "object", "required": [ "activation" ], "properties": { "activation": { "type": "boolean" } } } } } } } } } }, "post /open-api/v1/batch/variant/seller-stock/update": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "items" ], "properties": { "deadline": { "type": "integer" }, "items": { "type": "array", "required": [ "variant_id" ], "items": { "type": "object", "properties": { "variant_id": { "type": "integer" }, "payload": { "type": "object", "required": [ "seller_stock" ], "properties": { "seller_stock": { "type": "integer" } } } } } } } } } }, "post /open-api/v1/shipments/seller/new-settings": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "type", "nature_id" ], "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "cost": { "type": "integer" }, "free_shipping": { "type": "object", "required": [], "properties": { "cost": { "type": "integer" }, "active": { "type": "boolean" } } }, "nature_id": { "type": "integer" }, "status": { "type": "string" }, "dynamic_time_scope_id": { "type": "integer" }, "time_distance": { "type": "integer" }, "first_mile_delivery_time": { "type": "integer" }, "cities": { "type": "array", "required": false, "items": { "type": "integer" } }, "time_scopes": { "type": "array", "required": [], "items": { "type": "object", "properties": { "id": { "type": "integer" }, "active": { "type": "boolean" }, "capacity": { "type": "integer" } } } }, "coverages": { "type": "array", "required": [], "items": { "type": "object", "properties": { "id": { "type": "integer" }, "cost": { "type": "integer" }, "polygon_ids": { "type": "array", "required": false, "items": { "type": "integer" } } } } }, "warehouse_id": { "type": "integer" }, "pic_name": { "type": "string" }, "pic_phone": { "type": "string" }, "auto_approve_pending_orders": { "type": "boolean" } } } } }, "get /open-api/v1/shipments/seller/new-settings": { "parameters": [ { "name": "search[status]", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "inactive", "active", "draft" ] } }, { "name": "search[search_term]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[nature_id]", "in": "query", "required": false, "schema": { "type": "integer", "enum": [ 1, 2, 3 ] } }, { "name": "search[type]", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "self_shipping", "partner_shipping" ] } }, { "name": "search[ids]", "in": "query", "required": false, "schema": { "type": "array" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "patch /open-api/v1/shipments/seller/new-settings/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "name": { "type": "string" }, "cost": { "type": "integer" }, "free_shipping": { "type": "object", "required": [], "properties": { "cost": { "type": "integer" }, "active": { "type": "boolean" } } }, "nature_id": { "type": "integer" }, "status": { "type": "string" }, "dynamic_time_scope_id": { "type": "integer" }, "time_distance": { "type": "integer" }, "first_mile_delivery_time": { "type": "integer" }, "cities": { "type": "array", "required": false, "items": { "type": "integer" } }, "time_scopes": { "type": "array", "required": [], "items": { "type": "object", "properties": { "id": { "type": "integer" }, "active": { "type": "boolean" }, "capacity": { "type": "integer" } } } }, "coverages": { "type": "array", "required": [], "items": { "type": "object", "properties": { "id": { "type": "integer" }, "cost": { "type": "integer" }, "polygon_ids": { "type": "array", "required": false, "items": { "type": "integer" } } } } }, "warehouse_id": { "type": "integer" }, "pic_name": { "type": "string" }, "pic_phone": { "type": "string" }, "auto_approve_pending_orders": { "type": "boolean" } } } } }, "get /open-api/v1/shipments/seller/new-settings/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/shipments/seller/new-settings/state": { "parameters": [ { "name": "search[setting_id]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search[nature_id]", "in": "query", "required": true, "schema": { "type": "integer", "enum": [ 1, 2, 3 ] } }, { "name": "search[active]", "in": "query", "required": false, "schema": { "type": "integer", "enum": [ 0, 1 ] } }, { "name": "search[text]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/shipments/seller/new-settings/time-scope": { "parameters": [ { "name": "search[type]", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "self_shipping", "partner_shipping", "nearby_shipping" ] } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/shipments/seller/new-settings/deactivate-cities": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "city_ids", "nature_id" ], "properties": { "city_ids": { "type": "array", "required": true, "items": { "type": "integer" } }, "nature_id": { "type": "integer" } } } } }, "get /open-api/v1/ship-by-seller-orders": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id", "order_date", "promise_date", "order_id", "shipment_id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[status]", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "pending", "processed", "processing", "edited", "rejected" ] } }, { "name": "search[search_term]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[shipping_provider]", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "seller", "seller_post" ] } }, { "name": "search[past]", "in": "query", "required": false, "schema": { "type": "boolean", "enum": [ true, false ] } }, { "name": "search[future]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[time_scope_id]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search[category_ids]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[is_b2b]", "in": "query", "required": false, "schema": { "type": "boolean", "enum": [ true, false ] } }, { "name": "search[critical_only]", "in": "query", "required": false, "schema": { "type": "boolean", "enum": [ true, false ] } }, { "name": "search[min_shipment_id]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/ship-by-seller-orders/statistics": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/ship-by-seller-orders/{shipment_id}": { "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/ship-by-seller-orders/customer/{shipment_id}": { "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/ship-by-seller-orders/post-data/{shipment_id}": { "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/ship-by-seller-orders/time-scopes/{shipment_id}": { "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/ship-by-seller-orders/failed-delivery/time-scopes/{shipment_id}": { "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/ship-by-seller-orders/cancel-item": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "order_shipment_id", "item_id", "reason_id" ], "properties": { "order_shipment_id": { "type": "integer" }, "item_id": { "type": "integer" }, "reason_id": { "type": "integer" }, "count": { "type": "integer" } } } } }, "post /open-api/v1/ship-by-seller-orders/cancel-shipment": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "order_shipment_id", "reason_id" ], "properties": { "order_shipment_id": { "type": "integer" }, "reason_id": { "type": "integer" } } } } }, "post /open-api/v1/ship-by-seller-orders/tracking-code": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "order_shipment_id", "tracking_codes" ], "properties": { "order_shipment_id": { "type": "integer" }, "tracking_codes": { "type": "array", "required": [ "tracking_code" ], "items": { "type": "object", "properties": { "id": { "type": "integer" }, "tracking_code": { "type": "string" } } } }, "infra_type": { "type": "string" }, "service_name": { "type": "string" } } } } }, "put /open-api/v1/ship-by-seller-orders/update-status": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "order_shipment_id", "new_status" ], "properties": { "order_shipment_id": { "type": "integer" }, "new_status": { "type": "string" }, "verification_code": { "type": "integer" } } } } }, "post /open-api/v1/ship-by-seller-orders/full-delivered": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "order_shipment_id", "tracking_codes" ], "properties": { "order_shipment_id": { "type": "integer" }, "tracking_codes": { "type": "array", "required": true, "items": { "type": "string" } } } } } }, "put /open-api/v1/ship-by-seller-orders/update-edited": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "order_shipment_id" ], "properties": { "order_shipment_id": { "type": "integer" } } } } }, "post /open-api/v1/ship-by-seller-orders/failed-delivery": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "order_shipment_id", "reason_id", "capacity_id" ], "properties": { "order_shipment_id": { "type": "integer" }, "reason_id": { "type": "integer" }, "capacity_id": { "type": "integer" } } } } }, "put /open-api/v1/ship-by-seller-orders/change-time-scope": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "order_shipment_id", "capacity_id" ], "properties": { "order_shipment_id": { "type": "integer" }, "capacity_id": { "type": "integer" } } } } }, "get /open-api/v1/ship-by-seller-orders/post-order/{shipment_id}": { "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/ship-by-seller-orders/batch-update-status": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "new_status" ], "properties": { "order_shipment_ids": { "type": "array" }, "new_status": { "type": "string" }, "select_all": { "type": "boolean" } } } } }, "get /open-api/v1/webhook/event-types": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/webhook/subscription": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "event_types": { "type": "array", "required": false, "items": { "type": "string", "enum": [ "product_variant_status_change", "order_shipment", "seller_package_status_change", "commission_change", "product_moderation", "brand_request_moderation", "warranty_request_moderation", "color_request_moderation", "size_request_moderation", "order_processed", "order_item_cancellation", "order_return" ] } } } } } }, "post /open-api/v1/webhook/unsubscription": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "event_types": { "type": "array", "required": false, "items": { "type": "string", "enum": [ "product_variant_status_change", "order_shipment", "seller_package_status_change", "commission_change", "product_moderation", "brand_request_moderation", "warranty_request_moderation", "color_request_moderation", "size_request_moderation", "order_processed", "order_item_cancellation", "order_return" ] } } } } } }, "post /open-api/v1/webhook/subscription/change-activation": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "activation": { "type": "boolean" } } } } }, "get /open-api/v1/commissions/": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[my_commissions]", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "search[main_category_id]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search[category_id]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search[brand_id]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/shipping-services/postex-status": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/shipping-services/wallet/balance": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/shipping-services/user": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "first_name", "last_name", "birth_certificate_serial", "birth_certificate_series", "birth_certificate_issued_city_id", "birth_date", "gender", "national_identity_number", "national_identity_series", "warehouse_id", "register_phone", "store_name", "store_category_name", "store_phone" ], "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "birth_certificate_serial": { "type": "string" }, "birth_certificate_series": { "type": "string" }, "birth_certificate_issued_city_id": { "type": "integer" }, "birth_date": { "type": "date" }, "gender": { "type": "string" }, "national_identity_number": { "type": "string" }, "national_identity_series": { "type": "string" }, "warehouse_id": { "type": "integer" }, "register_phone": { "type": "string" }, "store_name": { "type": "string" }, "store_category_name": { "type": "string" }, "store_phone": { "type": "string" } } } } }, "get /open-api/v1/shipping-services/user": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/shipping-services/wallet/charge": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "amount" ], "properties": { "amount": { "type": "integer" }, "order_id": { "type": "integer" }, "order_shipment_ids": { "type": "array,array,array" }, "callback_url": { "type": "string" } } } } }, "get /open-api/v1/shipping-services/wallet/transactions": { "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from_date", "in": "query", "required": false, "schema": { "type": "datetime" } }, { "name": "to_date", "in": "query", "required": false, "schema": { "type": "datetime" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/shipping-services/wallet/transactions/{transaction_id}": { "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/shipping-services/wallet/verify": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "payment_id", "order_no" ], "properties": { "payment_id": { "type": "string" }, "order_no": { "type": "integer" }, "error_message": { "type": "string" } } } } }, "get /open-api/v1/shipping-services/boxes": { "parameters": [ { "name": "shipment_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/shipping-services/token-status": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/shipping-services/excel/post-tracking-sample": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/shipping-services/send_otp": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "phone_number" ], "properties": { "phone_number": { "type": "string" } } } } }, "post /open-api/v1/shipping-services/import/tracking-code": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "file_id" ], "properties": { "file_id": { "type": "integer" } } } } }, "get /open-api/v1/shipping-services/parcels/total-weight": { "parameters": [ { "name": "variant_ids", "in": "query", "required": true, "schema": { "type": "string,array" } }, { "name": "quantities", "in": "query", "required": true, "schema": { "type": "string,object" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/shipping-services/parcels/calculate-price": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "shipment_id", "registration_method", "warehouse_id", "added_services", "ready_date_time" ], "properties": { "shipment_id": { "type": "integer" }, "registration_method": { "type": "string,array" }, "warehouse_id": { "type": "integer" }, "added_services": { "type": "array" }, "ready_date_time": { "type": "string" }, "parcel": { "type": "array,array" } } } } }, "post /open-api/v1/shipping-services/parcels/post-tracking-code/bulk": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "order_shipment_ids", "warehouse_id" ], "properties": { "order_shipment_ids": { "type": "array", "required": true, "items": { "type": "int" } }, "warehouse_id": { "type": "int" } } } } }, "post /open-api/v1/shipping-services/parcels/excel": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "order_shipment_ids" ], "properties": { "order_shipment_ids": { "type": "array", "required": true, "items": { "type": "int" } } } } } }, "post /open-api/v1/shipping-services/parcels/cost": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "order_shipment_ids", "warehouse_id" ], "properties": { "order_shipment_ids": { "type": "array", "required": true, "items": { "type": "int" } }, "warehouse_id": { "type": "int" }, "request_type": { "type": "string" } } } } }, "get /open-api/v1/shipping-services/order/{shipment_id}": { "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/shipping-services/order/detail/{order_id}": { "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "order_id", "in": "query", "required": true, "schema": { "type": "int" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "put /open-api/v1/shipping-services/order/cancel/{shipment_id}": { "parameters": [ { "name": "shipment_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "registration_method": { "type": "string,array" }, "deactivate_parcel": { "type": "boolean" } } } } }, "post /open-api/v1/shipping-services/user/register": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "otp" ], "properties": { "otp": { "type": "integer" } } } } }, "get /open-api/v1/shipping-services/user/info": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/shipping-services/label/{registration_method}/{parcel_number}": { "parameters": [ { "name": "registration_method", "in": "path", "required": true, "schema": { "type": null } }, { "name": "parcel_number", "in": "path", "required": true, "schema": { "type": null } }, { "name": "Content-Type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/shipping-services/label-request": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "shipment_ids" ], "properties": { "shipment_ids": { "type": "array" } } } } }, "get /open-api/v1/shipping-services/label-request/{request_id}": { "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/bulk-shipping-services/packaging": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "shipment_id" ], "properties": { "shipment_id": { "type": "integer" }, "parcel": { "type": "array,array" } } } } }, "post /open-api/v1/bulk-shipping-services/bulk-packaging": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "shipments_data" ], "properties": { "shipments_data": { "type": "array,array" } } } } }, "post /open-api/v1/bulk-shipping-services/simple-packaging": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "shipment_ids", "box_size_id", "total_weight" ], "properties": { "shipment_ids": { "type": "array,array" }, "box_size_id": { "type": "integer" }, "total_weight": { "type": "Undefined!" }, "width": { "type": "number" }, "height": { "type": "number" }, "length": { "type": "number" } } } } }, "post /open-api/v1/bulk-shipping-services/pickup": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "pickup_method", "shipment_ids", "ready_date_time", "warehouse_id" ], "properties": { "pickup_method": { "type": "string,array" }, "shipment_ids": { "type": "array" }, "ready_date_time": { "type": "Undefined!" }, "warehouse_id": { "type": "integer" }, "promise_date_start": { "type": "string" }, "promise_date_end": { "type": "string" } } } } }, "get /open-api/v1/bulk-shipping-services/detail/{shipment_ids}": { "parameters": [ { "name": "shipment_ids", "in": "path", "required": true, "schema": { "type": null } }, { "name": "shipment_ids", "in": "query", "required": true, "schema": { "type": "array" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/bulk-shipping-services/promise-date/{shipment_ids}": { "parameters": [ { "name": "shipment_ids", "in": "path", "required": true, "schema": { "type": null } }, { "name": "shipment_ids", "in": "query", "required": true, "schema": { "type": "array" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/invoices": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[payout_order_status]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search[invoice_start_date]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[invoice_end_date]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/invoices/{invoice_id}/details": { "parameters": [ { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/invoices/{invoice_id}/items/{financial_notation_id}/{calculation_type}": { "parameters": [ { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "financial_notation_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "calculation_type", "in": "path", "required": true, "schema": { "type": null } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[invoice_id]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search[financial_notation_id]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search[calculation_type]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/invoices/vat": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "product_id", "date", "price", "is_vat_included_in_price" ], "properties": { "product_id": { "type": "integer" }, "date": { "type": "string" }, "price": { "type": "integer" }, "is_vat_included_in_price": { "type": "boolean" } } } } }, "get /open-api/v1/finance/overview/v2": { "parameters": [ { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/finance/transactions": { "parameters": [ { "name": "search[status]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[aggregation_type]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[search]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[start_date]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[end_date]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/finance/transactions/rows": { "parameters": [ { "name": "search[status]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[notations]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[search]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[start_date]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[end_date]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/finance/transactions/summary": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/finance/transactions/{transaction_id}": { "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/finance/payouts": { "parameters": [ { "name": "search[status]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/finance/payouts/{payout_id}": { "parameters": [ { "name": "payout_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/finance/seller-invoices": { "parameters": [ { "name": "search[month]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search[year]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search[invoice_id]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/finance/transactions/export/excel": { "parameters": [ { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "start_date": { "type": "string" }, "end_date": { "type": "string" } } } } }, "get /open-api/v1/commitments": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "variant_id", "commitment_count" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[multi_search]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[category_ids]", "in": "query", "required": false, "schema": { "type": "string,integer" } }, { "name": "search[shipping_nature_ids]", "in": "query", "required": false, "schema": { "type": "string,integer", "enum": [ 1, 3, 2 ] } }, { "name": "search[is_effective]", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "search[to_commitment_date]", "in": "query", "required": false, "schema": { "type": "string,date" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/commitments/metadata": { "parameters": [ { "name": "commitment_date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/commitments/export": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "search": { "type": "object", "required": [], "properties": { "multi_search": { "type": "string" }, "category_ids": { "type": "string" }, "shipping_nature_ids": { "type": "string" }, "is_effective": { "type": "boolean" }, "to_commitment_date": { "type": "string" } } }, "sort": { "type": "string" }, "order": { "type": "string" } } } } }, "post /open-api/v1/commitments/report/export": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "fromDate": { "type": "string" }, "toDate": { "type": "string" } } } } }, "get /open-api/v1/commitments/{variant_id}": { "parameters": [ { "name": "variant_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "commitment_date", "quantity" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[commitment_date]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/search-ads/campaigns": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "enum" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "enum" } }, { "name": "search[q]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[status]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[start_date]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[end_date]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/search-ads/campaigns": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "campaign": { "type": "object", "required": [ "title", "start_date", "bid_amount" ], "properties": { "title": { "type": "string" }, "product_ids": { "type": "array", "required": false, "items": { "type": "integer", "required": true } }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "bid_amount": { "type": "integer" }, "daily_budget": { "type": "integer" }, "total_budget": { "type": "integer" }, "payment_method": { "type": "string" } } } } } } }, "get /open-api/v1/search-ads/campaigns/{campaignId}": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/search-ads/campaigns/recommended-products": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "cr" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[q]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "put /open-api/v1/search-ads/campaigns/{campaign_id}": { "parameters": [ { "name": "campaign_id", "in": "path", "required": true, "schema": { "type": null } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [], "properties": { "campaign": { "type": "object", "required": [ "title", "start_date", "bid_amount" ], "properties": { "title": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "bid_amount": { "type": "integer" }, "daily_budget": { "type": "integer" }, "total_budget": { "type": "integer" }, "payment_method": { "type": "string" } } } } } } }, "patch /open-api/v1/search-ads/campaigns/{campaignId}/status": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string" } } } } }, "get /open-api/v1/search-ads/v2/products": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "enum", "enum": [ "id", "created_at", "latest", "best_seller", "highest_cr", "most_visited", "most_popular", "fastest_shipping", "highest_discount", "price_high_low", "price_low_high", "recommended" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[q]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[category_filter]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "search[campaign_id]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/search-ads/v2/setting": { "parameters": [ { "name": "category_ids[]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/search-ads/v2/campaigns": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "campaign" ], "properties": { "campaign": { "type": "object", "required": [ "title", "products", "start_date" ], "properties": { "title": { "type": "string" }, "products": { "type": "array", "required": [], "items": { "type": "object", "properties": { "product_id": { "type": "integer" }, "bid_amount": { "type": "integer" } } } }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "daily_budget": { "type": "integer" }, "total_budget": { "type": "integer" }, "payment_method": { "type": "string" } } } } } } }, "get /open-api/v1/search-ads/v2/campaigns": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "enum", "enum": [ "id", "title", "start_date", "end_date", "status", "created_at", "updated_at" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[status]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[start_date]", "in": "query", "required": false, "schema": { "type": "date" } }, { "name": "search[end_date]", "in": "query", "required": false, "schema": { "type": "date" } }, { "name": "search[campaign_id]", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/search-ads/v2/campaigns/{campaign_id}": { "parameters": [ { "name": "campaign_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "patch /open-api/v1/search-ads/v2/campaigns/{campaign_id}": { "parameters": [ { "name": "campaign_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "campaign" ], "properties": { "campaign": { "type": "object", "required": [], "properties": { "title": { "type": "string" }, "products": { "type": "array", "required": [], "items": { "type": "object", "properties": { "product_id": { "type": "integer" }, "bid_amount": { "type": "integer" } } } }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "daily_budget": { "type": "integer" }, "total_budget": { "type": "integer" }, "payment_method": { "type": "string" } } } } } } }, "get /open-api/v1/search-ads/v2/campaigns/{campaign_id}/report": { "parameters": [ { "name": "campaign_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "start", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/search-ads/v2/campaigns/{campaign_id}/overview": { "parameters": [ { "name": "campaign_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "start", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/search-ads/v2/campaigns/{campaign_id}/products/{product_id}/overview": { "parameters": [ { "name": "campaign_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "product_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "start", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/search-ads/v2/products/{product_id}/overview": { "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "start", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "get /open-api/v1/search-ads/v2/seller/overview": { "parameters": [ { "name": "start", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "patch /open-api/v1/search-ads/v2/campaigns/{campaign_id}/status/{status}": { "parameters": [ { "name": "campaign_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "status", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "patch /open-api/v1/search-ads/v2/campaigns/{campaign_id}/bid": { "parameters": [ { "name": "campaign_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "campaign" ], "properties": { "campaign": { "type": "object", "required": [ "product_id", "bid_amount" ], "properties": { "product_id": { "type": "integer" }, "bid_amount": { "type": "integer" } } } } } } }, "post /open-api/v1/search-ads/v2/campaigns/{campaign_id}/products": { "parameters": [ { "name": "campaign_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "products" ], "properties": { "products": { "type": "array", "required": [], "items": { "type": "object", "properties": { "product_id": { "type": "integer" }, "bid_amount": { "type": "integer" } } } } } } } }, "patch /open-api/v1/search-ads/v2/campaigns/{campaign_id}/products/{product_id}/status": { "parameters": [ { "name": "campaign_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "product_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "active" ], "properties": { "active": { "type": "boolean" } } } } }, "get /open-api/v1/near-by-stores": { "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "id", "order_date", "promise_date", "order_id", "nearby_stores_sla_start_at" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[status]", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "pending", "processing", "processed" ] } }, { "name": "search[search_term]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search[category_ids]", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "content-type", "in": "header", "required": true, "schema": [] } ] }, "post /open-api/v1/near-by-stores/customer-not-respond": { "parameters": [ { "name": "content-type", "in": "header", "required": true, "schema": [] } ], "body": { "application/json": { "type": "object", "required": [ "order_shipment_ids", "reason_id" ], "properties": { "order_shipment_ids": { "type": "array", "required": true, "items": { "type": "integer" } }, "reason_id": { "type": "integer" } } } } } } }