{ "openapi": "3.0.0", "info": { "title": "Unified.to SHIPPING API", "version": "1.0", "description": "One API to Rule Them All", "contact": { "email": "hello@unified.to", "url": "https://unified.to/contact" }, "termsOfService": "https://unified.to/tos" }, "externalDocs": { "description": "API Documentation", "url": "https://docs.unified.to" }, "tags": [ { "name": "unifiedapi", "description": "Unified.to API" }, { "name": "shipping" }, { "name": "shipment" }, { "name": "label" }, { "name": "tracking" }, { "name": "rate" }, { "name": "carrier" } ], "security": [ { "jwt": [] } ], "servers": [ { "url": "https://api.unified.to", "description": "North American data region" }, { "url": "https://api-eu.unified.to", "description": "European data region" }, { "url": "https://api-au.unified.to", "description": "Australian data region" } ], "components": { "securitySchemes": { "jwt": { "type": "apiKey", "name": "authorization", "in": "header" } }, "requestBodies": { "ShippingShipment": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingShipment" } } } }, "ShippingLabel": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingLabel" } } } }, "ShippingRate": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingRate" } } } } }, "schemas": { "property_ShippingShipment_from_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string" }, "name": { "type": "string" }, "company_name": { "type": "string" }, "telephone": { "type": "string" }, "email": { "type": "string" }, "is_residential": { "type": "boolean" }, "is_validated": { "type": "boolean" }, "delivery_instructions": { "type": "string" } }, "description": "Origin address" }, "property_ShippingShipment_to_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string" }, "name": { "type": "string" }, "company_name": { "type": "string" }, "telephone": { "type": "string" }, "email": { "type": "string" }, "is_residential": { "type": "boolean" }, "is_validated": { "type": "boolean" }, "delivery_instructions": { "type": "string" } }, "description": "Destination address" }, "ShippingPackage": { "type": "object", "properties": { "weight": { "type": "number" }, "weight_unit": { "type": "string", "enum": [ "g", "kg", "oz", "lb" ], "x-speakeasy-unknown-values": "allow" }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "size_unit": { "type": "string", "enum": [ "cm", "inch" ], "x-speakeasy-unknown-values": "allow" }, "description": { "type": "string" }, "value": { "type": "number" }, "currency": { "type": "string" }, "tracking_number": { "type": "string" }, "insured_amount": { "type": "number" } } }, "property_ShippingShipment_packages": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingPackage" }, "description": "Array of packages in this shipment" }, "property_ShippingShipment_return_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string" }, "name": { "type": "string" }, "company_name": { "type": "string" }, "telephone": { "type": "string" }, "email": { "type": "string" }, "is_residential": { "type": "boolean" }, "is_validated": { "type": "boolean" }, "delivery_instructions": { "type": "string" } }, "description": "Return address (may differ from from_address)" }, "ShippingCustomsItem": { "type": "object", "properties": { "description": { "type": "string" }, "quantity": { "type": "number" }, "amount": { "type": "number" }, "currency": { "type": "string" }, "weight": { "type": "number" }, "weight_unit": { "type": "string", "enum": [ "g", "kg", "oz", "lb" ], "x-speakeasy-unknown-values": "allow" }, "harmonized_tariff_code": { "type": "string" }, "country_of_origin": { "type": "string" }, "sku": { "type": "string" } } }, "property_ShippingShipment_customs_items": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingCustomsItem" }, "description": "Customs items" }, "property_ShippingShipment_customs_restrictions": { "type": "array", "items": { "type": "string" }, "description": "Any restrictions" }, "property_ShippingShipment_customs": { "type": "object", "properties": { "contents_type": { "type": "string", "enum": [ "MERCHANDISE", "DOCUMENTS", "GIFT", "RETURNED_GOODS", "SAMPLE", "OTHER" ], "x-speakeasy-unknown-values": "allow" }, "description": { "type": "string" }, "amount": { "type": "number" }, "currency": { "type": "string" }, "duties_paid_by": { "type": "string", "enum": [ "SENDER", "RECIPIENT", "THIRD_PARTY" ], "x-speakeasy-unknown-values": "allow" }, "taxes_paid_by": { "type": "string", "enum": [ "SENDER", "RECIPIENT", "THIRD_PARTY" ], "x-speakeasy-unknown-values": "allow" }, "shipper_eori": { "type": "string" }, "recipient_eori": { "type": "string" }, "shipper_tax_number": { "type": "string" }, "recipient_tax_number": { "type": "string" }, "items": { "$ref": "#/components/schemas/property_ShippingShipment_customs_items" }, "restrictions": { "$ref": "#/components/schemas/property_ShippingShipment_customs_restrictions" }, "non_delivery_option": { "type": "string", "enum": [ "RETURN", "ABANDON" ], "x-speakeasy-unknown-values": "allow" } }, "description": "Customs information" }, "property_ShippingShipment_insurance": { "type": "object", "properties": { "insured_value": { "type": "number" }, "currency": { "type": "string" }, "insurance_provider": { "type": "string" }, "insurance_provider_code": { "type": "string" }, "insurance_cost": { "type": "number" }, "insurance_cost_currency": { "type": "string" }, "coverage_type": { "type": "string", "enum": [ "STANDARD", "PREMIUM", "CUSTOM" ], "x-speakeasy-unknown-values": "allow" }, "coverage_amount": { "type": "number" } }, "description": "Insurance details" }, "property_ShippingShipment_special_instructions": { "type": "array", "items": { "type": "string" }, "description": "Array of special instructions" }, "ShippingShipmentLineitem": { "type": "object", "properties": { "id": { "type": "string" }, "item_id": { "type": "string" }, "item_variant_id": { "type": "string" }, "order_lineitem_id": { "type": "string" }, "quantity": { "type": "number" }, "item_name": { "type": "string" }, "sku": { "type": "string" } } }, "property_ShippingShipment_lineitems": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingShipmentLineitem" }, "description": "Item-level fulfillment lines (what shipped); used by commerce-platform fulfillments" }, "ShippingShipment": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "order_id": { "type": "string" }, "organization_id": { "type": "string" }, "from_address": { "$ref": "#/components/schemas/property_ShippingShipment_from_address" }, "to_address": { "$ref": "#/components/schemas/property_ShippingShipment_to_address" }, "packages": { "$ref": "#/components/schemas/property_ShippingShipment_packages" }, "carrier_id": { "type": "string" }, "service_code": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "IN_TRANSIT", "DELIVERED", "EXCEPTION", "CANCELLED", "LABEL_CREATED", "PICKED_UP", "OUT_FOR_DELIVERY", "DELIVERY_ATTEMPTED", "RETURNED_TO_SENDER", "HELD_AT_LOCATION", "CUSTOMS_CLEARANCE", "EXCEPTION_RESOLVED" ], "x-speakeasy-unknown-values": "allow" }, "rate_id": { "type": "string" }, "label_id": { "type": "string" }, "tracking_id": { "type": "string" }, "shipped_at": { "type": "string", "format": "date-time" }, "rate_amount": { "type": "number" }, "rate_currency": { "type": "string" }, "rate_service_name": { "type": "string" }, "rate_estimated_days": { "type": "number" }, "rate_estimated_delivery_at": { "type": "string", "format": "date-time" }, "is_rate_guaranteed": { "type": "boolean" }, "return_address": { "$ref": "#/components/schemas/property_ShippingShipment_return_address" }, "return_authorization_number": { "type": "string" }, "warehouse_location_id": { "type": "string" }, "warehouse_location_name": { "type": "string" }, "customs": { "$ref": "#/components/schemas/property_ShippingShipment_customs" }, "is_international": { "type": "boolean" }, "insurance": { "$ref": "#/components/schemas/property_ShippingShipment_insurance" }, "special_instructions": { "$ref": "#/components/schemas/property_ShippingShipment_special_instructions" }, "is_signature_required": { "type": "boolean" }, "is_adult_signature_required": { "type": "boolean" }, "reference_number": { "type": "string" }, "is_return": { "type": "boolean" }, "original_shipment_id": { "type": "string" }, "return_reason": { "type": "string" }, "return_type": { "type": "string", "enum": [ "CUSTOMER", "VENDOR", "WARRANTY", "DEFECTIVE", "OTHER" ], "x-speakeasy-unknown-values": "allow" }, "carrier_name": { "type": "string" }, "tracking_url": { "type": "string" }, "lineitems": { "$ref": "#/components/schemas/property_ShippingShipment_lineitems" }, "raw": { "type": "object", "additionalProperties": true } } }, "ShippingShipments": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingShipment" } }, "ShippingLabel": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "shipment_id": { "type": "string" }, "tracking_number": { "type": "string" }, "label_url": { "type": "string" }, "label_format": { "type": "string", "enum": [ "PDF", "PNG", "ZPL", "EPL2", "PDF_4X6", "PDF_4X8", "PNG_4X6", "PNG_4X8" ], "x-speakeasy-unknown-values": "allow" }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "IN_TRANSIT", "DELIVERED", "EXCEPTION", "CANCELLED", "LABEL_CREATED", "PICKED_UP", "OUT_FOR_DELIVERY", "DELIVERY_ATTEMPTED", "RETURNED_TO_SENDER", "HELD_AT_LOCATION", "CUSTOMS_CLEARANCE", "EXCEPTION_RESOLVED" ], "x-speakeasy-unknown-values": "allow" }, "is_voided": { "type": "boolean" }, "label_cost": { "type": "number" }, "label_cost_currency": { "type": "string" }, "rate_id": { "type": "string" }, "service_code": { "type": "string" }, "raw": { "type": "object", "additionalProperties": true } } }, "ShippingLabels": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingLabel" } }, "property_ShippingTrackingEvent_location_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string" }, "name": { "type": "string" }, "company_name": { "type": "string" }, "telephone": { "type": "string" }, "email": { "type": "string" }, "is_residential": { "type": "boolean" }, "is_validated": { "type": "boolean" }, "delivery_instructions": { "type": "string" } } }, "ShippingTrackingEvent": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "IN_TRANSIT", "DELIVERED", "EXCEPTION", "CANCELLED", "LABEL_CREATED", "PICKED_UP", "OUT_FOR_DELIVERY", "DELIVERY_ATTEMPTED", "RETURNED_TO_SENDER", "HELD_AT_LOCATION", "CUSTOMS_CLEARANCE", "EXCEPTION_RESOLVED" ], "x-speakeasy-unknown-values": "allow" }, "event_code": { "type": "string" }, "carrier_status_code": { "type": "string" }, "location_address": { "$ref": "#/components/schemas/property_ShippingTrackingEvent_location_address" }, "location_id": { "type": "string" }, "location_name": { "type": "string" }, "notes": { "type": "string" }, "signed_by": { "type": "string" } } }, "property_ShippingTracking_events": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingTrackingEvent" }, "description": "Array of tracking events" }, "ShippingTracking": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "shipment_id": { "type": "string" }, "tracking_number": { "type": "string" }, "status": { "type": "string", "enum": [ "PENDING", "PROCESSING", "IN_TRANSIT", "DELIVERED", "EXCEPTION", "CANCELLED", "LABEL_CREATED", "PICKED_UP", "OUT_FOR_DELIVERY", "DELIVERY_ATTEMPTED", "RETURNED_TO_SENDER", "HELD_AT_LOCATION", "CUSTOMS_CLEARANCE", "EXCEPTION_RESOLVED" ], "x-speakeasy-unknown-values": "allow" }, "events": { "$ref": "#/components/schemas/property_ShippingTracking_events" }, "estimated_delivery": { "type": "string", "format": "date-time" }, "actual_delivery_at": { "type": "string", "format": "date-time" }, "status_description": { "type": "string" }, "carrier_id": { "type": "string" }, "carrier_status_code": { "type": "string" }, "carrier_status_description": { "type": "string" }, "raw": { "type": "object", "additionalProperties": true } } }, "ShippingTrackings": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingTracking" } }, "property_ShippingRate_from_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string" }, "name": { "type": "string" }, "company_name": { "type": "string" }, "telephone": { "type": "string" }, "email": { "type": "string" }, "is_residential": { "type": "boolean" }, "is_validated": { "type": "boolean" }, "delivery_instructions": { "type": "string" } }, "description": "Origin address" }, "property_ShippingRate_to_address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "region_code": { "type": "string" }, "postal_code": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string" }, "name": { "type": "string" }, "company_name": { "type": "string" }, "telephone": { "type": "string" }, "email": { "type": "string" }, "is_residential": { "type": "boolean" }, "is_validated": { "type": "boolean" }, "delivery_instructions": { "type": "string" } }, "description": "Destination address" }, "property_ShippingRate_packages": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingPackage" }, "description": "Multiple packages (alternative to package)" }, "ShippingRateSurcharge": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "amount": { "type": "number" }, "description": { "type": "string" } } }, "property_ShippingRateRate_surcharges": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingRateSurcharge" }, "description": "Additional charges" }, "ShippingRateRate": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "amount": { "type": "number" }, "currency": { "type": "string" }, "base_amount": { "type": "number" }, "tax_amount": { "type": "number" }, "discount_amount": { "type": "number" }, "surcharges": { "$ref": "#/components/schemas/property_ShippingRateRate_surcharges" }, "rate_source": { "type": "string" }, "is_negotiated_rate": { "type": "boolean" }, "estimated_days": { "type": "number" }, "delivery_days": { "type": "number" }, "estimated_delivery_end_at": { "type": "string", "format": "date-time" }, "estimated_delivery_start_at": { "type": "string", "format": "date-time" }, "delivery_terms": { "type": "string" }, "transit_hours": { "type": "number" }, "is_guaranteed": { "type": "boolean" }, "package_type": { "type": "string" }, "is_trackable": { "type": "boolean" }, "is_active": { "type": "boolean" } }, "required": [ "title" ] }, "property_ShippingRate_rates": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingRateRate" } }, "ShippingRate": { "type": "object", "properties": { "shipment_id": { "type": "string" }, "currency": { "type": "string" }, "from_address": { "$ref": "#/components/schemas/property_ShippingRate_from_address" }, "to_address": { "$ref": "#/components/schemas/property_ShippingRate_to_address" }, "packages": { "$ref": "#/components/schemas/property_ShippingRate_packages" }, "ship_by_at": { "type": "string", "format": "date-time" }, "carrier_id": { "type": "string" }, "id": { "type": "string" }, "rates": { "$ref": "#/components/schemas/property_ShippingRate_rates" }, "raw": { "type": "object", "additionalProperties": true } } }, "ShippingCarrier": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "code": { "type": "string" }, "is_active": { "type": "boolean" }, "logo_url": { "type": "string" }, "website_url": { "type": "string" }, "raw": { "type": "object", "additionalProperties": true } } }, "ShippingCarriers": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingCarrier" } } } }, "paths": { "/shipping/{connection_id}/shipment": { "post": { "summary": "Create a shipment", "parameters": [ { "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "order_id", "organization_id", "from_address", "to_address", "packages", "carrier_id", "service_code", "status", "rate_id", "label_id", "tracking_id", "shipped_at", "rate_amount", "rate_currency", "rate_service_name", "rate_estimated_days", "rate_estimated_delivery_at", "is_rate_guaranteed", "return_address", "return_authorization_number", "warehouse_location_id", "warehouse_location_name", "customs", "is_international", "insurance", "special_instructions", "is_signature_required", "is_adult_signature_required", "reference_number", "is_return", "original_shipment_id", "return_reason", "return_type", "carrier_name", "tracking_url", "lineitems", "raw" ] } }, "name": "fields", "in": "query", "required": false, "description": "Fields to return" }, { "schema": { "type": "string" }, "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "schema": { "type": "string" }, "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true } ], "tags": [ "shipping", "shipment" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingShipment" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingShipment" } } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createShippingShipment" }, "get": { "summary": "List all shipments", "parameters": [ { "schema": { "type": "number" }, "name": "limit", "in": "query", "required": false }, { "schema": { "type": "number" }, "name": "offset", "in": "query", "required": false }, { "schema": { "type": "string" }, "name": "updated_gte", "in": "query", "required": false, "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "schema": { "type": "string" }, "name": "sort", "in": "query", "required": false }, { "schema": { "type": "string" }, "name": "order", "in": "query", "required": false }, { "schema": { "type": "string" }, "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "schema": { "type": "string" }, "name": "order_id", "in": "query", "required": false, "description": "The AccountingOrder ID to filter by" }, { "schema": { "type": "string" }, "name": "carrier_id", "in": "query", "required": false, "description": "The ShippingCarrier ID to filter by" }, { "schema": { "type": "string" }, "name": "org_id", "in": "query", "required": false, "description": "The org ID to filter by" }, { "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "order_id", "organization_id", "from_address", "to_address", "packages", "carrier_id", "service_code", "status", "rate_id", "label_id", "tracking_id", "shipped_at", "rate_amount", "rate_currency", "rate_service_name", "rate_estimated_days", "rate_estimated_delivery_at", "is_rate_guaranteed", "return_address", "return_authorization_number", "warehouse_location_id", "warehouse_location_name", "customs", "is_international", "insurance", "special_instructions", "is_signature_required", "is_adult_signature_required", "reference_number", "is_return", "original_shipment_id", "return_reason", "return_type", "carrier_name", "tracking_url", "lineitems", "raw" ] } }, "name": "fields", "in": "query", "required": false, "description": "Fields to return" }, { "schema": { "type": "string" }, "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "schema": { "type": "string" }, "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true } ], "tags": [ "shipping", "shipment" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingShipments" } } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listShippingShipments" } }, "/shipping/{connection_id}/shipment/{id}": { "get": { "summary": "Retrieve a shipment", "parameters": [ { "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "order_id", "organization_id", "from_address", "to_address", "packages", "carrier_id", "service_code", "status", "rate_id", "label_id", "tracking_id", "shipped_at", "rate_amount", "rate_currency", "rate_service_name", "rate_estimated_days", "rate_estimated_delivery_at", "is_rate_guaranteed", "return_address", "return_authorization_number", "warehouse_location_id", "warehouse_location_name", "customs", "is_international", "insurance", "special_instructions", "is_signature_required", "is_adult_signature_required", "reference_number", "is_return", "original_shipment_id", "return_reason", "return_type", "carrier_name", "tracking_url", "lineitems", "raw" ] } }, "name": "fields", "in": "query", "required": false, "description": "Fields to return" }, { "schema": { "type": "string" }, "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "schema": { "type": "string" }, "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true }, { "schema": { "type": "string" }, "description": "ID of the Shipment", "name": "id", "in": "path", "required": true } ], "tags": [ "shipping", "shipment" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingShipment" } } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getShippingShipment" }, "put": { "summary": "Update a shipment", "parameters": [ { "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "order_id", "organization_id", "from_address", "to_address", "packages", "carrier_id", "service_code", "status", "rate_id", "label_id", "tracking_id", "shipped_at", "rate_amount", "rate_currency", "rate_service_name", "rate_estimated_days", "rate_estimated_delivery_at", "is_rate_guaranteed", "return_address", "return_authorization_number", "warehouse_location_id", "warehouse_location_name", "customs", "is_international", "insurance", "special_instructions", "is_signature_required", "is_adult_signature_required", "reference_number", "is_return", "original_shipment_id", "return_reason", "return_type", "carrier_name", "tracking_url", "lineitems", "raw" ] } }, "name": "fields", "in": "query", "required": false, "description": "Fields to return" }, { "schema": { "type": "string" }, "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "schema": { "type": "string" }, "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true }, { "schema": { "type": "string" }, "description": "ID of the Shipment", "name": "id", "in": "path", "required": true } ], "tags": [ "shipping", "shipment" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingShipment" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingShipment" } } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateShippingShipment" }, "patch": { "summary": "Update a shipment", "parameters": [ { "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "order_id", "organization_id", "from_address", "to_address", "packages", "carrier_id", "service_code", "status", "rate_id", "label_id", "tracking_id", "shipped_at", "rate_amount", "rate_currency", "rate_service_name", "rate_estimated_days", "rate_estimated_delivery_at", "is_rate_guaranteed", "return_address", "return_authorization_number", "warehouse_location_id", "warehouse_location_name", "customs", "is_international", "insurance", "special_instructions", "is_signature_required", "is_adult_signature_required", "reference_number", "is_return", "original_shipment_id", "return_reason", "return_type", "carrier_name", "tracking_url", "lineitems", "raw" ] } }, "name": "fields", "in": "query", "required": false, "description": "Fields to return" }, { "schema": { "type": "string" }, "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "schema": { "type": "string" }, "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true }, { "schema": { "type": "string" }, "description": "ID of the Shipment", "name": "id", "in": "path", "required": true } ], "tags": [ "shipping", "shipment" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingShipment" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingShipment" } } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "patchShippingShipment" }, "delete": { "summary": "Remove a shipment", "parameters": [ { "schema": { "type": "string" }, "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true }, { "schema": { "type": "string" }, "description": "ID of the Shipment", "name": "id", "in": "path", "required": true } ], "tags": [ "shipping", "shipment" ], "responses": { "200": { "description": "Successful" }, "default": { "headers": { "Content-Type": { "required": false, "schema": { "type": "string" } } }, "content": {}, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeShippingShipment" } }, "/shipping/{connection_id}/label": { "post": { "summary": "Create a label", "parameters": [ { "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "shipment_id", "tracking_number", "label_url", "label_format", "status", "is_voided", "label_cost", "label_cost_currency", "rate_id", "service_code", "raw" ] } }, "name": "fields", "in": "query", "required": false, "description": "Fields to return" }, { "schema": { "type": "string" }, "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "schema": { "type": "string" }, "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true } ], "tags": [ "shipping", "label" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingLabel" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingLabel" } } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createShippingLabel" }, "get": { "summary": "List all labels", "parameters": [ { "schema": { "type": "number" }, "name": "limit", "in": "query", "required": false }, { "schema": { "type": "number" }, "name": "offset", "in": "query", "required": false }, { "schema": { "type": "string" }, "name": "updated_gte", "in": "query", "required": false, "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "schema": { "type": "string" }, "name": "sort", "in": "query", "required": false }, { "schema": { "type": "string" }, "name": "order", "in": "query", "required": false }, { "schema": { "type": "string" }, "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "schema": { "type": "string" }, "name": "shipment_id", "in": "query", "required": false, "description": "The ShippingShipment ID to filter by" }, { "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "shipment_id", "tracking_number", "label_url", "label_format", "status", "is_voided", "label_cost", "label_cost_currency", "rate_id", "service_code", "raw" ] } }, "name": "fields", "in": "query", "required": false, "description": "Fields to return" }, { "schema": { "type": "string" }, "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "schema": { "type": "string" }, "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true } ], "tags": [ "shipping", "label" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingLabels" } } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listShippingLabels" } }, "/shipping/{connection_id}/label/{id}": { "get": { "summary": "Retrieve a label", "parameters": [ { "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "shipment_id", "tracking_number", "label_url", "label_format", "status", "is_voided", "label_cost", "label_cost_currency", "rate_id", "service_code", "raw" ] } }, "name": "fields", "in": "query", "required": false, "description": "Fields to return" }, { "schema": { "type": "string" }, "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "schema": { "type": "string" }, "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true }, { "schema": { "type": "string" }, "description": "ID of the Label", "name": "id", "in": "path", "required": true } ], "tags": [ "shipping", "label" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingLabel" } } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getShippingLabel" }, "put": { "summary": "Update a label", "parameters": [ { "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "shipment_id", "tracking_number", "label_url", "label_format", "status", "is_voided", "label_cost", "label_cost_currency", "rate_id", "service_code", "raw" ] } }, "name": "fields", "in": "query", "required": false, "description": "Fields to return" }, { "schema": { "type": "string" }, "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "schema": { "type": "string" }, "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true }, { "schema": { "type": "string" }, "description": "ID of the Label", "name": "id", "in": "path", "required": true } ], "tags": [ "shipping", "label" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingLabel" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingLabel" } } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "updateShippingLabel" }, "patch": { "summary": "Update a label", "parameters": [ { "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "shipment_id", "tracking_number", "label_url", "label_format", "status", "is_voided", "label_cost", "label_cost_currency", "rate_id", "service_code", "raw" ] } }, "name": "fields", "in": "query", "required": false, "description": "Fields to return" }, { "schema": { "type": "string" }, "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "schema": { "type": "string" }, "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true }, { "schema": { "type": "string" }, "description": "ID of the Label", "name": "id", "in": "path", "required": true } ], "tags": [ "shipping", "label" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingLabel" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingLabel" } } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "patchShippingLabel" }, "delete": { "summary": "Remove a label", "parameters": [ { "schema": { "type": "string" }, "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true }, { "schema": { "type": "string" }, "description": "ID of the Label", "name": "id", "in": "path", "required": true } ], "tags": [ "shipping", "label" ], "responses": { "200": { "description": "Successful" }, "default": { "headers": { "Content-Type": { "required": false, "schema": { "type": "string" } } }, "content": {}, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "removeShippingLabel" } }, "/shipping/{connection_id}/tracking/{id}": { "get": { "summary": "Retrieve a tracking", "parameters": [ { "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "shipment_id", "tracking_number", "status", "events", "estimated_delivery", "actual_delivery_at", "status_description", "carrier_id", "carrier_status_code", "carrier_status_description", "raw" ] } }, "name": "fields", "in": "query", "required": false, "description": "Fields to return" }, { "schema": { "type": "string" }, "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "schema": { "type": "string" }, "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true }, { "schema": { "type": "string" }, "description": "ID of the Tracking", "name": "id", "in": "path", "required": true } ], "tags": [ "shipping", "tracking" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingTracking" } } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getShippingTracking" } }, "/shipping/{connection_id}/tracking": { "get": { "summary": "List all trackings", "parameters": [ { "schema": { "type": "number" }, "name": "limit", "in": "query", "required": false }, { "schema": { "type": "number" }, "name": "offset", "in": "query", "required": false }, { "schema": { "type": "string" }, "name": "updated_gte", "in": "query", "required": false, "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "schema": { "type": "string" }, "name": "sort", "in": "query", "required": false }, { "schema": { "type": "string" }, "name": "order", "in": "query", "required": false }, { "schema": { "type": "string" }, "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "schema": { "type": "string" }, "name": "order_id", "in": "query", "required": false, "description": "The AccountingOrder ID to filter by" }, { "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "shipment_id", "tracking_number", "status", "events", "estimated_delivery", "actual_delivery_at", "status_description", "carrier_id", "carrier_status_code", "carrier_status_description", "raw" ] } }, "name": "fields", "in": "query", "required": false, "description": "Fields to return" }, { "schema": { "type": "string" }, "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "schema": { "type": "string" }, "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true } ], "tags": [ "shipping", "tracking" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingTrackings" } } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listShippingTrackings" } }, "/shipping/{connection_id}/rate": { "post": { "summary": "Create a rate", "parameters": [ { "schema": { "type": "array", "items": { "type": "string", "enum": [ "shipment_id", "currency", "from_address", "to_address", "packages", "ship_by_at", "carrier_id", "id", "rates", "raw" ] } }, "name": "fields", "in": "query", "required": false, "description": "Fields to return" }, { "schema": { "type": "string" }, "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "schema": { "type": "string" }, "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true } ], "tags": [ "shipping", "rate" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingRate" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingRate" } } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "createShippingRate" } }, "/shipping/{connection_id}/carrier/{id}": { "get": { "summary": "Retrieve a carrier", "parameters": [ { "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "code", "is_active", "logo_url", "website_url", "raw" ] } }, "name": "fields", "in": "query", "required": false, "description": "Fields to return" }, { "schema": { "type": "string" }, "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "schema": { "type": "string" }, "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true }, { "schema": { "type": "string" }, "description": "ID of the Carrier", "name": "id", "in": "path", "required": true } ], "tags": [ "shipping", "carrier" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingCarrier" } } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "getShippingCarrier" } }, "/shipping/{connection_id}/carrier": { "get": { "summary": "List all carriers", "parameters": [ { "schema": { "type": "number" }, "name": "limit", "in": "query", "required": false }, { "schema": { "type": "number" }, "name": "offset", "in": "query", "required": false }, { "schema": { "type": "string" }, "name": "updated_gte", "in": "query", "required": false, "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "schema": { "type": "string" }, "name": "sort", "in": "query", "required": false }, { "schema": { "type": "string" }, "name": "order", "in": "query", "required": false }, { "schema": { "type": "string" }, "name": "query", "in": "query", "required": false, "description": "Query string to search. eg. email address or name" }, { "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "created_at", "updated_at", "name", "code", "is_active", "logo_url", "website_url", "raw" ] } }, "name": "fields", "in": "query", "required": false, "description": "Fields to return" }, { "schema": { "type": "string" }, "name": "raw", "in": "query", "required": false, "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "schema": { "type": "string" }, "description": "ID of the connection", "name": "connection_id", "in": "path", "required": true } ], "tags": [ "shipping", "carrier" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingCarriers" } } }, "description": "Successful" } }, "security": [ { "jwt": [] } ], "operationId": "listShippingCarriers" } } } }