{ "swagger": "2.0", "info": { "title": "eTop External API: Shop", "version": "v1" }, "schemes": [ "http", "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/v1/shop.History/GetChanges": { "post": { "operationId": "GetChanges", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/externalCallback" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/externalGetChangesRequest" } } ], "tags": [ "History" ] } }, "/v1/shop.Misc/CurrentAccount": { "post": { "operationId": "CurrentAccount", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/etopPublicAccountInfo" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/cmEmpty" } } ], "tags": [ "Misc" ] } }, "/v1/shop.Misc/GetLocationList": { "post": { "operationId": "GetLocationList", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/externalLocationResponse" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/cmEmpty" } } ], "tags": [ "Misc" ] } }, "/v1/shop.Misc/VersionInfo": { "post": { "operationId": "VersionInfo", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/cmVersionInfoResponse" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/cmEmpty" } } ], "tags": [ "Misc" ] } }, "/v1/shop.Shipping/CancelOrder": { "post": { "operationId": "CancelOrder", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/externalOrderAndFulfillments" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/externalCancelOrderRequest" } } ], "tags": [ "Shipping" ] } }, "/v1/shop.Shipping/CreateAndConfirmOrder": { "post": { "operationId": "CreateAndConfirmOrder", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/externalOrderAndFulfillments" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/externalCreateOrderRequest" } } ], "tags": [ "Shipping" ] } }, "/v1/shop.Shipping/GetFulfillment": { "post": { "operationId": "GetFulfillment", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/externalFulfillment" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/externalFulfillmentIDRequest" } } ], "tags": [ "Shipping" ] } }, "/v1/shop.Shipping/GetOrder": { "post": { "operationId": "GetOrder", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/externalOrderAndFulfillments" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/externalOrderIDRequest" } } ], "tags": [ "Shipping" ] } }, "/v1/shop.Shipping/GetShippingServices": { "post": { "operationId": "GetShippingServices", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/externalGetShippingServicesResponse" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/externalGetShippingServicesRequest" } } ], "tags": [ "Shipping" ] } }, "/v1/shop.Webhook/CreateWebhook": { "post": { "operationId": "CreateWebhook", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/externalWebhook" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/externalCreateWebhookRequest" } } ], "tags": [ "Webhook" ] } }, "/v1/shop.Webhook/DeleteWebhook": { "post": { "operationId": "DeleteWebhook", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/externalWebhooksResponse" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/externalDeleteWebhookRequest" } } ], "tags": [ "Webhook" ] } }, "/v1/shop.Webhook/GetWebhooks": { "post": { "operationId": "GetWebhooks", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/externalWebhooksResponse" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/cmEmpty" } } ], "tags": [ "Webhook" ] } } }, "definitions": { "cmEmpty": { "type": "object" }, "cmError": { "type": "object", "properties": { "code": { "type": "string" }, "msg": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "string" } } } }, "cmForwardPaging": { "type": "object", "properties": { "since": { "type": "string" }, "limit": { "type": "integer", "format": "int32" } } }, "cmVersionInfoResponse": { "type": "object", "properties": { "service": { "type": "string" }, "version": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" } } }, "etopAccountType": { "type": "string", "enum": [ "unknown", "partner", "shop", "affiliate", "etop" ], "default": "unknown", "description": "Indicates whether given account is **etop**, **shop**, **partner** or **sale**." }, "etopPublicAccountInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "name": { "type": "string" }, "type": { "$ref": "#/definitions/etopAccountType" }, "image_url": { "type": "string" }, "website": { "type": "string" } } }, "externalCallback": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "changes": { "type": "array", "items": { "$ref": "#/definitions/externalChange" } } } }, "externalCancelOrderRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "code": { "type": "string" }, "external_id": { "type": "string" }, "cancel_reason": { "type": "string" } } }, "externalChange": { "type": "object", "properties": { "time": { "type": "string", "format": "date-time" }, "change_type": { "type": "string" }, "entity": { "type": "string" }, "latest": { "$ref": "#/definitions/externalLatestOneOf" }, "changed": { "$ref": "#/definitions/externalChangeOneOf" } } }, "externalChangeOneOf": { "type": "object", "properties": { "order": { "$ref": "#/definitions/externalOrder" }, "fulfillment": { "$ref": "#/definitions/externalFulfillment" } } }, "externalCreateOrderRequest": { "type": "object", "properties": { "external_id": { "type": "string" }, "external_code": { "type": "string" }, "external_url": { "type": "string" }, "customer_address": { "$ref": "#/definitions/externalOrderAddress" }, "shipping_address": { "$ref": "#/definitions/externalOrderAddress" }, "lines": { "type": "array", "items": { "$ref": "#/definitions/externalOrderLine" } }, "total_items": { "type": "integer", "format": "int32" }, "basket_value": { "type": "integer", "format": "int32", "title": "basket_value = SUM(lines.retail_price)" }, "order_discount": { "type": "integer", "format": "int32" }, "total_discount": { "type": "integer", "format": "int32" }, "total_fee": { "type": "integer", "format": "int32" }, "fee_lines": { "type": "array", "items": { "$ref": "#/definitions/orderOrderFeeLine" } }, "total_amount": { "type": "integer", "format": "int32" }, "order_note": { "type": "string" }, "shipping": { "$ref": "#/definitions/externalOrderShipping" }, "external_meta": { "type": "object", "additionalProperties": { "type": "string" } } } }, "externalCreateWebhookRequest": { "type": "object", "properties": { "entities": { "type": "array", "items": { "type": "string" } }, "fields": { "type": "array", "items": { "type": "string" } }, "url": { "type": "string" }, "metadata": { "type": "string" } } }, "externalDeleteWebhookRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" } } }, "externalDistrict": { "type": "object", "properties": { "name": { "type": "string" }, "wards": { "type": "array", "items": { "$ref": "#/definitions/externalWard" } } } }, "externalFulfillment": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "order_id": { "type": "string", "format": "int64" }, "shop_id": { "type": "string", "format": "int64" }, "self_url": { "type": "string" }, "total_items": { "type": "integer", "format": "int32" }, "basket_value": { "type": "integer", "format": "int32" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "closed_at": { "type": "string", "format": "date-time" }, "cancelled_at": { "type": "string", "format": "date-time" }, "cancel_reason": { "type": "string" }, "carrier": { "$ref": "#/definitions/shipping_providerShippingProvider" }, "shipping_service_name": { "type": "string" }, "shipping_service_fee": { "type": "integer", "format": "int32" }, "actual_shipping_service_fee": { "type": "integer", "format": "int32" }, "shipping_service_code": { "type": "string" }, "shipping_code": { "type": "string" }, "shipping_note": { "type": "string" }, "try_on": { "$ref": "#/definitions/try_onTryOnCode" }, "include_insurance": { "type": "boolean", "format": "boolean" }, "confirm_status": { "$ref": "#/definitions/status3Status" }, "shipping_state": { "$ref": "#/definitions/shippingState" }, "shipping_status": { "$ref": "#/definitions/status5Status" }, "status": { "$ref": "#/definitions/status5Status" }, "cod_amount": { "type": "integer", "format": "int32" }, "actual_cod_amount": { "type": "integer", "format": "int32" }, "chargeable_weight": { "type": "integer", "format": "int32" }, "pickup_address": { "$ref": "#/definitions/externalOrderAddress" }, "return_address": { "$ref": "#/definitions/externalOrderAddress" }, "shipping_address": { "$ref": "#/definitions/externalOrderAddress" }, "etop_payment_status": { "$ref": "#/definitions/status4Status" }, "estimated_delivery_at": { "type": "string", "format": "date-time" }, "estimated_pickup_at": { "type": "string", "format": "date-time" } } }, "externalFulfillmentIDRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "shipping_code": { "type": "string" } } }, "externalGetChangesRequest": { "type": "object", "properties": { "paging": { "$ref": "#/definitions/cmForwardPaging" }, "entity": { "type": "string" }, "entity_id": { "type": "string" } } }, "externalGetShippingServicesRequest": { "type": "object", "properties": { "pickup_address": { "$ref": "#/definitions/externalLocationAddress" }, "shipping_address": { "$ref": "#/definitions/externalLocationAddress" }, "gross_weight": { "type": "integer", "format": "int32", "title": "in gram (g)" }, "chargeable_weight": { "type": "integer", "format": "int32", "title": "in gram (g)" }, "length": { "type": "integer", "format": "int32", "title": "in centimetre (cm)" }, "width": { "type": "integer", "format": "int32", "title": "in centimetre (cm)" }, "height": { "type": "integer", "format": "int32", "title": "in centimetre (cm)" }, "basket_value": { "type": "integer", "format": "int32" }, "cod_amount": { "type": "integer", "format": "int32" }, "include_insurance": { "type": "boolean", "format": "boolean" } } }, "externalGetShippingServicesResponse": { "type": "object", "properties": { "services": { "type": "array", "items": { "$ref": "#/definitions/externalShipping" } } } }, "externalLatestOneOf": { "type": "object", "properties": { "order": { "$ref": "#/definitions/externalOrder" }, "fulfillment": { "$ref": "#/definitions/externalFulfillment" } } }, "externalLocationAddress": { "type": "object", "properties": { "province": { "type": "string" }, "district": { "type": "string" } } }, "externalLocationResponse": { "type": "object", "properties": { "provinces": { "type": "array", "items": { "$ref": "#/definitions/externalProvince" } } } }, "externalOrder": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "shop_id": { "type": "string", "format": "int64" }, "code": { "type": "string" }, "external_id": { "type": "string" }, "external_code": { "type": "string" }, "external_url": { "type": "string" }, "self_url": { "type": "string" }, "customer_address": { "$ref": "#/definitions/externalOrderAddress" }, "shipping_address": { "$ref": "#/definitions/externalOrderAddress" }, "created_at": { "type": "string", "format": "date-time" }, "processed_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "closed_at": { "type": "string", "format": "date-time" }, "confirmed_at": { "type": "string", "format": "date-time" }, "cancelled_at": { "type": "string", "format": "date-time" }, "cancel_reason": { "type": "string" }, "confirm_status": { "$ref": "#/definitions/status3Status" }, "status": { "$ref": "#/definitions/status5Status" }, "fulfillment_shipping_status": { "$ref": "#/definitions/status5Status" }, "etop_payment_status": { "$ref": "#/definitions/status4Status" }, "lines": { "type": "array", "items": { "$ref": "#/definitions/externalOrderLine" } }, "total_items": { "type": "integer", "format": "int32" }, "basket_value": { "type": "integer", "format": "int32" }, "order_discount": { "type": "integer", "format": "int32" }, "total_discount": { "type": "integer", "format": "int32" }, "total_fee": { "type": "integer", "format": "int32" }, "fee_lines": { "type": "array", "items": { "$ref": "#/definitions/orderOrderFeeLine" } }, "total_amount": { "type": "integer", "format": "int32" }, "order_note": { "type": "string" }, "shipping": { "$ref": "#/definitions/externalOrderShipping" } } }, "externalOrderAddress": { "type": "object", "properties": { "full_name": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "province": { "type": "string" }, "district": { "type": "string" }, "ward": { "type": "string" }, "company": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" } } }, "externalOrderAndFulfillments": { "type": "object", "properties": { "order": { "$ref": "#/definitions/externalOrder" }, "fulfillments": { "type": "array", "items": { "$ref": "#/definitions/externalFulfillment" } }, "fulfillment_errors": { "type": "array", "items": { "$ref": "#/definitions/cmError" } } } }, "externalOrderIDRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "code": { "type": "string" }, "external_id": { "type": "string" } } }, "externalOrderLine": { "type": "object", "properties": { "variant_id": { "type": "string", "format": "int64" }, "product_id": { "type": "string", "format": "int64" }, "product_name": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" }, "list_price": { "type": "integer", "format": "int32" }, "retail_price": { "type": "integer", "format": "int32" }, "payment_price": { "type": "integer", "format": "int32", "title": "payment_price = retail_price - discount_per_item" }, "image_url": { "type": "string" }, "attributes": { "type": "array", "items": { "$ref": "#/definitions/orderAttribute" } } } }, "externalOrderShipping": { "type": "object", "properties": { "pickup_address": { "$ref": "#/definitions/externalOrderAddress" }, "return_address": { "$ref": "#/definitions/externalOrderAddress" }, "shipping_service_name": { "type": "string" }, "shipping_service_code": { "type": "string" }, "shipping_service_fee": { "type": "integer", "format": "int32" }, "carrier": { "$ref": "#/definitions/shipping_providerShippingProvider" }, "include_insurance": { "type": "boolean", "format": "boolean" }, "try_on": { "$ref": "#/definitions/try_onTryOnCode" }, "shipping_note": { "type": "string" }, "cod_amount": { "type": "integer", "format": "int32" }, "gross_weight": { "type": "integer", "format": "int32" }, "length": { "type": "integer", "format": "int32" }, "width": { "type": "integer", "format": "int32" }, "height": { "type": "integer", "format": "int32" }, "chargeable_weight": { "type": "integer", "format": "int32" } } }, "externalProvince": { "type": "object", "properties": { "name": { "type": "string" }, "districts": { "type": "array", "items": { "$ref": "#/definitions/externalDistrict" } } } }, "externalShipping": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "fee": { "type": "integer", "format": "int32" }, "carrier": { "$ref": "#/definitions/shipping_providerShippingProvider" }, "estimated_pickup_at": { "type": "string", "format": "date-time" }, "estimated_delivery_at": { "type": "string", "format": "date-time" } } }, "externalWard": { "type": "object", "properties": { "name": { "type": "string" } } }, "externalWebhook": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "entities": { "type": "array", "items": { "type": "string" } }, "fields": { "type": "array", "items": { "type": "string" } }, "url": { "type": "string" }, "metadata": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "states": { "$ref": "#/definitions/externalWebhookStates" } } }, "externalWebhookError": { "type": "object", "properties": { "error": { "type": "string" }, "resp_status": { "type": "integer", "format": "int32" }, "resp_body": { "type": "string" }, "retried": { "type": "integer", "format": "int32" }, "sent_at": { "type": "string", "format": "date-time" } } }, "externalWebhookStates": { "type": "object", "properties": { "state": { "type": "string" }, "last_sent_at": { "type": "string", "format": "date-time" }, "last_error": { "$ref": "#/definitions/externalWebhookError" } } }, "externalWebhooksResponse": { "type": "object", "properties": { "webhooks": { "type": "array", "items": { "$ref": "#/definitions/externalWebhook" } } } }, "feeFeeType": { "type": "string", "enum": [ "other", "shipping", "tax" ], "default": "other" }, "orderAttribute": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "orderOrderFeeLine": { "type": "object", "properties": { "type": { "$ref": "#/definitions/feeFeeType" }, "name": { "type": "string" }, "code": { "type": "string" }, "desc": { "type": "string" }, "amount": { "type": "integer", "format": "int32" } }, "required": [ "name", "amount" ] }, "shippingState": { "type": "string", "enum": [ "default", "created", "confirmed", "processing", "picking", "holding", "returning", "returned", "delivering", "delivered", "unknown", "undeliverable", "cancelled" ], "default": "default" }, "shipping_providerShippingProvider": { "type": "string", "enum": [ "unknown", "all", "manual", "ghn", "ghtk", "vtpost" ], "default": "unknown" }, "status3Status": { "type": "string", "enum": [ "Z", "P", "N" ], "default": "Z" }, "status4Status": { "type": "string", "enum": [ "Z", "P", "S", "N" ], "default": "Z" }, "status5Status": { "type": "string", "enum": [ "Z", "P", "S", "N", "NS" ], "default": "Z" }, "try_onTryOnCode": { "type": "string", "enum": [ "unknown", "none", "open", "try" ], "default": "unknown" } }, "tags": [ { "name": "History" }, { "name": "Misc" }, { "name": "Shipping" }, { "name": "Webhook" } ] }