{ "schemes": [ "https", "http" ], "swagger": "2.0", "info": { "description": "Shipment API Documentation", "title": "Shipment API Documentation", "contact": {}, "version": "1.0" }, "paths": { "/": { "get": { "description": "Get the info of server.", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "HeathCheck" ], "summary": "Show the info of server.", "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/admin/shipments/_status": { "post": { "description": "Development API for update shipment", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "summary": "Development API for update shipment", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.DevUpdateShipmentRequest" } } ], "responses": { "200": { "description": "" } } } }, "/business-profiles/{id}": { "get": { "security": [ { "BearerToken": [] } ], "description": "Get business profile by ID", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "BusinessProfile" ], "summary": "Get business profile by ID", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true }, { "type": "string", "description": "Business Profile ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.BusinessProfile" } } } } }, "/couriers": { "get": { "security": [ { "BearerToken": [] } ], "description": "Get list of all couriers.", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Courier" ], "summary": "Get list of all couriers.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetCouriersResponse" } } } }, "post": { "security": [ { "BearerToken": [] } ], "description": "Create a new courier", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Courier" ], "summary": "CreateCourier", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.CreateCourierRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.Courier" } } } } }, "/couriers/{id}": { "get": { "security": [ { "BearerToken": [] } ], "description": "Get Courier by id.", "consumes": [ "*/*" ], "tags": [ "Courier" ], "summary": "Get Courier by id.", "parameters": [ { "type": "integer", "description": "Courier ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetCourierResponse" } } } }, "put": { "security": [ { "BearerToken": [] } ], "description": "Update a courier", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Courier" ], "summary": "UpdateCourier", "parameters": [ { "type": "integer", "description": "Courier ID", "name": "id", "in": "path", "required": true }, { "description": "Update Courier", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.UpdateCourierRequest" } } ], "responses": { "204": { "description": "" } } }, "delete": { "security": [ { "BearerToken": [] } ], "description": "Delete a courier", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Courier" ], "summary": "DeleteCourier", "parameters": [ { "type": "integer", "description": "Courier ID", "name": "id", "in": "path", "required": true } ], "responses": { "204": { "description": "" } } } }, "/couriers/{id}/link-account": { "post": { "security": [ { "BearerToken": [] } ], "description": "Get link account URL.", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Courier" ], "summary": "Get link account URL.", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true }, { "type": "integer", "description": "Courier ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetLinkAccountUrlResponse" } } } } }, "/delivery-plans": { "get": { "security": [ { "BearerToken": [] } ], "description": "Get list of all delivery plans.", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Delivery Plan" ], "summary": "Get list of all delivery plans.", "parameters": [ { "type": "string", "name": "countryCode", "in": "query" }, { "type": "integer", "name": "courierID", "in": "query" }, { "type": "boolean", "name": "deactivate", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetDeliveryPlansResponse" } } } }, "post": { "security": [ { "BearerToken": [] } ], "description": "Create a new delivery plan", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Delivery Plan" ], "summary": "CreateDeliveryPlan", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.CreateDeliveryPlanRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DeliveryPlan" } } } } }, "/delivery-plans/{id}": { "put": { "security": [ { "BearerToken": [] } ], "description": "Update a delivery plan", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Delivery Plan" ], "summary": "UpdateDeliveryPlan", "parameters": [ { "type": "integer", "description": "DeliveryPlan ID", "name": "id", "in": "path", "required": true }, { "description": "Update DeliveryPlan", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.UpdateDeliveryPlanRequest" } } ], "responses": { "204": { "description": "" } } }, "delete": { "security": [ { "BearerToken": [] } ], "description": "Delete a delivery plan", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Delivery Plan" ], "summary": "DeleteDeliveryPlan", "parameters": [ { "type": "integer", "description": "DeliveryPlan ID", "name": "id", "in": "path", "required": true } ], "responses": { "204": { "description": "" } } } }, "/health-check": { "get": { "description": "Get the status of server.", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "HeathCheck" ], "summary": "Show the status of server.", "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/pickup-points": { "get": { "security": [ { "BearerToken": [] } ], "description": "Get list of all pickup points.", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "PickupPoint" ], "summary": "Get list of all pickup points.", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true }, { "type": "boolean", "name": "deactivate", "in": "query" }, { "type": "integer", "name": "limit", "in": "query" }, { "type": "integer", "name": "page", "in": "query" }, { "type": "string", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetPickupPointsResponse" } } } }, "post": { "security": [ { "BearerToken": [] } ], "description": "Add a pickup point", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "PickupPoint" ], "summary": "CreatePickupPoint", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true }, { "description": "CreatePickupPointRequest", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.CreatePickupPointRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PickupPoint" } } } } }, "/pickup-points/{id}": { "get": { "security": [ { "BearerToken": [] } ], "description": "Get a pickup point.", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "PickupPoint" ], "summary": "Get a pickup point.", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true }, { "type": "integer", "description": "Pickup point id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.PickupPoint" } } } }, "put": { "security": [ { "BearerToken": [] } ], "description": "Update a pickup point", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "PickupPoint" ], "summary": "UpdatePickupPoint", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true }, { "type": "integer", "description": "Pickup point id", "name": "id", "in": "path", "required": true }, { "description": "UpdatePickupPointRequest", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.UpdatePickupPointRequest" } } ], "responses": { "204": { "description": "" } } }, "delete": { "security": [ { "BearerToken": [] } ], "description": "Delete a pickup point", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "PickupPoint" ], "summary": "DeletePickupPoint", "parameters": [ { "type": "integer", "description": "Pickup point id", "name": "id", "in": "path", "required": true } ], "responses": { "204": { "description": "" } } } }, "/seller-couriers": { "get": { "security": [ { "BearerToken": [] } ], "description": "Get list of all couriers of seller.", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Seller Courier" ], "summary": "Get list of all couriers of seller.", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true }, { "type": "boolean", "name": "deactivate", "in": "query" }, { "type": "boolean", "name": "verified", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetCouriersResponse" } } } }, "post": { "security": [ { "BearerToken": [] } ], "description": "Create a new seller courier", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Seller Courier" ], "summary": "CreateSellerCourier", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true }, { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.CreateSellerCourierRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.SellerCourier" } } } } }, "/seller-couriers/{id}": { "put": { "security": [ { "BearerToken": [] } ], "description": "Update a seller courier", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Seller Courier" ], "summary": "UpdateSellerCourier", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true }, { "type": "integer", "description": "Seller Courier ID", "name": "id", "in": "path", "required": true }, { "description": "Update Seller Courier", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.UpdateSellerCourierRequest" } } ], "responses": { "204": { "description": "" } } }, "delete": { "security": [ { "BearerToken": [] } ], "description": "Delete a seller courier", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Seller Courier" ], "summary": "DeleteSellerCourier", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true }, { "type": "integer", "description": "Seller Courier ID", "name": "id", "in": "path", "required": true } ], "responses": { "204": { "description": "" } } } }, "/seller-couriers/{id}/associate-status": { "get": { "security": [ { "BearerToken": [] } ], "description": "Get account associate status.", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Seller Courier" ], "summary": "Get account associate status.", "parameters": [ { "type": "integer", "description": "Seller Courier ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetAccountAssociateStatusResponse" } } } } }, "/seller-couriers/{id}/status": { "put": { "security": [ { "BearerToken": [] } ], "description": "Update seller courier status", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Seller Courier" ], "summary": "UpdateSellerCourierStatusRequest", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true }, { "type": "integer", "description": "Seller Courier ID", "name": "id", "in": "path", "required": true }, { "description": "Update Seller Courier status", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.UpdateSellerCourierStatusRequest" } } ], "responses": { "204": { "description": "" } } } }, "/shipments": { "get": { "security": [ { "BearerToken": [] } ], "description": "Get Shipments.", "consumes": [ "*/*" ], "tags": [ "Shipment" ], "summary": "Get Shipments.", "parameters": [ { "type": "integer", "name": "limit", "in": "query" }, { "type": "integer", "name": "page", "in": "query" }, { "type": "string", "name": "searchKeyword", "in": "query" }, { "type": "string", "name": "sort", "in": "query" }, { "type": "string", "name": "status", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetShipmentsResponse" } } } }, "post": { "security": [ { "BearerToken": [] } ], "description": "CreateShipment.", "consumes": [ "*/*" ], "tags": [ "Shipment" ], "summary": "CreateShipment.", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.CreateShipmentRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CreateShipmentResponse" } } } } }, "/shipments/archived": { "get": { "security": [ { "BearerToken": [] } ], "description": "Get archived shipments", "consumes": [ "*/*" ], "tags": [ "Shipment" ], "summary": "Get archived shipments", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetShipmentsResponse" } } } } }, "/shipments/labels": { "post": { "security": [ { "BearerToken": [] } ], "description": "Get shipment labels", "consumes": [ "*/*" ], "tags": [ "Shipment" ], "summary": "Get shipment labels", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.GetShipmentLabelsRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetShipmentLabelsResponse" } } } } }, "/shipments/labels/pdf": { "post": { "security": [ { "BearerToken": [] } ], "description": "Generate shipment labels", "consumes": [ "*/*" ], "tags": [ "Shipment" ], "summary": "Generate shipment labels", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true }, { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.GenerateShipmentLabelsRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenerateShipmentLabelsResponse" } } } } }, "/shipments/notify-pickup": { "post": { "security": [ { "BearerToken": [] } ], "description": "Notify staff to pickup parcel in batch", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "summary": "Notify staff to pickup parcel in batch", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.NotifyPickupInBatchRequest" } } ], "responses": { "200": { "description": "" } } } }, "/shipments/re-arrange": { "post": { "security": [ { "BearerToken": [] } ], "description": "Re-arrange shipments", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "summary": "ReArrangeShipments", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true }, { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.ReArrangeShipmentsRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ReArrangeShipmentsResponse" } } } } }, "/shipments/status": { "post": { "security": [ { "BearerToken": [] } ], "description": "GetShipmentOrdersStatus", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "summary": "GetShipmentOrdersStatus", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.GetShipmentOrdersStatusRequest" } } ], "responses": { "200": { "description": "" } } } }, "/shipments/tracking-urls": { "post": { "security": [ { "BearerToken": [] } ], "description": "Get Tracking URLs", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "summary": "Get Tracking URLs", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.GetTrackingUrlsRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetTrackingUrlsResponse" } } } } }, "/shipments/{id}": { "get": { "security": [ { "BearerToken": [] } ], "description": "Get Shipment by id.", "consumes": [ "*/*" ], "tags": [ "Shipment" ], "summary": "Get Shipment by id.", "parameters": [ { "type": "integer", "description": "Shipment ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetShipmentResponse" } } } }, "put": { "security": [ { "BearerToken": [] } ], "description": "Update a shipment", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "summary": "UpdateShipment", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true }, { "type": "integer", "description": "Shipment ID", "name": "id", "in": "path", "required": true }, { "description": "Update Shipment", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.UpdateShipmentRequest" } } ], "responses": { "204": { "description": "" } } } }, "/shipments/{id}/archive": { "post": { "security": [ { "BearerToken": [] } ], "description": "Archive a shipment", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "summary": "ArchiveShipment", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true }, { "type": "integer", "description": "Shipment ID", "name": "id", "in": "path", "required": true } ], "responses": { "204": { "description": "" } } } }, "/shipments/{id}/cancel": { "post": { "security": [ { "BearerToken": [] } ], "description": "Cancel a shipment", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "summary": "CancelShipment", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true }, { "type": "integer", "description": "Shipment ID", "name": "id", "in": "path", "required": true }, { "description": "Cancel Shipment", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.CancelShipmentRequest" } } ], "responses": { "204": { "description": "" } } } }, "/shipments/{id}/notify-pickup": { "post": { "security": [ { "BearerToken": [] } ], "description": "Notify staff to pickup parcel", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "summary": "Notify staff to pickup parcel", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true }, { "type": "string", "description": "Shipment ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "" } } } }, "/shipments/{id}/status": { "get": { "security": [ { "BearerToken": [] } ], "description": "Get status history of a shipment", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "summary": "Get status history of a shipment", "parameters": [ { "type": "string", "description": "User workspace", "name": "userworkspace", "in": "header", "required": true }, { "type": "string", "description": "Shipment ID", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetShipmentStatusResponse" } } } } }, "/webhook/flash-express-ph/courier": { "post": { "description": "Update shipment courier webhook", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "summary": "Update shipment courier webhook", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.NotifyCourierFlashExpressRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.NotifyStatusFlashExpressSuccessResponse" } } } } }, "/webhook/flash-express-ph/status": { "post": { "description": "Update shipment status webhook", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "summary": "Update shipment status webhook", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.NotifyStatusFlashExpressRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.NotifyStatusFlashExpressSuccessResponse" } } } } }, "/webhook/flash-express/courier": { "post": { "description": "Update shipment courier webhook", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "summary": "Update shipment courier webhook", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.NotifyCourierFlashExpressRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.NotifyStatusFlashExpressSuccessResponse" } } } } }, "/webhook/flash-express/status": { "post": { "description": "Update shipment status webhook", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "summary": "Update shipment status webhook", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.NotifyStatusFlashExpressRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.NotifyStatusFlashExpressSuccessResponse" } } } } }, "/webhook/jt-express-my/status": { "post": { "description": "Update shipment status webhook", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "summary": "Update shipment status webhook", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.NotifyStatusJTExpressMYRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.NotifyStatusJTExpressMYResponse" } } } } }, "/webhook/jt-express-sg/status": { "post": { "description": "JTExpressSingaporeNotifyStatus webhook", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "summary": "JTExpressSingaporeNotifyStatus webhook", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.NotifyStatusJTExpressSGRequest" } } ], "responses": { "200": { "description": "" } } } }, "/webhook/jt-express/status": { "post": { "description": "Update shipment status webhook", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "summary": "Update shipment status webhook", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.NotifyStatusJTExpressTHRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.NotifyStatusJTExpressTHResponse" } } } } }, "/webhook/kerry-express-th/status": { "post": { "description": "NotifyStatusKerryExpressTH webhook", "consumes": [ "*/*" ], "produces": [ "application/json" ], "tags": [ "Shipment" ], "summary": "NotifyStatusKerryExpressTH webhook", "parameters": [ { "description": "request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.NotifyStatusKerryExpressTHRequest" } } ], "responses": { "200": { "description": "" } } } } }, "definitions": { "dto.Address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "countryId": { "type": "integer" }, "deactivate": { "type": "boolean" }, "id": { "type": "integer" }, "postalCode": { "type": "string" }, "subLevelLocations": { "type": "array", "items": { "$ref": "#/definitions/dto.SubLevelLocation" } }, "unitNumber": { "type": "string" } } }, "dto.BusinessProfile": { "type": "object", "properties": { "id": { "type": "string" }, "merchantCode": { "type": "string" }, "workspaceID": { "type": "string" } } }, "dto.CancelShipmentRequest": { "type": "object", "properties": { "id": { "type": "string" }, "reason": { "type": "string" } } }, "dto.Courier": { "type": "object", "properties": { "code": { "type": "string" }, "country_id": { "type": "integer" }, "deactivate": { "type": "boolean" }, "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "type": "integer" } } }, "dto.CreateAddressRequest": { "type": "object", "required": [ "address1", "countryCode" ], "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "countryCode": { "type": "string" }, "postalCode": { "type": "string" }, "subLevelLocationIds": { "type": "array", "items": { "type": "integer" } }, "unitNumber": { "type": "string" } } }, "dto.CreateCourierRequest": { "type": "object", "properties": { "code": { "type": "string" }, "countryId": { "type": "integer" }, "deactivate": { "type": "boolean" }, "name": { "type": "string" }, "type": { "type": "integer" } } }, "dto.CreateDeliveryPlanRequest": { "type": "object", "properties": { "code": { "type": "string" }, "countryId": { "type": "integer" }, "courierId": { "type": "integer" }, "deactivate": { "type": "boolean" }, "effectiveDate": { "type": "string" }, "maxDeliveryDay": { "type": "integer" }, "minDeliveryDay": { "type": "integer" }, "name": { "type": "string" } } }, "dto.CreatePickupPointRequest": { "type": "object", "required": [ "address", "email", "fistName", "lastName", "phoneNumber" ], "properties": { "address": { "$ref": "#/definitions/dto.CreateAddressRequest" }, "default": { "type": "boolean" }, "email": { "type": "string" }, "fistName": { "type": "string" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string" } } }, "dto.CreateSellerCourierRequest": { "type": "object", "required": [ "courierId" ], "properties": { "courierId": { "type": "integer" }, "customerCode": { "type": "string" }, "key": { "type": "string" }, "merchantCode": { "type": "string" }, "merchantId": { "type": "string" }, "password": { "type": "string" }, "sellerId": { "type": "string" }, "sellerName": { "type": "string" }, "shopId": { "type": "string" }, "shopName": { "type": "string" } } }, "dto.CreateShipmentRequest": { "type": "object", "properties": { "fulfillmentId": { "type": "string" } } }, "dto.CreateShipmentResponse": { "type": "object", "properties": { "fails": { "type": "array", "items": { "$ref": "#/definitions/dto.FailedShipment" } }, "successes": { "type": "array", "items": { "$ref": "#/definitions/dto.Shipment" } } } }, "dto.DeliveryPlan": { "type": "object", "properties": { "code": { "type": "string" }, "countryId": { "type": "integer" }, "courierId": { "type": "integer" }, "deactivate": { "type": "boolean" }, "effectiveDate": { "type": "string" }, "id": { "type": "integer" }, "maxDeliveryDay": { "type": "integer" }, "minDeliveryDay": { "type": "integer" }, "name": { "type": "string" } } }, "dto.DevUpdateShipmentRequest": { "type": "object", "properties": { "cancelReasonCode": { "type": "string" }, "cancelReasonText": { "type": "string" }, "courierStatus": { "type": "string" }, "courierTrackingId": { "type": "string" }, "courierWebhookStatus": { "type": "string" } } }, "dto.FailedShipment": { "type": "object", "properties": { "cartId": { "type": "string" }, "code": { "type": "integer" }, "detail": { "$ref": "#/definitions/dto.FailedShipmentDetail" }, "message": { "type": "string" }, "shipmentCode": { "type": "string" }, "shippingGroupId": { "type": "string" } } }, "dto.FailedShipmentDetail": { "type": "object", "properties": { "pickupPoint": { "$ref": "#/definitions/dto.PickupPoint" }, "receiverInfo": { "$ref": "#/definitions/dto.ReceiverInfo" } } }, "dto.GenerateShipmentLabelsRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "language": { "type": "string" } } }, "dto.GenerateShipmentLabelsResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/dto.GenerateShipmentLabelsResponseData" } } }, "dto.GenerateShipmentLabelsResponseData": { "type": "object", "properties": { "error": { "type": "string" }, "failedShipments": { "type": "array", "items": { "$ref": "#/definitions/dto.GenerateShipmentLabelsResponseDataFailedShipment" } }, "url": { "type": "string" } } }, "dto.GenerateShipmentLabelsResponseDataFailedShipment": { "type": "object", "properties": { "error": { "type": "string" }, "id": { "type": "string" } } }, "dto.GetAccountAssociateStatusResponse": { "type": "object", "properties": { "associated": { "type": "boolean" } } }, "dto.GetCourierResponse": { "type": "object", "properties": { "code": { "type": "string" }, "country_id": { "type": "integer" }, "deactivate": { "type": "boolean" }, "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "type": "integer" } } }, "dto.GetCouriersResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/dto.Courier" } } } }, "dto.GetDeliveryPlansResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/dto.DeliveryPlan" } } } }, "dto.GetLinkAccountUrlResponse": { "type": "object", "properties": { "linkAccountUrl": { "type": "string" }, "sellerCourierId": { "type": "integer" } } }, "dto.GetPickupPointsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/dto.PickupPoint" } }, "total": { "type": "integer" } } }, "dto.GetShipmentLabelData": { "type": "object", "properties": { "error": { "type": "string" }, "id": { "type": "string" }, "url": { "type": "string" } } }, "dto.GetShipmentLabelsRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } } } }, "dto.GetShipmentLabelsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/dto.GetShipmentLabelData" } } } }, "dto.GetShipmentOrdersStatusRequest": { "type": "object", "properties": { "cartIds": { "type": "array", "items": { "type": "string" } } } }, "dto.GetShipmentResponse": { "type": "object", "properties": { "data": { "$ref": "#/definitions/dto.Shipment" } } }, "dto.GetShipmentStatusItemResponse": { "type": "object", "properties": { "courierStatus": { "type": "string" }, "createdAt": { "type": "string" }, "stateDate": { "type": "string" }, "stateText": { "type": "string" }, "status": { "type": "string" } } }, "dto.GetShipmentStatusResponse": { "type": "object", "properties": { "courierTrackingId": { "type": "string" }, "id": { "type": "string" }, "statusHistory": { "type": "array", "items": { "$ref": "#/definitions/dto.GetShipmentStatusItemResponse" } } } }, "dto.GetShipmentsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/dto.Shipment" } }, "total": { "type": "integer" } } }, "dto.GetTrackingUrlsRequest": { "type": "object", "properties": { "cartIds": { "type": "array", "items": { "type": "string" } } } }, "dto.GetTrackingUrlsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/dto.TrackingUrl" } } } }, "dto.NotifyCourierFlashExpressRequest": { "type": "object", "properties": { "data": { "$ref": "#/definitions/dto.NotifyCourierFlashExpressRequestData" }, "mchId": { "type": "string" }, "nonceStr": { "type": "string" }, "sign": { "type": "string" } } }, "dto.NotifyCourierFlashExpressRequestData": { "type": "object", "properties": { "cancelOperatorId": { "type": "string" }, "cancelReasonCode": { "type": "string" }, "cancelReasonText": { "type": "string" }, "currentTicketPickupId": { "type": "string" }, "state": { "description": "0:Pending assign - 1:Pending pickup - 2:Picked up - 3:Transferred - 4:Cancelled", "type": "string" }, "stateText": { "type": "string" }, "ticketPickupId": { "type": "string" }, "updateAt": { "type": "string" } } }, "dto.NotifyPickupInBatchRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } } } }, "dto.NotifyStatusFlashExpressRequest": { "type": "object", "properties": { "data": { "$ref": "#/definitions/dto.NotifyStatusFlashExpressRequestData" }, "mchId": { "type": "string" }, "nonceStr": { "type": "string" }, "sign": { "type": "string" } } }, "dto.NotifyStatusFlashExpressRequestData": { "type": "object", "properties": { "mchId": { "type": "string" }, "orderId": { "type": "string" }, "outTradeNo": { "type": "string" }, "pno": { "type": "string" }, "state": { "type": "string" }, "stateDate": { "type": "string" }, "stateText": { "type": "string" } } }, "dto.NotifyStatusFlashExpressSuccessResponse": { "type": "object", "properties": { "errorCode": { "type": "string" }, "state": { "type": "string" } } }, "dto.NotifyStatusJTExpressMYRequest": { "type": "object", "properties": { "data_digest": { "type": "string" }, "eccompanyid": { "type": "string" }, "logistics_interface": { "type": "string" }, "msg_type": { "type": "string" } } }, "dto.NotifyStatusJTExpressMYResponse": { "type": "object", "properties": { "logisticproviderid": { "type": "string" }, "responseitems": { "$ref": "#/definitions/dto.NotifyStatusJTExpressMYResponseItem" } } }, "dto.NotifyStatusJTExpressMYResponseItem": { "type": "object", "properties": { "billcode": { "type": "string" }, "reason": { "type": "string" }, "success": { "type": "string" } } }, "dto.NotifyStatusJTExpressSGRequest": { "type": "object", "properties": { "comments": { "type": "string" }, "no_of_attempts": { "description": "status FAILED_DELIVERY", "type": "integer" }, "pod_url": { "description": "status DELIVERED", "type": "string" }, "reference_number": { "type": "string" }, "status": { "type": "string" }, "timestamp": { "type": "string" }, "tracking_id": { "type": "string" } } }, "dto.NotifyStatusJTExpressTHRequest": { "type": "object", "properties": { "data_digest": { "type": "string" }, "eccompanyid": { "type": "string" }, "logistics_interface": { "type": "object", "additionalProperties": true }, "msg_type": { "type": "string" } } }, "dto.NotifyStatusJTExpressTHResponse": { "type": "object", "properties": { "logisticproviderid": { "type": "string" }, "responseitems": { "$ref": "#/definitions/dto.NotifyStatusJTExpressTHResponseItem" } } }, "dto.NotifyStatusJTExpressTHResponseItem": { "type": "object", "properties": { "billcode": { "type": "string" }, "reason": { "type": "string" }, "success": { "type": "string" }, "txlogisticid": { "type": "string" } } }, "dto.NotifyStatusKerryExpressTHRequest": { "type": "object", "properties": { "statusCode": { "type": "string" }, "statusDate": { "type": "string" }, "trackingID": { "type": "string" } } }, "dto.PickupPoint": { "type": "object", "properties": { "address": { "$ref": "#/definitions/dto.Address" }, "deactivate": { "type": "boolean" }, "default": { "type": "boolean" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "id": { "type": "integer" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string" } } }, "dto.ReArrangeShipmentsRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } } } }, "dto.ReArrangeShipmentsResponse": { "type": "object", "properties": { "fulfillmentId": { "type": "string" } } }, "dto.ReceiverInfo": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "contactNumber": { "type": "string" }, "instructions": { "type": "string" }, "postalCode": { "type": "string" }, "recipientName": { "type": "string" }, "subLevelLocations": { "type": "array", "items": { "$ref": "#/definitions/dto.ReceiverInfoSubLevelLocation" } }, "unitNumber": { "type": "string" } } }, "dto.ReceiverInfoSubLevelLocation": { "type": "object", "properties": { "internationalName": { "type": "string" }, "localizedName": { "type": "string" } } }, "dto.SellerCourier": { "type": "object", "properties": { "courier": { "$ref": "#/definitions/dto.Courier" }, "courierAuthenticationInfo": { "type": "object", "additionalProperties": true }, "courierId": { "type": "integer" }, "deactivate": { "type": "boolean" }, "id": { "type": "integer" }, "lastUpdated": { "type": "string" }, "verified": { "type": "boolean" } } }, "dto.Shipment": { "type": "object", "properties": { "archivedAt": { "type": "string" }, "buyerInfo": { "$ref": "#/definitions/dto.ShipmentBuyerInfo" }, "cancelReasonCode": { "type": "string" }, "cancelReasonText": { "type": "string" }, "cartId": { "type": "string" }, "courier": { "$ref": "#/definitions/dto.Courier" }, "courierStatus": { "type": "string" }, "courierTrackingID": { "type": "string" }, "courierWebhookStatus": { "type": "string" }, "createdAt": { "type": "string" }, "deliveryPlan": { "$ref": "#/definitions/dto.DeliveryPlan" }, "fee": { "type": "number" }, "id": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/definitions/dto.ShipmentItem" } }, "pickupEndTime": { "type": "string" }, "pickupInstruction": { "type": "string" }, "pickupPoint": { "$ref": "#/definitions/dto.PickupPoint" }, "pickupStartTime": { "type": "string" }, "pickupTime": { "type": "string" }, "printable": { "type": "boolean" }, "shipmentCode": { "type": "string" }, "shippingGroupId": { "type": "string" }, "stateDate": { "type": "string" }, "status": { "type": "string" }, "weightDimension": { "$ref": "#/definitions/dto.ShipmentWeightDimension" } } }, "dto.ShipmentBuyerInfo": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "contactNumber": { "type": "string" }, "countryCode": { "type": "string" }, "email": { "type": "string" }, "instructions": { "type": "string" }, "name": { "type": "string" }, "postalCode": { "type": "string" }, "recipientName": { "type": "string" }, "state": { "type": "string" }, "subLevelLocations": { "type": "array", "items": { "$ref": "#/definitions/dto.ReceiverInfoSubLevelLocation" } }, "unitNumber": { "type": "string" } } }, "dto.ShipmentItem": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "quantity": { "type": "integer" } } }, "dto.ShipmentWeightDimension": { "type": "object", "properties": { "height": { "type": "number" }, "length": { "type": "number" }, "weight": { "type": "number" }, "width": { "type": "number" } } }, "dto.SubLevelLocation": { "type": "object", "properties": { "id": { "type": "integer" }, "internationalName": { "type": "string" }, "localizedName": { "type": "string" }, "parentId": { "type": "integer" } } }, "dto.TrackingUrl": { "type": "object", "properties": { "cartId": { "type": "string" }, "shipmentId": { "type": "string" }, "shippingGroupId": { "type": "string" }, "trackingUrl": { "type": "string" } } }, "dto.UpdateCourierRequest": { "type": "object", "properties": { "code": { "type": "string" }, "countryId": { "type": "integer" }, "deactivate": { "type": "boolean" }, "name": { "type": "string" }, "type": { "type": "integer" } } }, "dto.UpdateDeliveryPlanRequest": { "type": "object", "properties": { "code": { "type": "string" }, "countryId": { "type": "integer" }, "courierId": { "type": "integer" }, "deactivate": { "type": "boolean" }, "effectiveDate": { "type": "string" }, "maxDeliveryDay": { "type": "integer" }, "minDeliveryDay": { "type": "integer" }, "name": { "type": "string" } } }, "dto.UpdatePickupPointAddressRequest": { "type": "object", "required": [ "address1", "countryId", "id" ], "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "countryId": { "type": "integer" }, "deactivate": { "type": "boolean" }, "id": { "type": "integer" }, "postalCode": { "type": "string" }, "subLevelLocationIds": { "type": "array", "items": { "type": "integer" } }, "unitNumber": { "type": "string" } } }, "dto.UpdatePickupPointRequest": { "type": "object", "properties": { "address": { "$ref": "#/definitions/dto.UpdatePickupPointAddressRequest" }, "deactivate": { "type": "boolean" }, "default": { "type": "boolean" }, "email": { "type": "string" }, "fistName": { "type": "string" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string" } } }, "dto.UpdateSellerCourierRequest": { "type": "object", "properties": { "customerCode": { "type": "string" }, "key": { "type": "string" }, "merchantCode": { "type": "string" }, "merchantId": { "type": "string" }, "password": { "type": "string" }, "sellerId": { "type": "string" }, "sellerName": { "type": "string" }, "shopId": { "type": "string" }, "shopName": { "type": "string" } } }, "dto.UpdateSellerCourierStatusRequest": { "type": "object", "properties": { "deactivate": { "type": "boolean" } } }, "dto.UpdateShipmentRequest": { "type": "object", "properties": { "pickupEndTime": { "type": "string" }, "pickupStartTime": { "type": "string" }, "pickupTime": { "type": "string" } } } }, "securityDefinitions": { "BearerToken": { "type": "apiKey", "name": "Authorization", "in": "header" } } }