diff --git a/independent-publisher-connectors/Easyship/apiDefinition.swagger.json b/independent-publisher-connectors/Easyship/apiDefinition.swagger.json new file mode 100644 index 000000000..8347c22ec --- /dev/null +++ b/independent-publisher-connectors/Easyship/apiDefinition.swagger.json @@ -0,0 +1,5145 @@ +{ + "swagger": "2.0", + "info": { + "version": "1.0", + "title": "Easyship", + "description": "Easyship provides a powerful service for you to add hassle free worldwide shipping options to your website and end to end shipping functionality to your warehouse, ERP or platform.", + "contact": { + "name": "Troy Taylor", + "url": "https://www.hitachisolutions.com", + "email": "ttaylor@hitachisolutions.com" + } + }, + "host": "api.easyship.com", + "basePath": "/", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/v2/rates": { + "post": { + "summary": "Get rates and taxes", + "description": "Retrieve a list of shipping quotes for a prospective shipment.", + "operationId": "GetRatesTaxes", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "origin_address": { + "type": "object", + "properties": { + "line_1": { + "type": "string", + "description": "The address.", + "title": "Address" + }, + "line_2": { + "type": "string", + "description": "The address line 2.", + "title": "Address Line 2" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "postal_code": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country_alpha2": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + } + }, + "title": "Origin Address" + }, + "destination_address": { + "type": "object", + "properties": { + "line_1": { + "type": "string", + "description": "The address.", + "title": "Address" + }, + "line_2": { + "type": "string", + "description": "The address line 2.", + "title": "Address Line 2" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "postal_code": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country_alpha2": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + } + }, + "title": "Destination Address" + }, + "incoterms": { + "type": "string", + "description": "The incoterms.", + "title": "Incoterms" + }, + "insurance": { + "type": "object", + "properties": { + "is_insured": { + "type": "boolean", + "description": "Whether is insured.", + "title": "Is Insured" + }, + "insured_amount": { + "type": "integer", + "format": "int32", + "description": "The insured amount.", + "title": "Insured Amount" + }, + "insured_currency": { + "type": "string", + "description": "The insured currency.", + "title": "Insured Currency" + } + }, + "title": "Insurance" + }, + "courier_selection": { + "type": "object", + "properties": { + "apply_shipping_rules": { + "type": "boolean", + "description": "Whether shipping rules were applied.", + "title": "Apply Shipping Rules" + } + }, + "title": "Courier Selection" + }, + "shipping_settings": { + "type": "object", + "properties": { + "units": { + "type": "object", + "properties": { + "weight": { + "type": "string", + "description": "The weight.", + "title": "Weight" + }, + "dimensions": { + "type": "string", + "description": "The dimensions.", + "title": "Dimensions" + } + }, + "title": "Units" + }, + "output_currency": { + "type": "string", + "description": "The output currency.", + "title": "Output Currency" + } + }, + "title": "Shipping Settings" + }, + "parcels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "total_actual_weight": { + "type": "number", + "format": "float", + "description": "The total actual weight.", + "title": "Total Actual Weight" + }, + "box": { + "type": "object", + "properties": { + "slug": { + "type": "string", + "description": "The reference slug.", + "title": "Slug" + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length.", + "title": "Length" + }, + "width": { + "type": "integer", + "format": "int32", + "description": "The width.", + "title": "Width" + }, + "height": { + "type": "integer", + "format": "int32", + "description": "The height.", + "title": "Height" + } + }, + "title": "Box" + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description.", + "title": "Description" + }, + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "sku": { + "type": "string", + "description": "The SKU.", + "title": "SKU" + }, + "quantity": { + "type": "integer", + "format": "int32", + "description": "The quantity.", + "title": "Quantity" + }, + "dimensions": { + "type": "object", + "properties": { + "length": { + "type": "string", + "description": "The length.", + "title": "Length" + }, + "width": { + "type": "string", + "description": "The width.", + "title": "Width" + }, + "height": { + "type": "string", + "description": "The height.", + "title": "Height" + } + }, + "title": "Dimensions" + }, + "actual_weight": { + "type": "integer", + "format": "int32", + "description": "The actual weight.", + "title": "Actual Weight" + }, + "declared_currency": { + "type": "string", + "description": "The declared currency.", + "title": "Declared Currency" + }, + "declared_customs_value": { + "type": "integer", + "format": "int32", + "description": "The declared customs value.", + "title": "Declared Customs Value" + } + } + }, + "title": "Items" + } + } + }, + "title": "Parcels" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "rates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courier_id": { + "type": "string", + "description": "The courier unique identifier.", + "title": "Courier ID" + }, + "courier_name": { + "type": "string", + "description": "The courier name.", + "title": "Courier Name" + }, + "min_delivery_time": { + "type": "integer", + "format": "int32", + "description": "The minimum delivery time.", + "title": "Min Delivery Time" + }, + "max_delivery_time": { + "type": "integer", + "format": "int32", + "description": "The maximum delivery time.", + "title": "Max Delivery Time" + }, + "value_for_money_rank": { + "type": "integer", + "format": "int32", + "description": "The value for money rank.", + "title": "Value For Money Rank" + }, + "delivery_time_rank": { + "type": "integer", + "format": "int32", + "description": "The delivery time rank.", + "title": "Delivery Time Rank" + }, + "shipment_charge": { + "type": "number", + "format": "float", + "description": "The shipment charge.", + "title": "Shipment Charge" + }, + "fuel_surcharge": { + "type": "number", + "format": "float", + "description": "The fuel surcharge.", + "title": "Fuel Surcharge" + }, + "remote_area_surcharge": { + "type": "integer", + "format": "int32", + "description": "The remote area surcharge.", + "title": "Remote Area Surcharge" + }, + "shipment_charge_total": { + "type": "number", + "format": "float", + "description": "The shipment charge total.", + "title": "Shipment Charge Total" + }, + "warehouse_handling_fee": { + "type": "integer", + "format": "int32", + "description": "The warehouse handling fee.", + "title": "Warehouse Handling Fee" + }, + "insurance_fee": { + "type": "integer", + "format": "int32", + "description": "The insurance fee.", + "title": "Insurance Fee" + }, + "ddp_handling_fee": { + "type": "integer", + "format": "int32", + "description": "The DDP handling fee if incoterm is DDP.", + "title": "DDP Handling Fee" + }, + "import_tax_charge": { + "type": "integer", + "format": "int32", + "description": "The import tax charge.", + "title": "Import Tax Charge" + }, + "import_duty_charge": { + "type": "integer", + "format": "int32", + "description": "The import duty charge.", + "title": "Import Duty Charge" + }, + "total_charge": { + "type": "number", + "format": "float", + "description": "The total charge.", + "title": "Total Charge" + }, + "is_above_threshold": { + "type": "boolean", + "description": "Whether is above threshold.", + "title": "Is Above Threshold" + }, + "effective_incoterms": { + "type": "string", + "description": "The effective incoterms.", + "title": "Effective Incoterms" + }, + "estimated_import_tax": { + "type": "integer", + "format": "int32", + "description": "The estimated import tax.", + "title": "Estimated Import Tax" + }, + "estimated_import_duty": { + "type": "integer", + "format": "int32", + "description": "The estimated import duty.", + "title": "Estimated Import Duty" + }, + "courier_does_pickup": { + "type": "boolean", + "description": "Whether the courier does pickup.", + "title": "Courier Does Pickup" + }, + "courier_dropoff_url": { + "type": "string", + "description": "The courier dropoff URL address.", + "title": "Courier Dropoff URL" + }, + "tracking_rating": { + "type": "integer", + "format": "int32", + "description": "The tracking rating.", + "title": "Tracking Rating" + }, + "payment_recipient": { + "type": "string", + "description": "The payment recipient.", + "title": "Payment Recipient" + }, + "courier_remarks": { + "type": "string", + "description": "The courier remarks.", + "title": "Courier Remarks" + }, + "currency": { + "type": "string", + "description": "The currency.", + "title": "Currency" + }, + "box": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length.", + "title": "Length" + }, + "width": { + "type": "integer", + "format": "int32", + "description": "The width.", + "title": "Width" + }, + "height": { + "type": "integer", + "format": "int32", + "description": "The height.", + "title": "Height" + } + }, + "title": "Box" + }, + "minimum_pickup_fee": { + "type": "integer", + "format": "int32", + "description": "The minimum pickup fee.", + "title": "Minimum Pickup Fee" + }, + "title": { + "type": "string", + "description": "The description.", + "title": "Description" + }, + "full_description": { + "type": "string", + "description": "The full description.", + "title": "Full Description" + } + } + }, + "title": "Rates" + } + } + } + } + } + } + }, + "/v2/shipments": { + "get": { + "summary": "List all shipments", + "description": "Retrieves a list of all shipments.", + "operationId": "ListAllShipments", + "parameters": [ + { + "name": "easyship_shipment_id", + "in": "query", + "x-ms-summary": "Easyship Shipment ID", + "description": "The Easyship shipment unique identifier.", + "required": false, + "type": "string" + }, + { + "name": "platform_order_number", + "in": "query", + "x-ms-summary": "Platform Order Number", + "description": "The platform order number.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "x-ms-summary": "Page", + "description": "The page.", + "required": false, + "type": "integer" + }, + { + "name": "per_page", + "in": "query", + "x-ms-summary": "Per Page", + "description": "The number per page.", + "required": false, + "type": "integer" + }, + { + "name": "created_at_from", + "in": "query", + "x-ms-summary": "Created At From", + "description": "The created at from.", + "required": false, + "type": "string" + }, + { + "name": "created_at_to", + "in": "query", + "x-ms-summary": "Created At To", + "description": "The created at to.", + "required": false, + "type": "string" + }, + { + "name": "confirmed_at_from", + "in": "query", + "x-ms-summary": "Confirmed At From", + "description": "The confirmed at from.", + "required": false, + "type": "string" + }, + { + "name": "confirm_at_to", + "in": "query", + "x-ms-summary": "Confirmed At To", + "description": "The confirmed at to.", + "required": false, + "type": "string" + }, + { + "name": "label_generated_at_from", + "in": "query", + "x-ms-summary": "Label Generate At From", + "description": "The label generate at from.", + "required": false, + "type": "string" + }, + { + "name": "label_generated_at_to", + "in": "query", + "x-ms-summary": "Label Generated At To", + "description": "The label generated at to.", + "required": false, + "type": "string" + }, + { + "name": "shipment_state", + "in": "query", + "x-ms-summary": "Shipment State", + "description": "The shipment state.", + "required": false, + "type": "string" + }, + { + "name": "pickup_state", + "in": "query", + "x-ms-summary": "Pickup State", + "description": "The pickup state.", + "required": false, + "type": "string" + }, + { + "name": "delivery_state", + "in": "query", + "x-ms-summary": "Delivery State", + "description": "The delivery state.", + "required": false, + "type": "string" + }, + { + "name": "label_state", + "in": "query", + "x-ms-summary": "Label State", + "description": "The label state.", + "required": false, + "type": "string" + }, + { + "name": "warehouse_state", + "in": "query", + "x-ms-summary": "Warehouse State", + "description": "The warehouse state.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "shipments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "easyship_shipment_id": { + "type": "string", + "description": "The Easyship shipment unique identifier.", + "title": "Easyship Shipment ID" + }, + "created_at": { + "type": "string", + "description": "The created at.", + "title": "Created At" + }, + "updated_at": { + "type": "string", + "description": "The updated at.", + "title": "Updated At" + }, + "label_paid_at": { + "type": "string", + "description": "The label paid at.", + "title": "Label Paid At" + }, + "label_generated_at": { + "type": "string", + "description": "The generated at.", + "title": "Label Generated At" + }, + "order_created_at": { + "type": "string", + "description": "The order created at.", + "title": "Order Created At" + }, + "origin_address": { + "type": "object", + "properties": { + "line_1": { + "type": "string", + "description": "The address.", + "title": "Address" + }, + "line_2": { + "type": "string", + "description": "The address line 2.", + "title": "Address Line 2" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "postal_code": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country_alpha2": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + }, + "contact_name": { + "type": "string", + "description": "The contact name.", + "title": "Contact Name" + }, + "company_name": { + "type": "string", + "description": "The company name.", + "title": "Company Name" + }, + "contact_phone": { + "type": "string", + "description": "The contact phone number.", + "title": "Contact Phone" + }, + "contact_email": { + "type": "string", + "description": "The contact email address.", + "title": "Contact Email" + } + }, + "title": "Origin Address" + }, + "sender_address": { + "type": "object", + "properties": { + "line_1": { + "type": "string", + "description": "The address.", + "title": "Address" + }, + "line_2": { + "type": "string", + "description": "The address line 2.", + "title": "Address Line 2" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "postal_code": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country_alpha2": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + }, + "contact_name": { + "type": "string", + "description": "The contact name.", + "title": "Contact Name" + }, + "company_name": { + "type": "string", + "description": "The company name.", + "title": "Company Name" + }, + "contact_phone": { + "type": "string", + "description": "The contact phone number.", + "title": "Contact Phone" + }, + "contact_email": { + "type": "string", + "description": "The contact email address.", + "title": "Contact Email" + } + }, + "title": "Sender Address" + }, + "return_address": { + "type": "object", + "properties": { + "line_1": { + "type": "string", + "description": "The address.", + "title": "Address" + }, + "line_2": { + "type": "string", + "description": "The address line 2.", + "title": "Address Line 2" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "postal_code": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country_alpha2": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + }, + "contact_name": { + "type": "string", + "description": "The contact name.", + "title": "Contact Name" + }, + "company_name": { + "type": "string", + "description": "The company name.", + "title": "Company Name" + }, + "contact_phone": { + "type": "string", + "description": "The contact phone number.", + "title": "Contact Phone" + }, + "contact_email": { + "type": "string", + "description": "The contact email address.", + "title": "Contact Email" + } + }, + "title": "Return Address" + }, + "destination_address": { + "type": "object", + "properties": { + "line_1": { + "type": "string", + "description": "The address.", + "title": "Address" + }, + "line_2": { + "type": "string", + "description": "The address line 2.", + "title": "Address Line 2" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "postal_code": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country_alpha2": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + }, + "contact_name": { + "type": "string", + "description": "The contact name.", + "title": "Contact Name" + }, + "company_name": { + "type": "string", + "description": "The company name.", + "title": "Company Name" + }, + "contact_phone": { + "type": "string", + "description": "The contact phone number.", + "title": "Contact Phone" + }, + "contact_email": { + "type": "string", + "description": "The contact email address.", + "title": "Contact Email" + } + }, + "title": "Destination Address" + }, + "order_data": { + "type": "object", + "properties": { + "platform_name": { + "type": "string", + "description": "The platform name.", + "title": "Platform Name" + }, + "platform_order_number": { + "type": "string", + "description": "The platform order number.", + "title": "Platform Order Number" + }, + "order_tag_list": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The order tag list", + "title": "Order Tag List" + }, + "seller_notes": { + "type": "string", + "description": "The seller notes.", + "title": "Seller Notes" + }, + "buyer_notes": { + "type": "string", + "description": "The buyer notes.", + "title": "Buyer Notes" + } + }, + "title": "Order Data" + }, + "set_as_residential": { + "type": "boolean", + "description": "Whether set as residential.", + "title": "Set As Residential" + }, + "consignee_tax_id": { + "type": "string", + "description": "The consignee tax identifier.", + "title": "Consignee Tax ID" + }, + "eei_reference": { + "type": "string", + "description": "The EEI reference.", + "title": "EEI Reference" + }, + "incoterms": { + "type": "string", + "description": "The incoterms.", + "title": "Incoterms" + }, + "insurance": { + "type": "object", + "properties": { + "is_insured": { + "type": "boolean", + "description": "Whether is insured.", + "title": "Is Insured" + }, + "insured_amount": { + "type": "integer", + "format": "int32", + "description": "The insured amount.", + "title": "Insured Amount" + }, + "insured_currency": { + "type": "string", + "description": "The insured currency.", + "title": "Insured Currency" + } + }, + "title": "Insurance" + }, + "parcels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "total_actual_weight": { + "type": "number", + "format": "float", + "description": "The total actual weight.", + "title": "Total Actual Weight" + }, + "total_customs_value": { + "type": "number", + "format": "float", + "description": "The total customs value.", + "title": "Total Customs Value" + }, + "total_dimensional_weight": { + "type": "number", + "format": "float", + "description": "The total dimensional weight.", + "title": "Total Dimensional Weight" + }, + "total_volumetric_weight": { + "type": "number", + "format": "float", + "description": "The total volumetric weight.", + "title": "Total Volumetric Weight" + }, + "box": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier.", + "title": "ID" + }, + "courier_umbrella_name": { + "type": "string", + "description": "The courier umbrella name.", + "title": "Courier Umbrella Name" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "slug": { + "type": "string", + "description": "The slug.", + "title": "Slug" + }, + "outer_length": { + "type": "number", + "format": "float", + "description": "The outer length.", + "title": "Outer Length" + }, + "outer_width": { + "type": "number", + "format": "float", + "description": "The outer width.", + "title": "Outer Width" + }, + "outer_height": { + "type": "number", + "format": "float", + "description": "The outer height.", + "title": "Outer Height" + }, + "weight": { + "type": "integer", + "format": "int32", + "description": "The weight.", + "title": "Weight" + } + }, + "title": "Box" + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description.", + "title": "Description" + }, + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "sku": { + "type": "string", + "description": "The SKU.", + "title": "SKU" + }, + "quantity": { + "type": "integer", + "format": "int32", + "description": "The quantity.", + "title": "Quantity" + }, + "actual_weight": { + "type": "integer", + "format": "int32", + "description": "The actual weight.", + "title": "Actual Weight" + }, + "dimensional_weight": { + "type": "integer", + "format": "int32", + "description": "The dimensional weight.", + "title": "Dimensional Weight" + }, + "volumetric_weight": { + "type": "integer", + "format": "int32", + "description": "The volumetric weight.", + "title": "Volumetric Weight" + }, + "origin_currency": { + "type": "string", + "description": "The origin currency.", + "title": "Origin Currency" + }, + "origin_customs_value": { + "type": "integer", + "format": "int32", + "description": "The origin customs value.", + "title": "Origin Customs Value" + }, + "declared_currency": { + "type": "string", + "description": "The declared currency.", + "title": "Declared Currency" + }, + "declared_customs_value": { + "type": "integer", + "format": "int32", + "description": "The declared customs value.", + "title": "Declared Customs Value" + }, + "dimensions": { + "type": "object", + "properties": { + "length": { + "type": "integer", + "format": "int32", + "description": "The length.", + "title": "Length" + }, + "width": { + "type": "integer", + "format": "int32", + "description": "The width.", + "title": "Width" + }, + "height": { + "type": "integer", + "format": "int32", + "description": "The height.", + "title": "Height" + } + }, + "title": "Dimensions" + } + } + }, + "title": "Items" + } + } + }, + "title": "Parcels" + }, + "total_customs_value": { + "type": "number", + "format": "float", + "description": "The total customs value.", + "title": "Total Customs Value" + }, + "total_actual_weight": { + "type": "number", + "format": "float", + "description": "The total actual weight.", + "title": "Total Actual Weight" + }, + "total_dimensional_weight": { + "type": "number", + "format": "float", + "description": "The total dimensional weight.", + "title": "Total Dimensional Weight" + }, + "total_volumetric_weight": { + "type": "number", + "format": "float", + "description": "The total volumetric weight.", + "title": "Total Volumetric Weight" + }, + "shipment_state": { + "type": "string", + "description": "The shipment state.", + "title": "Shipment State" + }, + "pickup_state": { + "type": "string", + "description": "The pickup state.", + "title": "Pickup State" + }, + "delivery_state": { + "type": "string", + "description": "The delivery state.", + "title": "Delivery State" + }, + "label_state": { + "type": "string", + "description": "The label state.", + "title": "Label State" + }, + "warehouse_state": { + "type": "string", + "description": "The warehouse state.", + "title": "Warehouse State" + }, + "trackings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tracking_number": { + "type": "string", + "description": "The tracking number.", + "title": "Tracking Number" + }, + "local_tracking_number": { + "type": "string", + "description": "The local tracking number.", + "title": "Local Tracking Number" + }, + "alternate_tracking_number": { + "type": "string", + "description": "The alternate tracking number.", + "title": "Alternate Tracking Number" + }, + "leg_number": { + "type": "integer", + "format": "int32", + "description": "The leg number.", + "title": "Leg Number" + }, + "handler": { + "type": "string", + "description": "The handler.", + "title": "Handler" + }, + "tracking_state": { + "type": "string", + "description": "The tracking state.", + "title": "Tracking State" + } + } + }, + "title": "Trackings" + }, + "tracking_page_url": { + "type": "string", + "description": "The tracking page URL address.", + "title": "Tracking Page URL" + }, + "shipping_documents": { + "type": "array", + "items": {}, + "description": "The shipping documents.", + "title": "Shipping Documents" + }, + "currency": { + "type": "string", + "description": "The currency.", + "title": "Currency" + }, + "selected_courier": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier.", + "title": "ID" + } + }, + "title": "Selected Courier" + }, + "rates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courier_id": { + "type": "string", + "description": "The courier unique identifier.", + "title": "Courier ID" + }, + "courier_name": { + "type": "string", + "description": "The courier name.", + "title": "Courier Name" + }, + "min_delivery_time": { + "type": "integer", + "format": "int32", + "description": "The minimum delivery time.", + "title": "Min Delivery Time" + }, + "max_delivery_time": { + "type": "integer", + "format": "int32", + "description": "The maximum delivery time.", + "title": "Max Delivery Time" + }, + "value_for_money_rank": { + "type": "integer", + "format": "int32", + "description": "The value for money rank.", + "title": "Value For Money Rank" + }, + "delivery_time_rank": { + "type": "integer", + "format": "int32", + "description": "The delivery time rank.", + "title": "Delivery Time Rank" + }, + "shipment_charge": { + "type": "number", + "format": "float", + "description": "The shipment charge.", + "title": "Shipment Charge" + }, + "fuel_surcharge": { + "type": "number", + "format": "float", + "description": "The fuel surcharge.", + "title": "Fuel Surcharge" + }, + "remote_area_surcharge": { + "type": "integer", + "format": "int32", + "description": "The remote area surcharge.", + "title": "Remote Area Surcharge" + }, + "oversized_surcharge": { + "type": "integer", + "format": "int32", + "description": "The oversized surcharge.", + "title": "Oversized Surcharge" + }, + "additional_services_surcharge": { + "type": "integer", + "format": "int32", + "description": "The additional services surcharge.", + "title": "Additional Services Surcharge" + }, + "residential_full_fee": { + "type": "integer", + "format": "int32", + "description": "The residential full fee.", + "title": "Residential Full Fee" + }, + "residential_discounted_fee": { + "type": "integer", + "format": "int32", + "description": "The residential discounted fee.", + "title": "Residential Discounted Fee" + }, + "shipment_charge_total": { + "type": "number", + "format": "float", + "description": "The shipment charge total.", + "title": "Shipment Charge Total" + }, + "warehouse_handling_fee": { + "type": "integer", + "format": "int32", + "description": "The warehouse handling fee.", + "title": "Warehouse Handling Fee" + }, + "insurance_fee": { + "type": "integer", + "format": "int32", + "description": "The insurance fee.", + "title": "Insurance Fee" + }, + "sales_tax": { + "type": "integer", + "format": "int32", + "description": "The sales tax.", + "title": "Sales Tax" + }, + "provincial_sales_tax": { + "type": "integer", + "format": "int32", + "description": "The provincial sales tax.", + "title": "Provincial Sales Tax" + }, + "ddp_handling_fee": { + "type": "integer", + "format": "int32", + "description": "The DDP handling fee.", + "title": "DDP Handling Fee" + }, + "import_tax_charge": { + "type": "integer", + "format": "int32", + "description": "The import tax charge.", + "title": "Import Tax Charge" + }, + "import_duty_charge": { + "type": "integer", + "format": "int32", + "description": "The import duty charge.", + "title": "Import Duty Charge" + }, + "total_charge": { + "type": "number", + "format": "float", + "description": "The total charge.", + "title": "Total Charge" + }, + "is_above_threshold": { + "type": "boolean", + "description": "Whether is above threshold.", + "title": "Is Above Threshold" + }, + "incoterms": { + "type": "string", + "description": "The incoterms.", + "title": "Incoterms" + }, + "estimated_import_tax": { + "type": "integer", + "format": "int32", + "description": "The estimated import tax.", + "title": "Estimated Import Tax" + }, + "estimated_import_duty": { + "type": "integer", + "format": "int32", + "description": "The estimated import duty.", + "title": "Estimated Import Duty" + }, + "available_handover_options": { + "type": "string", + "description": "The available handover options.", + "title": "Available Handover Options" + }, + "tracking_rating": { + "type": "integer", + "format": "int32", + "description": "The tracking rating.", + "title": "Tracking Rating" + }, + "easyship_rating": { + "type": "integer", + "format": "int32", + "description": "The Easyship rating.", + "title": "Easyship Rating" + }, + "courier_remarks": { + "type": "string", + "description": "The courier remarks.", + "title": "Courier Remarks" + }, + "payment_recipient": { + "type": "string", + "description": "The payment recipient.", + "title": "Payment Recipient" + }, + "discount": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "amount": { + "type": "integer", + "format": "int32", + "description": "The amount.", + "title": "Amount" + }, + "expires_at": { + "type": "string", + "description": "The expires at.", + "title": "Expires At" + }, + "percentage": { + "type": "string", + "description": "The percentage.", + "title": "Percentage" + } + }, + "title": "Discount" + }, + "effective_incoterms": { + "type": "string", + "description": "The effective incoterms.", + "title": "Effective Incoterms" + } + } + }, + "title": "Rates" + } + } + }, + "title": "shipments" + } + } + } + } + } + }, + "post": { + "summary": "Create a shipment", + "description": "Creates and retrieves the information about a shipment.", + "operationId": "CreateAShipment", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "origin_address": { + "type": "object", + "properties": { + "line_1": { + "type": "string", + "description": "The address.", + "title": "Address" + }, + "line_2": { + "type": "string", + "description": "The address line 2.", + "title": "Address Line 2" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "postal_code": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country_alpha2": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + }, + "contact_name": { + "type": "string", + "description": "The contact name.", + "title": "Contact Name" + }, + "company_name": { + "type": "string", + "description": "The company name.", + "title": "Company Name" + }, + "contact_phone": { + "type": "string", + "description": "The contact phone number.", + "title": "Contact Phone" + }, + "contact_email": { + "type": "string", + "description": "The contact email address.", + "title": "Contact Email" + } + }, + "title": "Origin Address" + }, + "sender_address": { + "type": "object", + "properties": { + "line_1": { + "type": "string", + "description": "The address.", + "title": "Address" + }, + "line_2": { + "type": "string", + "description": "The address line 2.", + "title": "Address Line 2" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "postal_code": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country_alpha2": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + }, + "contact_name": { + "type": "string", + "description": "The contact name.", + "title": "Contact Name" + }, + "company_name": { + "type": "string", + "description": "The company name.", + "title": "Company Name" + }, + "contact_phone": { + "type": "string", + "description": "The contact phone number.", + "title": "Contact Phone" + }, + "contact_email": { + "type": "string", + "description": "The contact email address.", + "title": "Contact Email" + } + }, + "title": "Sender Address" + }, + "return_address": { + "type": "object", + "properties": { + "line_1": { + "type": "string", + "description": "The address.", + "title": "Address" + }, + "line_2": { + "type": "string", + "description": "The address line 2.", + "title": "Address Line 2" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "postal_code": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country_alpha2": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + }, + "contact_name": { + "type": "string", + "description": "The contact name.", + "title": "Contact Name" + }, + "company_name": { + "type": "string", + "description": "The company name.", + "title": "Company Name" + }, + "contact_phone": { + "type": "string", + "description": "The contact phone number.", + "title": "Contact Phone" + }, + "contact_email": { + "type": "string", + "description": "The contact email address.", + "title": "Contact Email" + } + }, + "title": "Return Address" + }, + "destination_address": { + "type": "object", + "properties": { + "line_1": { + "type": "string", + "description": "The address.", + "title": "Address" + }, + "line_2": { + "type": "string", + "description": "The address line 2.", + "title": "Address Line 2" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "postal_code": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country_alpha2": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + }, + "contact_name": { + "type": "string", + "description": "The contact name.", + "title": "Contact Name" + }, + "company_name": { + "type": "string", + "description": "The company name.", + "title": "Company Name" + }, + "contact_phone": { + "type": "string", + "description": "The contact phone number.", + "title": "Contact Phone" + }, + "contact_email": { + "type": "string", + "description": "The contact email address.", + "title": "Contact Email" + } + }, + "title": "Destination Address" + }, + "metadata": { + "type": "object", + "properties": {}, + "description": "The metadata.", + "title": "Metadata" + }, + "set_as_residential": { + "type": "boolean", + "description": "Whether set as residential.", + "title": "Set As Residential" + }, + "consignee_tax_id": { + "type": "string", + "description": "The consignee tax identifier.", + "title": "Consignee Tax ID" + }, + "eei_reference": { + "type": "string", + "description": "The EEI reference.", + "title": "EEI Reference" + }, + "incoterms": { + "type": "string", + "description": "The incoterms.", + "title": "Incoterms" + }, + "insurance": { + "type": "object", + "properties": { + "is_insured": { + "type": "boolean", + "description": "Whether is insured.", + "title": "Is Insured" + }, + "insured_amount": { + "type": "integer", + "format": "int32", + "description": "The insured amount.", + "title": "Insured Amount" + }, + "insured_currency": { + "type": "string", + "description": "The insured currency.", + "title": "Insured Currency" + } + }, + "title": "Insurance" + }, + "order_data": { + "type": "object", + "properties": { + "platform_name": { + "type": "string", + "description": "The platform name.", + "title": "Platform Name" + }, + "platform_order_number": { + "type": "string", + "description": "The platform order number.", + "title": "Platform Order Number" + }, + "order_tag_list": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The order tag list.", + "title": "Order Tag List" + }, + "seller_notes": { + "type": "string", + "description": "The seller notes.", + "title": "Seller Notes" + }, + "buyer_notes": { + "type": "string", + "description": "The buyer notes.", + "title": "Buyer Notes" + } + }, + "title": "Order Data" + }, + "courier_selection": { + "type": "object", + "properties": { + "selected_courier_id": { + "type": "string", + "description": "The selected courier identifier.", + "title": "Selected Courier ID" + }, + "allow_courier_fallback": { + "type": "boolean", + "description": "Whether to allow courier fallback.", + "title": "Allow Courier Fallback" + }, + "apply_shipping_rules": { + "type": "boolean", + "description": "Whether shipping rules were applied.", + "title": "Apply Shipping Rules" + } + }, + "title": "Courier Selection" + }, + "shipping_settings": { + "type": "object", + "properties": { + "units": { + "type": "object", + "properties": { + "weight": { + "type": "string", + "description": "The weight.", + "title": "Weight" + }, + "dimensions": { + "type": "string", + "description": "The dimensions.", + "title": "Dimensions" + } + }, + "title": "Units" + }, + "printing_options": { + "type": "object", + "properties": { + "format": { + "type": "string", + "description": "The format.", + "title": "Format" + }, + "label": { + "type": "string", + "description": "The label.", + "title": "Label" + }, + "commercial_invoice": { + "type": "string", + "description": "The commercial invoice.", + "title": "Commercial Invoice" + }, + "packing_slip": { + "type": "string", + "description": "The packing slip.", + "title": "Packing Slip" + } + }, + "title": "Printing Options" + }, + "buy_label": { + "type": "boolean", + "description": "Whether label is bought.", + "title": "Buy Label" + }, + "buy_label_synchronous": { + "type": "boolean", + "description": "Whether label is bought synchronously.", + "title": "Buy Label Synchronous" + } + }, + "title": "Shipping Settings" + }, + "parcels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "total_actual_weight": { + "type": "number", + "format": "float", + "description": "The total actual weight.", + "title": "Total Actual Weight" + }, + "box": { + "type": "object", + "properties": { + "slug": { + "type": "string", + "title": "Slug" + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length.", + "title": "Length" + }, + "width": { + "type": "integer", + "format": "int32", + "description": "The width.", + "title": "Width" + }, + "height": { + "type": "integer", + "format": "int32", + "description": "The height.", + "title": "Height" + } + }, + "title": "Box" + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description.", + "title": "Description" + }, + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "sku": { + "type": "string", + "description": "The SKU.", + "title": "SKU" + }, + "quantity": { + "type": "integer", + "format": "int32", + "description": "The quantity.", + "title": "Quantity" + }, + "dimensions": { + "type": "object", + "properties": { + "length": { + "type": "string", + "description": "The length.", + "title": "Length" + }, + "width": { + "type": "string", + "description": "The width.", + "title": "Width" + }, + "height": { + "type": "string", + "description": "The height.", + "title": "Height" + } + }, + "title": "Dimensions" + }, + "actual_weight": { + "type": "integer", + "format": "int32", + "description": "The actual weight.", + "title": "Actual Weight" + }, + "declared_currency": { + "type": "string", + "description": "The declared currency.", + "title": "Declared Currency" + }, + "declared_customs_value": { + "type": "integer", + "format": "int32", + "description": "The declared customs value.", + "title": "Declared Customs Value" + } + } + }, + "title": "Items" + } + } + }, + "title": "Parcels" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "errors": { + "type": "array", + "items": {}, + "description": "The errors.", + "title": "Errors" + }, + "shipment": { + "type": "object", + "properties": { + "easyship_shipment_id": { + "type": "string", + "description": "The Easyship shipment identifier.", + "title": "Easyship Shipment ID" + }, + "created_at": { + "type": "string", + "description": "The created at.", + "title": "Created At" + }, + "updated_at": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "label_paid_at": { + "type": "string", + "description": "The label paid at.", + "title": "Label Paid At" + }, + "label_generated_at": { + "type": "string", + "description": "The label generated at.", + "title": "Label Generated At" + }, + "order_created_at": { + "type": "string", + "description": "The order created at.", + "title": "Order Created At" + }, + "origin_address": { + "type": "object", + "properties": { + "line_1": { + "type": "string", + "description": "The address.", + "title": "Address" + }, + "line_2": { + "type": "string", + "description": "The address line 2.", + "title": "Address Line 2" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "postal_code": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country_alpha2": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + }, + "contact_name": { + "type": "string", + "description": "The contact name.", + "title": "Contact Name" + }, + "company_name": { + "type": "string", + "description": "The company name.", + "title": "Company Name" + }, + "contact_phone": { + "type": "string", + "description": "The contact phone number.", + "title": "Contact Phone" + }, + "contact_email": { + "type": "string", + "description": "The contact email address.", + "title": "Contact Email" + } + }, + "title": "Origin Address" + }, + "sender_address": { + "type": "object", + "properties": { + "line_1": { + "type": "string", + "description": "The address.", + "title": "Address" + }, + "line_2": { + "type": "string", + "description": "The address line 2.", + "title": "Address Line 2" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "postal_code": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country_alpha2": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + }, + "contact_name": { + "type": "string", + "description": "The contact name.", + "title": "Contact Name" + }, + "company_name": { + "type": "string", + "description": "The company name.", + "title": "Company Name" + }, + "contact_phone": { + "type": "string", + "description": "The contact phone number.", + "title": "Contact Phone" + }, + "contact_email": { + "type": "string", + "description": "The contact email address.", + "title": "Contact Email" + } + }, + "title": "Sender Address" + }, + "return_address": { + "type": "object", + "properties": { + "line_1": { + "type": "string", + "description": "The address.", + "title": "Address" + }, + "line_2": { + "type": "string", + "description": "The address line 2.", + "title": "Address Line 2" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "postal_code": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country_alpha2": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + }, + "contact_name": { + "type": "string", + "description": "The contact name.", + "title": "Contact Name" + }, + "company_name": { + "type": "string", + "description": "The company name.", + "title": "Company Name" + }, + "contact_phone": { + "type": "string", + "description": "The contact phone number.", + "title": "Contact Phone" + }, + "contact_email": { + "type": "string", + "description": "The contact email address.", + "title": "Contact Email" + } + }, + "title": "Return Address" + }, + "destination_address": { + "type": "object", + "properties": { + "line_1": { + "type": "string", + "description": "The address.", + "title": "Address" + }, + "line_2": { + "type": "string", + "description": "The address line 2.", + "title": "Address Line 2" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "postal_code": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "country_alpha2": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + }, + "contact_name": { + "type": "string", + "description": "The contact name.", + "title": "Contact Name" + }, + "company_name": { + "type": "string", + "description": "The company name.", + "title": "Company Name" + }, + "contact_phone": { + "type": "string", + "description": "The contact phone number.", + "title": "Contact Phone" + }, + "contact_email": { + "type": "string", + "description": "The contact email address.", + "title": "Contact Email" + } + }, + "title": "Destination Address" + }, + "order_data": { + "type": "object", + "properties": { + "platform_name": { + "type": "string", + "description": "The platform name.", + "title": "Platform Name" + }, + "platform_order_number": { + "type": "string", + "description": "The platform order number.", + "title": "Platform Order Number" + }, + "order_tag_list": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The order tag list.", + "title": "Order Tag List" + }, + "seller_notes": { + "type": "string", + "description": "The seller notes.", + "title": "Seller Notes" + }, + "buyer_notes": { + "type": "string", + "description": "The buyer notes.", + "title": "Buyer Notes" + } + }, + "title": "Order Data" + }, + "set_as_residential": { + "type": "boolean", + "description": "Whether set as residential.", + "title": "Set As Residential" + }, + "consignee_tax_id": { + "type": "string", + "description": "The consignee tax identifier.", + "title": "Consignee Tax ID" + }, + "eei_reference": { + "type": "string", + "description": "The EEI reference.", + "title": "EEI Reference" + }, + "incoterms": { + "type": "string", + "description": "The incoterms.", + "title": "Incoterms" + }, + "insurance": { + "type": "object", + "properties": { + "is_insured": { + "type": "boolean", + "description": "Whether is insured.", + "title": "Is Insured" + }, + "insured_amount": { + "type": "integer", + "format": "int32", + "description": "The insured amount.", + "title": "Insured Amount" + }, + "insured_currency": { + "type": "string", + "description": "The insured currency.", + "title": "Insured Currency" + } + }, + "title": "Insurance" + }, + "parcels_count": { + "type": "integer", + "format": "int32", + "description": "The parcels count.", + "title": "Parcels Count" + }, + "parcels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "total_actual_weight": { + "type": "number", + "format": "float", + "description": "The total actual weight.", + "title": "Total Actual Weight" + }, + "total_customs_value": { + "type": "number", + "format": "float", + "description": "The total customs value.", + "title": "Total Customs Value" + }, + "total_dimensional_weight": { + "type": "number", + "format": "float", + "description": "The total dimensional weight.", + "title": "Total Dimensional Weight" + }, + "total_volumetric_weight": { + "type": "number", + "format": "float", + "description": "The total volumetric weight.", + "title": "Total Volumetric Weight" + }, + "box": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier .", + "title": "ID" + }, + "slug": { + "type": "string", + "description": "The slug.", + "title": "Slug" + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length.", + "title": "Length" + }, + "width": { + "type": "integer", + "format": "int32", + "description": "The width.", + "title": "Width" + }, + "height": { + "type": "integer", + "format": "int32", + "description": "The height.", + "title": "Height" + } + }, + "description": "box" + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description.", + "title": "Description" + }, + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "sku": { + "type": "string", + "description": "The SKU.", + "title": "SKU" + }, + "quantity": { + "type": "integer", + "format": "int32", + "description": "The quantity.", + "title": "Quantity" + }, + "actual_weight": { + "type": "integer", + "format": "int32", + "description": "The actual weight.", + "title": "Actual Weight" + }, + "dimensional_weight": { + "type": "integer", + "format": "int32", + "description": "The dimensional weight.", + "title": "Dimensional Weight" + }, + "volumetric_weight": { + "type": "integer", + "format": "int32", + "description": "The volumetric weight.", + "title": "Volumetric Weight" + }, + "origin_currency": { + "type": "string", + "description": "The origin currency.", + "title": "Origin Currency" + }, + "origin_customs_value": { + "type": "integer", + "format": "int32", + "description": "The origin customs value.", + "title": "Origin Customs Value" + }, + "declared_currency": { + "type": "string", + "description": "The declared currency.", + "title": "Declared Currency" + }, + "declared_customs_value": { + "type": "integer", + "format": "int32", + "description": "The declared customs value.", + "title": "Declared Customs Value" + }, + "dimensions": { + "type": "object", + "properties": { + "length": { + "type": "integer", + "format": "int32", + "description": "The length.", + "title": "Length" + }, + "width": { + "type": "integer", + "format": "int32", + "description": "The width.", + "title": "Width" + }, + "height": { + "type": "integer", + "format": "int32", + "description": "The height.", + "title": "Height" + } + }, + "title": "dimensions" + } + } + }, + "title": "items" + } + } + }, + "title": "Parcels" + }, + "total_customs_value": { + "type": "number", + "format": "float", + "description": "The total customs value.", + "title": "Total Customs Value" + }, + "total_actual_weight": { + "type": "number", + "format": "float", + "description": "The total actual weight.", + "title": "Total Actual Weight" + }, + "total_dimensional_weight": { + "type": "number", + "format": "float", + "description": "The total dimensional weight.", + "title": "Total Dimensional Weight" + }, + "total_volumetric_weight": { + "type": "number", + "format": "float", + "description": "The total volumetric weight.", + "title": "Total Volumetric Weight" + }, + "shipment_state": { + "type": "string", + "description": "The shipment state.", + "title": "Shipment State" + }, + "pickup_state": { + "type": "string", + "description": "The pickup state.", + "title": "Pickup State" + }, + "delivery_state": { + "type": "string", + "description": "The delivery state.", + "title": "Delivery State" + }, + "label_state": { + "type": "string", + "description": "The label state.", + "title": "Label State" + }, + "warehouse_state": { + "type": "string", + "description": "The warehouse state.", + "title": "Warehouse State" + }, + "trackings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tracking_number": { + "type": "string", + "description": "The tracking number.", + "title": "Tracking Number" + }, + "local_tracking_number": { + "type": "string", + "description": "The local tracking number.", + "title": "Local Tracking Number" + }, + "alternate_tracking_number": { + "type": "string", + "description": "The alternate tracking number.", + "title": "Alternate Tracking Number" + }, + "leg_number": { + "type": "integer", + "format": "int32", + "description": "The leg number.", + "title": "Leg Number" + }, + "handler": { + "type": "string", + "description": "The handler.", + "title": "Handler" + }, + "tracking_state": { + "type": "string", + "description": "The tracking state.", + "title": "Tracking State" + } + } + }, + "title": "Trackings" + }, + "tracking_page_url": { + "type": "string", + "description": "The tracking page URL.", + "title": "Tracking Page URL" + }, + "shipping_documents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "required": { + "type": "boolean", + "description": "Whether required.", + "title": "Required" + }, + "page_size": { + "type": "string", + "description": "The page size.", + "title": "Page Size" + }, + "format": { + "type": "string", + "description": "The format.", + "title": "Format" + }, + "base64_encoded_strings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The Base64 encoded strings.", + "title": "Base64 Encoded Strings" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + } + }, + "title": "Shipping Documents" + }, + "currency": { + "type": "string", + "description": "The currency.", + "title": "Currency" + }, + "selected_courier": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier.", + "title": "ID" + } + }, + "title": "Selected Courier" + }, + "rates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courier_id": { + "type": "string", + "description": "The courier identifier.", + "title": "Courier ID" + }, + "courier_name": { + "type": "string", + "description": "The courier name.", + "title": "Courier Name" + }, + "min_delivery_time": { + "type": "integer", + "format": "int32", + "description": "The minimum delivery time.", + "title": "Min Delivery Time" + }, + "max_delivery_time": { + "type": "integer", + "format": "int32", + "description": "The maximum delivery time.", + "title": "Max Delivery Time" + }, + "value_for_money_rank": { + "type": "integer", + "format": "int32", + "description": "The value for money rank.", + "title": "Value For Money Rank" + }, + "delivery_time_rank": { + "type": "integer", + "format": "int32", + "description": "The delivery time rank.", + "title": "Delivery Time Rank" + }, + "shipment_charge": { + "type": "number", + "format": "float", + "description": "The shipment charge.", + "title": "Shipment Charge" + }, + "fuel_surcharge": { + "type": "number", + "format": "float", + "description": "The fuel surcharge.", + "title": "Fuel Surcharge" + }, + "remote_area_surcharge": { + "type": "integer", + "format": "int32", + "description": "The remote area surcharge.", + "title": "Remote Area Surcharge" + }, + "oversized_surcharge": { + "type": "integer", + "format": "int32", + "description": "The oversized surcharge.", + "title": "Oversized Surcharge" + }, + "additional_services_surcharge": { + "type": "integer", + "format": "int32", + "description": "The additional services surcharge.", + "title": "Additional Services Surcharge" + }, + "residential_full_fee": { + "type": "integer", + "format": "int32", + "description": "The residential full fee.", + "title": "Residential Full Fee" + }, + "residential_discounted_fee": { + "type": "integer", + "format": "int32", + "description": "The residential discounted fee.", + "title": "Residential Discounted Fee" + }, + "shipment_charge_total": { + "type": "number", + "format": "float", + "description": "The shipment charge total.", + "title": "Shipment Charge Total" + }, + "warehouse_handling_fee": { + "type": "integer", + "format": "int32", + "description": "The warehouse handling fee.", + "title": "Warehouse Handling Fee" + }, + "insurance_fee": { + "type": "integer", + "format": "int32", + "description": "The insurance fee.", + "title": "Insurance Fee" + }, + "sales_tax": { + "type": "integer", + "format": "int32", + "description": "The sales tax.", + "title": "Sales Tax" + }, + "provincial_sales_tax": { + "type": "integer", + "format": "int32", + "description": "The provincial sales tax.", + "title": "Provincial Sales Tax" + }, + "ddp_handling_fee": { + "type": "integer", + "format": "int32", + "description": "The DDP handling fee.", + "title": "DDP Handling Fee" + }, + "import_tax_charge": { + "type": "integer", + "format": "int32", + "description": "The import tax change.", + "title": "Import Tax Charge" + }, + "import_duty_charge": { + "type": "integer", + "format": "int32", + "description": "The import duty charge.", + "title": "Import Duty Charge" + }, + "total_charge": { + "type": "number", + "format": "float", + "description": "The total charge.", + "title": "Total Charge" + }, + "is_above_threshold": { + "type": "boolean", + "description": "Whether is above threshold.", + "title": "Is Above Threshold" + }, + "incoterms": { + "type": "string", + "description": "The incoterms.", + "title": "Incoterms" + }, + "estimated_import_tax": { + "type": "integer", + "format": "int32", + "description": "The estimated import tax.", + "title": "Estimated Import Tax" + }, + "estimated_import_duty": { + "type": "integer", + "format": "int32", + "description": "The estimated import duty.", + "title": "Estimated Import Duty" + }, + "available_handover_options": { + "type": "string", + "description": "The available handover options.", + "title": "Available Handover Options" + }, + "tracking_rating": { + "type": "integer", + "format": "int32", + "description": "The tracking rating.", + "title": "Tracking Rating" + }, + "easyship_rating": { + "type": "integer", + "format": "int32", + "description": "The Easyship rating.", + "title": "Easyship Rating" + }, + "courier_remarks": { + "type": "string", + "description": "The courier remarks.", + "title": "Courier Remarks" + }, + "payment_recipient": { + "type": "string", + "description": "The payment recipient.", + "title": "Payment Recipient" + }, + "discount": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code.", + "title": "Code" + }, + "amount": { + "type": "integer", + "format": "int32", + "description": "The amount.", + "title": "Amount" + }, + "expires_at": { + "type": "string", + "description": "The expires at.", + "title": "Expires At" + }, + "percentage": { + "type": "string", + "description": "The percentage.", + "title": "Percentage" + } + }, + "title": "Discount" + }, + "effective_incoterms": { + "type": "string", + "description": "The effective incoterms.", + "title": "Effective Incoterms" + } + } + }, + "title": "Rates" + } + }, + "title": "Shipment" + } + } + } + } + } + } + }, + "/label/v1/labels": { + "post": { + "summary": "Buy a shipment label (V1)", + "description": "Buy and retrieve information about a shipping label.", + "operationId": "BuyAShipmentLabel", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "shipments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "easyship_shipment_id": { + "type": "string", + "description": "The Easyship shipment unique identifier.", + "title": "Easyship Shipment ID" + }, + "courier_id": { + "type": "string", + "description": "The courier unique identifier.", + "title": "Courier ID" + } + } + }, + "title": "Shipments" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "errors": { + "type": "array", + "items": {}, + "description": "The errors.", + "title": "Errors" + }, + "total_cost": { + "type": "integer", + "format": "int32", + "description": "The total cost.", + "title": "Total Cost" + }, + "available_balance": { + "type": "integer", + "format": "int32", + "description": "The available balance.", + "title": "Available Balance" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "easyship_shipment_id": { + "type": "string", + "description": "The Easyship shipment unique identifier.", + "title": "Easyship Shipment ID" + }, + "label_state": { + "type": "string", + "description": "The state of the label.", + "title": "Label State" + }, + "label_url": { + "type": "string", + "description": "The URL address of the label.", + "title": "Label URL" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "tracking_number": { + "type": "string", + "description": "The tracking number.", + "title": "Tracking Number" + }, + "tracking_page_url": { + "type": "string", + "description": "The tracking page URL address.", + "title": "Tracking Page URL" + } + } + }, + "title": "Labels" + } + } + } + } + } + } + }, + "/shipment/v1/shipments/{easyship_shipment_id}": { + "delete": { + "summary": "Delete a shipment (V1)", + "description": "Delete and receive confirmation of a shipment deletion.", + "operationId": "DeleteAShipment", + "parameters": [ + { + "name": "easyship_shipment_id", + "in": "path", + "x-ms-summary": "Easyship Shipment ID", + "x-ms-url-encoding": "single", + "description": "The Easyship shipment identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + } + } + } + } + } + }, + "patch": { + "summary": "Update a shipment", + "description": "Update a shipment details.", + "operationId": "UpdateAShipment", + "parameters": [ + { + "name": "easyship_shipment_id", + "in": "path", + "x-ms-summary": "Easyship Shipment ID", + "x-ms-url-encoding": "single", + "description": "The Easyship shipment identifier.", + "type": "string", + "required": true + }, + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "destination_country_alpha2": { + "type": "string", + "description": "The destination country code.", + "title": "Destination Country Code" + }, + "destination_city": { + "type": "string", + "description": "The destination city.", + "title": "Destination City" + }, + "destination_name": { + "type": "string", + "description": "The destination name.", + "title": "Destination Name" + }, + "destination_address_line_1": { + "type": "string", + "description": "The destination address.", + "title": "Destination Address" + }, + "destination_phone_number": { + "type": "string", + "description": "The destination phone number.", + "title": "Destination Phone Number" + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description.", + "title": "Description" + }, + "actual_weight": { + "type": "number", + "format": "float", + "description": "The actual weight.", + "title": "Actual Weight" + }, + "height": { + "type": "integer", + "format": "int32", + "description": "The height.", + "title": "Height" + }, + "width": { + "type": "integer", + "format": "int32", + "description": "The width.", + "title": "Width" + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length.", + "title": "Length" + }, + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + }, + "declared_currency": { + "type": "string", + "description": "The declared currency.", + "title": "Declared Currency" + }, + "declared_customs_value": { + "type": "integer", + "format": "int32", + "description": "The declared customs value.", + "title": "Declared Customs Value" + }, + "sku": { + "type": "string", + "description": "The SKU.", + "title": "SKU" + } + } + }, + "title": "Items" + }, + "platform_name": { + "type": "string", + "description": "The platform name.", + "title": "Platform Name" + }, + "platform_order_number": { + "type": "string", + "description": "The platform order number.", + "title": "Platform Order Number" + }, + "taxes_duties_paid_by": { + "type": "string", + "description": "The taxes and duties paid by.", + "title": "Taxes Duties Paid By" + }, + "is_insured": { + "type": "boolean", + "description": "Whether is insured.", + "title": "Is Insured" + }, + "selected_courier_id": { + "type": "string", + "description": "The selected courier identifier.", + "title": "Selected Courier ID" + }, + "destination_postal_code": { + "type": "integer", + "format": "int32", + "description": "The destination postal code.", + "title": "Destination Postal Code" + }, + "destination_state": { + "type": "string", + "description": "The destination state.", + "title": "Destination State" + }, + "destination_address_line_2": { + "type": "string", + "description": "The destination address line 2.", + "title": "Destination Address Line 2" + }, + "destination_email_address": { + "type": "string", + "description": "The destination email address.", + "title": "Destination Email Address" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "shipment": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "description": "The created at.", + "title": "Created At" + }, + "updated_at": { + "type": "string", + "description": "When updated at.", + "title": "Updated At" + }, + "easyship_shipment_id": { + "type": "string", + "description": "The Easyship shipment identifier.", + "title": "Easyship Shipment ID" + }, + "destination_name": { + "type": "string", + "description": "The destination name.", + "title": "Destination Name" + }, + "destination_address_line_1": { + "type": "string", + "description": "The destination address.", + "title": "Destination Address" + }, + "destination_address_line_2": { + "type": "string", + "description": "The destination address line 2.", + "title": "Destination Address Line 2" + }, + "destination_city": { + "type": "string", + "description": "The destination city.", + "title": "Destination City" + }, + "destination_state": { + "type": "string", + "description": "The destination state.", + "title": "Destination State" + }, + "destination_postal_code": { + "type": "string", + "description": "The destination postal code.", + "title": "Destination Postal Code" + }, + "destination_phone_number": { + "type": "string", + "description": "The destination phone number.", + "title": "Destination Phone Number" + }, + "destination_email_address": { + "type": "string", + "description": "The destination email address.", + "title": "Destination Email Address" + }, + "platform_name": { + "type": "string", + "description": "The platform name.", + "title": "Platform Name" + }, + "platform_order_number": { + "type": "string", + "description": "The platform order number.", + "title": "Platform Order Number" + }, + "total_customs_value": { + "type": "number", + "format": "float", + "description": "The total customs value.", + "title": "Total Customs Value" + }, + "total_actual_weight": { + "type": "number", + "format": "float", + "description": "The total actual weight.", + "title": "Total Actual Weight" + }, + "total_dimensional_weight": { + "type": "number", + "format": "float", + "description": "The total dimensional weight.", + "title": "Total Dimensional Weight" + }, + "total_volumetric_weight": { + "type": "number", + "format": "float", + "description": "The total volumetric weight.", + "title": "Total Volumetric Weight" + }, + "is_insured": { + "type": "boolean", + "description": "Whether is insured.", + "title": "Is Insured" + }, + "currency": { + "type": "string", + "description": "The currency.", + "title": "Currency" + }, + "origin_country": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "alpha2": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + } + }, + "title": "Origin Country" + }, + "destination_country": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "alpha2": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + } + }, + "title": "Destination Country" + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier.", + "title": "ID" + }, + "description": { + "type": "string", + "description": "The description.", + "title": "Description" + }, + "sku": { + "type": "string", + "description": "The SKU.", + "title": "SKU" + }, + "width": { + "type": "integer", + "format": "int32", + "description": "The width.", + "title": "Width" + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length.", + "title": "Length" + }, + "height": { + "type": "integer", + "format": "int32", + "description": "The height.", + "title": "Height" + }, + "actual_weight": { + "type": "number", + "format": "float", + "description": "The actual weight.", + "title": "Actual Weight" + }, + "dimensional_weight": { + "type": "number", + "format": "float", + "description": "The dimensional weight.", + "title": "Dimensional Weight" + }, + "volumetric_weight": { + "type": "number", + "format": "float", + "description": "The columetric weight.", + "title": "Volumetric Weight" + }, + "declared_customs_value": { + "type": "integer", + "format": "int32", + "description": "The declared customs value.", + "title": "Declared Customs Value" + }, + "declared_currency": { + "type": "string", + "description": "The declared currency.", + "title": "Declared Currency" + }, + "origin_customs_value": { + "type": "number", + "format": "float", + "description": "The origin customs value.", + "title": "Origin Customs Value" + }, + "origin_currency": { + "type": "string", + "description": "The origin currency.", + "title": "Origin Currency" + }, + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + } + } + }, + "title": "Items" + }, + "box": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length.", + "title": "Length" + }, + "width": { + "type": "integer", + "format": "int32", + "description": "The width.", + "title": "Width" + }, + "height": { + "type": "integer", + "format": "int32", + "description": "The height.", + "title": "Height" + } + }, + "title": "Box" + }, + "selected_courier": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier.", + "title": "ID" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "min_delivery_time": { + "type": "integer", + "format": "int32", + "description": "The minimum delivery time.", + "title": "Min Delivery Time" + }, + "max_delivery_time": { + "type": "integer", + "format": "int32", + "description": "The maximum delivery time.", + "title": "Max Delivery Time" + }, + "shipment_charge": { + "type": "number", + "format": "float", + "description": "The shipment charge.", + "title": "Shipment Charge" + }, + "fuel_surcharge": { + "type": "number", + "format": "float", + "description": "The fuel surcharge.", + "title": "Fuel Surcharge" + }, + "remote_area_surcharge": { + "type": "integer", + "format": "int32", + "description": "The remote area surcharge.", + "title": "Remote Area Surcharge" + }, + "shipment_charge_total": { + "type": "number", + "format": "float", + "description": "The shipment charge total.", + "title": "Shipment Charge Total" + }, + "warehouse_handling_fee": { + "type": "integer", + "format": "int32", + "description": "The warehouse handling fee.", + "title": "Warehouse Handling Fee" + }, + "insurance_fee": { + "type": "integer", + "format": "int32", + "description": "The insurance fee.", + "title": "Insurance Fee" + }, + "import_tax_charge": { + "type": "integer", + "format": "int32", + "description": "The import tax charge.", + "title": "Import Tax Charge" + }, + "import_duty_charge": { + "type": "integer", + "format": "int32", + "description": "The import duty charge.", + "title": "Import Duty Charge" + }, + "ddp_handling_fee": { + "type": "integer", + "format": "int32", + "description": "The DDP handling fee.", + "title": "DDP Handling Fee" + }, + "total_charge": { + "type": "number", + "format": "float", + "description": "The total charge.", + "title": "Total Charge" + }, + "is_above_threshold": { + "type": "boolean", + "description": "Whether is above threshold.", + "title": "Is Above Threshold" + }, + "effective_incoterms": { + "type": "string", + "description": "The effective incoterms.", + "title": "Effective Incoterms" + }, + "estimated_import_tax": { + "type": "integer", + "format": "int32", + "description": "The estimate import tax.", + "title": "Estimated Import Tax" + }, + "estimated_import_duty": { + "type": "integer", + "format": "int32", + "description": "The estimated importy duty.", + "title": "Estimated Import Duty" + }, + "courier_does_pickup": { + "type": "boolean", + "description": "Whether the courier does pickup.", + "title": "Courier Does Pickup" + }, + "courier_dropoff_url": { + "type": "string", + "description": "The courier dropoff URL address.", + "title": "Courier Dropoff URL" + }, + "courier_remarks": { + "type": "string", + "description": "The courier remarks.", + "title": "Courier Remarks" + }, + "payment_recipient": { + "type": "string", + "description": "The payment recipient.", + "title": "Payment Recipient" + } + }, + "title": "Selected Courier" + }, + "rates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "courier_id": { + "type": "string", + "description": "The courier identifier.", + "title": "Courier ID" + }, + "courier_name": { + "type": "string", + "description": "The courier name.", + "title": "Courier Name" + }, + "min_delivery_time": { + "type": "integer", + "format": "int32", + "description": "The minimum delivery time.", + "title": "Min Delivery Time" + }, + "max_delivery_time": { + "type": "integer", + "format": "int32", + "description": "The maximum delivery time.", + "title": "Max Delivery Time" + }, + "value_for_money_rank": { + "type": "integer", + "format": "int32", + "description": "The value for money rank.", + "title": "Value For Money Rank" + }, + "delivery_time_rank": { + "type": "integer", + "format": "int32", + "description": "The delivery time rank.", + "title": "Delivery Time Rank" + }, + "shipment_charge": { + "type": "number", + "format": "float", + "description": "The shipment charge.", + "title": "Shipment Charge" + }, + "fuel_surcharge": { + "type": "number", + "format": "float", + "description": "The fuel surcharge.", + "title": "Fuel Surcharge" + }, + "remote_area_surcharge": { + "type": "integer", + "format": "int32", + "description": "The remote area surcharge.", + "title": "Remote Area Surcharge" + }, + "shipment_charge_total": { + "type": "number", + "format": "float", + "description": "The shipment charge total.", + "title": "Shipment Charge Total" + }, + "warehouse_handling_fee": { + "type": "integer", + "format": "int32", + "description": "The warehouse handling fee.", + "title": "Warehouse Handling Fee" + }, + "insurance_fee": { + "type": "integer", + "format": "int32", + "description": "The insurance fee.", + "title": "Insurance Fee" + }, + "ddp_handling_fee": { + "type": "integer", + "format": "int32", + "description": "The DDP handling fee.", + "title": "DDP Handling Fee" + }, + "import_tax_charge": { + "type": "integer", + "format": "int32", + "description": "The import tax change.", + "title": "Import Tax Charge" + }, + "import_duty_charge": { + "type": "integer", + "format": "int32", + "description": "The import duty charge.", + "title": "Import Duty Charge" + }, + "total_charge": { + "type": "number", + "format": "float", + "description": "The total charge.", + "title": "Total Charge" + }, + "is_above_threshold": { + "type": "boolean", + "description": "Whether is above threshold.", + "title": "Is Above Threshold" + }, + "effective_incoterms": { + "type": "string", + "description": "The effective incoterms.", + "title": "Effective Incoterms" + }, + "estimated_import_tax": { + "type": "integer", + "format": "int32", + "description": "The estimated import tax.", + "title": "Estimated Import Tax" + }, + "estimated_import_duty": { + "type": "integer", + "format": "int32", + "description": "The estimated import duty.", + "title": "Estimated Import Duty" + }, + "courier_does_pickup": { + "type": "boolean", + "description": "Whether the courier does pickup.", + "title": "Courier Does Pickup" + }, + "courier_dropoff_url": { + "type": "string", + "description": "The courier dropoff URL address.", + "title": "Courier Dropoff URL" + }, + "tracking_rating": { + "type": "integer", + "format": "int32", + "description": "The tracking rating.", + "title": "Tracking Rating" + }, + "easyship_rating": { + "type": "number", + "format": "float", + "description": "The Easyship rating.", + "title": "Easyship Rating" + }, + "courier_remarks": { + "type": "string", + "description": "The courier remarks.", + "title": "Courier Remarks" + }, + "payment_recipient": { + "type": "string", + "description": "The payment recipient.", + "title": "Payment Recipient" + } + } + }, + "title": "Rates" + } + }, + "title": "Shipment" + } + } + } + } + } + } + }, + "/v2/shipments/{easyship_shipment_id}": { + "get": { + "summary": "Get a shipment", + "description": "Get the details of a shipment.", + "operationId": "GetAShipment", + "parameters": [ + { + "name": "easyship_shipment_id", + "in": "path", + "x-ms-summary": "Easyship Shipment ID", + "x-ms-url-encoding": "single", + "description": "The Easyship shipment identifier.", + "required": true, + "type": "string" + }, + { + "name": "format", + "in": "query", + "x-ms-summary": "Format", + "description": "The format.", + "required": false, + "type": "string" + }, + { + "name": "label", + "in": "query", + "x-ms-summary": "Label", + "description": "The label.", + "required": false, + "type": "string" + }, + { + "name": "commercial_invoice", + "in": "query", + "x-ms-summary": "Commercial Invoice", + "description": "The commercial invoice.", + "required": false, + "type": "string" + }, + { + "name": "packing_slip", + "in": "query", + "x-ms-summary": "Packing Slip", + "description": "The packing slip.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "description": "When created at.", + "title": "Created At" + }, + "updated_at": { + "type": "string", + "description": "When update at.", + "title": "Updated At" + }, + "easyship_shipment_id": { + "type": "string", + "description": "The Easyship shipment indentifier.", + "title": "Easyship Shipment ID" + }, + "destination_name": { + "type": "string", + "description": "The destination name.", + "title": "Destination Name" + }, + "destination_address_line_1": { + "type": "string", + "description": "The destination address.", + "title": "Destination Address" + }, + "destination_address_line_2": { + "type": "string", + "description": "The destination address line 2.", + "title": "Destination Address Line 2" + }, + "destination_city": { + "type": "string", + "description": "The destination city.", + "title": "Destination City" + }, + "destination_state": { + "type": "string", + "description": "The destination state.", + "title": "Destination State" + }, + "destination_postal_code": { + "type": "string", + "description": "The destination postal code.", + "title": "Destination Postal Code" + }, + "destination_phone_number": { + "type": "string", + "description": "The destination phone number.", + "title": "Destination Phone Number" + }, + "destination_email_address": { + "type": "string", + "description": "The destination email address.", + "title": "Destination Email Address" + }, + "order_notes": { + "type": "string", + "description": "The order notes.", + "title": "Order Notes" + }, + "order_created_at": { + "type": "string", + "description": "The order created at.", + "title": "Order Created At" + }, + "platform_name": { + "type": "string", + "description": "The platform name.", + "title": "Platform Name" + }, + "platform_order_number": { + "type": "string", + "description": "The platform order number.", + "title": "Platform Order Number" + }, + "total_customs_value": { + "type": "number", + "format": "float", + "description": "The total customs value.", + "title": "Total Customs Value" + }, + "total_actual_weight": { + "type": "number", + "format": "float", + "description": "The total actual weight.", + "title": "Total Actual Weight" + }, + "total_dimensional_weight": { + "type": "number", + "format": "float", + "description": "The total dimensional weight.", + "title": "Total Dimensional Weight" + }, + "total_volumetric_weight": { + "type": "number", + "format": "float", + "description": "The total volumetric weight.", + "title": "Total Volumetric Weight" + }, + "is_insured": { + "type": "boolean", + "description": "Whether is insured.", + "title": "Is Insured" + }, + "currency": { + "type": "string", + "description": "The currency.", + "title": "Currency" + }, + "warehouse_state": { + "type": "string", + "description": "The warehouse state.", + "title": "Warehouse State" + }, + "origin_country": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "alpha2": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + } + }, + "title": "Origin Country" + }, + "destination_country": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "alpha2": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + } + }, + "title": "Destination Country" + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier.", + "title": "ID" + }, + "title": { + "type": "string", + "description": "The description.", + "title": "Description" + }, + "sku": { + "type": "string", + "description": "The SKU.", + "title": "SKU" + }, + "width": { + "type": "integer", + "format": "int32", + "description": "The width.", + "title": "Width" + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length.", + "title": "Length" + }, + "height": { + "type": "integer", + "format": "int32", + "description": "The height.", + "title": "Height" + }, + "actual_weight": { + "type": "number", + "format": "float", + "description": "The actual weight.", + "title": "Actual Weight" + }, + "dimensional_weight": { + "type": "number", + "format": "float", + "description": "The dimensional weight.", + "title": "Dimensional Weight" + }, + "volumetric_weight": { + "type": "number", + "format": "float", + "description": "The volumetric weight.", + "title": "Volumetric Weight" + }, + "declared_customs_value": { + "type": "integer", + "format": "int32", + "description": "The declared customs value.", + "title": "Declared Customs Value" + }, + "declared_currency": { + "type": "string", + "description": "The declared currency.", + "title": "Declared Currency" + }, + "origin_customs_value": { + "type": "number", + "format": "float", + "description": "The origin customs value.", + "title": "Origin Customs Value" + }, + "origin_currency": { + "type": "string", + "description": "The origin currency.", + "title": "Origin Currency" + }, + "category": { + "type": "string", + "description": "The category.", + "title": "Category" + } + } + }, + "title": "Items" + }, + "box": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length.", + "title": "Length" + }, + "width": { + "type": "integer", + "format": "int32", + "description": "The width.", + "title": "Width" + }, + "height": { + "type": "integer", + "format": "int32", + "description": "The height.", + "title": "Height" + } + }, + "title": "Box" + }, + "selected_courier": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier.", + "title": "ID" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "min_delivery_time": { + "type": "integer", + "format": "int32", + "description": "The minimum delivery time.", + "title": "Min Delivery Time" + }, + "max_delivery_time": { + "type": "integer", + "format": "int32", + "description": "The maximum delivery time.", + "title": "Max Delivery Time" + }, + "shipment_charge": { + "type": "number", + "format": "float", + "description": "The shipment charge.", + "title": "Shipment Charge" + }, + "fuel_surcharge": { + "type": "number", + "format": "float", + "description": "The fuel surcharge.", + "title": "Fuel Surcharge" + }, + "remote_area_surcharge": { + "type": "integer", + "format": "int32", + "description": "The remote area surcharge.", + "title": "Remote Area Surcharge" + }, + "shipment_charge_total": { + "type": "number", + "format": "float", + "description": "The shipment charge total.", + "title": "Shipment Charge Total" + }, + "warehouse_handling_fee": { + "type": "integer", + "format": "int32", + "description": "The warehouse handling fee.", + "title": "Warehouse Handling Fee" + }, + "insurance_fee": { + "type": "integer", + "format": "int32", + "description": "The insurance fee.", + "title": "Insurance Fee" + }, + "import_tax_charge": { + "type": "integer", + "format": "int32", + "description": "The import tax charge.", + "title": "Import Tax Charge" + }, + "import_duty_charge": { + "type": "integer", + "format": "int32", + "description": "The import duty charge.", + "title": "Import Duty Charge" + }, + "ddp_handling_fee": { + "type": "integer", + "format": "int32", + "description": "The DDP handling fee.", + "title": "DDP Handling Fee" + }, + "total_charge": { + "type": "number", + "format": "float", + "description": "The total charge.", + "title": "Total Charge" + }, + "is_above_threshold": { + "type": "boolean", + "description": "Whether is above threshold.", + "title": "Is Above Threshold" + }, + "effective_incoterms": { + "type": "string", + "description": "The effective incoterms.", + "title": "Effective Incoterms" + }, + "estimated_import_tax": { + "type": "integer", + "format": "int32", + "description": "The estimated imported tax.", + "title": "Estimated Import Tax" + }, + "estimated_import_duty": { + "type": "integer", + "format": "int32", + "description": "The estimated import duty.", + "title": "Estimated Import Duty" + }, + "courier_does_pickup": { + "type": "boolean", + "description": "Whether the courier does pickup.", + "title": "Courier Does Pickup" + }, + "courier_dropoff_url": { + "type": "string", + "description": "The courier dropoff URL address.", + "title": "Courier Dropoff URL" + }, + "courier_remarks": { + "type": "string", + "description": "The courier remarks.", + "title": "Courier Remarks" + }, + "payment_recipient": { + "type": "string", + "description": "The payment recipient.", + "title": "Payment Recipient" + } + }, + "title": "Selected Courier" + }, + "shipping_documents": { + "type": "object", + "properties": { + "label": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Whether required.", + "title": "Required" + }, + "page_size": { + "type": "string", + "description": "The page size.", + "title": "Page Size" + }, + "format": { + "type": "string", + "description": "The format.", + "title": "Format" + }, + "base64_encoded_strings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The Base64 encoded strings.", + "title": "Base64 Encoded Strings" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + } + }, + "title": "Label" + }, + "commercial_invoice": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Whether required.", + "title": "Required" + }, + "page_size": { + "type": "string", + "description": "The page size.", + "title": "Page Size" + }, + "format": { + "type": "string", + "description": "The format.", + "title": "Format" + }, + "base64_encoded_strings": { + "type": "array", + "items": {}, + "description": "The Base64 encoded strings.", + "title": "Base64 Encoded Strings" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Commercial Invoice" + }, + "packing_slip": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Whether required.", + "title": "Required" + }, + "page_size": { + "type": "string", + "description": "The page size.", + "title": "Page Size" + }, + "format": { + "type": "string", + "description": "The format.", + "title": "Format" + }, + "base64_encoded_strings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The Base64 encoded strings.", + "title": "Base64 Encoded Strings" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Packing Slip" + }, + "battery_form": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Whether required.", + "title": "Required" + }, + "page_size": { + "type": "string", + "description": "The page size.", + "title": "Page Size" + }, + "format": { + "type": "string", + "description": "The format.", + "title": "Format" + }, + "base64_encoded_strings": { + "type": "array", + "items": {}, + "description": "The Base64 encoded strings.", + "title": "Base64 Encoded Strings" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Battery Form" + }, + "battery_caution_label": { + "type": "object", + "properties": { + "required": { + "type": "boolean", + "description": "Whether required.", + "title": "Required" + }, + "page_size": { + "type": "string", + "description": "The page size.", + "title": "Page Size" + }, + "format": { + "type": "string", + "description": "The format.", + "title": "Format" + }, + "base64_encoded_strings": { + "type": "array", + "items": {}, + "description": "The Base64 encoded strings.", + "title": "Base64 Encoded Strings" + }, + "url": { + "type": "string", + "description": "The URL address.", + "title": "URL" + } + }, + "title": "Battery Caution Label" + } + }, + "title": "Shipping Documents" + } + } + } + } + } + } + }, + "/v2/shipments/warehouse_state": { + "patch": { + "summary": "Update warehouse state", + "description": "Update a shipment's warehouse state. Only available for shipments fulfilled at one of the Easyship integrated warehouses.", + "operationId": "UpdateWarehouseState", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "shipments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "easyship_shipment_id": { + "type": "string", + "description": "The Easyship shipment unique identifier.", + "title": "Easyship Shipment ID" + }, + "warehouse_state": { + "type": "string", + "description": "The warehouse state.", + "title": "Warehouse State" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "metadata": { + "type": "object", + "properties": { + "serial_number": { + "type": "string", + "description": "The serial number.", + "title": "Serial Number" + } + }, + "title": "Metadata" + } + } + }, + "title": "Shipments" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "message": { + "type": "array", + "items": { + "type": "object", + "properties": { + "easyship_shipment_id": { + "type": "string", + "description": "The Easyship shipment unique identifier.", + "title": "Easyship Shipment ID" + }, + "warehouse_state_updated": { + "type": "string", + "description": "The updated warehouse state.", + "title": "Warehouse State Updated" + } + } + }, + "title": "Message" + } + } + } + } + } + } + }, + "/pickup/v1/pickup_slots/{courier_id}": { + "get": { + "summary": "Get available pickup slots (V1)", + "description": "Available pickup slots will be calculated for a specific courier, in local time and for the coming 7 days. A pickup can then be requested using the \"Request pickup\" action.", + "operationId": "GetAvailablePickupSlots", + "parameters": [ + { + "name": "courier_id", + "in": "path", + "x-ms-summary": "Courier ID", + "x-ms-url-encoding": "single", + "description": "The courier identifier.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "courier_id": { + "type": "string", + "description": "The courier identifier.", + "title": "Courier ID" + }, + "courier_name": { + "type": "string", + "description": "The courier name.", + "title": "Courier Name" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "pickup": { + "type": "object", + "properties": { + "provider_name": { + "type": "string", + "description": "The provider name.", + "title": "Provider Name" + }, + "provider_customer_service_phone": { + "type": "string", + "description": "The provider customer service phone number.", + "title": "Provider Customer Service Phone" + }, + "slots": { + "type": "object", + "properties": {}, + "description": "The slots available.", + "title": "Slots" + } + }, + "title": "Pickup" + } + } + } + } + } + } + }, + "/pickup/v1/pickups": { + "post": { + "summary": "Request a pickup (V1)", + "description": "When a pickup is created, a pickup request will be made directly to the courier, which will return a reference number. The reference number may be used when contacting the customer service of the courier. A pickup slot must be chosen; upcoming pickup slots may be found using the \"Get available pickup slots\" action.", + "operationId": "RequestAPickup", + "parameters": [ + { + "name": "body", + "in": "body", + "schema": { + "type": "object", + "properties": { + "courier_id": { + "type": "string", + "description": "The courier identifier.", + "title": "Courier ID" + }, + "preferred_date": { + "type": "string", + "description": "The preferred date.", + "title": "Preferred Date" + }, + "preferred_max_time": { + "type": "string", + "description": "The preferred maximum time.", + "title": "Preferred Max Time" + }, + "preferred_min_time": { + "type": "string", + "description": "The preferred minimum time.", + "title": "Preferred Min Time" + }, + "easyship_shipment_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The Easyship shipment identifers.", + "title": "Easyship Shipment IDs" + } + } + }, + "required": true + } + ], + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "courier_id": { + "type": "string", + "description": "The courier identifier.", + "title": "Courier ID" + }, + "courier_name": { + "type": "string", + "description": "The courier name.", + "title": "Courier Name" + }, + "easyship_shipment_ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The Easyship shipment identifiers.", + "title": "Easyship Shipment IDs" + }, + "pickup": { + "type": "object", + "properties": { + "easyship_pickup_id": { + "type": "string", + "description": "The Easyship pickup identifier.", + "title": "Easyship Pickup ID" + }, + "preferred_min_time": { + "type": "string", + "description": "The preferred minimum time.", + "title": "Preferred Min Time" + }, + "preferred_max_time": { + "type": "string", + "description": "The preferred maximum time.", + "title": "Preferred Max Time" + }, + "pickup_reference_number": { + "type": "string", + "description": "The pickup reference number.", + "title": "Pickup Reference Number" + }, + "pickup_fee": { + "type": "string", + "description": "The pickup fee.", + "title": "Pickup Fee" + }, + "provider_name": { + "type": "string", + "description": "The provider name.", + "title": "Provider Name" + }, + "provider_customer_service_phone": { + "type": "string", + "description": "The provider customer service phone number.", + "title": "Provider Customer Service Phone" + }, + "shipments_count": { + "type": "string", + "description": "The shipments count.", + "title": "Shipments Count" + }, + "total_actual_weight": { + "type": "string", + "description": "The total actual weight.", + "title": "Total Actual Weight" + }, + "pickup_state": { + "type": "string", + "description": "The pickup state.", + "title": "Pickup State" + }, + "address": { + "type": "object", + "properties": { + "line_1": { + "type": "string", + "description": "The address.", + "title": "Address" + }, + "line_2": { + "type": "string", + "description": "The address line 2.", + "title": "Address Line 2" + }, + "line_3": { + "type": "string", + "description": "The address line 3.", + "title": "Address Line 3" + }, + "postal_code": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "country": { + "type": "string", + "description": "The country.", + "title": "Country" + }, + "contact_email": { + "type": "string", + "description": "The contact email address.", + "title": "Contact Email" + }, + "contact_phone": { + "type": "string", + "description": "The contact phone number.", + "title": "Contact Phone" + }, + "company_name": { + "type": "string", + "description": "The company name.", + "title": "Company Name" + }, + "contact_name": { + "type": "string", + "description": "The contact name.", + "title": "Contact Name" + } + }, + "title": "Address" + } + }, + "title": "Pickup" + } + } + } + } + } + } + }, + "/track/v1/checkpoints": { + "get": { + "summary": "Get checkpoints", + "description": "Retrieves details of shipment checkpoints.", + "operationId": "GetCheckpoints", + "parameters": [ + { + "name": "easyship_shipment_id", + "in": "query", + "x-ms-summary": "Easyship Shipment ID", + "description": "The Easyship shipment unique identifier.", + "required": true, + "type": "string" + }, + { + "name": "platform_order_number", + "in": "query", + "x-ms-summary": "Platform Order Number", + "description": "The platform order number.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "x-ms-summary": "Page", + "description": "The page.", + "required": false, + "type": "integer" + }, + { + "name": "per_page", + "in": "query", + "x-ms-summary": "Per Page", + "description": "The number per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "total_page": { + "type": "integer", + "format": "int32", + "description": "The total page.", + "title": "Total Page" + }, + "current_page": { + "type": "integer", + "format": "int32", + "description": "The current page.", + "title": "Current Page" + }, + "shipments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "easyship_shipment_id": { + "type": "string", + "description": "The Easyship shipment unique identifier.", + "title": "Easyship Shipment ID" + }, + "platform_order_number": { + "type": "string", + "description": "The platform order number.", + "title": "Platform Order Number" + }, + "origin": { + "type": "string", + "description": "The origin.", + "title": "Origin" + }, + "destination": { + "type": "string", + "description": "The destination.", + "title": "Destination" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "tracking_number": { + "type": "string", + "description": "The tracking number.", + "title": "Tracking Number" + }, + "tracking_page_url": { + "type": "string", + "description": "The tracking page URL address.", + "title": "Tracking Page URL" + }, + "checkpoints": { + "type": "array", + "items": { + "type": "object", + "properties": { + "order_number": { + "type": "integer", + "format": "int32", + "description": "The order number.", + "title": "Order Number" + }, + "handler": { + "type": "string", + "description": "The handler.", + "title": "Handler" + }, + "message": { + "type": "string", + "description": "The message.", + "title": "Message" + }, + "location": { + "type": "string", + "description": "The location.", + "title": "Location" + }, + "city": { + "type": "string", + "description": "The city.", + "title": "City" + }, + "country_name": { + "type": "string", + "description": "The country.", + "title": "Country" + }, + "country_iso3": { + "type": "string", + "description": "The country code.", + "title": "Country Code" + }, + "coordinates": { + "type": "array", + "items": {}, + "description": "The coordinates.", + "title": "Coordinates" + }, + "state": { + "type": "string", + "description": "The state.", + "title": "State" + }, + "postal_code": { + "type": "string", + "description": "The postal code.", + "title": "Postal Code" + }, + "checkpoint_time": { + "type": "string", + "description": "The checkpoint time.", + "title": "Checkpoint Time" + }, + "primary_status": { + "type": "string", + "description": "The primary status.", + "title": "Primary Status" + } + } + }, + "title": "Checkpoints" + } + } + }, + "title": "Shipments" + } + } + } + } + } + } + }, + "/track/v1/status": { + "get": { + "summary": "Get tracking status", + "description": "Retrieves the tracking status of a shipment.", + "operationId": "GetStatus", + "parameters": [ + { + "name": "easyship_shipment_id", + "default": ":easyship_shipment_id", + "in": "query", + "x-ms-summary": "Easyship Shipment IDs", + "description": "The Easyship shipment identifiers.", + "type": "string", + "required": true + }, + { + "name": "platform_order_number", + "in": "query", + "x-ms-summary": "Platform Order Number", + "description": "The platform order number.", + "required": false, + "type": "string" + }, + { + "name": "page", + "in": "query", + "x-ms-summary": "Page", + "description": "The page.", + "required": false, + "type": "integer" + }, + { + "name": "per_page", + "in": "query", + "x-ms-summary": "Per Page", + "description": "The number per page.", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "total_page": { + "type": "integer", + "format": "int32", + "description": "The total page.", + "title": "Total Page" + }, + "current_page": { + "type": "integer", + "format": "int32", + "description": "The current page.", + "title": "Current Page" + }, + "shipments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "easyship_shipment_id": { + "type": "string", + "description": "The Easyship shipment unique identifier.", + "title": "Easyship Shipment ID" + }, + "platform_order_number": { + "type": "string", + "description": "The platform order number.", + "title": "Platform Order Number" + }, + "origin": { + "type": "string", + "description": "The origin.", + "title": "Origin" + }, + "destination": { + "type": "string", + "description": "The destination.", + "title": "Destination" + }, + "status": { + "type": "string", + "description": "The status.", + "title": "Status" + }, + "tracking_number": { + "type": "string", + "description": "The tracking number.", + "title": "Tracking Number" + }, + "tracking_page_url": { + "type": "string", + "description": "The tracking page URL address.", + "title": "Tracking Page URL" + } + } + }, + "title": "Shipments" + } + } + } + } + } + } + }, + "/reference/v1/categories": { + "get": { + "summary": "Get item categories", + "description": "Retrieves a list of shipment categories and the slug to use the category.", + "operationId": "GetItemCategories", + "parameters": [], + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "slug": { + "type": "string", + "description": "The slug.", + "title": "Slug" + } + } + }, + "title": "Categories" + } + } + } + } + } + } + }, + "/v2/boxes": { + "get": { + "summary": "List all boxes", + "description": "Retrieves a list of all available courier boxes.", + "operationId": "ListAllBoxes", + "parameters": [], + "responses": { + "200": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "boxes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier.", + "title": "ID" + }, + "courier_umbrella_name": { + "type": "string", + "description": "The courier umbrella name.", + "title": "Courier Umbrella Name" + }, + "name": { + "type": "string", + "description": "The name.", + "title": "Name" + }, + "slug": { + "type": "string", + "description": "The slug.", + "title": "Slug" + }, + "outer_length": { + "type": "number", + "format": "float", + "description": "The outer length.", + "title": "Outer Length" + }, + "outer_width": { + "type": "number", + "format": "float", + "description": "The outer width.", + "title": "Outer Width" + }, + "outer_height": { + "type": "number", + "format": "float", + "description": "The outer height.", + "title": "Outer Height" + }, + "weight": { + "type": "number", + "format": "float", + "description": "The weight.", + "title": "Weight" + } + } + }, + "title": "Boxes" + } + } + } + } + } + } + } + }, + "definitions": {}, + "parameters": {}, + "responses": {}, + "securityDefinitions": { + "API Key": { + "type": "apiKey", + "in": "header", + "name": "Authorization" + } + }, + "security": [ + { + "API Key": [] + } + ], + "tags": [], + "x-ms-connector-metadata": [ + { + "propertyName": "Website", + "propertyValue": "https://www.easyship.com/" + }, + { + "propertyName": "Privacy policy", + "propertyValue": "https://www.easyship.com/legal/privacy" + }, + { + "propertyName": "Categories", + "propertyValue": "Business Management;Commerce" + } + ] +} \ No newline at end of file diff --git a/independent-publisher-connectors/Easyship/apiProperties.json b/independent-publisher-connectors/Easyship/apiProperties.json new file mode 100644 index 000000000..154fde35f --- /dev/null +++ b/independent-publisher-connectors/Easyship/apiProperties.json @@ -0,0 +1,23 @@ +{ + "properties": { + "connectionParameters": { + "api_key": { + "type": "securestring", + "uiDefinition": { + "displayName": "API Access Token (in the format: Bearer APIAccessToken)", + "description": "The API Access Token (in the format: Bearer APIAccessToken) for this api", + "tooltip": "Provide your API Access Token (in the format: Bearer APIAccessToken)", + "constraints": { + "tabIndex": 2, + "clearText": false, + "required": "true" + } + } + } + }, + "iconBrandColor": "#da3b01", + "capabilities": [], + "publisher": "Troy Taylor", + "stackOwner": "Easyship" + } +} \ No newline at end of file diff --git a/independent-publisher-connectors/Easyship/readme.md b/independent-publisher-connectors/Easyship/readme.md new file mode 100644 index 000000000..eda840969 --- /dev/null +++ b/independent-publisher-connectors/Easyship/readme.md @@ -0,0 +1,43 @@ +# Easyship +Easyship provides a powerful service for you to add hassle free worldwide shipping options to your website and end to end shipping functionality to your warehouse, ERP or platform. + +## Publisher: Troy Taylor, Hitachi Solutions + +## Prerequisites +Use of the Easyship service requires a plan enrollment, with 50 shipments allowed per month on the $0 plan. + +## Obtaining Credentials +In your account dashboard, select Connect then New Integration. You will need to register an integration to receive access token for your production and sandbox environments. + +## Supported Operations +### Get rates and taxes +Retrieve a list of shipping quotes for a prospective shipment. +### List all shipments +Retrieves a list of all shipments. +### Create a shipment +Creates and retrieves the information about a shipment. +### Buy a shipment label (V1) +Buy and retrieve information about a shipping label. +### Delete a shipment (V1) +Delete and receive confirmation of a shipment deletion. +### Update a shipment +Update a shipment details. +### Get a shipment +Get the details of a shipment. +### Update warehouse state +Update a shipment's warehouse state. Only available for shipments fulfilled at one of the Easyship integrated warehouses. +### Get available pickup slots (V1) +Available pickup slots will be calculated for a specific courier, in local time and for the coming 7 days. A pickup can then be requested using the "Request pickup" action. +### Request a pickup (V1) +When a pickup is created, a pickup request will be made directly to the courier, which will return a reference number. The reference number may be used when contacting the customer service of the courier. A pickup slot must be chosen; upcoming pickup slots may be found using the "Get available pickup slots" action. +### Get checkpoints +Retrieves details of shipment checkpoints. +### Get tracking status +Retrieves the tracking status of a shipment. +### Get item categories +Retrieves a list of shipment categories and the slug to use the category. +### List all boxes +Retrieves a list of all available courier boxes. + +## Known Issues and Limitations +Some of these actions are only available through the V1 version of the API. These actions will have (V1) at the end of the action name.